PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.r5.core@4.2.0
    http://hl7.org/fhir/StructureDefinition/DocumentReference
description: A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this \"document\" encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare.  The DocumentReference resource provides metadata about the document so that the document can be discovered and managed.  The actual content may be inline base64 encoded data or provided by direct reference.
package_name: hl7.fhir.r5.core
derivation: specialization
name: DocumentReference
type: DocumentReference
elements:
  description: {short: Human-readable description, type: string, isSummary: true, index: 14}
  category:
    short: Categorization of document
    type: CodeableConcept
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/document-classcodes'}
    isSummary: true
    index: 5
  date: {short: When this document reference was created, type: instant, isSummary: true, index: 7}
  docStatus:
    short: preliminary | final | amended | entered-in-error
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/composition-status|4.2.0'}
    isSummary: true
    index: 3
  content:
    min: 1
    short: Document referenced
    index: 16
    type: BackboneElement
    array: true
    elements:
      attachment: {short: Where to access the document, type: Attachment, isSummary: true, index: 17}
      format:
        short: Format/content rules for the document
        type: Coding
        binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/formatcodes'}
        isSummary: true
        index: 18
    required: [attachment]
    isSummary: true
  type:
    short: Kind of document (LOINC if possible)
    type: CodeableConcept
    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/c80-doc-typecodes'}
    isSummary: true
    index: 4
  author:
    short: Who and/or what authored the document
    refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', '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
    array: true
    isSummary: true
    index: 8
  masterIdentifier: {short: Master Version Specific Identifier, type: Identifier, isSummary: true, index: 0}
  custodian:
    short: Organization which maintains the document
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    type: Reference
    index: 10
  status:
    isModifier: true
    short: current | superseded | entered-in-error
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/document-reference-status|4.2.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
    index: 2
  identifier: {short: Other identifiers for the document, type: Identifier, array: true, isSummary: true, index: 1}
  relatesTo:
    short: Relationships to other documents
    type: BackboneElement
    array: true
    isSummary: true
    index: 11
    elements:
      code:
        short: replaces | transforms | signs | appends
        type: code
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/document-relationship-type|4.2.0'}
        isSummary: true
        index: 12
      target:
        short: Target of the relationship
        refers: ['http://hl7.org/fhir/StructureDefinition/DocumentReference']
        type: Reference
        isSummary: true
        index: 13
    required: [target, code]
  context:
    short: Clinical context of document
    type: BackboneElement
    isSummary: true
    index: 19
    elements:
      encounter:
        short: Context of the document  content
        refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
        type: Reference
        array: true
        index: 20
      event:
        short: Main clinical acts documented
        type: CodeableConcept
        array: true
        binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/v3-ActCode'}
        index: 21
      period: {short: Time of service that is being documented, type: Period, isSummary: true, index: 22}
      facilityType:
        short: Kind of facility where patient was seen
        type: CodeableConcept
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/c80-facilitycodes'}
        index: 23
      practiceSetting:
        short: Additional details about where the content was created (e.g. clinical specialty)
        type: CodeableConcept
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/c80-practice-codes'}
        index: 24
      sourcePatientInfo:
        short: Patient demographics from source
        refers: ['http://hl7.org/fhir/StructureDefinition/Patient']
        type: Reference
        index: 25
      related:
        short: Related identifiers or resources
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        type: Reference
        array: true
        index: 26
      basedOn:
        short: Procedure that caused this media to be created
        refers: ['http://hl7.org/fhir/StructureDefinition/CarePlan', 'http://hl7.org/fhir/StructureDefinition/ServiceRequest']
        type: Reference
        array: true
        index: 27
  securityLabel:
    short: Document security-tags
    type: CodeableConcept
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/security-labels'}
    isSummary: true
    index: 15
  subject:
    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/Location', '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/Specimen']
    type: Reference
    isSummary: true
    index: 6
  authenticator:
    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
    index: 9
package_version: 4.2.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/DocumentReference
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.2.0
required: [status, content]