description: A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.
package_name: hl7.fhir.r4b.examples
derivation: specialization
name: DocumentReference
type: DocumentReference
elements:
  description: {isModifier: false, short: Human-readable description, type: string, mustSupport: false, isSummary: true, index: 14}
  category:
    isModifier: false
    short: Categorization of document
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/doc-classcodes'}
    isSummary: true
    index: 5
  date: {isModifier: false, short: When this document reference was created, type: instant, mustSupport: false, isSummary: true, index: 7}
  docStatus:
    isModifier: false
    short: preliminary | final | amended | entered-in-error
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/composition-status|4.3.0'}
    isSummary: true
    index: 3
  content:
    min: 1
    isModifier: false
    short: Document referenced
    index: 16
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      attachment: {isModifier: false, short: Where to access the document, type: Attachment, mustSupport: false, isSummary: true, index: 17}
      format:
        isModifier: false
        short: Format/content rules for the document
        type: Coding
        mustSupport: false
        binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/formatcodes'}
        isSummary: true
        index: 18
    required: [attachment]
    isSummary: true
  type:
    isModifier: false
    short: Kind of document (LOINC if possible)
    type: CodeableConcept
    mustSupport: false
    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/doc-typecodes'}
    isSummary: true
    index: 4
  author:
    isModifier: false
    short: Who and/or what authored the document
    refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
    type: Reference
    mustSupport: false
    array: true
    isSummary: true
    index: 8
  masterIdentifier: {isModifier: false, short: Master Version Specific Identifier, type: Identifier, mustSupport: false, isSummary: true, index: 0}
  custodian:
    isModifier: false
    short: Organization which maintains the document
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 10
  status:
    isModifier: true
    short: current | superseded | entered-in-error
    index: 2
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/document-reference-status|4.3.0'}
    isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    isSummary: true
  identifier: {isModifier: false, short: Other identifiers for the document, type: Identifier, mustSupport: false, array: true, isSummary: true, index: 1}
  relatesTo:
    isModifier: false
    short: Relationships to other documents
    index: 11
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      code:
        isModifier: false
        short: replaces | transforms | signs | appends
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/document-relationship-type|4.3.0'}
        isSummary: true
        index: 12
      target:
        isModifier: false
        short: Target of the relationship
        refers: ['http://hl7.org/fhir/StructureDefinition/DocumentReference']
        type: Reference
        mustSupport: false
        isSummary: true
        index: 13
    required: [target, code]
    isSummary: true
  context:
    isModifier: false
    short: Clinical context of document
    type: BackboneElement
    mustSupport: false
    isSummary: true
    index: 19
    elements:
      encounter:
        isModifier: false
        short: Context of the document  content
        refers: ['http://hl7.org/fhir/StructureDefinition/Encounter', 'http://hl7.org/fhir/StructureDefinition/EpisodeOfCare']
        type: Reference
        mustSupport: false
        array: true
        isSummary: false
        index: 20
      event:
        isModifier: false
        short: Main clinical acts documented
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/v3-ActCode'}
        isSummary: false
        index: 21
      period: {isModifier: false, short: Time of service that is being documented, type: Period, mustSupport: false, isSummary: true, index: 22}
      facilityType:
        isModifier: false
        short: Kind of facility where patient was seen
        type: CodeableConcept
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/c80-facilitycodes'}
        isSummary: false
        index: 23
      practiceSetting:
        isModifier: false
        short: Additional details about where the content was created (e.g. clinical specialty)
        type: CodeableConcept
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/c80-practice-codes'}
        isSummary: false
        index: 24
      sourcePatientInfo:
        isModifier: false
        short: Patient demographics from source
        refers: ['http://hl7.org/fhir/StructureDefinition/Patient']
        type: Reference
        mustSupport: false
        isSummary: false
        index: 25
      related:
        isModifier: false
        short: Related identifiers or resources
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        type: Reference
        mustSupport: false
        array: true
        isSummary: false
        index: 26
  securityLabel:
    isModifier: false
    short: Document security-tags
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/security-labels'}
    isSummary: true
    index: 15
  subject:
    isModifier: false
    short: Who/what is the subject of the document
    refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner']
    type: Reference
    mustSupport: false
    isSummary: true
    index: 6
  authenticator:
    isModifier: false
    short: Who/what authenticated the document
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 9
package_version: 4.3.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/DocumentReference
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.3.0
required: [status, content]