Class: RecordMetadata

name: RecordMetadata
description: A data structure that encapsulates provenance metadata that applies to
  a specific concrete record/encoding of information, as opposed to provenance of
  the abstract information content/knowledge the record represents.
title: Record Metadata
comments:
- "Record-level metadata applies to a specific concrete encoding/serialization of\
  \ knowledge  (e.g as a record in a specific database, or an online digital resource).\
  \ \n\nA RecordMetadata object can capture provenance and other metadata, including\
  \ when, how, and by whom a specific record was generated or modified; what upstream\
  \ resources it was derived/retrieved from; and record-level administrative information\
  \ such as versioning and system / lifecycle status."
from_schema: https://w3id.org/ga4gh-va-core-im
is_a: Utility
slots:
- recordIdentifier
- recordVersion
- derivedFrom
- dateRecordCreated
- contributions
slot_usage:
  recordIdentifier:
    name: recordIdentifier
    description: The business identifier of the record described in the RecordMetadata
      object (required when the record described is not the one in the present system)
    comments:
    - This is needed only when the RecordMetadata object describes an upstream source
      record, as opposed to the record in the present system, so it is clear what
      the metadata it contains is about.  e.g. when ClinGen ingests and transfroms
      ClinVar data, it wants to maintain a record of when the source ClinVar record
      was submitted and by whom.  A RecordMetadata object could be created that describes
      this upstream source recrod, including infromation about its submission to ClinVar.
    multivalued: false
    domain_of:
    - RecordMetadata
    range: Identifier
    required: false
  recordVersion:
    name: recordVersion
    description: The version number of the record-level artifact the object describes
    multivalued: false
    domain_of:
    - RecordMetadata
    range: string
    required: false
  derivedFrom:
    name: derivedFrom
    description: Another data record from which the record described here was derived.
    comments:
    - Value should be a string representing the identifier of the source record.
    multivalued: true
    domain_of:
    - InformationEntity
    - StudyResult
    - RecordMetadata
    range: Identifier
    required: false
  dateRecordCreated:
    name: dateRecordCreated
    description: The date the record was initially created.
    multivalued: false
    domain_of:
    - RecordMetadata
    range: DateTime
    required: false
  contributions:
    name: contributions
    description: Links to a 'Contribution' object allowing richer representation of
      specific types of contributions made by an agent to the creation, modification,
      or administrative management of a record.
    multivalued: true
    domain_of:
    - InformationEntity
    - RecordMetadata
    range: Contribution
    required: false

name: RecordMetadata
description: A data structure that encapsulates provenance metadata that applies to
  a specific concrete record/encoding of information, as opposed to provenance of
  the abstract information content/knowledge the record represents.
title: Record Metadata
comments:
- "Record-level metadata applies to a specific concrete encoding/serialization of\
  \ knowledge  (e.g as a record in a specific database, or an online digital resource).\
  \ \n\nA RecordMetadata object can capture provenance and other metadata, including\
  \ when, how, and by whom a specific record was generated or modified; what upstream\
  \ resources it was derived/retrieved from; and record-level administrative information\
  \ such as versioning and system / lifecycle status."
from_schema: https://w3id.org/ga4gh-va-core-im
is_a: Utility
slot_usage:
  recordIdentifier:
    name: recordIdentifier
    description: The business identifier of the record described in the RecordMetadata
      object (required when the record described is not the one in the present system)
    comments:
    - This is needed only when the RecordMetadata object describes an upstream source
      record, as opposed to the record in the present system, so it is clear what
      the metadata it contains is about.  e.g. when ClinGen ingests and transfroms
      ClinVar data, it wants to maintain a record of when the source ClinVar record
      was submitted and by whom.  A RecordMetadata object could be created that describes
      this upstream source recrod, including infromation about its submission to ClinVar.
    multivalued: false
    domain_of:
    - RecordMetadata
    range: Identifier
    required: false
  recordVersion:
    name: recordVersion
    description: The version number of the record-level artifact the object describes
    multivalued: false
    domain_of:
    - RecordMetadata
    range: string
    required: false
  derivedFrom:
    name: derivedFrom
    description: Another data record from which the record described here was derived.
    comments:
    - Value should be a string representing the identifier of the source record.
    multivalued: true
    domain_of:
    - InformationEntity
    - StudyResult
    - RecordMetadata
    range: Identifier
    required: false
  dateRecordCreated:
    name: dateRecordCreated
    description: The date the record was initially created.
    multivalued: false
    domain_of:
    - RecordMetadata
    range: DateTime
    required: false
  contributions:
    name: contributions
    description: Links to a 'Contribution' object allowing richer representation of
      specific types of contributions made by an agent to the creation, modification,
      or administrative management of a record.
    multivalued: true
    domain_of:
    - InformationEntity
    - RecordMetadata
    range: Contribution
    required: false
attributes:
  recordIdentifier:
    name: recordIdentifier
    description: The business identifier of the record described in the RecordMetadata
      object (required when the record described is not the one in the present system)
    comments:
    - This is needed only when the RecordMetadata object describes an upstream source
      record, as opposed to the record in the present system, so it is clear what
      the metadata it contains is about.  e.g. when ClinGen ingests and transfroms
      ClinVar data, it wants to maintain a record of when the source ClinVar record
      was submitted and by whom.  A RecordMetadata object could be created that describes
      this upstream source recrod, including infromation about its submission to ClinVar.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: false
    alias: recordIdentifier
    owner: RecordMetadata
    domain_of:
    - RecordMetadata
    range: Identifier
    required: false
  recordVersion:
    name: recordVersion
    description: The version number of the record-level artifact the object describes
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: false
    alias: recordVersion
    owner: RecordMetadata
    domain_of:
    - RecordMetadata
    range: string
    required: false
  derivedFrom:
    name: derivedFrom
    description: Another data record from which the record described here was derived.
    comments:
    - Value should be a string representing the identifier of the source record.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: true
    alias: derivedFrom
    owner: RecordMetadata
    domain_of:
    - InformationEntity
    - StudyResult
    - RecordMetadata
    range: Identifier
    required: false
  dateRecordCreated:
    name: dateRecordCreated
    description: The date the record was initially created.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: false
    alias: dateRecordCreated
    owner: RecordMetadata
    domain_of:
    - RecordMetadata
    range: DateTime
    required: false
  contributions:
    name: contributions
    description: Links to a 'Contribution' object allowing richer representation of
      specific types of contributions made by an agent to the creation, modification,
      or administrative management of a record.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: true
    alias: contributions
    owner: RecordMetadata
    domain_of:
    - InformationEntity
    - RecordMetadata
    range: Contribution
    required: false
  type:
    name: type
    description: The schema class that is instantiated by the data object.  Must be
      the name of a class from the VA schema.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: false
    alias: type
    owner: RecordMetadata
    domain_of:
    - Element
    range: Class
    required: true
  description:
    name: description
    description: A free text description of the Element.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: false
    alias: description
    owner: RecordMetadata
    domain_of:
    - Element
    - Extension
    range: string
    required: false
  extensions:
    name: extensions
    description: A key-value data structure that allows definition of custom fields
      to capture information not directly supported by the VA specification.
    comments:
    - The VA-Spec provides  implementers the ability to extend any model elements
      with new attributes using this flexible Extension element.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: true
    alias: extensions
    owner: RecordMetadata
    domain_of:
    - Element
    range: Extension
    required: false