This page is part of the CH Core (R4) (v5.0.0-ballot: STU 5 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

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

Resource Profile: CH Core DocumentReference

Base definition of the DocumentReference resource for use in Swiss specific use cases.

Usage:

• Derived from this Resource Profile: CH Core DocumentReference EPR
• Refer to this Resource Profile: CH Core DocumentReference and CH Core ServiceRequest
• Examples for this Resource Profile: DocumentReference/Docu

Formal Views of Profile Content

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

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

This structure is derived from DocumentReference

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	DocumentReference	CH Core DocumentReference
status		1..1	code	current | superseded | entered-in-error
type		0..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentEntry.typeCode (preferred)
category		0..*	CodeableConcept	Categorization of document Binding: DocumentEntry.classCode (preferred)
subject		0..1	Reference(CH Core Patient | CH Core Practitioner | Group | Device)	Who/what is the subject of the document
author		0..*	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | RelatedPerson)	Who and/or what authored the document
authenticator		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)	Who/what authenticated the document
custodian		0..1	Reference(CH Core Organization)	Organization which maintains the document
relatesTo
target		1..1	Reference(CH Core DocumentReference)	Target of the relationship
securityLabel		0..*	CodeableConcept	Document security-tags Binding: DocumentEntry.confidentialityCode (extensible)
content
attachment
contentType	C	0..1	code	Mime type of the content, with charset etc. ch-docref-1: The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
language		0..1	code	Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (preferred)
format		0..1	Coding	Format/content rules for the document Binding: DocumentEntry.formatCode (preferred)
context
encounter		0..*	Reference(CH Core Encounter | EpisodeOfCare)	Context of the document content
facilityType		0..1	CodeableConcept	Kind of facility where patient was seen Binding: DocumentEntry.healthcareFacilityTypeCode (preferred)
practiceSetting		0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntry.practiceSettingCode (preferred)
sourcePatientInfo		0..1	Reference(CH Core Patient)	Patient demographics from source
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
DocumentReference.type	preferred	DocumentEntryTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.category	preferred	DocumentEntryClassCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.securityLabel	extensible	DocumentEntryConfidentialityCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.language	preferred	DocumentEntryLanguageCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.format	preferred	DocumentEntryFormatCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityType	preferred	DocumentEntryHealthcareFacilityTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSetting	preferred	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')

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	DocumentReference	CH Core DocumentReference
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
type	Σ	0..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentEntry.typeCode (preferred)
category	Σ	0..*	CodeableConcept	Categorization of document Binding: DocumentEntry.classCode (preferred)
subject	Σ	0..1	Reference(CH Core Patient | CH Core Practitioner | Group | Device)	Who/what is the subject of the document
author	Σ	0..*	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | RelatedPerson)	Who and/or what authored the document
authenticator		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)	Who/what authenticated the document
custodian		0..1	Reference(CH Core Organization)	Organization which maintains the document
securityLabel	Σ	0..*	CodeableConcept	Document security-tags Binding: DocumentEntry.confidentialityCode (extensible)
content	Σ	1..*	BackboneElement	Document referenced
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
contentType	ΣC	0..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. 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	Σ	0..1	code	Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (preferred) Example General: en-AU
format	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentEntry.formatCode (preferred)
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	preferred	DocumentEntryTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.category	preferred	DocumentEntryClassCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.securityLabel	extensible	DocumentEntryConfidentialityCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
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	DocumentEntryLanguageCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.format	preferred	DocumentEntryFormatCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode

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')
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..*	DocumentReference	CH Core 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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	Σ	0..1	Identifier	Master Version Specific Identifier
identifier	Σ	0..*	Identifier	Other identifiers for the document
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
docStatus	Σ	0..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
type	Σ	0..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentEntry.typeCode (preferred)
category	Σ	0..*	CodeableConcept	Categorization of document Binding: DocumentEntry.classCode (preferred)
subject	Σ	0..1	Reference(CH Core Patient | CH Core Practitioner | Group | Device)	Who/what is the subject of the document
date	Σ	0..1	instant	When this document reference was created
author	Σ	0..*	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | RelatedPerson)	Who and/or what authored the document
authenticator		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)	Who/what authenticated the document
custodian		0..1	Reference(CH Core 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(CH Core DocumentReference)	Target of the relationship
description	Σ	0..1	string	Human-readable description
securityLabel	Σ	0..*	CodeableConcept	Document security-tags Binding: DocumentEntry.confidentialityCode (extensible)
content	Σ	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	ΣC	0..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. 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	Σ	0..1	code	Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (preferred) Example General: en-AU
data		0..1	base64Binary	Data inline, base64ed
url	Σ	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	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentEntry.formatCode (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(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	Σ	0..1	Period	Time of service that is being documented
facilityType		0..1	CodeableConcept	Kind of facility where patient was seen Binding: DocumentEntry.healthcareFacilityTypeCode (preferred)
practiceSetting		0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntry.practiceSettingCode (preferred)
sourcePatientInfo		0..1	Reference(CH Core Patient)	Patient demographics from source
related		0..*	Reference(Resource)	Related identifiers or resources
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard
DocumentReference.docStatus	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard
DocumentReference.type	preferred	DocumentEntryTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.category	preferred	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	extensible	DocumentEntryConfidentialityCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
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	DocumentEntryLanguageCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.format	preferred	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	preferred	DocumentEntryHealthcareFacilityTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSetting	preferred	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')
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 DocumentReference

Summary

Structures

This structure refers to these other structures:

• 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)
• CH Core DocumentReference (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-documentreference)
• CH Core Encounter (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-encounter)

Differential View

This structure is derived from DocumentReference

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	DocumentReference	CH Core DocumentReference
status		1..1	code	current | superseded | entered-in-error
type		0..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentEntry.typeCode (preferred)
category		0..*	CodeableConcept	Categorization of document Binding: DocumentEntry.classCode (preferred)
subject		0..1	Reference(CH Core Patient | CH Core Practitioner | Group | Device)	Who/what is the subject of the document
author		0..*	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | RelatedPerson)	Who and/or what authored the document
authenticator		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)	Who/what authenticated the document
custodian		0..1	Reference(CH Core Organization)	Organization which maintains the document
relatesTo
target		1..1	Reference(CH Core DocumentReference)	Target of the relationship
securityLabel		0..*	CodeableConcept	Document security-tags Binding: DocumentEntry.confidentialityCode (extensible)
content
attachment
contentType	C	0..1	code	Mime type of the content, with charset etc. ch-docref-1: The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
language		0..1	code	Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (preferred)
format		0..1	Coding	Format/content rules for the document Binding: DocumentEntry.formatCode (preferred)
context
encounter		0..*	Reference(CH Core Encounter | EpisodeOfCare)	Context of the document content
facilityType		0..1	CodeableConcept	Kind of facility where patient was seen Binding: DocumentEntry.healthcareFacilityTypeCode (preferred)
practiceSetting		0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntry.practiceSettingCode (preferred)
sourcePatientInfo		0..1	Reference(CH Core Patient)	Patient demographics from source
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
DocumentReference.type	preferred	DocumentEntryTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.category	preferred	DocumentEntryClassCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.securityLabel	extensible	DocumentEntryConfidentialityCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.language	preferred	DocumentEntryLanguageCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.format	preferred	DocumentEntryFormatCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityType	preferred	DocumentEntryHealthcareFacilityTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSetting	preferred	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')

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	DocumentReference	CH Core DocumentReference
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
type	Σ	0..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentEntry.typeCode (preferred)
category	Σ	0..*	CodeableConcept	Categorization of document Binding: DocumentEntry.classCode (preferred)
subject	Σ	0..1	Reference(CH Core Patient | CH Core Practitioner | Group | Device)	Who/what is the subject of the document
author	Σ	0..*	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | RelatedPerson)	Who and/or what authored the document
authenticator		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)	Who/what authenticated the document
custodian		0..1	Reference(CH Core Organization)	Organization which maintains the document
securityLabel	Σ	0..*	CodeableConcept	Document security-tags Binding: DocumentEntry.confidentialityCode (extensible)
content	Σ	1..*	BackboneElement	Document referenced
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
contentType	ΣC	0..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. 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	Σ	0..1	code	Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (preferred) Example General: en-AU
format	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentEntry.formatCode (preferred)
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	preferred	DocumentEntryTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.category	preferred	DocumentEntryClassCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.securityLabel	extensible	DocumentEntryConfidentialityCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
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	DocumentEntryLanguageCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.format	preferred	DocumentEntryFormatCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode

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')
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..*	DocumentReference	CH Core 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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	Σ	0..1	Identifier	Master Version Specific Identifier
identifier	Σ	0..*	Identifier	Other identifiers for the document
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
docStatus	Σ	0..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
type	Σ	0..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentEntry.typeCode (preferred)
category	Σ	0..*	CodeableConcept	Categorization of document Binding: DocumentEntry.classCode (preferred)
subject	Σ	0..1	Reference(CH Core Patient | CH Core Practitioner | Group | Device)	Who/what is the subject of the document
date	Σ	0..1	instant	When this document reference was created
author	Σ	0..*	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | RelatedPerson)	Who and/or what authored the document
authenticator		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)	Who/what authenticated the document
custodian		0..1	Reference(CH Core 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(CH Core DocumentReference)	Target of the relationship
description	Σ	0..1	string	Human-readable description
securityLabel	Σ	0..*	CodeableConcept	Document security-tags Binding: DocumentEntry.confidentialityCode (extensible)
content	Σ	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	ΣC	0..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. 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	Σ	0..1	code	Human language of the content (BCP-47) Binding: DocumentEntry.languageCode (preferred) Example General: en-AU
data		0..1	base64Binary	Data inline, base64ed
url	Σ	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	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentEntry.formatCode (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(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	Σ	0..1	Period	Time of service that is being documented
facilityType		0..1	CodeableConcept	Kind of facility where patient was seen Binding: DocumentEntry.healthcareFacilityTypeCode (preferred)
practiceSetting		0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: DocumentEntry.practiceSettingCode (preferred)
sourcePatientInfo		0..1	Reference(CH Core Patient)	Patient demographics from source
related		0..*	Reference(Resource)	Related identifiers or resources
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
DocumentReference.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard
DocumentReference.docStatus	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard
DocumentReference.type	preferred	DocumentEntryTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.category	preferred	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	extensible	DocumentEntryConfidentialityCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
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	DocumentEntryLanguageCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.format	preferred	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	preferred	DocumentEntryHealthcareFacilityTypeCode http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSetting	preferred	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')
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 DocumentReference

Summary

Structures

This structure refers to these other structures:

• 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)
• CH Core DocumentReference (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-documentreference)
• CH Core Encounter (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-encounter)

Other representations of profile: CSV, Excel, Schematron