Class: Document

A collection of information intented to be understood together as a whole, and codified in human-readable form.

classDiagram class Document Entity <|-- Document Document : description Document : document_type Document : focus Document --> Entity : focus Document : id Document : identity Document --> Identifier : identity Document : url

Inheritance

Entity
- Document

Slots

Name	Cardinality and Range	Description	Inheritance
identity	0..* Identifier	A 'business' identifier or accession number for the entity, typically as prov...	direct
document_type	0..1 String	The high-level type of the document (e	direct
description	0..1 String	A free text description or summary of the report	direct
focus	0..1 Entity	The entity that the report is primarily about	direct
url	0..* String	A URL/web address where the document can be accessed	direct
id	1..1 Uriorcurie	The 'logical' identifier of the entity within the system of record	Entity

Usages

used by	used in	type	used
Specimen	related_document	range	Document

Identifier and Mapping Information

Schema Source

from schema: https://w3id.org/nhlbidatastage/bdchm

Mappings

Mapping Type	Mapped Value
self	bdchm:Document
native	bdchm:Document

LinkML Source

Direct

name: Document
description: A collection of information intented to be understood together as a whole,
  and codified in human-readable form.
from_schema: https://w3id.org/nhlbidatastage/bdchm
is_a: Entity
slots:
- identity
attributes:
  document_type:
    name: document_type
    description: The high-level type of the document (e.g.  'publication', 'pathology
      report')
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    values_from:
    - crdch:enum_CRDCH_Document_document_type
    multivalued: false
    range: string
    required: false
  description:
    name: description
    description: A free text description or summary of the report.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    multivalued: false
    range: string
    required: false
  focus:
    name: focus
    description: The entity that the report is primarily about
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    multivalued: false
    range: Entity
    required: false
  url:
    name: url
    description: A URL/web address where the document can be accessed.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    multivalued: true
    range: string
    required: false
    inlined: true
    inlined_as_list: true

Induced

name: Document
description: A collection of information intented to be understood together as a whole,
  and codified in human-readable form.
from_schema: https://w3id.org/nhlbidatastage/bdchm
is_a: Entity
attributes:
  document_type:
    name: document_type
    description: The high-level type of the document (e.g.  'publication', 'pathology
      report')
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    values_from:
    - crdch:enum_CRDCH_Document_document_type
    multivalued: false
    alias: document_type
    owner: Document
    domain_of:
    - Document
    range: string
    required: false
  description:
    name: description
    description: A free text description or summary of the report.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    multivalued: false
    alias: description
    owner: Document
    domain_of:
    - Participant
    - ResearchStudy
    - Questionnaire
    - Document
    - Specimen
    - BiologicProduct
    range: string
    required: false
  focus:
    name: focus
    description: The entity that the report is primarily about
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    multivalued: false
    alias: focus
    owner: Document
    domain_of:
    - Document
    - SpecimenQualityObservation
    - SpecimenQuantityObservation
    range: Entity
    required: false
  url:
    name: url
    description: A URL/web address where the document can be accessed.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    multivalued: true
    alias: url
    owner: Document
    domain_of:
    - ResearchStudy
    - Questionnaire
    - Document
    range: string
    required: false
    inlined: true
    inlined_as_list: true
  identity:
    name: identity
    description: A 'business' identifier or accession number for the entity, typically
      as provided by an external system or authority, that are globally unique and
      persist across implementing systems. Also, since these identifiers are created
      outside the information system through a specific business process, the Identifier
      type has additional attributes to capture this additional metadata so the actual
      identifier values are qualified by the context that created those values. This
      additional context allows "identifier" instances to be transmitted as business
      data across systems while still being able to trace them back to the system
      of origin.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    slot_uri: schema:identifier
    multivalued: true
    alias: identity
    owner: Document
    domain_of:
    - Person
    - Demography
    - Participant
    - ResearchStudy
    - Organization
    - Questionnaire
    - QuestionnaireItem
    - Condition
    - Document
    - Specimen
    - BiologicProduct
    range: Identifier
  id:
    name: id
    description: The 'logical' identifier of the entity within the system of record.  The
      simple value of this attribute stands for an identifier of this data object
      within the system, it can be used as a reference from other objects within the
      same system (i.e. primary and foreign keys), and it should be unique per type
      of object. The same data object copied to a different system will likely have
      a different "id" in the new system since "id" values are system specific and
      do not represent persistent business identifiers. Business identifiers are assigned
      outside the information system and are captured in the "identifier" field. The
      "id" field is more likely to be a serially or randomly generated value that
      is assigned to the data object as it is created in a system.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    slot_uri: schema:identifier
    identifier: true
    alias: id
    owner: Document
    domain_of:
    - Entity
    range: uriorcurie
    required: true