Mobile access to Health Documents (MHD)
4.2.3-current - ci-build 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.3-current 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 Minimal

Official URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference Version: 4.2.3-current
Active as of 2024-06-11 Computable Name: MinimalDocumentReference

A profile on the DocumentReference resource for MHD with minimal metadata constraints.

Usage:

Formal Views of Profile Content

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

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... meta
.... profile 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... modifierExtension 0..0
... masterIdentifier 1..1 UniqueIdIdentifier An identifier intended for computation
... Slices for identifier S 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
... docStatus 0..0
... type S 0..1 CodeableConcept Kind of document (LOINC if possible)
... category S 0..1 CodeableConcept Categorization of document
... subject S 0..1 Reference(Patient) Who/what is the subject of the document
... date S 0..1 instant When this document reference was created
... author S 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo S 0..* BackboneElement Relationships to other documents
.... code 1..1 code replaces | transforms | signs | appends
.... target 1..1 Reference(DocumentReference) Target of the relationship
... description 0..1 string Human-readable description
... securityLabel S 0..* CodeableConcept Document security-tags
... content 1..1 BackboneElement Document referenced
.... attachment
..... contentType 1..1 code Mime type of the content, with charset etc.
..... language S 0..1 code Human language of the content (BCP-47)
..... data 0..0
..... url 1..1 url Uri where the data can be found
..... size 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title 0..1 string Label to display in place of the data
..... creation S 0..1 dateTime Date attachment was first created
.... format S 0..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
... context
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
.... period S 0..1 Period Time of service that is being documented
..... start 0..1 dateTime Starting time with inclusive boundary
..... end 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType S 0..1 CodeableConcept Kind of facility where patient was seen
.... practiceSetting S 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
.... sourcePatientInfo S 0..1 Reference(Patient) Patient demographics from source
..... reference 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier 0..1 Identifier Logical reference, when literal reference is not known
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.statusrequiredDocumentReferenceStats
https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
from this IG
DocumentReference.content.formatpreferredIHE_FormatCode_vs
http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... masterIdentifier 1..1 UniqueIdIdentifier An identifier intended for computation
... Slices for identifier SΣ 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.

... category SΣ 0..1 CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject SΣ 0..1 Reference(Patient) Who/what is the subject of the document
... date SΣ 0..1 instant When this document reference was created
... author SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 string Human-readable description
... securityLabel SΣ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... content Σ 1..1 BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... contentType Σ 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
..... language SΣ 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
..... url Σ 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ 0..1 dateTime Date attachment was first created
.... format SΣ 0..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
... context Σ 0..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period SΣ 0..1 Period Time of service that is being documented
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType S 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.

.... practiceSetting S 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).

.... sourcePatientInfo S 0..1 Reference(Patient) Patient demographics from source
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.statusrequiredDocumentReferenceStats
https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
from this IG
DocumentReference.typepreferredDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.content.formatpreferredIHE_FormatCode_vs
http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 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".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... masterIdentifier 1..1 UniqueIdIdentifier An identifier intended for computation
... Slices for identifier SΣ 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.

... category SΣ 0..1 CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject SΣ 0..1 Reference(Patient) Who/what is the subject of the document
... date SΣ 0..1 instant When this document reference was created
... author SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 string Human-readable description
... securityLabel SΣ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... content Σ 1..1 BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ 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
..... language SΣ 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
..... url Σ 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ 0..1 dateTime Date attachment was first created
.... format SΣ 0..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
... context Σ 0..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period SΣ 0..1 Period Time of service that is being documented
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType S 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.

.... practiceSetting S 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).

.... sourcePatientInfo S 0..1 Reference(Patient) Patient demographics from source
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 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).

..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStats
https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
from this IG
DocumentReference.typepreferredDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.content.formatpreferredIHE_FormatCode_vs
http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
DocumentReference.context.sourcePatientInfo.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

This structure is derived from DocumentReference

Summary

Mandatory: 3 elements
Must-Support: 15 elements
Prohibited: 3 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

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... meta
.... profile 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... modifierExtension 0..0
... masterIdentifier 1..1 UniqueIdIdentifier An identifier intended for computation
... Slices for identifier S 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
... docStatus 0..0
... type S 0..1 CodeableConcept Kind of document (LOINC if possible)
... category S 0..1 CodeableConcept Categorization of document
... subject S 0..1 Reference(Patient) Who/what is the subject of the document
... date S 0..1 instant When this document reference was created
... author S 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo S 0..* BackboneElement Relationships to other documents
.... code 1..1 code replaces | transforms | signs | appends
.... target 1..1 Reference(DocumentReference) Target of the relationship
... description 0..1 string Human-readable description
... securityLabel S 0..* CodeableConcept Document security-tags
... content 1..1 BackboneElement Document referenced
.... attachment
..... contentType 1..1 code Mime type of the content, with charset etc.
..... language S 0..1 code Human language of the content (BCP-47)
..... data 0..0
..... url 1..1 url Uri where the data can be found
..... size 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title 0..1 string Label to display in place of the data
..... creation S 0..1 dateTime Date attachment was first created
.... format S 0..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
... context
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
.... period S 0..1 Period Time of service that is being documented
..... start 0..1 dateTime Starting time with inclusive boundary
..... end 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType S 0..1 CodeableConcept Kind of facility where patient was seen
.... practiceSetting S 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
.... sourcePatientInfo S 0..1 Reference(Patient) Patient demographics from source
..... reference 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier 0..1 Identifier Logical reference, when literal reference is not known
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.statusrequiredDocumentReferenceStats
https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
from this IG
DocumentReference.content.formatpreferredIHE_FormatCode_vs
http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... masterIdentifier 1..1 UniqueIdIdentifier An identifier intended for computation
... Slices for identifier SΣ 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.

... category SΣ 0..1 CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject SΣ 0..1 Reference(Patient) Who/what is the subject of the document
... date SΣ 0..1 instant When this document reference was created
... author SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 string Human-readable description
... securityLabel SΣ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... content Σ 1..1 BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... contentType Σ 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
..... language SΣ 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
..... url Σ 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ 0..1 dateTime Date attachment was first created
.... format SΣ 0..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
... context Σ 0..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period SΣ 0..1 Period Time of service that is being documented
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType S 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.

.... practiceSetting S 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).

.... sourcePatientInfo S 0..1 Reference(Patient) Patient demographics from source
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.statusrequiredDocumentReferenceStats
https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
from this IG
DocumentReference.typepreferredDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.content.formatpreferredIHE_FormatCode_vs
http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 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".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... masterIdentifier 1..1 UniqueIdIdentifier An identifier intended for computation
... Slices for identifier SΣ 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.

... category SΣ 0..1 CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject SΣ 0..1 Reference(Patient) Who/what is the subject of the document
... date SΣ 0..1 instant When this document reference was created
... author SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 string Human-readable description
... securityLabel SΣ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... content Σ 1..1 BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ 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
..... language SΣ 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
..... url Σ 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ 0..1 dateTime Date attachment was first created
.... format SΣ 0..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
... context Σ 0..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period SΣ 0..1 Period Time of service that is being documented
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType S 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.

.... practiceSetting S 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).

.... sourcePatientInfo S 0..1 Reference(Patient) Patient demographics from source
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 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).

..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStats
https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
from this IG
DocumentReference.typepreferredDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.content.formatpreferredIHE_FormatCode_vs
http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
DocumentReference.context.sourcePatientInfo.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

This structure is derived from DocumentReference

Summary

Mandatory: 3 elements
Must-Support: 15 elements
Prohibited: 3 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