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 Comprehensive

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

A profile on the DocumentReference resource for MHD Comprehensive Option with Contained (not UnContained), compatible with XDS-on-FHIR and XCA use.

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..* UnContainedComprehensiveDocumentReference 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.Slices for extension Content/Rules for all slices
DocumentReference.Slices for extension.extension:homeCommunityId 0..1 oid The homeCommunityId where the artifact resides
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-HomeCommunityId
DocumentReference.masterIdentifier This element is included in summaries. 1..1 UniqueIdIdentifier Master Version Specific Identifier
DocumentReference.Slices for identifier This element must be supported. 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:entryUUID This element must be supported. This element is included in summaries. 0..1 EntryUUIDIdentifier Business identifier for the DocumentReference
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: MHD DocumentReference status codes (required)
DocumentReference.type This element must be supported. This element is included in summaries. 1..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. 1..1 CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
DocumentReference.subject This element must be supported. 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) {c} Who and/or what authored the document
DocumentReference.authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) {c} Who/what authenticated 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. 1..* 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. 1..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.url This element is included in summaries. 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
DocumentReference.content.attachment.creation This element must be supported. This element is included in summaries. 1..1 dateTime Date attachment was first created
DocumentReference.content.format This element must be supported. This element is included in summaries. 1..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
DocumentReference.context This element is included in summaries. 1..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. 1..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
DocumentReference.context.practiceSetting This element must be supported. 1..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. 1..1 Reference(Patient) {c} Patient demographics from source

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.5 This IG
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 IHE ValueSet of Format Codes for use with Document Sharing 📦1.6.0 IHE FormatCode Vocabulary v1.6
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 UnContainedComprehensiveDocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* UnContainedComprehensiveDocumentReference A reference to a document
DocumentReference.author 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) {c} Who and/or what authored the document
DocumentReference.authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) {c} Who/what authenticated the document
DocumentReference.context
DocumentReference.context.sourcePatientInfo 1..1 Reference(Patient) {c} Patient demographics from source

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* UnContainedComprehensiveDocumentReference 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.meta.id 0..1 string Unique id for inter-element referencing
DocumentReference.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
DocumentReference.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
DocumentReference.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
DocumentReference.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
DocumentReference.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for extension.extension:homeCommunityId 0..1 oid The homeCommunityId where the artifact resides
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-HomeCommunityId
DocumentReference.masterIdentifier This element is included in summaries. 1..1 UniqueIdIdentifier Master Version Specific Identifier
DocumentReference.Slices for identifier This element must be supported. 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:entryUUID This element must be supported. This element is included in summaries. 0..1 EntryUUIDIdentifier Business identifier for the DocumentReference
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: MHD DocumentReference status codes (required)
DocumentReference.type This element must be supported. This element is included in summaries. 1..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. 1..1 CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
DocumentReference.subject This element must be supported. 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) {c} Who and/or what authored the document
DocumentReference.authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) {c} 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. 1..* 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. 1..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.url This element is included in summaries. 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
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. 1..1 dateTime Date attachment was first created
DocumentReference.content.format This element must be supported. This element is included in summaries. 1..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
DocumentReference.context This element is included in summaries. 1..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.period.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.context.period.start This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
DocumentReference.context.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
DocumentReference.context.facilityType This element must be supported. 1..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
DocumentReference.context.practiceSetting This element must be supported. 1..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. 1..1 Reference(Patient) {c} Patient demographics from source
DocumentReference.context.sourcePatientInfo.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.sourcePatientInfo.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.context.sourcePatientInfo.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
DocumentReference.context.sourcePatientInfo.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
DocumentReference.context.sourcePatientInfo.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
DocumentReference.context.sourcePatientInfo.display This element is included in summaries. 0..1 string Text alternative for the resource
DocumentReference.context.related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.5 This IG
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 IHE ValueSet of Format Codes for use with Document Sharing 📦1.6.0 IHE FormatCode Vocabulary v1.6
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.
DocumentReference.context.​sourcePatientInfo.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from UnContainedComprehensiveDocumentReference

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* UnContainedComprehensiveDocumentReference 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.Slices for extension Content/Rules for all slices
DocumentReference.Slices for extension.extension:homeCommunityId 0..1 oid The homeCommunityId where the artifact resides
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-HomeCommunityId
DocumentReference.masterIdentifier This element is included in summaries. 1..1 UniqueIdIdentifier Master Version Specific Identifier
DocumentReference.Slices for identifier This element must be supported. 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:entryUUID This element must be supported. This element is included in summaries. 0..1 EntryUUIDIdentifier Business identifier for the DocumentReference
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: MHD DocumentReference status codes (required)
DocumentReference.type This element must be supported. This element is included in summaries. 1..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. 1..1 CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
DocumentReference.subject This element must be supported. 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) {c} Who and/or what authored the document
DocumentReference.authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) {c} Who/what authenticated 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. 1..* 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. 1..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.url This element is included in summaries. 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
DocumentReference.content.attachment.creation This element must be supported. This element is included in summaries. 1..1 dateTime Date attachment was first created
DocumentReference.content.format This element must be supported. This element is included in summaries. 1..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
DocumentReference.context This element is included in summaries. 1..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. 1..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
DocumentReference.context.practiceSetting This element must be supported. 1..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. 1..1 Reference(Patient) {c} Patient demographics from source

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.5 This IG
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 IHE ValueSet of Format Codes for use with Document Sharing 📦1.6.0 IHE FormatCode Vocabulary v1.6
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 UnContainedComprehensiveDocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* UnContainedComprehensiveDocumentReference A reference to a document
DocumentReference.author 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) {c} Who and/or what authored the document
DocumentReference.authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) {c} Who/what authenticated the document
DocumentReference.context
DocumentReference.context.sourcePatientInfo 1..1 Reference(Patient) {c} Patient demographics from source

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* UnContainedComprehensiveDocumentReference 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.meta.id 0..1 string Unique id for inter-element referencing
DocumentReference.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
DocumentReference.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
DocumentReference.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
DocumentReference.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
DocumentReference.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for extension.extension:homeCommunityId 0..1 oid The homeCommunityId where the artifact resides
URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-HomeCommunityId
DocumentReference.masterIdentifier This element is included in summaries. 1..1 UniqueIdIdentifier Master Version Specific Identifier
DocumentReference.Slices for identifier This element must be supported. 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:entryUUID This element must be supported. This element is included in summaries. 0..1 EntryUUIDIdentifier Business identifier for the DocumentReference
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: MHD DocumentReference status codes (required)
DocumentReference.type This element must be supported. This element is included in summaries. 1..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. 1..1 CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
DocumentReference.subject This element must be supported. 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) {c} Who and/or what authored the document
DocumentReference.authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) {c} 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. 1..* 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. 1..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.url This element is included in summaries. 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
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. 1..1 dateTime Date attachment was first created
DocumentReference.content.format This element must be supported. This element is included in summaries. 1..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
DocumentReference.context This element is included in summaries. 1..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.period.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.context.period.start This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
DocumentReference.context.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
DocumentReference.context.facilityType This element must be supported. 1..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
DocumentReference.context.practiceSetting This element must be supported. 1..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. 1..1 Reference(Patient) {c} Patient demographics from source
DocumentReference.context.sourcePatientInfo.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.sourcePatientInfo.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.context.sourcePatientInfo.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
DocumentReference.context.sourcePatientInfo.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
DocumentReference.context.sourcePatientInfo.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
DocumentReference.context.sourcePatientInfo.display This element is included in summaries. 0..1 string Text alternative for the resource
DocumentReference.context.related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.5 This IG
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 IHE ValueSet of Format Codes for use with Document Sharing 📦1.6.0 IHE FormatCode Vocabulary v1.6
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.
DocumentReference.context.​sourcePatientInfo.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from UnContainedComprehensiveDocumentReference

Summary

 

Other representations of profile: CSV, Excel, Schematron