Class: DocumentReference

A comprehensive reference element that points to an external document, combining elements from ODM and FHIR

URI: odm:class/DocumentReference

erDiagram
DocumentReference {
    string title  
    string leafID  
    integerList pages  
    string relationship  
    string version  
    string href  
    string OID  
    string uuid  
    string name  
    string description  
    string label  
    stringList aliases  
}
Coding {
    string code  
    string decode  
    string codeSystem  
    string codeSystemVersion  
    AliasPredicate aliasType  
}

DocumentReference ||--}o Coding : "coding"

Inheritance

Slots

Name Cardinality and Range Description Inheritance
title 0..1
String		 Document title direct
leafID 0..1
String		 Leaf identifier for document reference in Define-XML direct
pages *
Integer		 Reference to specific pages in a PDF document direct
relationship 0..1
String		 Relationship to the referencing entity direct
version 0..1
String		 The version of the external resources Versioned
href 0..1
String		 Machine-readable instructions to obtain the resource e.g. FHIR path, URL Versioned
OID 1
String		 Local identifier within this study/context. Use CDISC OID format for regulatory submissions, or simple strings for internal use. Identifiable
uuid 0..1
String		 Universal unique identifier Identifiable
name 0..1
String		 Short name or identifier, used for field names Labelled
description 0..1
String or 
String or 
TranslatedText		 Detailed description, shown in tooltips Labelled
coding *
Coding		 Semantic tags for this element Labelled
label 0..1
String or 
String or 
TranslatedText		 Human-readable label, shown in UIs Labelled
aliases *
String or 
String or 
TranslatedText		 Alternative name or identifier Labelled

Usages

used by used in type used
MetaDataVersion resources any_of[range] DocumentReference
MetaDataVersion annotatedCRFs range DocumentReference
Comment documents range DocumentReference
Method document range DocumentReference
SourceItem document range DocumentReference
Origin document range DocumentReference

Identifier and Mapping Information

Schema Source

  • from schema: https://cdisc.org/define-json

Mappings

Mapping Type Mapped Value
self odm:DocumentReference
native odm:DocumentReference

LinkML Source

Direct

name: DocumentReference
description: A comprehensive reference element that points to an external document,
  combining elements from ODM and FHIR
from_schema: https://cdisc.org/define-json
is_a: IdentifiableElement
mixins:
- Versioned
attributes:
  title:
    name: title
    description: Document title
    from_schema: https://cdisc.org/define-json
    rank: 1000
    domain_of:
    - DocumentReference
    range: string
  leafID:
    name: leafID
    description: Leaf identifier for document reference in Define-XML
    from_schema: https://cdisc.org/define-json
    rank: 1000
    domain_of:
    - DocumentReference
    range: string
  pages:
    name: pages
    description: Reference to specific pages in a PDF document
    from_schema: https://cdisc.org/define-json
    rank: 1000
    domain_of:
    - DocumentReference
    range: integer
    required: false
    multivalued: true
  relationship:
    name: relationship
    description: Relationship to the referencing entity
    from_schema: https://cdisc.org/define-json
    rank: 1000
    domain_of:
    - DocumentReference
    range: string
    required: false

Induced

name: DocumentReference
description: A comprehensive reference element that points to an external document,
  combining elements from ODM and FHIR
from_schema: https://cdisc.org/define-json
is_a: IdentifiableElement
mixins:
- Versioned
attributes:
  title:
    name: title
    description: Document title
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: title
    owner: DocumentReference
    domain_of:
    - DocumentReference
    range: string
  leafID:
    name: leafID
    description: Leaf identifier for document reference in Define-XML
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: leafID
    owner: DocumentReference
    domain_of:
    - DocumentReference
    range: string
  pages:
    name: pages
    description: Reference to specific pages in a PDF document
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: pages
    owner: DocumentReference
    domain_of:
    - DocumentReference
    range: integer
    required: false
    multivalued: true
  relationship:
    name: relationship
    description: Relationship to the referencing entity
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: relationship
    owner: DocumentReference
    domain_of:
    - DocumentReference
    range: string
    required: false
  version:
    name: version
    description: The version of the external resources
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: version
    owner: DocumentReference
    domain_of:
    - Versioned
    - Standard
    range: string
  href:
    name: href
    description: Machine-readable instructions to obtain the resource e.g. FHIR path,
      URL
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: href
    owner: DocumentReference
    domain_of:
    - Versioned
    range: string
    required: false
  OID:
    name: OID
    description: Local identifier within this study/context. Use CDISC OID format
      for regulatory submissions, or simple strings for internal use.
    from_schema: https://cdisc.org/define-json
    rank: 1000
    identifier: true
    alias: OID
    owner: DocumentReference
    domain_of:
    - Identifiable
    range: string
    required: true
    pattern: ^[A-Za-z][A-Za-z0-9._-]*$
  uuid:
    name: uuid
    description: Universal unique identifier
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: uuid
    owner: DocumentReference
    domain_of:
    - Identifiable
    range: string
  name:
    name: name
    description: Short name or identifier, used for field names
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: name
    owner: DocumentReference
    domain_of:
    - Labelled
    - Standard
    range: string
  description:
    name: description
    description: Detailed description, shown in tooltips
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: description
    owner: DocumentReference
    domain_of:
    - Labelled
    - CodeListItem
    range: string
    any_of:
    - range: string
    - range: TranslatedText
  coding:
    name: coding
    description: Semantic tags for this element
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: coding
    owner: DocumentReference
    domain_of:
    - Labelled
    - CodeListItem
    - SourceItem
    range: Coding
    multivalued: true
    inlined: true
    inlined_as_list: true
  label:
    name: label
    description: Human-readable label, shown in UIs
    from_schema: https://cdisc.org/define-json
    exact_mappings:
    - skos:prefLabel
    rank: 1000
    alias: label
    owner: DocumentReference
    domain_of:
    - Labelled
    range: string
    any_of:
    - range: string
    - range: TranslatedText
  aliases:
    name: aliases
    description: Alternative name or identifier
    from_schema: https://cdisc.org/define-json
    exact_mappings:
    - skos:altLabel
    rank: 1000
    alias: aliases
    owner: DocumentReference
    domain_of:
    - Labelled
    - CodeListItem
    range: string
    multivalued: true
    inlined: true
    inlined_as_list: true
    any_of:
    - range: string
    - range: TranslatedText