[go: up one dir, main page]
Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

10.2 Resource DocumentReference - Content

Orders and Observations icon Work GroupMaturity Level: 4 Trial UseSecurity Category: Not Classified Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

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.

10.2.1 Scope and Usage

A DocumentReference resource is used to index a document, clinical note, and other binary objects such as a photo, video, or audio recording, including those resulting from diagnostic or care provision procedures, to make them available to a healthcare system. A document is some sequence of bytes that is identifiable, establishes its own context (e.g., what subject, author, etc. can be presented to the user), and has defined update management. The DocumentReference resource can be used with any document format that has a recognized mime type and that conforms to this definition.

Typically, DocumentReference resources are used in document indexing systems, such as IHE XDS icon and as profiled in IHE Mobile Access to Health Documents icon.

DocumentReference contains metadata, inline content or direct references to documents such as:

  • CDA icon documents in FHIR systems
  • FHIR documents stored elsewhere (i.e. registry/repository following the XDS model)
  • PDF documents icon, Scanned Paper, and digital records of faxes
  • Clinical Notes in various forms
  • Image files (e.g., JPEG, GIF, TIFF)
  • Video files (e.g., MP4, WMV)
  • Audio files (e.g., WAV, MP3)
  • Non-Standard formats (e.g., CSV, RTF, WORD)
  • Other kinds of documents, such as records of prescriptions or immunizations

10.2.2 Boundaries and Relationships

This resource captures data that might not be in FHIR format. The document can be any object (e.g. file), and is not limited to the formal HL7 definitions of Document. This resource may be a report with unstructured text or a report that is not expressed in a DiagnosticReport. The DiagnosticReport is appropriate to reflect a set of discrete results (Observations) and associated contextual details for a specific report, and within those results any further structure within the Observation instances. The DocumentReference resource may be an Observation whose value is audio, video or image data. This resource is the preferred representation of such forms of information as it exposes the metadata relevant for interpreting the information. There is some overlap potential such as a scan of a CBC report that can either be referenced by way of a DocumentReference, or included in a DiagnosticReport as a presentedForm together with the structured, discrete data. Specific implementation guides would further clarify when one approach is more appropriate than another.

This resource is able to contain medical images in a DICOM format. These images may also be made accessible through an ImagingStudy resource, which provides a direct reference to the image to a WADO-RS server. For such images, the WADO-RS framework is a preferred method for representing the images - the WADO-RS service may include rendering the image with annotations and display parameters from an associated DICOM presentation state, for instance. On the other hand, the DocumentReference resource allows for a robust transfer of an image across boundaries where the WADO-RS service is not available. For this reason, medical images can also be represented in a DocumentReference resource, but the DocumentReference.content.attachment.url should provide a reference to a source WADO-RS service for the image.

FHIR defines both a document format and this document reference. FHIR documents are for documents that are authored and assembled in FHIR. DocumentReference is intended for general references to any type of media file including assembled documents.

The document that is a target of the reference can be a reference to a FHIR document served by another server, or the target can be stored in the special FHIR Binary Resource, or the target can be stored on some other server system. The document reference is also able to address documents that are retrieved by a service call such as an XDS.b RetrieveDocumentSet, or a DICOM exchange, or an HL7 V2 icon message query - though the way each of these service calls works must be specified in some external standard or other documentation.

A DocumentReference describes some other document. This means that there are two sets of provenance information relevant here: the provenance of the document, and the provenance of the document reference. Sometimes, the provenance information is closely related, as when the document producer also produces the document reference, but in other workflows, the document reference is generated later by other actors. In the DocumentReference resource, the meta content refers to the provenance of the reference itself, while the content described below concerns the document it references. Like all resources, there is overlap between the information in the resource directly, and in the general Provenance resource. This is discussed as part of the description of the Provenance resource.

10.2.3 References to this Resource

10.2.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference TUDomainResourceA reference to a document
+ Warning: facilityType SHALL only be present if context is not an encounter
+ Warning: practiceSetting SHALL only be present if context is not present

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness identifiers for the document

... version Σ0..1stringAn explicitly assigned identifer of a variation of the content in the DocumentReference
... basedOn 0..*Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription)Procedure that caused this media to be created

... docStatus Σ0..1coderegistered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: Composition Status (Required)
... modality Σ0..*CodeableConceptImaging modality used
Binding: Modality icon (Extensible)

... type Σ0..1CodeableConceptKind of document (LOINC if possible)
Binding: FHIR Document Type Codes (Preferred)
... category Σ0..*CodeableConceptCategorization of document
Binding: Referenced Item Category Value Set (Example)

... subject Σ0..1Reference(Any)Who/what is the subject of the document
... context C0..*Reference(Appointment | Encounter | EpisodeOfCare)Context of the document content

... event 0..*CodeableReference()Main clinical acts documented
Binding: v3 Code System ActCode icon (Example)

... bodySite Σ0..*CodeableReference(BodyStructure)Body part included
Binding: SNOMED CT Body Structures (Example)

... facilityType C0..1CodeableConceptKind of facility where patient was seen
Binding: Facility Type Code Value Set (Example)
... practiceSetting C0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: Practice Setting Code Value Set (Example)
... period Σ0..1PeriodTime of service that is being documented
... date Σ0..1instantWhen this document reference was created
... author Σ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam)Who and/or what authored the document

... attester 0..*BackboneElementAttests to accuracy of the document

.... mode 1..1CodeableConceptpersonal | professional | legal | official
Binding: Composition Attestation Mode (Preferred)
.... time 0..1dateTimeWhen the document was attested
.... party 0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)Who attested the document
... custodian 0..1Reference(Organization)Organization which maintains the document
... relatesTo Σ0..*BackboneElementRelationships to other documents

.... code Σ1..1CodeableConceptThe relationship type with another document
Binding: Document Relationship Type (Extensible)
.... target Σ1..1Reference(DocumentReference)Target of the relationship
... description Σ0..1markdownHuman-readable description
... securityLabel Σ0..*CodeableConceptDocument security-tags
Binding: Example set of Security Labels (Example)

... content Σ1..*BackboneElementDocument referenced

.... attachment Σ1..1AttachmentWhere to access the document
.... profile Σ0..*BackboneElementContent profile rules for the document

..... value[x] Σ1..1Code|uri|canonical
Binding: HL7 ValueSet of Format Codes for use with Document Sharing icon (Preferred)
...... valueCodingCoding
...... valueUriuri
...... valueCanonicalcanonical()

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

DocumentReference (DomainResource)Other business identifiers associated with the document, including version independent identifiersidentifier : Identifier [0..*]An explicitly assigned identifer of a variation of the content in the DocumentReferenceversion : string [0..1]A procedure that is fulfilled in whole or in part by the creation of this mediabasedOn : Reference [0..*] « Appointment|AppointmentResponse| CarePlan|Claim|CommunicationRequest|Contract| CoverageEligibilityRequest|DeviceRequest|EnrollmentRequest| ImmunizationRecommendation|MedicationRequest|NutritionOrder| RequestOrchestration|ServiceRequest|SupplyRequest| VisionPrescription »The status of this document reference (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)DocumentReferenceStatus! »The status of the underlying documentdocStatus : code [0..1] « null (Strength=Required)CompositionStatus! »Imaging modality used. This may include both acquisition and non-acquisition modalitiesmodality : CodeableConcept [0..*] « null (Strength=Extensible)Modality+ »Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referencedtype : CodeableConcept [0..1] « null (Strength=Preferred)FHIRDocumentTypeCodes? »A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.typecategory : CodeableConcept [0..*] « null (Strength=Example)ReferencedItemCategoryValueSet?? »Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure)subject : Reference [0..1] « Any »Describes the clinical encounter or type of care that the document content is associated withcontext : Reference [0..*] « Appointment|Encounter|EpisodeOfCare » « This element has or is affected by some invariantsC »This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" actevent : CodeableReference [0..*] « ; null (Strength=Example)ActCode?? »The anatomic structures included in the documentbodySite : CodeableReference [0..*] « BodyStructure; Codes describing anatomical locations. May include laterality. (Strength=Example) SNOMEDCTBodyStructures?? »The kind of facility where the patient was seenfacilityType : CodeableConcept [0..1] « null (Strength=Example)FacilityTypeCodeValueSet?? » « This element has or is affected by some invariantsC »This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialtypracticeSetting : CodeableConcept [0..1] « null (Strength=Example) PracticeSettingCodeValueSet?? » « This element has or is affected by some invariantsC »The time period over which the service that is described by the document was providedperiod : Period [0..1]When the document reference was createddate : instant [0..1]Identifies who is responsible for adding the information to the documentauthor : Reference [0..*] « Practitioner|PractitionerRole| Organization|Device|Patient|RelatedPerson|CareTeam »Identifies the organization or group who is responsible for ongoing maintenance of and access to the documentcustodian : Reference [0..1] « Organization »Human-readable description of the source documentdescription : markdown [0..1]A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happenedsecurityLabel : CodeableConcept [0..*] « null (Strength=Example)SecurityLabelExamples?? »AttesterThe type of attestation the authenticator offersmode : CodeableConcept [1..1] « null (Strength=Preferred)CompositionAttestationMode? »When the document was attested by the partytime : dateTime [0..1]Who attested the document in the specified wayparty : Reference [0..1] « Patient|RelatedPerson|Practitioner| PractitionerRole|Organization »RelatesToThe type of relationship that this document has with anther documentcode : CodeableConcept [1..1] « null (Strength=Extensible)DocumentRelationshipType+ »The target document of this relationshiptarget : Reference [1..1] « DocumentReference »ContentThe document or URL of the document along with critical metadata to prove content has integrityattachment : Attachment [1..1]ProfileCode|uri|canonicalvalue[x] : DataType [1..1] « Coding|uri|canonical; null (Strength=Preferred)HL7FormatCodes? »A participant who has authenticated the accuracy of the documentattester[0..*]Relationships that this document has with other document references that already existrelatesTo[0..*]An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeTypeprofile[0..*]The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadatacontent[1..*]

XML Template

<DocumentReference xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifiers for the document --></identifier>
 <version value="[string]"/><!-- 0..1 An explicitly assigned identifer of a variation of the content in the DocumentReference -->
 <basedOn><!-- 0..* Reference(Appointment|AppointmentResponse|CarePlan|Claim|
   CommunicationRequest|Contract|CoverageEligibilityRequest|DeviceRequest|
   EnrollmentRequest|ImmunizationRecommendation|MedicationRequest|NutritionOrder|
   RequestOrchestration|ServiceRequest|SupplyRequest|VisionPrescription) Procedure that caused this media to be created --></basedOn>
 <status value="[code]"/><!-- 1..1 current | superseded | entered-in-error -->
 <docStatus value="[code]"/><!-- 0..1 registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown -->
 <modality><!-- 0..* CodeableConcept Imaging modality used icon --></modality>
 <type><!-- 0..1 CodeableConcept Kind of document (LOINC if possible) --></type>
 <category><!-- 0..* CodeableConcept Categorization of document --></category>
 <subject><!-- 0..1 Reference(Any) Who/what is the subject of the document --></subject>
 <context><!-- I 0..* Reference(Appointment|Encounter|EpisodeOfCare) Context of the document content --></context>
 <event><!-- 0..* CodeableReference Main clinical acts documented icon --></event>
 <bodySite><!-- 0..* CodeableReference(BodyStructure) Body part included --></bodySite>
 <facilityType><!-- I 0..1 CodeableConcept Kind of facility where patient was seen --></facilityType>
 <practiceSetting><!-- I 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty) --></practiceSetting>
 <period><!-- 0..1 Period Time of service that is being documented --></period>
 <date value="[instant]"/><!-- 0..1 When this document reference was created -->
 <author><!-- 0..* Reference(CareTeam|Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) Who and/or what authored the document --></author>
 <attester>  <!-- 0..* Attests to accuracy of the document -->
  <mode><!-- 1..1 CodeableConcept personal | professional | legal | official --></mode>
  <time value="[dateTime]"/><!-- 0..1 When the document was attested -->
  <party><!-- 0..1 Reference(Organization|Patient|Practitioner|PractitionerRole|
    RelatedPerson) Who attested the document --></party>
 </attester>
 <custodian><!-- 0..1 Reference(Organization) Organization which maintains the document --></custodian>
 <relatesTo>  <!-- 0..* Relationships to other documents -->
  <code><!-- 1..1 CodeableConcept The relationship type with another document --></code>
  <target><!-- 1..1 Reference(DocumentReference) Target of the relationship --></target>
 </relatesTo>
 <description value="[markdown]"/><!-- 0..1 Human-readable description -->
 <securityLabel><!-- 0..* CodeableConcept Document security-tags --></securityLabel>
 <content>  <!-- 1..* Document referenced -->
  <attachment><!-- 1..1 Attachment Where to access the document --></attachment>
  <profile>  <!-- 0..* Content profile rules for the document -->
   <value[x]><!-- 1..1 Coding|uri|canonical Code|uri|canonical icon --></value[x]>
  </profile>
 </content>
</DocumentReference>

JSON Template

{doco
  "resourceType" : "DocumentReference",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifiers for the document
  "version" : "<string>", // An explicitly assigned identifer of a variation of the content in the DocumentReference
  "basedOn" : [{ Reference(Appointment|AppointmentResponse|CarePlan|Claim|
   CommunicationRequest|Contract|CoverageEligibilityRequest|DeviceRequest|
   EnrollmentRequest|ImmunizationRecommendation|MedicationRequest|NutritionOrder|
   RequestOrchestration|ServiceRequest|SupplyRequest|VisionPrescription) }], // Procedure that caused this media to be created
  "status" : "<code>", // R!  current | superseded | entered-in-error
  "docStatus" : "<code>", // registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
  "modality" : [{ CodeableConcept }], // Imaging modality used icon
  "type" : { CodeableConcept }, // Kind of document (LOINC if possible)
  "category" : [{ CodeableConcept }], // Categorization of document
  "subject" : { Reference(Any) }, // Who/what is the subject of the document
  "context" : [{ Reference(Appointment|Encounter|EpisodeOfCare) }], // I Context of the document content
  "event" : [{ CodeableReference }], // Main clinical acts documented icon
  "bodySite" : [{ CodeableReference(BodyStructure) }], // Body part included
  "facilityType" : { CodeableConcept }, // I Kind of facility where patient was seen
  "practiceSetting" : { CodeableConcept }, // I Additional details about where the content was created (e.g. clinical specialty)
  "period" : { Period }, // Time of service that is being documented
  "date" : "<instant>", // When this document reference was created
  "author" : [{ Reference(CareTeam|Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) }], // Who and/or what authored the document
  "attester" : [{ // Attests to accuracy of the document
    "mode" : { CodeableConcept }, // R!  personal | professional | legal | official
    "time" : "<dateTime>", // When the document was attested
    "party" : { Reference(Organization|Patient|Practitioner|PractitionerRole|
    RelatedPerson) } // Who attested the document
  }],
  "custodian" : { Reference(Organization) }, // Organization which maintains the document
  "relatesTo" : [{ // Relationships to other documents
    "code" : { CodeableConcept }, // R!  The relationship type with another document
    "target" : { Reference(DocumentReference) } // R!  Target of the relationship
  }],
  "description" : "<markdown>", // Human-readable description
  "securityLabel" : [{ CodeableConcept }], // Document security-tags
  "content" : [{ // R!  Document referenced
    "attachment" : { Attachment }, // R!  Where to access the document
    "profile" : [{ // Content profile rules for the document
      // value[x]: Code|uri|canonical. One of these 3:
      "valueCoding" : { Coding },
      "valueUri" : "<uri>",
      "valueCanonical" : "<canonical>"
    }]
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:DocumentReference;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifiers for the document
  fhir:version [ string ] ; # 0..1 An explicitly assigned identifer of a variation of the content in the DocumentReference
  fhir:basedOn  ( [ Reference(Appointment|AppointmentResponse|CarePlan|Claim|CommunicationRequest|Contract|
  CoverageEligibilityRequest|DeviceRequest|EnrollmentRequest|
  ImmunizationRecommendation|MedicationRequest|NutritionOrder|
  RequestOrchestration|ServiceRequest|SupplyRequest|VisionPrescription) ] ... ) ; # 0..* Procedure that caused this media to be created
  fhir:status [ code ] ; # 1..1 current | superseded | entered-in-error
  fhir:docStatus [ code ] ; # 0..1 registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
  fhir:modality  ( [ CodeableConcept ] ... ) ; # 0..* Imaging modality used
  fhir:type [ CodeableConcept ] ; # 0..1 Kind of document (LOINC if possible)
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Categorization of document
  fhir:subject [ Reference(Any) ] ; # 0..1 Who/what is the subject of the document
  fhir:context  ( [ Reference(Appointment|Encounter|EpisodeOfCare) ] ... ) ; # 0..* I Context of the document content
  fhir:event  ( [ CodeableReference ] ... ) ; # 0..* Main clinical acts documented
  fhir:bodySite  ( [ CodeableReference(BodyStructure) ] ... ) ; # 0..* Body part included
  fhir:facilityType [ CodeableConcept ] ; # 0..1 I Kind of facility where patient was seen
  fhir:practiceSetting [ CodeableConcept ] ; # 0..1 I Additional details about where the content was created (e.g. clinical specialty)
  fhir:period [ Period ] ; # 0..1 Time of service that is being documented
  fhir:date [ instant ] ; # 0..1 When this document reference was created
  fhir:author  ( [ Reference(CareTeam|Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ... ) ; # 0..* Who and/or what authored the document
  fhir:attester ( [ # 0..* Attests to accuracy of the document
    fhir:mode [ CodeableConcept ] ; # 1..1 personal | professional | legal | official
    fhir:time [ dateTime ] ; # 0..1 When the document was attested
    fhir:party [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Who attested the document
  ] ... ) ;
  fhir:custodian [ Reference(Organization) ] ; # 0..1 Organization which maintains the document
  fhir:relatesTo ( [ # 0..* Relationships to other documents
    fhir:code [ CodeableConcept ] ; # 1..1 The relationship type with another document
    fhir:target [ Reference(DocumentReference) ] ; # 1..1 Target of the relationship
  ] ... ) ;
  fhir:description [ markdown ] ; # 0..1 Human-readable description
  fhir:securityLabel  ( [ CodeableConcept ] ... ) ; # 0..* Document security-tags
  fhir:content ( [ # 1..* Document referenced
    fhir:attachment [ Attachment ] ; # 1..1 Where to access the document
    fhir:profile ( [ # 0..* Content profile rules for the document
      # value[x] : 1..1 Code|uri|canonical. One of these 3
        fhir:value [  a fhir:Coding ; Coding ]
        fhir:value [  a fhir:uri ; uri ]
        fhir:value [  a fhir:canonical ; canonical ]
    ] ... ) ;
  ] ... ) ;
]

Changes from both R4 and R4B

DocumentReference
DocumentReference.version
  • Added Element
DocumentReference.basedOn
  • Added Element
DocumentReference.docStatus
  • Add codes registered, partial, corrected, appended, cancelled, deprecated, unknown
DocumentReference.modality
  • Added Element
DocumentReference.subject
  • Type Reference: Added Target Type Resource
  • Type Reference: Removed Target Types Patient, Practitioner, Group, Device
DocumentReference.context
  • Max Cardinality changed from 1 to *
  • Type changed from BackboneElement to Reference(Appointment | Encounter | EpisodeOfCare)
DocumentReference.event
  • Added Element
DocumentReference.bodySite
  • Added Element
DocumentReference.facilityType
  • Added Element
DocumentReference.practiceSetting
  • Added Element
DocumentReference.period
  • Added Element
DocumentReference.author
  • Type Reference: Added Target Type CareTeam
DocumentReference.attester
  • Added Element
DocumentReference.attester.mode
  • Added Mandatory Element
DocumentReference.attester.time
  • Added Element
DocumentReference.attester.party
  • Added Element
DocumentReference.relatesTo.code
  • Type changed from code to CodeableConcept
  • Change binding strength from required to extensible
DocumentReference.description
  • Type changed from string to markdown
DocumentReference.securityLabel
  • Remove Binding `http://hl7.org/fhir/ValueSet/security-labels` (extensible)
DocumentReference.content.profile
  • Added Element
DocumentReference.content.profile.value[x]
  • Added Mandatory Element
DocumentReference.masterIdentifier
  • Deleted (-> identifier)
DocumentReference.authenticator
  • Deleted (-> attester)
DocumentReference.content.format
  • Deleted (-> content.profile)
DocumentReference.context.encounter
  • Deleted (-> context)
DocumentReference.context.event
  • Deleted (-> event)
DocumentReference.context.period
  • Deleted (-> period)
DocumentReference.context.facilityType
  • Deleted (-> facilityType)
DocumentReference.context.practiceSetting
  • Deleted (-> practiceSetting)
DocumentReference.context.sourcePatientInfo
  • Deleted (-> use extension http://hl7.org/fhir/StructureDefinition/documentreference-sourcepatient)
DocumentReference.context.related
  • Deleted (-> basedOn)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference TUDomainResourceA reference to a document
+ Warning: facilityType SHALL only be present if context is not an encounter
+ Warning: practiceSetting SHALL only be present if context is not present

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness identifiers for the document

... version Σ0..1stringAn explicitly assigned identifer of a variation of the content in the DocumentReference
... basedOn 0..*Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription)Procedure that caused this media to be created

... docStatus Σ0..1coderegistered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: Composition Status (Required)
... modality Σ0..*CodeableConceptImaging modality used
Binding: Modality icon (Extensible)

... type Σ0..1CodeableConceptKind of document (LOINC if possible)
Binding: FHIR Document Type Codes (Preferred)
... category Σ0..*CodeableConceptCategorization of document
Binding: Referenced Item Category Value Set (Example)

... subject Σ0..1Reference(Any)Who/what is the subject of the document
... context C0..*Reference(Appointment | Encounter | EpisodeOfCare)Context of the document content

... event 0..*CodeableReference()Main clinical acts documented
Binding: v3 Code System ActCode icon (Example)

... bodySite Σ0..*CodeableReference(BodyStructure)Body part included
Binding: SNOMED CT Body Structures (Example)

... facilityType C0..1CodeableConceptKind of facility where patient was seen
Binding: Facility Type Code Value Set (Example)
... practiceSetting C0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: Practice Setting Code Value Set (Example)
... period Σ0..1PeriodTime of service that is being documented
... date Σ0..1instantWhen this document reference was created
... author Σ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam)Who and/or what authored the document

... attester 0..*BackboneElementAttests to accuracy of the document

.... mode 1..1CodeableConceptpersonal | professional | legal | official
Binding: Composition Attestation Mode (Preferred)
.... time 0..1dateTimeWhen the document was attested
.... party 0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)Who attested the document
... custodian 0..1Reference(Organization)Organization which maintains the document
... relatesTo Σ0..*BackboneElementRelationships to other documents

.... code Σ1..1CodeableConceptThe relationship type with another document
Binding: Document Relationship Type (Extensible)
.... target Σ1..1Reference(DocumentReference)Target of the relationship
... description Σ0..1markdownHuman-readable description
... securityLabel Σ0..*CodeableConceptDocument security-tags
Binding: Example set of Security Labels (Example)

... content Σ1..*BackboneElementDocument referenced

.... attachment Σ1..1AttachmentWhere to access the document
.... profile Σ0..*BackboneElementContent profile rules for the document

..... value[x] Σ1..1Code|uri|canonical
Binding: HL7 ValueSet of Format Codes for use with Document Sharing icon (Preferred)
...... valueCodingCoding
...... valueUriuri
...... valueCanonicalcanonical()

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

DocumentReference (DomainResource)Other business identifiers associated with the document, including version independent identifiersidentifier : Identifier [0..*]An explicitly assigned identifer of a variation of the content in the DocumentReferenceversion : string [0..1]A procedure that is fulfilled in whole or in part by the creation of this mediabasedOn : Reference [0..*] « Appointment|AppointmentResponse| CarePlan|Claim|CommunicationRequest|Contract| CoverageEligibilityRequest|DeviceRequest|EnrollmentRequest| ImmunizationRecommendation|MedicationRequest|NutritionOrder| RequestOrchestration|ServiceRequest|SupplyRequest| VisionPrescription »The status of this document reference (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)DocumentReferenceStatus! »The status of the underlying documentdocStatus : code [0..1] « null (Strength=Required)CompositionStatus! »Imaging modality used. This may include both acquisition and non-acquisition modalitiesmodality : CodeableConcept [0..*] « null (Strength=Extensible)Modality+ »Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referencedtype : CodeableConcept [0..1] « null (Strength=Preferred)FHIRDocumentTypeCodes? »A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.typecategory : CodeableConcept [0..*] « null (Strength=Example)ReferencedItemCategoryValueSet?? »Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure)subject : Reference [0..1] « Any »Describes the clinical encounter or type of care that the document content is associated withcontext : Reference [0..*] « Appointment|Encounter|EpisodeOfCare » « This element has or is affected by some invariantsC »This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" actevent : CodeableReference [0..*] « ; null (Strength=Example)ActCode?? »The anatomic structures included in the documentbodySite : CodeableReference [0..*] « BodyStructure; Codes describing anatomical locations. May include laterality. (Strength=Example) SNOMEDCTBodyStructures?? »The kind of facility where the patient was seenfacilityType : CodeableConcept [0..1] « null (Strength=Example)FacilityTypeCodeValueSet?? » « This element has or is affected by some invariantsC »This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialtypracticeSetting : CodeableConcept [0..1] « null (Strength=Example) PracticeSettingCodeValueSet?? » « This element has or is affected by some invariantsC »The time period over which the service that is described by the document was providedperiod : Period [0..1]When the document reference was createddate : instant [0..1]Identifies who is responsible for adding the information to the documentauthor : Reference [0..*] « Practitioner|PractitionerRole| Organization|Device|Patient|RelatedPerson|CareTeam »Identifies the organization or group who is responsible for ongoing maintenance of and access to the documentcustodian : Reference [0..1] « Organization »Human-readable description of the source documentdescription : markdown [0..1]A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happenedsecurityLabel : CodeableConcept [0..*] « null (Strength=Example)SecurityLabelExamples?? »AttesterThe type of attestation the authenticator offersmode : CodeableConcept [1..1] « null (Strength=Preferred)CompositionAttestationMode? »When the document was attested by the partytime : dateTime [0..1]Who attested the document in the specified wayparty : Reference [0..1] « Patient|RelatedPerson|Practitioner| PractitionerRole|Organization »RelatesToThe type of relationship that this document has with anther documentcode : CodeableConcept [1..1] « null (Strength=Extensible)DocumentRelationshipType+ »The target document of this relationshiptarget : Reference [1..1] « DocumentReference »ContentThe document or URL of the document along with critical metadata to prove content has integrityattachment : Attachment [1..1]ProfileCode|uri|canonicalvalue[x] : DataType [1..1] « Coding|uri|canonical; null (Strength=Preferred)HL7FormatCodes? »A participant who has authenticated the accuracy of the documentattester[0..*]Relationships that this document has with other document references that already existrelatesTo[0..*]An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeTypeprofile[0..*]The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadatacontent[1..*]

XML Template

<DocumentReference xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifiers for the document --></identifier>
 <version value="[string]"/><!-- 0..1 An explicitly assigned identifer of a variation of the content in the DocumentReference -->
 <basedOn><!-- 0..* Reference(Appointment|AppointmentResponse|CarePlan|Claim|
   CommunicationRequest|Contract|CoverageEligibilityRequest|DeviceRequest|
   EnrollmentRequest|ImmunizationRecommendation|MedicationRequest|NutritionOrder|
   RequestOrchestration|ServiceRequest|SupplyRequest|VisionPrescription) Procedure that caused this media to be created --></basedOn>
 <status value="[code]"/><!-- 1..1 current | superseded | entered-in-error -->
 <docStatus value="[code]"/><!-- 0..1 registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown -->
 <modality><!-- 0..* CodeableConcept Imaging modality used icon --></modality>
 <type><!-- 0..1 CodeableConcept Kind of document (LOINC if possible) --></type>
 <category><!-- 0..* CodeableConcept Categorization of document --></category>
 <subject><!-- 0..1 Reference(Any) Who/what is the subject of the document --></subject>
 <context><!-- I 0..* Reference(Appointment|Encounter|EpisodeOfCare) Context of the document content --></context>
 <event><!-- 0..* CodeableReference Main clinical acts documented icon --></event>
 <bodySite><!-- 0..* CodeableReference(BodyStructure) Body part included --></bodySite>
 <facilityType><!-- I 0..1 CodeableConcept Kind of facility where patient was seen --></facilityType>
 <practiceSetting><!-- I 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty) --></practiceSetting>
 <period><!-- 0..1 Period Time of service that is being documented --></period>
 <date value="[instant]"/><!-- 0..1 When this document reference was created -->
 <author><!-- 0..* Reference(CareTeam|Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) Who and/or what authored the document --></author>
 <attester>  <!-- 0..* Attests to accuracy of the document -->
  <mode><!-- 1..1 CodeableConcept personal | professional | legal | official --></mode>
  <time value="[dateTime]"/><!-- 0..1 When the document was attested -->
  <party><!-- 0..1 Reference(Organization|Patient|Practitioner|PractitionerRole|
    RelatedPerson) Who attested the document --></party>
 </attester>
 <custodian><!-- 0..1 Reference(Organization) Organization which maintains the document --></custodian>
 <relatesTo>  <!-- 0..* Relationships to other documents -->
  <code><!-- 1..1 CodeableConcept The relationship type with another document --></code>
  <target><!-- 1..1 Reference(DocumentReference) Target of the relationship --></target>
 </relatesTo>
 <description value="[markdown]"/><!-- 0..1 Human-readable description -->
 <securityLabel><!-- 0..* CodeableConcept Document security-tags --></securityLabel>
 <content>  <!-- 1..* Document referenced -->
  <attachment><!-- 1..1 Attachment Where to access the document --></attachment>
  <profile>  <!-- 0..* Content profile rules for the document -->
   <value[x]><!-- 1..1 Coding|uri|canonical Code|uri|canonical icon --></value[x]>
  </profile>
 </content>
</DocumentReference>

JSON Template

{doco
  "resourceType" : "DocumentReference",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifiers for the document
  "version" : "<string>", // An explicitly assigned identifer of a variation of the content in the DocumentReference
  "basedOn" : [{ Reference(Appointment|AppointmentResponse|CarePlan|Claim|
   CommunicationRequest|Contract|CoverageEligibilityRequest|DeviceRequest|
   EnrollmentRequest|ImmunizationRecommendation|MedicationRequest|NutritionOrder|
   RequestOrchestration|ServiceRequest|SupplyRequest|VisionPrescription) }], // Procedure that caused this media to be created
  "status" : "<code>", // R!  current | superseded | entered-in-error
  "docStatus" : "<code>", // registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
  "modality" : [{ CodeableConcept }], // Imaging modality used icon
  "type" : { CodeableConcept }, // Kind of document (LOINC if possible)
  "category" : [{ CodeableConcept }], // Categorization of document
  "subject" : { Reference(Any) }, // Who/what is the subject of the document
  "context" : [{ Reference(Appointment|Encounter|EpisodeOfCare) }], // I Context of the document content
  "event" : [{ CodeableReference }], // Main clinical acts documented icon
  "bodySite" : [{ CodeableReference(BodyStructure) }], // Body part included
  "facilityType" : { CodeableConcept }, // I Kind of facility where patient was seen
  "practiceSetting" : { CodeableConcept }, // I Additional details about where the content was created (e.g. clinical specialty)
  "period" : { Period }, // Time of service that is being documented
  "date" : "<instant>", // When this document reference was created
  "author" : [{ Reference(CareTeam|Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) }], // Who and/or what authored the document
  "attester" : [{ // Attests to accuracy of the document
    "mode" : { CodeableConcept }, // R!  personal | professional | legal | official
    "time" : "<dateTime>", // When the document was attested
    "party" : { Reference(Organization|Patient|Practitioner|PractitionerRole|
    RelatedPerson) } // Who attested the document
  }],
  "custodian" : { Reference(Organization) }, // Organization which maintains the document
  "relatesTo" : [{ // Relationships to other documents
    "code" : { CodeableConcept }, // R!  The relationship type with another document
    "target" : { Reference(DocumentReference) } // R!  Target of the relationship
  }],
  "description" : "<markdown>", // Human-readable description
  "securityLabel" : [{ CodeableConcept }], // Document security-tags
  "content" : [{ // R!  Document referenced
    "attachment" : { Attachment }, // R!  Where to access the document
    "profile" : [{ // Content profile rules for the document
      // value[x]: Code|uri|canonical. One of these 3:
      "valueCoding" : { Coding },
      "valueUri" : "<uri>",
      "valueCanonical" : "<canonical>"
    }]
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:DocumentReference;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifiers for the document
  fhir:version [ string ] ; # 0..1 An explicitly assigned identifer of a variation of the content in the DocumentReference
  fhir:basedOn  ( [ Reference(Appointment|AppointmentResponse|CarePlan|Claim|CommunicationRequest|Contract|
  CoverageEligibilityRequest|DeviceRequest|EnrollmentRequest|
  ImmunizationRecommendation|MedicationRequest|NutritionOrder|
  RequestOrchestration|ServiceRequest|SupplyRequest|VisionPrescription) ] ... ) ; # 0..* Procedure that caused this media to be created
  fhir:status [ code ] ; # 1..1 current | superseded | entered-in-error
  fhir:docStatus [ code ] ; # 0..1 registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
  fhir:modality  ( [ CodeableConcept ] ... ) ; # 0..* Imaging modality used
  fhir:type [ CodeableConcept ] ; # 0..1 Kind of document (LOINC if possible)
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Categorization of document
  fhir:subject [ Reference(Any) ] ; # 0..1 Who/what is the subject of the document
  fhir:context  ( [ Reference(Appointment|Encounter|EpisodeOfCare) ] ... ) ; # 0..* I Context of the document content
  fhir:event  ( [ CodeableReference ] ... ) ; # 0..* Main clinical acts documented
  fhir:bodySite  ( [ CodeableReference(BodyStructure) ] ... ) ; # 0..* Body part included
  fhir:facilityType [ CodeableConcept ] ; # 0..1 I Kind of facility where patient was seen
  fhir:practiceSetting [ CodeableConcept ] ; # 0..1 I Additional details about where the content was created (e.g. clinical specialty)
  fhir:period [ Period ] ; # 0..1 Time of service that is being documented
  fhir:date [ instant ] ; # 0..1 When this document reference was created
  fhir:author  ( [ Reference(CareTeam|Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ... ) ; # 0..* Who and/or what authored the document
  fhir:attester ( [ # 0..* Attests to accuracy of the document
    fhir:mode [ CodeableConcept ] ; # 1..1 personal | professional | legal | official
    fhir:time [ dateTime ] ; # 0..1 When the document was attested
    fhir:party [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Who attested the document
  ] ... ) ;
  fhir:custodian [ Reference(Organization) ] ; # 0..1 Organization which maintains the document
  fhir:relatesTo ( [ # 0..* Relationships to other documents
    fhir:code [ CodeableConcept ] ; # 1..1 The relationship type with another document
    fhir:target [ Reference(DocumentReference) ] ; # 1..1 Target of the relationship
  ] ... ) ;
  fhir:description [ markdown ] ; # 0..1 Human-readable description
  fhir:securityLabel  ( [ CodeableConcept ] ... ) ; # 0..* Document security-tags
  fhir:content ( [ # 1..* Document referenced
    fhir:attachment [ Attachment ] ; # 1..1 Where to access the document
    fhir:profile ( [ # 0..* Content profile rules for the document
      # value[x] : 1..1 Code|uri|canonical. One of these 3
        fhir:value [  a fhir:Coding ; Coding ]
        fhir:value [  a fhir:uri ; uri ]
        fhir:value [  a fhir:canonical ; canonical ]
    ] ... ) ;
  ] ... ) ;
]

Changes from both R4 and R4B

DocumentReference
DocumentReference.version
  • Added Element
DocumentReference.basedOn
  • Added Element
DocumentReference.docStatus
  • Add codes registered, partial, corrected, appended, cancelled, deprecated, unknown
DocumentReference.modality
  • Added Element
DocumentReference.subject
  • Type Reference: Added Target Type Resource
  • Type Reference: Removed Target Types Patient, Practitioner, Group, Device
DocumentReference.context
  • Max Cardinality changed from 1 to *
  • Type changed from BackboneElement to Reference(Appointment | Encounter | EpisodeOfCare)
DocumentReference.event
  • Added Element
DocumentReference.bodySite
  • Added Element
DocumentReference.facilityType
  • Added Element
DocumentReference.practiceSetting
  • Added Element
DocumentReference.period
  • Added Element
DocumentReference.author
  • Type Reference: Added Target Type CareTeam
DocumentReference.attester
  • Added Element
DocumentReference.attester.mode
  • Added Mandatory Element
DocumentReference.attester.time
  • Added Element
DocumentReference.attester.party
  • Added Element
DocumentReference.relatesTo.code
  • Type changed from code to CodeableConcept
  • Change binding strength from required to extensible
DocumentReference.description
  • Type changed from string to markdown
DocumentReference.securityLabel
  • Remove Binding `http://hl7.org/fhir/ValueSet/security-labels` (extensible)
DocumentReference.content.profile
  • Added Element
DocumentReference.content.profile.value[x]
  • Added Mandatory Element
DocumentReference.masterIdentifier
  • Deleted (-> identifier)
DocumentReference.authenticator
  • Deleted (-> attester)
DocumentReference.content.format
  • Deleted (-> content.profile)
DocumentReference.context.encounter
  • Deleted (-> context)
DocumentReference.context.event
  • Deleted (-> event)
DocumentReference.context.period
  • Deleted (-> period)
DocumentReference.context.facilityType
  • Deleted (-> facilityType)
DocumentReference.context.practiceSetting
  • Deleted (-> practiceSetting)
DocumentReference.context.sourcePatientInfo
  • Deleted (-> use extension http://hl7.org/fhir/StructureDefinition/documentreference-sourcepatient)
DocumentReference.context.related
  • Deleted (-> basedOn)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

10.2.4.1 Terminology Bindings

PathValueSetTypeDocumentation
DocumentReference.status DocumentReferenceStatus Required

The status of the document reference.
DocumentReference.docStatus CompositionStatus Required

The workflow/clinical status of the composition.
DocumentReference.modality Modality icon Extensible

Transitive closure of CID 33 Modality
DocumentReference.type FHIRDocumentTypeCodes Preferred

FHIR Document Codes - all LOINC codes where scale type = 'DOC'.
DocumentReference.category ReferencedItemCategoryValueSet Example

This is the code specifying the high-level kind of document (e.g. Prescription, Discharge Summary, Report, etc.). Made up of a set of non-healthcare specific codes and all LOINC codes where scale type = 'DOC'.
DocumentReference.event ActCode icon Example

A code specifying the particular kind of Act that the Act-instance represents within its class. Constraints: The kind of Act (e.g. physical examination, serum potassium, inpatient encounter, charge financial transaction, etc.) is specified with a code from one of several, typically external, coding systems. The coding system will depend on the class of Act, such as LOINC for observations, etc. Conceptually, the Act.code must be a specialization of the Act.classCode. This is why the structure of ActClass domain should be reflected in the superstructure of the ActCode domain and then individual codes or externally referenced vocabularies subordinated under these domains that reflect the ActClass structure. Act.classCode and Act.code are not modifiers of each other but the Act.code concept should really imply the Act.classCode concept. For a negative example, it is not appropriate to use an Act.code "potassium" together with and Act.classCode for "laboratory observation" to somehow mean "potassium laboratory observation" and then use the same Act.code for "potassium" together with Act.classCode for "medication" to mean "substitution of potassium". This mutually modifying use of Act.code and Act.classCode is not permitted.
DocumentReference.bodySite SNOMEDCTBodyStructures Example

This value set includes all codes from SNOMED CT icon where concept is-a 442083009 (Anatomical or acquired body site (body structure)).
DocumentReference.facilityType FacilityTypeCodeValueSet Example

This is the code representing the type of organizational setting where the clinical encounter, service, interaction, or treatment occurred. The value set used for Healthcare Facility Type has been defined by HITSP to be the value set reproduced from HITSP C80 Table 2-147.
DocumentReference.practiceSetting PracticeSettingCodeValueSet Example

This is the code representing the clinical specialty of the clinician or provider who interacted with, treated, or provided a service to/for the patient. The value set used for clinical specialty has been limited by HITSP to the value set reproduced from HITSP C80 Table 2-149 Clinical Specialty Value Set Definition.
DocumentReference.attester.mode CompositionAttestationMode Preferred

The way in which a person authenticated a composition.
DocumentReference.relatesTo.code DocumentRelationshipType Extensible

The type of relationship between documents.
DocumentReference.securityLabel SecurityLabelExamples Example

A sample of security labels from Healthcare Privacy and Security Classification System as the combination of data and event codes.
DocumentReference.content.profile.value[x] HL7FormatCodes icon Preferred

The HL7-FormatCodes value set is defined to be the set of FormatCode(s) defined by implementation guides published by HL7 and other SDOs. The use of a formatCode from the FormatCodes value set specifies the technical format that a document conforms to. The formatCode is a further specialization more detailed than the mime-type. The formatCode provides sufficient information to allow any potential document content consumer to know if it can process and/or display the content of the document based on the document encoding, structure and template conformance indicated by the formatCode. The set of formatCodes is intended to be extensible. The Content Logical Description is defined intentionally to permit formatCodes defined by other Standards Development Organizations to be added by inclusion of additional formatCode Code Systems.

10.2.4.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
img docRef-1Warning (base)facilityType SHALL only be present if context is not an encounterfacilityType.empty() or context.where(resolve() is Encounter).empty()
img docRef-2Warning (base)practiceSetting SHALL only be present if context is not presentpracticeSetting.empty() or context.where(resolve() is Encounter).empty()

10.2.5 Implementation Notes

  • The resources maintain one way relationships that point backwards - e.g., the document that replaces one document points towards the document that it replaced. The reverse relationships can be followed by using indexes built from the resources. Typically, this is done using the search parameters described below. Given that documents may have other documents that replace or append them, clients should always check these relationships when accessing documents
  • The _content search parameter shall search across the DocumentReference.content.attachment.data, and DocumentReference.content.url.
  • If the referenced resource changes, then the corresponding DocumentRefererence may be out of sync temporarily. Coordination will be needed to ensure that the DocumentReference gets updated if the referenced resource changes (and to not allow updates to the DocumentReference that cause it to be misaligned with the referenced resource).

10.2.6 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
attesterreferenceWho attested the documentDocumentReference.attester.party
(Practitioner, Organization, Patient, PractitionerRole, RelatedPerson)
authorreferenceWho and/or what authored the documentDocumentReference.author
(Practitioner, Organization, CareTeam, Device, Patient, PractitionerRole, RelatedPerson)
based-onreferenceProcedure that caused this media to be createdDocumentReference.basedOn
(Appointment, MedicationRequest, RequestOrchestration, VisionPrescription, ServiceRequest, SupplyRequest, AppointmentResponse, CoverageEligibilityRequest, CarePlan, EnrollmentRequest, NutritionOrder, DeviceRequest, Contract, Claim, CommunicationRequest, ImmunizationRecommendation)
bodysitetokenThe body site studiedDocumentReference.bodySite.concept
bodysite-referencereferenceThe body site studiedDocumentReference.bodySite.reference
categorytokenCategorization of documentDocumentReference.category
contenttypetokenMime type of the content, with charset etc.DocumentReference.content.attachment.contentType
contextreferenceContext of the document contentDocumentReference.context
(Appointment, EpisodeOfCare, Encounter)
creationdateDate attachment was first createdDocumentReference.content.attachment.creation
custodianreferenceOrganization which maintains the documentDocumentReference.custodian
(Organization)
datedateWhen this document reference was createdDocumentReference.date27 Resources
descriptionstringHuman-readable descriptionDocumentReference.description
doc-statustokenpreliminary | final | amended | entered-in-errorDocumentReference.docStatus
event-codetokenMain clinical acts documentedDocumentReference.event.concept
event-referencereferenceMain clinical acts documentedDocumentReference.event.reference
facilitytokenKind of facility where patient was seenDocumentReference.facilityType
format-canonicalreferenceProfile canonical content rules for the document(DocumentReference.content.profile.value.ofType(canonical))
format-codetokenFormat code content rules for the document(DocumentReference.content.profile.value.ofType(Coding))
format-uriuriProfile URI content rules for the document(DocumentReference.content.profile.value.ofType(uri))
identifiertokenIdentifier of the attachment binaryDocumentReference.identifier65 Resources
languagetokenHuman language of the content (BCP-47)DocumentReference.content.attachment.language
locationuriUri where the data can be foundDocumentReference.content.attachment.url
modalitytokenThe modality usedDocumentReference.modality
patientreferenceWho/what is the subject of the documentDocumentReference.subject.where(resolve() is Patient)
(Patient)		66 Resources
perioddateTime of service that is being documentedDocumentReference.period
relatestoreferenceTarget of the relationshipDocumentReference.relatesTo.target
(DocumentReference)
relationtokenreplaces | transforms | signs | appendsDocumentReference.relatesTo.code
relationshipcompositeCombination of relation and relatesToOn DocumentReference.relatesTo:
  relatesto: code
  relation: target
security-labeltokenDocument security-tagsDocumentReference.securityLabel
settingtokenAdditional details about where the content was created (e.g. clinical specialty)DocumentReference.practiceSetting
statustokencurrent | superseded | entered-in-errorDocumentReference.status
subjectreferenceWho/what is the subject of the documentDocumentReference.subject
(Any)
typetokenKind of document (LOINC if possible)DocumentReference.type11 Resources
versionstringThe business version identifierDocumentReference.version