CH EPR FHIR (R4), published by eHealth Suisse. This guide is not an authorized publication; it is the continuous build for version 5.0.0-ballot-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ehealthsuisse/ch-epr-fhir/ and changes regularly. See the Directory of published versions

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

Resource Profile: CH MHD DocumentReference Comprehensive

CH MHD Profile on CH Core DocumentReference

Usage:

• Use this Resource Profile: CH MHD Find Document References Comprehensive Response message and CH MHD Provide Document Bundle Comprehensive
• Refer to this Resource Profile: CH MHD SubmissionSet Comprehensive
• Examples for this Resource Profile: DocumentReference/2-7-DocRefMedicationCard
• CapabilityStatements using this Resource Profile: MHD Document Consumer (client), MHD Document Recipient (server), MHD Document Responder (server) and MHD Document Source (client)

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints
DocumentReference	C	0..*	CHCoreDocumentReference	CH Core DocumentReference 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 ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:deletionStatus	S	0..1	Coding	Deletion status of the document URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-deletionstatus Binding: DocumentEntry.Ext.EprDeletionStatus (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:originalProviderRole	S	1..1	Coding	Original ProviderRole: This extra metadata attribute SHALL be set by the Document Source actor to the role value of the current user and SHALL NOT be updated by Update Initiator or Document Administrator actors. URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-author-authorrole Binding: DocumentEntry.originalProviderRole (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
masterIdentifier	SΣ	1..1	UniqueIdIdentifier	Master Version Specific Identifier ele-1: All FHIR elements must have a @value or children
identifier	SΣ	0..*	Identifier	Other identifiers for the document ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	current | superseded Binding: DocumentReferenceStatus (required): The status of the document reference. ele-1: All FHIR elements must have a @value or children
type	SΣ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentEntry.typeCode (required) ele-1: All FHIR elements must have a @value or children
category	SΣ	1..1	CodeableConcept	Categorization of document Binding: DocumentEntry.classCode (required) ele-1: All FHIR elements must have a @value or children
subject	SΣ	1..1	Reference(CH Core Patient) {r}	Who/what is the subject of the document 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(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | RelatedPerson) {c}	Who and/or what authored the document ele-1: All FHIR elements must have a @value or children
authenticator		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) {c}	Who/what authenticated 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(CH Core DocumentReference)	Target of the relationship ele-1: All FHIR elements must have a @value or children
description	SΣ	0..1	string	Human-readable description ele-1: All FHIR elements must have a @value or children
securityLabel	SΣ	1..*	CodeableConcept	Document security-tags Binding: DocumentEntry.confidentialityCode (required) ele-1: All FHIR elements must have a @value or children
content	Σ	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	SΣ	1..1	Attachment	Where to access the document ele-1: All FHIR elements must have a @value or children
contentType	SΣC	1..1	code	Mime type of the content, with charset etc. Binding: DocumentEntry.mimeType (required) ele-1: All FHIR elements must have a @value or children ch-docref-1: The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType Example General: text/plain; charset=UTF-8, image/png
language	SΣ	1..1	code	Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (required) 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
size	SΣ	0..1	unsignedInt	Number of bytes of content (if url provided) ele-1: All FHIR elements must have a @value or children
hash	SΣ	0..1	base64Binary	Hash of the data (sha-1, base64ed) ele-1: All FHIR elements must have a @value or children
title	SΣ	1..1	string	Label to display in place of the data ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo
creation	SΣ	1..1	dateTime	Date attachment was first created ele-1: All FHIR elements must have a @value or children
format	SΣ	1..1	Coding	Format/content rules for the document Binding: DocumentEntry.formatCode (required): Document Format Codes. ele-1: All FHIR elements must have a @value or children
context	Σ	1..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	1..1	CodeableConcept	Kind of facility where patient was seen Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type. ele-1: All FHIR elements must have a @value or children
practiceSetting	S	1..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntry.practiceSettingCode (required): 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	1..1	Reference(CH Core Patient) {c}	Patient demographics from source ele-1: All FHIR elements must have a @value or children
related	S	0..*	Reference(Resource)	Related identifiers or resources ele-1: All FHIR elements must have a @value or children
identifier	SΣ	0..1	Identifier	Requirements on XDS-I.b (Swiss context): When a Imaging Document Source provides a document to the Document Repository, it must provide the StudyInstanceUID, found in the to be registered KOS object, in the referenceIdList (urn:ihe:iti:xds:2013:referenceIdList) attribute of the documentEntry metadata. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard
DocumentReference.type	required	DocumentEntryTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.category	required	DocumentEntryClassCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard
DocumentReference.securityLabel	required	DocumentEntryConfidentialityCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentType	required	DocumentEntryMimeType http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.language	required	DocumentEntryLanguageCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.format	required	DocumentEntryFormatCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityType	required	DocumentEntryHealthcareFacilityTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSetting	required	DocumentEntryPracticeSettingCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.practiceSettingCode

Constraints

Id	Grade	Path(s)	Details	Requirements
ch-docref-1	warning	DocumentReference.content.attachment.contentType	The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType : memberOf('http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType')
ch-mhd	error	DocumentReference	The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference : conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')
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 CHCoreDocumentReference

Name	Flags	Card.	Type	Description & Constraints
DocumentReference	C	0..*	CHCoreDocumentReference	CH Core DocumentReference ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:deletionStatus	S	0..1	Coding	Deletion status of the document URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-deletionstatus Binding: DocumentEntry.Ext.EprDeletionStatus (required)
extension:originalProviderRole	S	1..1	Coding	Original ProviderRole: This extra metadata attribute SHALL be set by the Document Source actor to the role value of the current user and SHALL NOT be updated by Update Initiator or Document Administrator actors. URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-author-authorrole Binding: DocumentEntry.originalProviderRole (required)
masterIdentifier	S	1..1	UniqueIdIdentifier	Master Version Specific Identifier
identifier	S	0..*	Identifier	Other identifiers for the document
status	S	1..1	code	current | superseded
docStatus		0..0
type	S	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentEntry.typeCode (required)
category	S	1..1	CodeableConcept	Categorization of document Binding: DocumentEntry.classCode (required)
subject	S	1..1	Reference(CH Core Patient) {r}	Who/what is the subject of the document
date	S	1..1	instant	When this document reference was created
author	S	0..*	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | RelatedPerson) {c}	Who and/or what authored the document
authenticator		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) {c}	Who/what authenticated the document
custodian		0..0
relatesTo	S	0..*	BackboneElement	Relationships to other documents
description	S	0..1	string	Human-readable description
securityLabel	S	1..*	CodeableConcept	Document security-tags Binding: DocumentEntry.confidentialityCode (required)
content		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. Binding: DocumentEntry.mimeType (required)
language	S	1..1	code	Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (required)
data		0..0
url	S	1..1	url	Uri where the data can be found
size	S	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	S	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	S	1..1	string	Label to display in place of the data
creation	S	1..1	dateTime	Date attachment was first created
format	S	1..1	Coding	Format/content rules for the document Binding: DocumentEntry.formatCode (required): Document Format Codes.
context		1..1	BackboneElement	Clinical context of document
period	S	0..1	Period	Time of service that is being documented
facilityType	S	1..1	CodeableConcept	Kind of facility where patient was seen Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.
practiceSetting	S	1..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntry.practiceSettingCode (required): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo	S	1..1	Reference(CH Core Patient) {c}	Patient demographics from source
related	S	0..*	Reference(Resource)	Related identifiers or resources
identifier	S	0..1	Identifier	Requirements on XDS-I.b (Swiss context): When a Imaging Document Source provides a document to the Document Repository, it must provide the StudyInstanceUID, found in the to be registered KOS object, in the referenceIdList (urn:ihe:iti:xds:2013:referenceIdList) attribute of the documentEntry metadata.
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
DocumentReference.type	required	DocumentEntryTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.category	required	DocumentEntryClassCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.securityLabel	required	DocumentEntryConfidentialityCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentType	required	DocumentEntryMimeType http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.language	required	DocumentEntryLanguageCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.format	required	DocumentEntryFormatCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityType	required	DocumentEntryHealthcareFacilityTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSetting	required	DocumentEntryPracticeSettingCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.practiceSettingCode

Constraints

Id	Grade	Path(s)	Details	Requirements
ch-mhd	error	DocumentReference	The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference : conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')

Name	Flags	Card.	Type	Description & Constraints
DocumentReference	C	0..*	CHCoreDocumentReference	CH Core DocumentReference ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
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
extension:deletionStatus	S	0..1	Coding	Deletion status of the document URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-deletionstatus Binding: DocumentEntry.Ext.EprDeletionStatus (required)
extension:originalProviderRole	S	1..1	Coding	Original ProviderRole: This extra metadata attribute SHALL be set by the Document Source actor to the role value of the current user and SHALL NOT be updated by Update Initiator or Document Administrator actors. URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-author-authorrole Binding: DocumentEntry.originalProviderRole (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	SΣ	1..1	UniqueIdIdentifier	Master Version Specific Identifier
identifier	SΣ	0..*	Identifier	Other identifiers for the document
status	?!SΣ	1..1	code	current | superseded Binding: DocumentReferenceStatus (required): The status of the document reference.
type	SΣ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentEntry.typeCode (required)
category	SΣ	1..1	CodeableConcept	Categorization of document Binding: DocumentEntry.classCode (required)
subject	SΣ	1..1	Reference(CH Core Patient) {r}	Who/what is the subject of the document
date	SΣ	1..1	instant	When this document reference was created
author	SΣ	0..*	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | RelatedPerson) {c}	Who and/or what authored the document
authenticator		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) {c}	Who/what authenticated 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(CH Core DocumentReference)	Target of the relationship
description	SΣ	0..1	string	Human-readable description
securityLabel	SΣ	1..*	CodeableConcept	Document security-tags Binding: DocumentEntry.confidentialityCode (required)
content	Σ	1..1	BackboneElement	Document referenced
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	SΣ	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ΣC	1..1	code	Mime type of the content, with charset etc. Binding: DocumentEntry.mimeType (required) ch-docref-1: The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType Example General: text/plain; charset=UTF-8, image/png
language	SΣ	1..1	code	Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (required) 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	SΣ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	SΣ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	SΣ	1..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	SΣ	1..1	dateTime	Date attachment was first created
format	SΣ	1..1	Coding	Format/content rules for the document Binding: DocumentEntry.formatCode (required): Document Format Codes.
context	Σ	1..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(CH Core 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
facilityType	S	1..1	CodeableConcept	Kind of facility where patient was seen Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.
practiceSetting	S	1..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntry.practiceSettingCode (required): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo	S	1..1	Reference(CH Core Patient) {c}	Patient demographics from source
related	S	0..*	Reference(Resource)	Related identifiers or resources
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	SΣ	0..1	Identifier	Requirements on XDS-I.b (Swiss context): When a Imaging Document Source provides a document to the Document Repository, it must provide the StudyInstanceUID, found in the to be registered KOS object, in the referenceIdList (urn:ihe:iti:xds:2013:referenceIdList) attribute of the documentEntry metadata.
display	Σ	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard
DocumentReference.type	required	DocumentEntryTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.category	required	DocumentEntryClassCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard
DocumentReference.securityLabel	required	DocumentEntryConfidentialityCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentType	required	DocumentEntryMimeType http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.language	required	DocumentEntryLanguageCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.format	required	DocumentEntryFormatCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.event	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityType	required	DocumentEntryHealthcareFacilityTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSetting	required	DocumentEntryPracticeSettingCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.practiceSettingCode
DocumentReference.context.related.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ch-docref-1	warning	DocumentReference.content.attachment.contentType	The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType : memberOf('http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType')
ch-mhd	error	DocumentReference	The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference : conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')
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 CHCoreDocumentReference

Summary

Mandatory: 18 elements
Must-Support: 28 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

• uniqueId Identifier (https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.UniqueIdIdentifier)
• CH Core Patient (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient)
• CH Core Practitioner (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-practitioner)
• CH Core PractitionerRole (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-practitionerrole)
• CH Core Organization (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-organization)

Extensions

This structure refers to these extensions:

• http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-deletionstatus
• http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-author-authorrole

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
DocumentReference	C	0..*	CHCoreDocumentReference	CH Core DocumentReference 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 ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:deletionStatus	S	0..1	Coding	Deletion status of the document URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-deletionstatus Binding: DocumentEntry.Ext.EprDeletionStatus (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:originalProviderRole	S	1..1	Coding	Original ProviderRole: This extra metadata attribute SHALL be set by the Document Source actor to the role value of the current user and SHALL NOT be updated by Update Initiator or Document Administrator actors. URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-author-authorrole Binding: DocumentEntry.originalProviderRole (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
masterIdentifier	SΣ	1..1	UniqueIdIdentifier	Master Version Specific Identifier ele-1: All FHIR elements must have a @value or children
identifier	SΣ	0..*	Identifier	Other identifiers for the document ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	current | superseded Binding: DocumentReferenceStatus (required): The status of the document reference. ele-1: All FHIR elements must have a @value or children
type	SΣ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentEntry.typeCode (required) ele-1: All FHIR elements must have a @value or children
category	SΣ	1..1	CodeableConcept	Categorization of document Binding: DocumentEntry.classCode (required) ele-1: All FHIR elements must have a @value or children
subject	SΣ	1..1	Reference(CH Core Patient) {r}	Who/what is the subject of the document 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(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | RelatedPerson) {c}	Who and/or what authored the document ele-1: All FHIR elements must have a @value or children
authenticator		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) {c}	Who/what authenticated 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(CH Core DocumentReference)	Target of the relationship ele-1: All FHIR elements must have a @value or children
description	SΣ	0..1	string	Human-readable description ele-1: All FHIR elements must have a @value or children
securityLabel	SΣ	1..*	CodeableConcept	Document security-tags Binding: DocumentEntry.confidentialityCode (required) ele-1: All FHIR elements must have a @value or children
content	Σ	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	SΣ	1..1	Attachment	Where to access the document ele-1: All FHIR elements must have a @value or children
contentType	SΣC	1..1	code	Mime type of the content, with charset etc. Binding: DocumentEntry.mimeType (required) ele-1: All FHIR elements must have a @value or children ch-docref-1: The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType Example General: text/plain; charset=UTF-8, image/png
language	SΣ	1..1	code	Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (required) 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
size	SΣ	0..1	unsignedInt	Number of bytes of content (if url provided) ele-1: All FHIR elements must have a @value or children
hash	SΣ	0..1	base64Binary	Hash of the data (sha-1, base64ed) ele-1: All FHIR elements must have a @value or children
title	SΣ	1..1	string	Label to display in place of the data ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo
creation	SΣ	1..1	dateTime	Date attachment was first created ele-1: All FHIR elements must have a @value or children
format	SΣ	1..1	Coding	Format/content rules for the document Binding: DocumentEntry.formatCode (required): Document Format Codes. ele-1: All FHIR elements must have a @value or children
context	Σ	1..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	1..1	CodeableConcept	Kind of facility where patient was seen Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type. ele-1: All FHIR elements must have a @value or children
practiceSetting	S	1..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntry.practiceSettingCode (required): 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	1..1	Reference(CH Core Patient) {c}	Patient demographics from source ele-1: All FHIR elements must have a @value or children
related	S	0..*	Reference(Resource)	Related identifiers or resources ele-1: All FHIR elements must have a @value or children
identifier	SΣ	0..1	Identifier	Requirements on XDS-I.b (Swiss context): When a Imaging Document Source provides a document to the Document Repository, it must provide the StudyInstanceUID, found in the to be registered KOS object, in the referenceIdList (urn:ihe:iti:xds:2013:referenceIdList) attribute of the documentEntry metadata. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard
DocumentReference.type	required	DocumentEntryTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.category	required	DocumentEntryClassCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard
DocumentReference.securityLabel	required	DocumentEntryConfidentialityCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentType	required	DocumentEntryMimeType http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.language	required	DocumentEntryLanguageCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.format	required	DocumentEntryFormatCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityType	required	DocumentEntryHealthcareFacilityTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSetting	required	DocumentEntryPracticeSettingCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.practiceSettingCode

Constraints

Id	Grade	Path(s)	Details	Requirements
ch-docref-1	warning	DocumentReference.content.attachment.contentType	The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType : memberOf('http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType')
ch-mhd	error	DocumentReference	The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference : conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')
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()

Differential View

This structure is derived from CHCoreDocumentReference

Name	Flags	Card.	Type	Description & Constraints
DocumentReference	C	0..*	CHCoreDocumentReference	CH Core DocumentReference ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:deletionStatus	S	0..1	Coding	Deletion status of the document URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-deletionstatus Binding: DocumentEntry.Ext.EprDeletionStatus (required)
extension:originalProviderRole	S	1..1	Coding	Original ProviderRole: This extra metadata attribute SHALL be set by the Document Source actor to the role value of the current user and SHALL NOT be updated by Update Initiator or Document Administrator actors. URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-author-authorrole Binding: DocumentEntry.originalProviderRole (required)
masterIdentifier	S	1..1	UniqueIdIdentifier	Master Version Specific Identifier
identifier	S	0..*	Identifier	Other identifiers for the document
status	S	1..1	code	current | superseded
docStatus		0..0
type	S	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentEntry.typeCode (required)
category	S	1..1	CodeableConcept	Categorization of document Binding: DocumentEntry.classCode (required)
subject	S	1..1	Reference(CH Core Patient) {r}	Who/what is the subject of the document
date	S	1..1	instant	When this document reference was created
author	S	0..*	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | RelatedPerson) {c}	Who and/or what authored the document
authenticator		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) {c}	Who/what authenticated the document
custodian		0..0
relatesTo	S	0..*	BackboneElement	Relationships to other documents
description	S	0..1	string	Human-readable description
securityLabel	S	1..*	CodeableConcept	Document security-tags Binding: DocumentEntry.confidentialityCode (required)
content		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. Binding: DocumentEntry.mimeType (required)
language	S	1..1	code	Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (required)
data		0..0
url	S	1..1	url	Uri where the data can be found
size	S	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	S	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	S	1..1	string	Label to display in place of the data
creation	S	1..1	dateTime	Date attachment was first created
format	S	1..1	Coding	Format/content rules for the document Binding: DocumentEntry.formatCode (required): Document Format Codes.
context		1..1	BackboneElement	Clinical context of document
period	S	0..1	Period	Time of service that is being documented
facilityType	S	1..1	CodeableConcept	Kind of facility where patient was seen Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.
practiceSetting	S	1..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntry.practiceSettingCode (required): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo	S	1..1	Reference(CH Core Patient) {c}	Patient demographics from source
related	S	0..*	Reference(Resource)	Related identifiers or resources
identifier	S	0..1	Identifier	Requirements on XDS-I.b (Swiss context): When a Imaging Document Source provides a document to the Document Repository, it must provide the StudyInstanceUID, found in the to be registered KOS object, in the referenceIdList (urn:ihe:iti:xds:2013:referenceIdList) attribute of the documentEntry metadata.
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
DocumentReference.type	required	DocumentEntryTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.category	required	DocumentEntryClassCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.securityLabel	required	DocumentEntryConfidentialityCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentType	required	DocumentEntryMimeType http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.language	required	DocumentEntryLanguageCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.format	required	DocumentEntryFormatCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityType	required	DocumentEntryHealthcareFacilityTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSetting	required	DocumentEntryPracticeSettingCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.practiceSettingCode

Constraints

Id	Grade	Path(s)	Details	Requirements
ch-mhd	error	DocumentReference	The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference : conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
DocumentReference	C	0..*	CHCoreDocumentReference	CH Core DocumentReference ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
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
extension:deletionStatus	S	0..1	Coding	Deletion status of the document URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-deletionstatus Binding: DocumentEntry.Ext.EprDeletionStatus (required)
extension:originalProviderRole	S	1..1	Coding	Original ProviderRole: This extra metadata attribute SHALL be set by the Document Source actor to the role value of the current user and SHALL NOT be updated by Update Initiator or Document Administrator actors. URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-author-authorrole Binding: DocumentEntry.originalProviderRole (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	SΣ	1..1	UniqueIdIdentifier	Master Version Specific Identifier
identifier	SΣ	0..*	Identifier	Other identifiers for the document
status	?!SΣ	1..1	code	current | superseded Binding: DocumentReferenceStatus (required): The status of the document reference.
type	SΣ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentEntry.typeCode (required)
category	SΣ	1..1	CodeableConcept	Categorization of document Binding: DocumentEntry.classCode (required)
subject	SΣ	1..1	Reference(CH Core Patient) {r}	Who/what is the subject of the document
date	SΣ	1..1	instant	When this document reference was created
author	SΣ	0..*	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | RelatedPerson) {c}	Who and/or what authored the document
authenticator		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) {c}	Who/what authenticated 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(CH Core DocumentReference)	Target of the relationship
description	SΣ	0..1	string	Human-readable description
securityLabel	SΣ	1..*	CodeableConcept	Document security-tags Binding: DocumentEntry.confidentialityCode (required)
content	Σ	1..1	BackboneElement	Document referenced
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	SΣ	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ΣC	1..1	code	Mime type of the content, with charset etc. Binding: DocumentEntry.mimeType (required) ch-docref-1: The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType Example General: text/plain; charset=UTF-8, image/png
language	SΣ	1..1	code	Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (required) 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	SΣ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	SΣ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	SΣ	1..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	SΣ	1..1	dateTime	Date attachment was first created
format	SΣ	1..1	Coding	Format/content rules for the document Binding: DocumentEntry.formatCode (required): Document Format Codes.
context	Σ	1..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(CH Core 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
facilityType	S	1..1	CodeableConcept	Kind of facility where patient was seen Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.
practiceSetting	S	1..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntry.practiceSettingCode (required): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo	S	1..1	Reference(CH Core Patient) {c}	Patient demographics from source
related	S	0..*	Reference(Resource)	Related identifiers or resources
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	SΣ	0..1	Identifier	Requirements on XDS-I.b (Swiss context): When a Imaging Document Source provides a document to the Document Repository, it must provide the StudyInstanceUID, found in the to be registered KOS object, in the referenceIdList (urn:ihe:iti:xds:2013:referenceIdList) attribute of the documentEntry metadata.
display	Σ	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard
DocumentReference.type	required	DocumentEntryTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.category	required	DocumentEntryClassCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard
DocumentReference.securityLabel	required	DocumentEntryConfidentialityCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentType	required	DocumentEntryMimeType http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.language	required	DocumentEntryLanguageCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.format	required	DocumentEntryFormatCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.event	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityType	required	DocumentEntryHealthcareFacilityTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSetting	required	DocumentEntryPracticeSettingCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.practiceSettingCode
DocumentReference.context.related.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ch-docref-1	warning	DocumentReference.content.attachment.contentType	The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType : memberOf('http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType')
ch-mhd	error	DocumentReference	The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference : conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')
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 CHCoreDocumentReference

Summary

Mandatory: 18 elements
Must-Support: 28 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

• uniqueId Identifier (https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.UniqueIdIdentifier)
• CH Core Patient (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient)
• CH Core Practitioner (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-practitioner)
• CH Core PractitionerRole (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-practitionerrole)
• CH Core Organization (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-organization)

Extensions

This structure refers to these extensions:

• http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-deletionstatus
• http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-author-authorrole

Other representations of profile: CSV, Excel, Schematron