Mobile access to Health Documents (MHD)
4.2.5 - trial-use International flag

Mobile access to Health Documents (MHD), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 4.2.5 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.MHD/ and changes regularly. See the Directory of published versions

Resource Profile: MHD DocumentReference for Simplified Publish

Official URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.SimplifiedPublish.DocumentReference Version: 4.2.5
Active as of 2026-10-13 Computable Name: SimplifiedPublishDocumentReference

A profile on the DocumentReference resource for MHD Simplified Publish constraints.

Simplified Publish

  • Similar to Minimal Metadata constraints
    • must be status current
    • must have a patient indicated
  • uses attachment.data to carry the document, rather than attachment.url
    • so that the Simplified Publish is a simple POST of the DocumentReference
    • Document Recipient is expected to extract the .data, use .url

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* DocumentReference A reference to a document
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DocumentReference.masterIdentifier This element is included in summaries. 1..1 Identifier Master Version Specific Identifier
DocumentReference.Slices for identifier This element is included in summaries. 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for identifier.identifier:uniqueId This element must be supported. This element is included in summaries. 0..1 UniqueIdIdentifier Unique identifier for the referenced Document
DocumentReference.status This element is a modifier element. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
Required Pattern: current
DocumentReference.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
DocumentReference.category This element must be supported. This element is included in summaries. 0..1 CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
DocumentReference.subject This element is included in summaries. 1..1 Reference(Patient) Who/what is the subject of the document
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant When this document reference was created
DocumentReference.author This element must be supported. This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
DocumentReference.relatesTo This element must be supported. This element is included in summaries. 0..* BackboneElement Relationships to other documents
DocumentReference.relatesTo.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.relatesTo.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.relatesTo.target This element is included in summaries. 1..1 Reference(DocumentReference) Target of the relationship
DocumentReference.securityLabel This element must be supported. This element is included in summaries. 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content This element is included in summaries. 1..1 BackboneElement Document referenced
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element is included in summaries. 1..1 Attachment Where to access the document
DocumentReference.content.attachment.contentType This element is included in summaries. 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
DocumentReference.content.attachment.language This element must be supported. This element is included in summaries. 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
DocumentReference.content.attachment.data 1..1 base64Binary The document is contained in the .data element, base64 encoded
DocumentReference.content.attachment.creation This element must be supported. This element is included in summaries. 0..1 dateTime Date attachment was first created
DocumentReference.content.format This element must be supported. This element is included in summaries. 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
DocumentReference.context This element is included in summaries. 0..1 BackboneElement Clinical context of document
DocumentReference.context.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.context.period This element must be supported. This element is included in summaries. 0..1 Period Time of service that is being documented
DocumentReference.context.facilityType This element must be supported. 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
DocumentReference.context.practiceSetting This element must be supported. 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
DocumentReference.context.sourcePatientInfo This element must be supported. 0..1 Reference(Patient) Patient demographics from source

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* DocumentReference A reference to a document
DocumentReference.modifierExtension 0..0 Extension
DocumentReference.masterIdentifier 1..1 Identifier Master Version Specific Identifier
DocumentReference.Slices for identifier 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for identifier.identifier:entryUUID 0..0 Business identifier for the DocumentReference
DocumentReference.Slices for identifier.identifier:uniqueId This element must be supported. 0..1 UniqueIdIdentifier Unique identifier for the referenced Document
DocumentReference.status 1..1 code current | superseded | entered-in-error
Required Pattern: current
DocumentReference.docStatus 0..0 preliminary | final | amended | entered-in-error
DocumentReference.type This element must be supported. 0..1 CodeableConcept Kind of document (LOINC if possible)
DocumentReference.category This element must be supported. 0..1 CodeableConcept Categorization of document
DocumentReference.subject 1..1 Reference(Patient) Who/what is the subject of the document
DocumentReference.date This element must be supported. 0..1 instant When this document reference was created
DocumentReference.author This element must be supported. 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
DocumentReference.relatesTo This element must be supported. 0..* BackboneElement Relationships to other documents
DocumentReference.securityLabel This element must be supported. 0..* CodeableConcept Document security-tags
DocumentReference.content 1..1 BackboneElement Document referenced
DocumentReference.content.attachment
DocumentReference.content.attachment.contentType 1..1 code Mime type of the content, with charset etc.
DocumentReference.content.attachment.language This element must be supported. 0..1 code Human language of the content (BCP-47)
DocumentReference.content.attachment.data 1..1 base64Binary The document is contained in the .data element, base64 encoded
DocumentReference.content.attachment.url 0..0 Uri where the data can be found
DocumentReference.content.attachment.creation This element must be supported. 0..1 dateTime Date attachment was first created
DocumentReference.content.format This element must be supported. 0..1 Coding Format/content rules for the document
DocumentReference.context
DocumentReference.context.period This element must be supported. 0..1 Period Time of service that is being documented
DocumentReference.context.facilityType This element must be supported. 0..1 CodeableConcept Kind of facility where patient was seen
DocumentReference.context.practiceSetting This element must be supported. 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
DocumentReference.context.sourcePatientInfo This element must be supported. 0..1 Reference(Patient) Patient demographics from source

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* DocumentReference A reference to a document
DocumentReference.id This element is included in summaries. 0..1 id Logical id of this artifact
DocumentReference.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DocumentReference.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
DocumentReference.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
DocumentReference.contained 0..* Resource Contained, inline Resources
DocumentReference.extension 0..* Extension Additional content defined by implementations
DocumentReference.masterIdentifier This element is included in summaries. 1..1 Identifier Master Version Specific Identifier
DocumentReference.Slices for identifier This element is included in summaries. 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for identifier.identifier:uniqueId This element must be supported. This element is included in summaries. 0..1 UniqueIdIdentifier Unique identifier for the referenced Document
DocumentReference.status This element is a modifier element. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
Required Pattern: current
DocumentReference.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
DocumentReference.category This element must be supported. This element is included in summaries. 0..1 CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
DocumentReference.subject This element is included in summaries. 1..1 Reference(Patient) Who/what is the subject of the document
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant When this document reference was created
DocumentReference.author This element must be supported. This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
DocumentReference.authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
DocumentReference.custodian 0..1 Reference(Organization) Organization which maintains the document
DocumentReference.relatesTo This element must be supported. This element is included in summaries. 0..* BackboneElement Relationships to other documents
DocumentReference.relatesTo.id 0..1 string Unique id for inter-element referencing
DocumentReference.relatesTo.extension 0..* Extension Additional content defined by implementations
DocumentReference.relatesTo.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.relatesTo.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.relatesTo.target This element is included in summaries. 1..1 Reference(DocumentReference) Target of the relationship
DocumentReference.description This element is included in summaries. 0..1 string Human-readable description
DocumentReference.securityLabel This element must be supported. This element is included in summaries. 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content This element is included in summaries. 1..1 BackboneElement Document referenced
DocumentReference.content.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.extension 0..* Extension Additional content defined by implementations
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element is included in summaries. 1..1 Attachment Where to access the document
DocumentReference.content.attachment.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.attachment.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.content.attachment.contentType This element is included in summaries. 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
DocumentReference.content.attachment.language This element must be supported. This element is included in summaries. 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
DocumentReference.content.attachment.data 1..1 base64Binary The document is contained in the .data element, base64 encoded
DocumentReference.content.attachment.size This element is included in summaries. 0..1 unsignedInt Number of bytes of content (if url provided)
DocumentReference.content.attachment.hash This element is included in summaries. 0..1 base64Binary Hash of the data (sha-1, base64ed)
DocumentReference.content.attachment.title This element is included in summaries. 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
DocumentReference.content.attachment.creation This element must be supported. This element is included in summaries. 0..1 dateTime Date attachment was first created
DocumentReference.content.format This element must be supported. This element is included in summaries. 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
DocumentReference.context This element is included in summaries. 0..1 BackboneElement Clinical context of document
DocumentReference.context.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.extension 0..* Extension Additional content defined by implementations
DocumentReference.context.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.context.encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
DocumentReference.context.event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
DocumentReference.context.period This element must be supported. This element is included in summaries. 0..1 Period Time of service that is being documented
DocumentReference.context.facilityType This element must be supported. 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
DocumentReference.context.practiceSetting This element must be supported. 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
DocumentReference.context.sourcePatientInfo This element must be supported. 0..1 Reference(Patient) Patient demographics from source
DocumentReference.context.related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.4
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from DocumentReference

Summary

Mandatory: 4 elements
Must-Support: 14 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DocumentReference.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* DocumentReference A reference to a document
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DocumentReference.masterIdentifier This element is included in summaries. 1..1 Identifier Master Version Specific Identifier
DocumentReference.Slices for identifier This element is included in summaries. 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for identifier.identifier:uniqueId This element must be supported. This element is included in summaries. 0..1 UniqueIdIdentifier Unique identifier for the referenced Document
DocumentReference.status This element is a modifier element. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
Required Pattern: current
DocumentReference.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
DocumentReference.category This element must be supported. This element is included in summaries. 0..1 CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
DocumentReference.subject This element is included in summaries. 1..1 Reference(Patient) Who/what is the subject of the document
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant When this document reference was created
DocumentReference.author This element must be supported. This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
DocumentReference.relatesTo This element must be supported. This element is included in summaries. 0..* BackboneElement Relationships to other documents
DocumentReference.relatesTo.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.relatesTo.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.relatesTo.target This element is included in summaries. 1..1 Reference(DocumentReference) Target of the relationship
DocumentReference.securityLabel This element must be supported. This element is included in summaries. 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content This element is included in summaries. 1..1 BackboneElement Document referenced
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element is included in summaries. 1..1 Attachment Where to access the document
DocumentReference.content.attachment.contentType This element is included in summaries. 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
DocumentReference.content.attachment.language This element must be supported. This element is included in summaries. 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
DocumentReference.content.attachment.data 1..1 base64Binary The document is contained in the .data element, base64 encoded
DocumentReference.content.attachment.creation This element must be supported. This element is included in summaries. 0..1 dateTime Date attachment was first created
DocumentReference.content.format This element must be supported. This element is included in summaries. 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
DocumentReference.context This element is included in summaries. 0..1 BackboneElement Clinical context of document
DocumentReference.context.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.context.period This element must be supported. This element is included in summaries. 0..1 Period Time of service that is being documented
DocumentReference.context.facilityType This element must be supported. 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
DocumentReference.context.practiceSetting This element must be supported. 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
DocumentReference.context.sourcePatientInfo This element must be supported. 0..1 Reference(Patient) Patient demographics from source

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* DocumentReference A reference to a document
DocumentReference.modifierExtension 0..0 Extension
DocumentReference.masterIdentifier 1..1 Identifier Master Version Specific Identifier
DocumentReference.Slices for identifier 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for identifier.identifier:entryUUID 0..0 Business identifier for the DocumentReference
DocumentReference.Slices for identifier.identifier:uniqueId This element must be supported. 0..1 UniqueIdIdentifier Unique identifier for the referenced Document
DocumentReference.status 1..1 code current | superseded | entered-in-error
Required Pattern: current
DocumentReference.docStatus 0..0 preliminary | final | amended | entered-in-error
DocumentReference.type This element must be supported. 0..1 CodeableConcept Kind of document (LOINC if possible)
DocumentReference.category This element must be supported. 0..1 CodeableConcept Categorization of document
DocumentReference.subject 1..1 Reference(Patient) Who/what is the subject of the document
DocumentReference.date This element must be supported. 0..1 instant When this document reference was created
DocumentReference.author This element must be supported. 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
DocumentReference.relatesTo This element must be supported. 0..* BackboneElement Relationships to other documents
DocumentReference.securityLabel This element must be supported. 0..* CodeableConcept Document security-tags
DocumentReference.content 1..1 BackboneElement Document referenced
DocumentReference.content.attachment
DocumentReference.content.attachment.contentType 1..1 code Mime type of the content, with charset etc.
DocumentReference.content.attachment.language This element must be supported. 0..1 code Human language of the content (BCP-47)
DocumentReference.content.attachment.data 1..1 base64Binary The document is contained in the .data element, base64 encoded
DocumentReference.content.attachment.url 0..0 Uri where the data can be found
DocumentReference.content.attachment.creation This element must be supported. 0..1 dateTime Date attachment was first created
DocumentReference.content.format This element must be supported. 0..1 Coding Format/content rules for the document
DocumentReference.context
DocumentReference.context.period This element must be supported. 0..1 Period Time of service that is being documented
DocumentReference.context.facilityType This element must be supported. 0..1 CodeableConcept Kind of facility where patient was seen
DocumentReference.context.practiceSetting This element must be supported. 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
DocumentReference.context.sourcePatientInfo This element must be supported. 0..1 Reference(Patient) Patient demographics from source

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* DocumentReference A reference to a document
DocumentReference.id This element is included in summaries. 0..1 id Logical id of this artifact
DocumentReference.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DocumentReference.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
DocumentReference.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
DocumentReference.contained 0..* Resource Contained, inline Resources
DocumentReference.extension 0..* Extension Additional content defined by implementations
DocumentReference.masterIdentifier This element is included in summaries. 1..1 Identifier Master Version Specific Identifier
DocumentReference.Slices for identifier This element is included in summaries. 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for identifier.identifier:uniqueId This element must be supported. This element is included in summaries. 0..1 UniqueIdIdentifier Unique identifier for the referenced Document
DocumentReference.status This element is a modifier element. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
Required Pattern: current
DocumentReference.type This element must be supported. This element is included in summaries. 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
DocumentReference.category This element must be supported. This element is included in summaries. 0..1 CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
DocumentReference.subject This element is included in summaries. 1..1 Reference(Patient) Who/what is the subject of the document
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant When this document reference was created
DocumentReference.author This element must be supported. This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
DocumentReference.authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
DocumentReference.custodian 0..1 Reference(Organization) Organization which maintains the document
DocumentReference.relatesTo This element must be supported. This element is included in summaries. 0..* BackboneElement Relationships to other documents
DocumentReference.relatesTo.id 0..1 string Unique id for inter-element referencing
DocumentReference.relatesTo.extension 0..* Extension Additional content defined by implementations
DocumentReference.relatesTo.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.relatesTo.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.relatesTo.target This element is included in summaries. 1..1 Reference(DocumentReference) Target of the relationship
DocumentReference.description This element is included in summaries. 0..1 string Human-readable description
DocumentReference.securityLabel This element must be supported. This element is included in summaries. 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content This element is included in summaries. 1..1 BackboneElement Document referenced
DocumentReference.content.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.extension 0..* Extension Additional content defined by implementations
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element is included in summaries. 1..1 Attachment Where to access the document
DocumentReference.content.attachment.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.attachment.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.content.attachment.contentType This element is included in summaries. 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
DocumentReference.content.attachment.language This element must be supported. This element is included in summaries. 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
DocumentReference.content.attachment.data 1..1 base64Binary The document is contained in the .data element, base64 encoded
DocumentReference.content.attachment.size This element is included in summaries. 0..1 unsignedInt Number of bytes of content (if url provided)
DocumentReference.content.attachment.hash This element is included in summaries. 0..1 base64Binary Hash of the data (sha-1, base64ed)
DocumentReference.content.attachment.title This element is included in summaries. 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
DocumentReference.content.attachment.creation This element must be supported. This element is included in summaries. 0..1 dateTime Date attachment was first created
DocumentReference.content.format This element must be supported. This element is included in summaries. 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
DocumentReference.context This element is included in summaries. 0..1 BackboneElement Clinical context of document
DocumentReference.context.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.extension 0..* Extension Additional content defined by implementations
DocumentReference.context.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.context.encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
DocumentReference.context.event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
DocumentReference.context.period This element must be supported. This element is included in summaries. 0..1 Period Time of service that is being documented
DocumentReference.context.facilityType This element must be supported. 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
DocumentReference.context.practiceSetting This element must be supported. 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
DocumentReference.context.sourcePatientInfo This element must be supported. 0..1 Reference(Patient) Patient demographics from source
DocumentReference.context.related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.4
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from DocumentReference

Summary

Mandatory: 4 elements
Must-Support: 14 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DocumentReference.identifier

 

Other representations of profile: CSV, Excel, Schematron