HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

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

Resource Profile: RR DocumentReference

This profile represents external resources such as a text guidance, link to access forms for additional reporting needs, additional testing and/or laboratory testing needs, treatment and/or prevention resources, Public Health Agency contact information and general additional resources.

Usage:

• Refer to this Resource Profile: RR External Resource Extension
• Examples for this Resource Profile: DocumentReference/documentreference-add-reporting-needs-pdf, DocumentReference/documentreference-zika-follow-up-pdf and DocumentReference/documentreference-zika-info-pdf

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 USCoreDocumentReferenceProfile

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	USCoreDocumentReferenceProfile	RR Document Reference
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
priority	S	1..1	CodeableConcept	Reportability Response Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): Reportability Priority
category	S	1..*	CodeableConcept	External Resource Type Binding: External Resource Type (eCR) (extensible): External Resource Type
subject	S	1..1	Reference(US Public Health Patient)	Who/what is the subject of the document
description	S	1..1	string	External resource description
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
DocumentReference.category	extensible	RRVS_ExternalResourceType_eCR

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	USCoreDocumentReferenceProfile	RR Document Reference
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
priority	S	1..1	CodeableConcept	Reportability Response Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): Reportability Priority
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Other identifiers for the document
status	?!SΣ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required)
type	SΣ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: US Core DocumentReference Type (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown' Additional Bindings Purpose US Core Clinical Note Type Min Binding
category	SΣ	1..*	CodeableConcept	External Resource Type Binding: External Resource Type (eCR) (extensible): External Resource Type
subject	SΣ	1..1	Reference(US Public Health Patient)	Who/what is the subject of the document
date	SΣ	0..1	instant	When this document reference was created
author	SΣ	0..*	Reference(US Core Practitioner Profile)	Who and/or what authored the document
description	SΣ	1..1	string	External resource description
content	SΣ	1..*	BackboneElement	Document referenced
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	SΣC	1..1	Attachment	Where to access the document
contentType	SΣ	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
data	SC	0..1	base64Binary	Data inline, base64ed
url	SΣC	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
format	SΣ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (extensible)
context	SΣ	0..1	BackboneElement	Clinical context of document
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
encounter	S	0..1	Reference(US Core Encounter Profile)	Context of the document content
period	SΣ	0..1	Period	Time of service that is being documented
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
DocumentReference.status	required	DocumentReferenceStatus
DocumentReference.type	required	USCoreDocumentReferenceType Additional Bindings Purpose US Core Clinical Note Type Min Binding
DocumentReference.category	extensible	RRVS_ExternalResourceType_eCR
DocumentReference.content.attachment.contentType	required	Mime Types (a valid code from urn:ietf:bcp:13)
DocumentReference.content.format	extensible	DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)

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()
us-core-6	error	DocumentReference.content.attachment	DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists()

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	USCoreDocumentReferenceProfile	RR Document Reference
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: 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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
priority	S	1..1	CodeableConcept	Reportability Response Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): Reportability Priority
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	Σ	0..1	Identifier	Master Version Specific Identifier
identifier	SΣ	0..*	Identifier	Other identifiers for the document
status	?!SΣ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required)
docStatus	Σ	0..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
type	SΣ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: US Core DocumentReference Type (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown' Additional Bindings Purpose US Core Clinical Note Type Min Binding
category	SΣ	1..*	CodeableConcept	External Resource Type Binding: External Resource Type (eCR) (extensible): External Resource Type
subject	SΣ	1..1	Reference(US Public Health Patient)	Who/what is the subject of the document
date	SΣ	0..1	instant	When this document reference was created
author	SΣ	0..*	Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | US Core PractitionerRole Profile | RelatedPerson | Device)	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	Σ	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	SΣ	1..1	string	External resource description
securityLabel	Σ	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
content	SΣ	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	SΣC	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	SΣ	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	Σ	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
data	SC	0..1	base64Binary	Data inline, base64ed
url	SΣC	0..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	Σ	0..1	dateTime	Date attachment was first created
format	SΣ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (extensible)
context	SΣ	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	S	0..1	Reference(US Core Encounter Profile)	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
facilityType		0..1	CodeableConcept	Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
practiceSetting		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		0..1	Reference(Patient)	Patient demographics from source
related		0..*	Reference(Resource)	Related identifiers or resources
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
DocumentReference.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.status	required	DocumentReferenceStatus
DocumentReference.docStatus	required	CompositionStatus
DocumentReference.type	required	USCoreDocumentReferenceType Additional Bindings Purpose US Core Clinical Note Type Min Binding
DocumentReference.category	extensible	RRVS_ExternalResourceType_eCR
DocumentReference.relatesTo.code	required	DocumentRelationshipType
DocumentReference.securityLabel	extensible	All Security Labels
DocumentReference.content.attachment.contentType	required	Mime Types (a valid code from urn:ietf:bcp:13)
DocumentReference.content.attachment.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.content.format	extensible	DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
DocumentReference.context.event	example	ActCode
DocumentReference.context.facilityType	example	FacilityTypeCodeValueSet
DocumentReference.context.practiceSetting	example	PracticeSettingCodeValueSet

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()
us-core-6	error	DocumentReference.content.attachment	DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists()

This structure is derived from USCoreDocumentReferenceProfile

Summary

Mandatory: 5 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• US Public Health Patient (http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-patient)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension

Differential View

This structure is derived from USCoreDocumentReferenceProfile

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	USCoreDocumentReferenceProfile	RR Document Reference
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
priority	S	1..1	CodeableConcept	Reportability Response Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): Reportability Priority
category	S	1..*	CodeableConcept	External Resource Type Binding: External Resource Type (eCR) (extensible): External Resource Type
subject	S	1..1	Reference(US Public Health Patient)	Who/what is the subject of the document
description	S	1..1	string	External resource description
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
DocumentReference.category	extensible	RRVS_ExternalResourceType_eCR

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	USCoreDocumentReferenceProfile	RR Document Reference
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
priority	S	1..1	CodeableConcept	Reportability Response Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): Reportability Priority
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Other identifiers for the document
status	?!SΣ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required)
type	SΣ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: US Core DocumentReference Type (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown' Additional Bindings Purpose US Core Clinical Note Type Min Binding
category	SΣ	1..*	CodeableConcept	External Resource Type Binding: External Resource Type (eCR) (extensible): External Resource Type
subject	SΣ	1..1	Reference(US Public Health Patient)	Who/what is the subject of the document
date	SΣ	0..1	instant	When this document reference was created
author	SΣ	0..*	Reference(US Core Practitioner Profile)	Who and/or what authored the document
description	SΣ	1..1	string	External resource description
content	SΣ	1..*	BackboneElement	Document referenced
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	SΣC	1..1	Attachment	Where to access the document
contentType	SΣ	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
data	SC	0..1	base64Binary	Data inline, base64ed
url	SΣC	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
format	SΣ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (extensible)
context	SΣ	0..1	BackboneElement	Clinical context of document
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
encounter	S	0..1	Reference(US Core Encounter Profile)	Context of the document content
period	SΣ	0..1	Period	Time of service that is being documented
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
DocumentReference.status	required	DocumentReferenceStatus
DocumentReference.type	required	USCoreDocumentReferenceType Additional Bindings Purpose US Core Clinical Note Type Min Binding
DocumentReference.category	extensible	RRVS_ExternalResourceType_eCR
DocumentReference.content.attachment.contentType	required	Mime Types (a valid code from urn:ietf:bcp:13)
DocumentReference.content.format	extensible	DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)

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()
us-core-6	error	DocumentReference.content.attachment	DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	USCoreDocumentReferenceProfile	RR Document Reference
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: 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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
priority	S	1..1	CodeableConcept	Reportability Response Priority URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension Binding: Reportability Priority (eCR) (extensible): Reportability Priority
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	Σ	0..1	Identifier	Master Version Specific Identifier
identifier	SΣ	0..*	Identifier	Other identifiers for the document
status	?!SΣ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required)
docStatus	Σ	0..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
type	SΣ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: US Core DocumentReference Type (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown' Additional Bindings Purpose US Core Clinical Note Type Min Binding
category	SΣ	1..*	CodeableConcept	External Resource Type Binding: External Resource Type (eCR) (extensible): External Resource Type
subject	SΣ	1..1	Reference(US Public Health Patient)	Who/what is the subject of the document
date	SΣ	0..1	instant	When this document reference was created
author	SΣ	0..*	Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | US Core PractitionerRole Profile | RelatedPerson | Device)	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	Σ	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	SΣ	1..1	string	External resource description
securityLabel	Σ	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
content	SΣ	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	SΣC	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	SΣ	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	Σ	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
data	SC	0..1	base64Binary	Data inline, base64ed
url	SΣC	0..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	Σ	0..1	dateTime	Date attachment was first created
format	SΣ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (extensible)
context	SΣ	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	S	0..1	Reference(US Core Encounter Profile)	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
facilityType		0..1	CodeableConcept	Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
practiceSetting		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		0..1	Reference(Patient)	Patient demographics from source
related		0..*	Reference(Resource)	Related identifiers or resources
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
DocumentReference.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.status	required	DocumentReferenceStatus
DocumentReference.docStatus	required	CompositionStatus
DocumentReference.type	required	USCoreDocumentReferenceType Additional Bindings Purpose US Core Clinical Note Type Min Binding
DocumentReference.category	extensible	RRVS_ExternalResourceType_eCR
DocumentReference.relatesTo.code	required	DocumentRelationshipType
DocumentReference.securityLabel	extensible	All Security Labels
DocumentReference.content.attachment.contentType	required	Mime Types (a valid code from urn:ietf:bcp:13)
DocumentReference.content.attachment.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.content.format	extensible	DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
DocumentReference.context.event	example	ActCode
DocumentReference.context.facilityType	example	FacilityTypeCodeValueSet
DocumentReference.context.practiceSetting	example	PracticeSettingCodeValueSet

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()
us-core-6	error	DocumentReference.content.attachment	DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists()

This structure is derived from USCoreDocumentReferenceProfile

Summary

Mandatory: 5 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• US Public Health Patient (http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-patient)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension

Other representations of profile: CSV, Excel, Schematron