This page is part of the WHO Digital Documentation of COVID-19 Certificates (DDCC) (v1.0.1: releases Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

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

Resource Profile: DDCC Document Reference

A DDCC Document Reference is a document reference to a DDCC Document containing the DDCC. The content attachment url will point to a DDCC Document.

Usage:

• Use this Resource Profile: DDCC Provide Document Bundle and DDCC:VS Add Bundle
• Refer to this Resource Profile: DDCC Folder and DDCC Submission Set

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 MinimalDocumentReference

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	MinimalDocumentReference	A reference to a document
subject		1..1	Reference(DDCC Patient)	Who/what is the subject of the document
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
date		1..1	instant	When this document reference was created
content	S	1..1	BackboneElement	Document referenced
attachment
url	S	1..1	url	Uri where the data can be found
hash	S	0..1	base64Binary	Hash of the data (sha-1, base64ed)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	MinimalDocumentReference	A reference to a document dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
masterIdentifier		1..1	UniqueIdIdentifier	An identifier intended for computation ele-1: All FHIR elements must have a @value or children
Slices for identifier	SΣ	0..*	Identifier	Other identifiers for the document Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children
identifier:entryUUID		0..*	EntryUUIDIdentifier	An identifier intended for computation ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: MHD DocumentReference status codes (required) ele-1: All FHIR elements must have a @value or children
type	SΣ	0..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. ele-1: All FHIR elements must have a @value or children
category	SΣ	0..1	CodeableConcept	Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. ele-1: All FHIR elements must have a @value or children
subject	SΣ	1..1	Reference(DDCC Patient)	Who/what is the subject of the document ele-1: All FHIR elements must have a @value or children
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
date	SΣ	1..1	instant	When this document reference was created ele-1: All FHIR elements must have a @value or children
author	SΣ	0..*	Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)	Who and/or what authored the document ele-1: All FHIR elements must have a @value or children
relatesTo	SΣ	0..*	BackboneElement	Relationships to other documents ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
code	Σ	1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. ele-1: All FHIR elements must have a @value or children
target	Σ	1..1	Reference(DocumentReference)	Target of the relationship ele-1: All FHIR elements must have a @value or children
securityLabel	SΣ	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children
content	SΣ	1..1	BackboneElement	Document referenced ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
attachment	Σ	1..1	Attachment	Where to access the document ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children 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 Bindings Purpose AllLanguages Max Binding ele-1: All FHIR elements must have a @value or children Example General: en-AU
url	SΣ	1..1	url	Uri where the data can be found ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png
hash	SΣ	0..1	base64Binary	Hash of the data (sha-1, base64ed) ele-1: All FHIR elements must have a @value or children
creation	SΣ	0..1	dateTime	Date attachment was first created ele-1: All FHIR elements must have a @value or children
format	SΣ	0..1	Coding	Format/content rules for the document Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred) ele-1: All FHIR elements must have a @value or children
context	Σ	0..1	BackboneElement	Clinical context of document ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
period	SΣ	0..1	Period	Time of service that is being documented ele-1: All FHIR elements must have a @value or children
facilityType	S	0..1	CodeableConcept	Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. ele-1: All FHIR elements must have a @value or children
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). ele-1: All FHIR elements must have a @value or children
sourcePatientInfo	S	0..1	Reference(Patient)	Patient demographics from source ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.status	required	DocumentReferenceStats https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
DocumentReference.type	preferred	DocumentTypeValueSet http://hl7.org/fhir/ValueSet/c80-doc-typecodes from the FHIR Standard
DocumentReference.category	example	DocumentClassValueSet http://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard
DocumentReference.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
DocumentReference.content.attachment.contentType	required	Mime 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.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.content.format	preferred	IHE_FormatCode_vs http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode
DocumentReference.context.facilityType	example	FacilityTypeCodeValueSet http://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard
DocumentReference.context.practiceSetting	example	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5	error	DocumentReference	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	DocumentReference	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	MinimalDocumentReference	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 Bindings Purpose 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Σ	1..1	Reference(DDCC Patient)	Who/what is the subject of 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
reference	SΣC	1..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
date	SΣ	1..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	SΣ	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 Bindings Purpose AllLanguages Max Binding Example General: en-AU
url	SΣ	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	SΣ	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
DocumentReference.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
DocumentReference.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.status	required	DocumentReferenceStats https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
DocumentReference.type	preferred	DocumentTypeValueSet http://hl7.org/fhir/ValueSet/c80-doc-typecodes from the FHIR Standard
DocumentReference.category	example	DocumentClassValueSet http://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard
DocumentReference.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard
DocumentReference.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
DocumentReference.content.attachment.contentType	required	Mime 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.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.content.format	preferred	IHE_FormatCode_vs http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode
DocumentReference.context.event	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityType	example	FacilityTypeCodeValueSet http://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard
DocumentReference.context.practiceSetting	example	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
DocumentReference.context.sourcePatientInfo.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5	error	DocumentReference	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	DocumentReference	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from MinimalDocumentReference

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• DDCC Patient (http://smart.who.int/ddcc/StructureDefinition/DDCCPatient)

Differential View

This structure is derived from MinimalDocumentReference

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	MinimalDocumentReference	A reference to a document
subject		1..1	Reference(DDCC Patient)	Who/what is the subject of the document
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
date		1..1	instant	When this document reference was created
content	S	1..1	BackboneElement	Document referenced
attachment
url	S	1..1	url	Uri where the data can be found
hash	S	0..1	base64Binary	Hash of the data (sha-1, base64ed)
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	MinimalDocumentReference	A reference to a document dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
masterIdentifier		1..1	UniqueIdIdentifier	An identifier intended for computation ele-1: All FHIR elements must have a @value or children
Slices for identifier	SΣ	0..*	Identifier	Other identifiers for the document Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children
identifier:entryUUID		0..*	EntryUUIDIdentifier	An identifier intended for computation ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: MHD DocumentReference status codes (required) ele-1: All FHIR elements must have a @value or children
type	SΣ	0..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. ele-1: All FHIR elements must have a @value or children
category	SΣ	0..1	CodeableConcept	Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. ele-1: All FHIR elements must have a @value or children
subject	SΣ	1..1	Reference(DDCC Patient)	Who/what is the subject of the document ele-1: All FHIR elements must have a @value or children
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
date	SΣ	1..1	instant	When this document reference was created ele-1: All FHIR elements must have a @value or children
author	SΣ	0..*	Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)	Who and/or what authored the document ele-1: All FHIR elements must have a @value or children
relatesTo	SΣ	0..*	BackboneElement	Relationships to other documents ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
code	Σ	1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. ele-1: All FHIR elements must have a @value or children
target	Σ	1..1	Reference(DocumentReference)	Target of the relationship ele-1: All FHIR elements must have a @value or children
securityLabel	SΣ	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children
content	SΣ	1..1	BackboneElement	Document referenced ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
attachment	Σ	1..1	Attachment	Where to access the document ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children 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 Bindings Purpose AllLanguages Max Binding ele-1: All FHIR elements must have a @value or children Example General: en-AU
url	SΣ	1..1	url	Uri where the data can be found ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png
hash	SΣ	0..1	base64Binary	Hash of the data (sha-1, base64ed) ele-1: All FHIR elements must have a @value or children
creation	SΣ	0..1	dateTime	Date attachment was first created ele-1: All FHIR elements must have a @value or children
format	SΣ	0..1	Coding	Format/content rules for the document Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred) ele-1: All FHIR elements must have a @value or children
context	Σ	0..1	BackboneElement	Clinical context of document ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
period	SΣ	0..1	Period	Time of service that is being documented ele-1: All FHIR elements must have a @value or children
facilityType	S	0..1	CodeableConcept	Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. ele-1: All FHIR elements must have a @value or children
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). ele-1: All FHIR elements must have a @value or children
sourcePatientInfo	S	0..1	Reference(Patient)	Patient demographics from source ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.status	required	DocumentReferenceStats https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
DocumentReference.type	preferred	DocumentTypeValueSet http://hl7.org/fhir/ValueSet/c80-doc-typecodes from the FHIR Standard
DocumentReference.category	example	DocumentClassValueSet http://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard
DocumentReference.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
DocumentReference.content.attachment.contentType	required	Mime 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.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.content.format	preferred	IHE_FormatCode_vs http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode
DocumentReference.context.facilityType	example	FacilityTypeCodeValueSet http://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard
DocumentReference.context.practiceSetting	example	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5	error	DocumentReference	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	DocumentReference	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	MinimalDocumentReference	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 Bindings Purpose 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Σ	1..1	Reference(DDCC Patient)	Who/what is the subject of 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
reference	SΣC	1..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
date	SΣ	1..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	SΣ	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 Bindings Purpose AllLanguages Max Binding Example General: en-AU
url	SΣ	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	SΣ	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
DocumentReference.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
DocumentReference.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.status	required	DocumentReferenceStats https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
DocumentReference.type	preferred	DocumentTypeValueSet http://hl7.org/fhir/ValueSet/c80-doc-typecodes from the FHIR Standard
DocumentReference.category	example	DocumentClassValueSet http://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard
DocumentReference.subject.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard
DocumentReference.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
DocumentReference.content.attachment.contentType	required	Mime 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.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.content.format	preferred	IHE_FormatCode_vs http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode
DocumentReference.context.event	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityType	example	FacilityTypeCodeValueSet http://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard
DocumentReference.context.practiceSetting	example	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
DocumentReference.context.sourcePatientInfo.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5	error	DocumentReference	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	DocumentReference	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from MinimalDocumentReference

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• DDCC Patient (http://smart.who.int/ddcc/StructureDefinition/DDCCPatient)

Other representations of profile: CSV, Excel, Schematron