PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.r6.core@6.0.0-ballot4
    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.r6.core
derivation: specialization
name: DocumentReference
type: DocumentReference
elements:
  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: 14
  description: {isModifier: false, short: Human-readable description, type: markdown, mustSupport: false, isSummary: true, index: 26}
  category:
    isModifier: false
    short: Categorization of document
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/referenced-item-category'}
    isSummary: true
    index: 7
  date: {isModifier: false, short: When this document reference was created, type: dateTime, mustSupport: false, isSummary: true, index: 16}
  docStatus:
    isModifier: true
    short: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/composition-status|6.0.0-ballot4'}
    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: 4
  content:
    min: 1
    isModifier: false
    short: Document referenced
    index: 28
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      attachment: {isModifier: false, short: Where to access the document, type: Attachment, mustSupport: false, isSummary: true, index: 29}
      profile:
        isModifier: false
        short: Content profile rules for the document
        index: 30
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          value:
            isModifier: false
            short: Code|uri|canonical
            mustSupport: false
            choices: [valueCoding, valueUri, valueCanonical]
            isSummary: true
            index: 32
          valueCoding: {isModifier: false, short: Code|uri|canonical, type: Coding, mustSupport: false, choiceOf: value, isSummary: true, index: 33}
          valueUri: {isModifier: false, short: Code|uri|canonical, type: uri, mustSupport: false, choiceOf: value, isSummary: true, index: 34}
          valueCanonical: {isModifier: false, short: Code|uri|canonical, type: canonical, mustSupport: false, choiceOf: value, isSummary: true, index: 35}
        required: [valueCoding, valueUri, valueCanonical, value]
        isSummary: true
    required: [attachment]
    isSummary: true
  attester:
    isModifier: false
    short: Attests to accuracy of the document
    index: 18
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      mode:
        isModifier: false
        short: personal | professional | legal | official
        type: CodeableConcept
        mustSupport: false
        binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/composition-attestation-mode'}
        isSummary: false
        index: 19
      time: {isModifier: false, short: When the document was attested, type: dateTime, mustSupport: false, isSummary: false, index: 20}
      party:
        isModifier: false
        short: Who attested the document
        refers: ['http://hl7.org/fhir/StructureDefinition/Group', '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
        isSummary: false
        index: 21
    required: [mode]
    isSummary: false
  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: 6
  modality:
    isModifier: false
    short: Imaging modality used
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html'}
    isSummary: true
    index: 5
  related:
    isModifier: false
    short: Related identifiers or resources associated with the document reference
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    mustSupport: false
    array: true
    isSummary: false
    index: 11
  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: 13
  author:
    isModifier: false
    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/Group', '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: 17
  event:
    isModifier: false
    short: Main clinical acts documented
    type: CodeableReference
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/v3-ActCode'}
    isSummary: false
    index: 10
  custodian:
    isModifier: false
    short: Organization which maintains the document
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 22
  status:
    isModifier: true
    short: current | superseded | entered-in-error
    index: 3
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/document-reference-status|6.0.0-ballot4'}
    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: Business identifiers for the document, type: Identifier, mustSupport: false, array: true, isSummary: true, index: 0}
  relatesTo:
    isModifier: false
    short: Relationships to other documents
    index: 23
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      code:
        isModifier: false
        short: The relationship type with another document
        type: CodeableConcept
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/document-relationship-type'}
        isSummary: true
        index: 24
      target:
        isModifier: false
        short: Target of the relationship
        refers: ['http://hl7.org/fhir/StructureDefinition/DocumentReference']
        type: Reference
        mustSupport: false
        isSummary: true
        index: 25
    required: [target, code]
    isSummary: true
  context:
    isModifier: false
    short: Encounter the document reference is part of
    refers: ['http://hl7.org/fhir/StructureDefinition/Appointment', 'http://hl7.org/fhir/StructureDefinition/Encounter', 'http://hl7.org/fhir/StructureDefinition/EpisodeOfCare']
    type: Reference
    mustSupport: false
    array: true
    isSummary: true
    index: 9
  period: {isModifier: false, short: Time of service that is being documented, type: Period, mustSupport: false, isSummary: true, index: 15}
  basedOn:
    isModifier: false
    short: Procedure that caused this media to be created
    refers: ['http://hl7.org/fhir/StructureDefinition/Appointment', 'http://hl7.org/fhir/StructureDefinition/AppointmentResponse', 'http://hl7.org/fhir/StructureDefinition/CarePlan', 'http://hl7.org/fhir/StructureDefinition/Claim', 'http://hl7.org/fhir/StructureDefinition/CommunicationRequest', 'http://hl7.org/fhir/StructureDefinition/Contract', 'http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest', 'http://hl7.org/fhir/StructureDefinition/DeviceRequest', 'http://hl7.org/fhir/StructureDefinition/EnrollmentRequest', 'http://hl7.org/fhir/StructureDefinition/MedicationRequest', 'http://hl7.org/fhir/StructureDefinition/NutritionOrder', 'http://hl7.org/fhir/StructureDefinition/RequestOrchestration', 'http://hl7.org/fhir/StructureDefinition/ServiceRequest', 'http://hl7.org/fhir/StructureDefinition/VisionPrescription']
    type: Reference
    mustSupport: false
    array: true
    isSummary: false
    index: 2
  bodyStructure:
    isModifier: false
    short: Body structure included
    type: CodeableReference
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/body-site'}
    isSummary: true
    index: 12
  version: {isModifier: false, short: An explicitly assigned identifier of a variation of the content in the DocumentReference, type: string, mustSupport: false, isSummary: true, index: 1}
  securityLabel:
    isModifier: false
    short: Document security-tags
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/security-label-example'}
    isSummary: true
    index: 27
  subject:
    isModifier: false
    short: Who/what is the subject of the document
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    mustSupport: false
    isSummary: true
    index: 8
package_version: 6.0.0-ballot4
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/DocumentReference
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 6.0.0-ballot4
required: [status, content]