Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: Nictiz IHE MHD Profile on DocumentReference (DocumentEntry) when used in the Provide Transaction with Minimal Metadata, see Table 3:4.3.1-3.

Copied profile on DocumentReference based on IHE IT Infrastructure Technical Framework Supplement - Mobile access to Health Documents (MHD) Rev. 2.3. See http://wiki.ihe.net/index.php/Mobile_access_to_Health_Documents_(MHD). The IHE MHD Profile text is Normative, this conformance resource is Informative.

Copied profile from IHE MHD to have control over the downstream references. The ProvideDocumentBundle.Minimal and DocumentManifest profiles contained errors that are only addressed in FHIR R4. This profile is copied and governed by Nictiz because the two mentioned profiles reference this profile. IHE differentiated between Provide DocumentReference and Query DocumentReference. However, these profiles are identical and for usability reasons it has been decided to merge the two profiles into this single profile.

Usages:

• Use this Profile: Nictiz IHE MHD profile on Provide Document Bundle (ITI-65) transaction with Minimal Metadata
• Refer to this Profile: Nictiz IHE MHD Profile on DocumentManifest (SubmissionSet)

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.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from DocumentReference

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
masterIdentifier	S	1..1	Identifier	Master Version Specific Identifier
identifier	S	0..*	Identifier	Other identifiers for the document
status		1..1	code	current | superseded | entered-in-error
docStatus		0..0
type	S	1..1	CodeableConcept	Kind of document (LOINC if possible)
class	S	0..1	CodeableConcept	Categorization of document
subject	S	0..1	Reference(Patient) {r, b}	Who/what is the subject of the document
created		0..0
indexed	S	1..1	instant	When this document reference was created
author	S	0..*	Reference(Practitioner | Organization) {c}	Who and/or what authored the document
authenticator		0..1	Reference() {c}	Who/what authenticated the document
custodian		0..0
relatesTo	S	0..*	BackboneElement	Relationships to other documents
description		0..1	string	Human-readable description (title)
securityLabel	S	0..*	CodeableConcept	Document security-tags
content	S	1..1	BackboneElement	Document referenced
attachment	S	1..1	Attachment	Where to access the document
contentType	S	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	S	1..1	uri	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		0..0
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
encounter		0..1	Reference(Encounter)	Context of the document content
event		0..*	CodeableConcept	Main clinical acts documented
period	S	0..1	Period	Time of service that is being documented
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() {c}	Patient demographics from source
related		0..*	BackboneElement	Related identifiers or resources
identifier		0..1	Identifier	Identifier of related objects or events
ref		0..1	Reference(Resource)	Related Resource
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
DocumentReference.content.format	preferred	IHE.FormatCode.vs(a valid code from urn:oid:1.3.6.1.4.1.19376.1.2.3) http://ihe.net/fhir/ValueSet/IHE.formatcode.vs From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	SΣ	1..1	Identifier	Master Version Specific Identifier
identifier	SΣ	0..*	Identifier	Other identifiers for the document
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
type	SΣ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: Document Type Value Set (preferred): Precise type of clinical document.
class	SΣ	0..1	CodeableConcept	Categorization of document Binding: Document Class Value Set (example): High-level kind of a clinical document at a macro level.
subject	SΣ	0..1	Reference(Patient) {r, b}	Who/what is the subject of the document
indexed	SΣ	1..1	instant	When this document reference was created
author	SΣ	0..*	Reference(Practitioner | Organization) {c}	Who and/or what authored the document
authenticator	Σ	0..1	Reference() {c}	Who/what authenticated the document
relatesTo	?!SΣ	0..*	BackboneElement	Relationships to other documents
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
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 (title)
securityLabel	SΣ	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
content	SΣ	1..1	BackboneElement	Document referenced
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
attachment	SΣ	1..1	Attachment	Where to access the document
contentType	SΣ	1..1	code	Mime type of the content, with charset etc. Binding: (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: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding Example General: en-AU
url	SΣ	1..1	uri	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
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
encounter	Σ	0..1	Reference(Encounter)	Context of the document content
event	Σ	0..*	CodeableConcept	​Main clinical acts documented Binding: ActCode|2016-11-11 (example): This list of codes represents the main clinical acts being documented.
period	SΣ	0..1	Period	Time of service that is being documented
facilityType	SΣ	0..1	CodeableConcept	Kind of facility where patient was seen Binding: Facility Type Code Value Set (example): XDS Facility Type.
practiceSetting	SΣ	0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: Practice Setting Code Value Set (example): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo	SΣ	0..1	Reference() {c}	Patient demographics from source
related	Σ	0..*	BackboneElement	Related identifiers or resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..1	Identifier	Identifier of related objects or events
ref	Σ	0..1	Reference(Resource)	Related Resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|3.0.2 From the FHIR Standard
DocumentReference.type	preferred	Document Type Value Set http://hl7.org/fhir/ValueSet/c80-doc-typecodes|20091109 From the FHIR Standard
DocumentReference.class	example	Document Class Value Set http://hl7.org/fhir/ValueSet/c80-doc-classcodes|20091109 From the FHIR Standard
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|3.0.2 From the FHIR Standard
DocumentReference.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels|3.0.2 From the FHIR Standard
DocumentReference.content.attachment.contentType	required	​ (missing link)(a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes
DocumentReference.content.attachment.language	extensible	Common Languages http://hl7.org/fhir/ValueSet/languages|3.0.2 From the FHIR Standard Additional Bindings Purpose All Languages Max Binding
DocumentReference.content.format	preferred	IHE.FormatCode.vs(a valid code from urn:oid:1.3.6.1.4.1.19376.1.2.3) http://ihe.net/fhir/ValueSet/IHE.formatcode.vs From this IG
DocumentReference.context.event	example	v3 Code System ActCode http://hl7.org/fhir/ValueSet/v3-ActCode|2016-11-11 From the FHIR Standard
DocumentReference.context.facilityType	example	Facility Type Code Value Set http://hl7.org/fhir/ValueSet/c80-facilitycodes|20091109 From the FHIR Standard
DocumentReference.context.practiceSetting	example	Practice Setting Code Value Set http://hl7.org/fhir/ValueSet/c80-practice-codes|20091109 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	DocumentReference	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	DocumentReference	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	SΣ	1..1	Identifier	Master Version Specific Identifier
identifier	SΣ	0..*	Identifier	Other identifiers for the document
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
type	SΣ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: Document Type Value Set (preferred): Precise type of clinical document.
class	SΣ	0..1	CodeableConcept	Categorization of document Binding: Document Class Value Set (example): High-level kind of a clinical document at a macro level.
subject	SΣ	0..1	Reference(Patient) {r, b}	Who/what is the subject of the document
indexed	SΣ	1..1	instant	When this document reference was created
author	SΣ	0..*	Reference(Practitioner | Organization) {c}	Who and/or what authored the document
authenticator	Σ	0..1	Reference() {c}	Who/what authenticated the document
relatesTo	?!SΣ	0..*	BackboneElement	Relationships to other documents
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
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 (title)
securityLabel	SΣ	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
content	SΣ	1..1	BackboneElement	Document referenced
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
attachment	SΣ	1..1	Attachment	Where to access the document
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
contentType	SΣ	1..1	code	Mime type of the content, with charset etc. Binding: (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: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding Example General: en-AU
url	SΣ	1..1	uri	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
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	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
encounter	Σ	0..1	Reference(Encounter)	Context of the document content
event	Σ	0..*	CodeableConcept	​Main clinical acts documented Binding: ActCode|2016-11-11 (example): This list of codes represents the main clinical acts being documented.
period	SΣ	0..1	Period	Time of service that is being documented
facilityType	SΣ	0..1	CodeableConcept	Kind of facility where patient was seen Binding: Facility Type Code Value Set (example): XDS Facility Type.
practiceSetting	SΣ	0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: Practice Setting Code Value Set (example): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo	SΣ	0..1	Reference() {c}	Patient demographics from source
related	Σ	0..*	BackboneElement	Related identifiers or resources
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..1	Identifier	Identifier of related objects or events
ref	Σ	0..1	Reference(Resource)	Related Resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.language	extensible	Common Languages http://hl7.org/fhir/ValueSet/languages|3.0.2 From the FHIR Standard Additional Bindings Purpose All Languages Max Binding
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|3.0.2 From the FHIR Standard
DocumentReference.type	preferred	Document Type Value Set http://hl7.org/fhir/ValueSet/c80-doc-typecodes|20091109 From the FHIR Standard
DocumentReference.class	example	Document Class Value Set http://hl7.org/fhir/ValueSet/c80-doc-classcodes|20091109 From the FHIR Standard
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|3.0.2 From the FHIR Standard
DocumentReference.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels|3.0.2 From the FHIR Standard
DocumentReference.content.attachment.contentType	required	​ (missing link)(a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes
DocumentReference.content.attachment.language	extensible	Common Languages http://hl7.org/fhir/ValueSet/languages|3.0.2 From the FHIR Standard Additional Bindings Purpose All Languages Max Binding
DocumentReference.content.format	preferred	IHE.FormatCode.vs(a valid code from urn:oid:1.3.6.1.4.1.19376.1.2.3) http://ihe.net/fhir/ValueSet/IHE.formatcode.vs From this IG
DocumentReference.context.event	example	v3 Code System ActCode http://hl7.org/fhir/ValueSet/v3-ActCode|2016-11-11 From the FHIR Standard
DocumentReference.context.facilityType	example	Facility Type Code Value Set http://hl7.org/fhir/ValueSet/c80-facilitycodes|20091109 From the FHIR Standard
DocumentReference.context.practiceSetting	example	Practice Setting Code Value Set http://hl7.org/fhir/ValueSet/c80-practice-codes|20091109 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	DocumentReference	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	DocumentReference	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())

This structure is derived from DocumentReference

Summary

Mandatory: 3 elements
Must-Support: 19 elements
Prohibited: 5 elements

Differential View

This structure is derived from DocumentReference

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
masterIdentifier	S	1..1	Identifier	Master Version Specific Identifier
identifier	S	0..*	Identifier	Other identifiers for the document
status		1..1	code	current | superseded | entered-in-error
docStatus		0..0
type	S	1..1	CodeableConcept	Kind of document (LOINC if possible)
class	S	0..1	CodeableConcept	Categorization of document
subject	S	0..1	Reference(Patient) {r, b}	Who/what is the subject of the document
created		0..0
indexed	S	1..1	instant	When this document reference was created
author	S	0..*	Reference(Practitioner | Organization) {c}	Who and/or what authored the document
authenticator		0..1	Reference() {c}	Who/what authenticated the document
custodian		0..0
relatesTo	S	0..*	BackboneElement	Relationships to other documents
description		0..1	string	Human-readable description (title)
securityLabel	S	0..*	CodeableConcept	Document security-tags
content	S	1..1	BackboneElement	Document referenced
attachment	S	1..1	Attachment	Where to access the document
contentType	S	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	S	1..1	uri	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		0..0
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
encounter		0..1	Reference(Encounter)	Context of the document content
event		0..*	CodeableConcept	Main clinical acts documented
period	S	0..1	Period	Time of service that is being documented
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() {c}	Patient demographics from source
related		0..*	BackboneElement	Related identifiers or resources
identifier		0..1	Identifier	Identifier of related objects or events
ref		0..1	Reference(Resource)	Related Resource
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
DocumentReference.content.format	preferred	IHE.FormatCode.vs(a valid code from urn:oid:1.3.6.1.4.1.19376.1.2.3) http://ihe.net/fhir/ValueSet/IHE.formatcode.vs From this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	SΣ	1..1	Identifier	Master Version Specific Identifier
identifier	SΣ	0..*	Identifier	Other identifiers for the document
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
type	SΣ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: Document Type Value Set (preferred): Precise type of clinical document.
class	SΣ	0..1	CodeableConcept	Categorization of document Binding: Document Class Value Set (example): High-level kind of a clinical document at a macro level.
subject	SΣ	0..1	Reference(Patient) {r, b}	Who/what is the subject of the document
indexed	SΣ	1..1	instant	When this document reference was created
author	SΣ	0..*	Reference(Practitioner | Organization) {c}	Who and/or what authored the document
authenticator	Σ	0..1	Reference() {c}	Who/what authenticated the document
relatesTo	?!SΣ	0..*	BackboneElement	Relationships to other documents
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
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 (title)
securityLabel	SΣ	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
content	SΣ	1..1	BackboneElement	Document referenced
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
attachment	SΣ	1..1	Attachment	Where to access the document
contentType	SΣ	1..1	code	Mime type of the content, with charset etc. Binding: (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: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding Example General: en-AU
url	SΣ	1..1	uri	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
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
encounter	Σ	0..1	Reference(Encounter)	Context of the document content
event	Σ	0..*	CodeableConcept	​Main clinical acts documented Binding: ActCode|2016-11-11 (example): This list of codes represents the main clinical acts being documented.
period	SΣ	0..1	Period	Time of service that is being documented
facilityType	SΣ	0..1	CodeableConcept	Kind of facility where patient was seen Binding: Facility Type Code Value Set (example): XDS Facility Type.
practiceSetting	SΣ	0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: Practice Setting Code Value Set (example): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo	SΣ	0..1	Reference() {c}	Patient demographics from source
related	Σ	0..*	BackboneElement	Related identifiers or resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..1	Identifier	Identifier of related objects or events
ref	Σ	0..1	Reference(Resource)	Related Resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|3.0.2 From the FHIR Standard
DocumentReference.type	preferred	Document Type Value Set http://hl7.org/fhir/ValueSet/c80-doc-typecodes|20091109 From the FHIR Standard
DocumentReference.class	example	Document Class Value Set http://hl7.org/fhir/ValueSet/c80-doc-classcodes|20091109 From the FHIR Standard
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|3.0.2 From the FHIR Standard
DocumentReference.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels|3.0.2 From the FHIR Standard
DocumentReference.content.attachment.contentType	required	​ (missing link)(a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes
DocumentReference.content.attachment.language	extensible	Common Languages http://hl7.org/fhir/ValueSet/languages|3.0.2 From the FHIR Standard Additional Bindings Purpose All Languages Max Binding
DocumentReference.content.format	preferred	IHE.FormatCode.vs(a valid code from urn:oid:1.3.6.1.4.1.19376.1.2.3) http://ihe.net/fhir/ValueSet/IHE.formatcode.vs From this IG
DocumentReference.context.event	example	v3 Code System ActCode http://hl7.org/fhir/ValueSet/v3-ActCode|2016-11-11 From the FHIR Standard
DocumentReference.context.facilityType	example	Facility Type Code Value Set http://hl7.org/fhir/ValueSet/c80-facilitycodes|20091109 From the FHIR Standard
DocumentReference.context.practiceSetting	example	Practice Setting Code Value Set http://hl7.org/fhir/ValueSet/c80-practice-codes|20091109 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	DocumentReference	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	DocumentReference	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	SΣ	1..1	Identifier	Master Version Specific Identifier
identifier	SΣ	0..*	Identifier	Other identifiers for the document
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
type	SΣ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: Document Type Value Set (preferred): Precise type of clinical document.
class	SΣ	0..1	CodeableConcept	Categorization of document Binding: Document Class Value Set (example): High-level kind of a clinical document at a macro level.
subject	SΣ	0..1	Reference(Patient) {r, b}	Who/what is the subject of the document
indexed	SΣ	1..1	instant	When this document reference was created
author	SΣ	0..*	Reference(Practitioner | Organization) {c}	Who and/or what authored the document
authenticator	Σ	0..1	Reference() {c}	Who/what authenticated the document
relatesTo	?!SΣ	0..*	BackboneElement	Relationships to other documents
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
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 (title)
securityLabel	SΣ	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
content	SΣ	1..1	BackboneElement	Document referenced
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
attachment	SΣ	1..1	Attachment	Where to access the document
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
contentType	SΣ	1..1	code	Mime type of the content, with charset etc. Binding: (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: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding Example General: en-AU
url	SΣ	1..1	uri	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
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	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
encounter	Σ	0..1	Reference(Encounter)	Context of the document content
event	Σ	0..*	CodeableConcept	​Main clinical acts documented Binding: ActCode|2016-11-11 (example): This list of codes represents the main clinical acts being documented.
period	SΣ	0..1	Period	Time of service that is being documented
facilityType	SΣ	0..1	CodeableConcept	Kind of facility where patient was seen Binding: Facility Type Code Value Set (example): XDS Facility Type.
practiceSetting	SΣ	0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: Practice Setting Code Value Set (example): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo	SΣ	0..1	Reference() {c}	Patient demographics from source
related	Σ	0..*	BackboneElement	Related identifiers or resources
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..1	Identifier	Identifier of related objects or events
ref	Σ	0..1	Reference(Resource)	Related Resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.language	extensible	Common Languages http://hl7.org/fhir/ValueSet/languages|3.0.2 From the FHIR Standard Additional Bindings Purpose All Languages Max Binding
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|3.0.2 From the FHIR Standard
DocumentReference.type	preferred	Document Type Value Set http://hl7.org/fhir/ValueSet/c80-doc-typecodes|20091109 From the FHIR Standard
DocumentReference.class	example	Document Class Value Set http://hl7.org/fhir/ValueSet/c80-doc-classcodes|20091109 From the FHIR Standard
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|3.0.2 From the FHIR Standard
DocumentReference.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels|3.0.2 From the FHIR Standard
DocumentReference.content.attachment.contentType	required	​ (missing link)(a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes
DocumentReference.content.attachment.language	extensible	Common Languages http://hl7.org/fhir/ValueSet/languages|3.0.2 From the FHIR Standard Additional Bindings Purpose All Languages Max Binding
DocumentReference.content.format	preferred	IHE.FormatCode.vs(a valid code from urn:oid:1.3.6.1.4.1.19376.1.2.3) http://ihe.net/fhir/ValueSet/IHE.formatcode.vs From this IG
DocumentReference.context.event	example	v3 Code System ActCode http://hl7.org/fhir/ValueSet/v3-ActCode|2016-11-11 From the FHIR Standard
DocumentReference.context.facilityType	example	Facility Type Code Value Set http://hl7.org/fhir/ValueSet/c80-facilitycodes|20091109 From the FHIR Standard
DocumentReference.context.practiceSetting	example	Practice Setting Code Value Set http://hl7.org/fhir/ValueSet/c80-practice-codes|20091109 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	DocumentReference	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	DocumentReference	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())

This structure is derived from DocumentReference

Summary

Mandatory: 3 elements
Must-Support: 19 elements
Prohibited: 5 elements

Other representations of profile: CSV, Excel, Schematron