CH Core (R4)
6.0.0-ci-build - ci-build Switzerland flag

CH Core (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 6.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-core/ and changes regularly. See the Directory of published versions

Resource Profile: CH Core DocumentReference

Official URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-documentreference Version: 6.0.0-ci-build
Active as of 2025-10-18 Computable Name: CHCoreDocumentReference

Copyright/Legal: CC0-1.0

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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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.
... 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 | CH Core 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.
Constraints: ch-docref-1
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)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred DocumentEntry.typeCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.category Base preferred DocumentEntry.classCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.securityLabel Base extensible DocumentEntry.confidentialityCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred DocumentEntry.languageCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.content.​format Base preferred DocumentEntry.formatCode 📦3.3.0-ci-build CH Term v3.3

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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)
... author 0..* Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | CH Core 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.
Constraints: ch-docref-1
..... 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

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.type Base preferred DocumentEntry.typeCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.category Base preferred DocumentEntry.classCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.securityLabel Base extensible DocumentEntry.confidentialityCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.content.​attachment.language Base preferred DocumentEntry.languageCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.content.​format Base preferred DocumentEntry.formatCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.context.​facilityType Base preferred DocumentEntry.healthcareFacilityTypeCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.context.​practiceSetting Base preferred DocumentEntry.practiceSettingCode 📦3.3.0-ci-build CH Term v3.3

Constraints

Id Grade Path(s) Description Expression
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')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 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 | CH Core 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.
Constraints: ch-docref-1
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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred DocumentEntry.typeCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.category Base preferred DocumentEntry.classCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible DocumentEntry.confidentialityCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred DocumentEntry.languageCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.content.​format Base preferred DocumentEntry.formatCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v6.5
DocumentReference.context.​facilityType Base preferred DocumentEntry.healthcareFacilityTypeCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.context.​practiceSetting Base preferred DocumentEntry.practiceSettingCode 📦3.3.0-ci-build CH Term v3.3

Constraints

Id Grade Path(s) Description Expression
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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.
... 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 | CH Core 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.
Constraints: ch-docref-1
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)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred DocumentEntry.typeCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.category Base preferred DocumentEntry.classCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.securityLabel Base extensible DocumentEntry.confidentialityCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred DocumentEntry.languageCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.content.​format Base preferred DocumentEntry.formatCode 📦3.3.0-ci-build CH Term v3.3

Constraints

Id Grade Path(s) Description Expression
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()

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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)
... author 0..* Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | CH Core 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.
Constraints: ch-docref-1
..... 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

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.type Base preferred DocumentEntry.typeCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.category Base preferred DocumentEntry.classCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.securityLabel Base extensible DocumentEntry.confidentialityCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.content.​attachment.language Base preferred DocumentEntry.languageCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.content.​format Base preferred DocumentEntry.formatCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.context.​facilityType Base preferred DocumentEntry.healthcareFacilityTypeCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.context.​practiceSetting Base preferred DocumentEntry.practiceSettingCode 📦3.3.0-ci-build CH Term v3.3

Constraints

Id Grade Path(s) Description Expression
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')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 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 | CH Core 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.
Constraints: ch-docref-1
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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred DocumentEntry.typeCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.category Base preferred DocumentEntry.classCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible DocumentEntry.confidentialityCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred DocumentEntry.languageCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.content.​format Base preferred DocumentEntry.formatCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v6.5
DocumentReference.context.​facilityType Base preferred DocumentEntry.healthcareFacilityTypeCode 📦3.3.0-ci-build CH Term v3.3
DocumentReference.context.​practiceSetting Base preferred DocumentEntry.practiceSettingCode 📦3.3.0-ci-build CH Term v3.3

Constraints

Id Grade Path(s) Description Expression
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()

 

Other representations of profile: CSV, Excel, Schematron