Class: Record Metadata (RecordMetadata)

A reusable structure that encapsulates provenance metadata about a serialized data record or object in a particular dataset (as opposed to provenance of the real world entity this record or object represents).

Comments

Record-level metadata applies to a specific concrete encoding/serialization of information (e.g as a record in a specific data/knowlegebase, or an online digital resource). A RecordMetadata object can capture when, how, and by whom a record serialization was generated or modified; what upstream resources it was derived or retrieved from; and record-level administrative information such as versioning and lifecycle status.

URI: sepio_linkml:RecordMetadata

classDiagram class RecordMetadata click RecordMetadata href "../RecordMetadata" Utility <|-- RecordMetadata click Utility href "../Utility" RecordMetadata : contributions RecordMetadata --> "*" Contribution : contributions click Contribution href "../Contribution" RecordMetadata : dateRecordCreated RecordMetadata : derivedFromRecord RecordMetadata : recordIdentifier RecordMetadata : recordVersion

Inheritance

Utility
- RecordMetadata

Slots

Direct slots

recordIdentifier --> String [0..1]

The identifier of the record described in the RecordMetadata object (required when the record described is not the one in the present system).

Implementation Guidance

* 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 transforms 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 record, including information about its submission to ClinVar.

recordVersion --> String [0..1]

The version number of the record-level artifact the object describes.

derivedFromRecord --> String [*]

Another data record from which the record described here was derived, through a data ingest and/or transformation process.

Implementation Guidance

* Value should be a string representing the identifier of the source record.

dateRecordCreated --> String [0..1]

The date the record was initially created.

contributions --> Contribution [*]

describes specific contributions made by an human or software agent to the creation, modification, or administrative management of a data record or object.

Usages

used by	used in	type	used
InformationEntity	recordMetadata	range	RecordMetadata
Method	recordMetadata	range	RecordMetadata
Document	recordMetadata	range	RecordMetadata
DataItem	recordMetadata	range	RecordMetadata
DataSet	recordMetadata	range	RecordMetadata
Statement	recordMetadata	range	RecordMetadata
StudyResult	recordMetadata	range	RecordMetadata
EvidenceLine	recordMetadata	range	RecordMetadata

Identifier and Mapping Information

Schema Source

from schema: https://w3id.org/sepio-framework/sepio-linkml

Mappings

Mapping Type	Mapped Value
self	sepio_linkml:RecordMetadata
native	sepio_linkml:RecordMetadata

LinkML Source

Direct

name: RecordMetadata
description: A reusable structure that encapsulates provenance metadata about a serialized
  data record or object in a particular dataset (as opposed to provenance of the real
  world entity this record or object represents).
title: Record Metadata
comments:
- Record-level metadata applies to a specific concrete encoding/serialization of information
  (e.g as a record in a specific data/knowlegebase, or an online digital resource).
  A RecordMetadata object can capture when, how, and by whom a record serialization
  was generated or modified; what upstream resources it was derived or retrieved from;
  and record-level administrative information such as versioning and lifecycle status.
from_schema: https://w3id.org/sepio-framework/sepio-linkml
status: Draft
is_a: Utility
attributes:
  recordIdentifier:
    name: recordIdentifier
    description: The 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 transforms
      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 record, including information about its submission to ClinVar.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    domain_of:
    - RecordMetadata
    range: string
    required: false
    multivalued: false
  recordVersion:
    name: recordVersion
    description: The version number of the record-level artifact the object describes.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    domain_of:
    - RecordMetadata
    range: string
    required: false
    multivalued: false
  derivedFromRecord:
    name: derivedFromRecord
    description: Another data record from which the record described here was derived,
      through a data ingest and/or transformation process.
    comments:
    - Value should be a string representing the identifier of the source record.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    domain_of:
    - RecordMetadata
    range: string
    required: false
    multivalued: true
  dateRecordCreated:
    name: dateRecordCreated
    description: The date the record was initially created.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    domain_of:
    - RecordMetadata
    range: string
    required: false
    multivalued: false
  contributions:
    name: contributions
    description: describes specific contributions made by an human or software agent
      to the creation, modification, or administrative management of a data record
      or object.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    domain_of:
    - InformationEntity
    - RecordMetadata
    range: Contribution
    required: false
    multivalued: true

Induced

name: RecordMetadata
description: A reusable structure that encapsulates provenance metadata about a serialized
  data record or object in a particular dataset (as opposed to provenance of the real
  world entity this record or object represents).
title: Record Metadata
comments:
- Record-level metadata applies to a specific concrete encoding/serialization of information
  (e.g as a record in a specific data/knowlegebase, or an online digital resource).
  A RecordMetadata object can capture when, how, and by whom a record serialization
  was generated or modified; what upstream resources it was derived or retrieved from;
  and record-level administrative information such as versioning and lifecycle status.
from_schema: https://w3id.org/sepio-framework/sepio-linkml
status: Draft
is_a: Utility
attributes:
  recordIdentifier:
    name: recordIdentifier
    description: The 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 transforms
      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 record, including information about its submission to ClinVar.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    alias: recordIdentifier
    owner: RecordMetadata
    domain_of:
    - RecordMetadata
    range: string
    required: false
    multivalued: false
  recordVersion:
    name: recordVersion
    description: The version number of the record-level artifact the object describes.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    alias: recordVersion
    owner: RecordMetadata
    domain_of:
    - RecordMetadata
    range: string
    required: false
    multivalued: false
  derivedFromRecord:
    name: derivedFromRecord
    description: Another data record from which the record described here was derived,
      through a data ingest and/or transformation process.
    comments:
    - Value should be a string representing the identifier of the source record.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    alias: derivedFromRecord
    owner: RecordMetadata
    domain_of:
    - RecordMetadata
    range: string
    required: false
    multivalued: true
  dateRecordCreated:
    name: dateRecordCreated
    description: The date the record was initially created.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    rank: 1000
    alias: dateRecordCreated
    owner: RecordMetadata
    domain_of:
    - RecordMetadata
    range: string
    required: false
    multivalued: false
  contributions:
    name: contributions
    description: describes specific contributions made by an human or software agent
      to the creation, modification, or administrative management of a data record
      or object.
    from_schema: https://w3id.org/sepio-model
    status: Draft
    alias: contributions
    owner: RecordMetadata
    domain_of:
    - InformationEntity
    - RecordMetadata
    range: Contribution
    required: false
    multivalued: true