CH Core (R4)
5.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 5.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 EPR

Official URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-documentreference-epr Version: 5.0.0-ci-build
Active as of 2024-03-22 Computable Name: CHCoreDocumentReferenceEPR

Copyright/Legal: CC0-1.0

Definition of the DocumentReference resource for use in the context of the electronic patient record (EPR).

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from CHCoreDocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*CHCoreDocumentReferenceCH Core DocumentReference EPR
... type 1..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (extensible)
... category 1..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (extensible)
... subject 1..1Reference(CH Core Patient EPR)Who/what is the subject of the document
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... author 1..*Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson)Who and/or what authored the document
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... authenticator 0..1Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | CH Core Organization EPR)Who/what authenticated the document
... custodian 0..1Reference(CH Core Organization EPR)Organization which maintains the document
... securityLabel 1..*CodeableConceptDocument security-tags
... content
.... attachment
..... contentType C1..1codeMime type of the content, with charset etc.
ch-docref-2: The codes from the following ValueSet shall be used if one of them can be applied (aka 'extensible'): http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
..... language 1..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (extensible)
..... url 1..1urlUri where the data can be found
.... format 1..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (extensible)
... context
.... facilityType 0..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (extensible)
.... practiceSetting 0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (extensible)
.... sourcePatientInfo 0..1Reference(CH Core Patient EPR)Patient demographics from source

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.typeextensibleDocumentEntryTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categoryextensibleDocumentEntryClassCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.content.attachment.languageextensibleDocumentEntryLanguageCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatextensibleDocumentEntryFormatCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityTypeextensibleDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingextensibleDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.practiceSettingCode

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-2warningDocumentReference.content.attachment.contentTypeThe codes from the following ValueSet shall be used if one of them can be applied (aka 'extensible'): http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
: memberOf('http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType')
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*CHCoreDocumentReferenceCH Core DocumentReference EPR
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... category Σ1..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (extensible)
... subject Σ1..1Reference(CH Core Patient EPR)Who/what is the subject of the document
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... date Σ1..1instantWhen this document reference was created
... author Σ1..*Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson)Who and/or what authored the document
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... authenticator 0..1Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | CH Core Organization EPR)Who/what authenticated the document
... custodian 0..1Reference(CH Core Organization EPR)Organization which maintains the document
... securityLabel Σ1..*CodeableConceptDocument security-tags
Binding: DocumentEntry.confidentialityCode (extensible)
... content Σ1..*BackboneElementDocument referenced
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment Σ1..1AttachmentWhere to access the document
..... contentType ΣC1..1codeMime 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
ch-docref-2: The codes from the following ValueSet shall be used if one of them can be applied (aka 'extensible'): http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language Σ1..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (extensible)
Example General: en-AU
..... url Σ1..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... format Σ1..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.typeextensibleDocumentEntryTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categoryextensibleDocumentEntryClassCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.securityLabelextensibleDocumentEntryConfidentialityCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentTyperequiredMime 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.languageextensibleDocumentEntryLanguageCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatextensibleDocumentEntryFormatCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe 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-docref-2warningDocumentReference.content.attachment.contentTypeThe codes from the following ValueSet shall be used if one of them can be applied (aka 'extensible'): http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
: memberOf('http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType')
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*CHCoreDocumentReferenceCH Core DocumentReference EPR
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier Σ0..1IdentifierMaster Version Specific Identifier
... identifier Σ0..*IdentifierOther identifiers for the document
... status ?!Σ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... docStatus Σ0..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.

... type Σ1..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (extensible)
... category Σ1..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (extensible)
... subject Σ1..1Reference(CH Core Patient EPR)Who/what is the subject of the document
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... date Σ1..1instantWhen this document reference was created
... author Σ1..*Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson)Who and/or what authored the document
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... authenticator 0..1Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | CH Core Organization EPR)Who/what authenticated the document
... custodian 0..1Reference(CH Core Organization EPR)Organization which maintains the document
... relatesTo Σ0..*BackboneElementRelationships to other documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ1..1Reference(CH Core DocumentReference)Target of the relationship
... description Σ0..1stringHuman-readable description
... securityLabel Σ1..*CodeableConceptDocument security-tags
Binding: DocumentEntry.confidentialityCode (extensible)
... content Σ1..*BackboneElementDocument referenced
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment Σ1..1AttachmentWhere to access the document
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType ΣC1..1codeMime 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
ch-docref-2: The codes from the following ValueSet shall be used if one of them can be applied (aka 'extensible'): http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language Σ1..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (extensible)
Example General: en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url Σ1..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created
.... format Σ1..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (extensible)
... context Σ0..1BackboneElementClinical context of document
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... encounter 0..*Reference(CH Core Encounter | EpisodeOfCare)Context of the document content
.... event 0..*CodeableConceptMain clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period Σ0..1PeriodTime of service that is being documented
.... facilityType 0..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (extensible)
.... practiceSetting 0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (extensible)
.... sourcePatientInfo 0..1Reference(CH Core Patient EPR)Patient demographics from source
.... related 0..*Reference(Resource)Related identifiers or resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
DocumentReference.typeextensibleDocumentEntryTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categoryextensibleDocumentEntryClassCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DocumentReference.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleDocumentEntryConfidentialityCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentTyperequiredMime 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.languageextensibleDocumentEntryLanguageCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatextensibleDocumentEntryFormatCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeextensibleDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingextensibleDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.practiceSettingCode

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe 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-docref-2warningDocumentReference.content.attachment.contentTypeThe codes from the following ValueSet shall be used if one of them can be applied (aka 'extensible'): http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
: memberOf('http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType')
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from CHCoreDocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*CHCoreDocumentReferenceCH Core DocumentReference EPR
... type 1..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (extensible)
... category 1..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (extensible)
... subject 1..1Reference(CH Core Patient EPR)Who/what is the subject of the document
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... author 1..*Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson)Who and/or what authored the document
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... authenticator 0..1Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | CH Core Organization EPR)Who/what authenticated the document
... custodian 0..1Reference(CH Core Organization EPR)Organization which maintains the document
... securityLabel 1..*CodeableConceptDocument security-tags
... content
.... attachment
..... contentType C1..1codeMime type of the content, with charset etc.
ch-docref-2: The codes from the following ValueSet shall be used if one of them can be applied (aka 'extensible'): http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
..... language 1..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (extensible)
..... url 1..1urlUri where the data can be found
.... format 1..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (extensible)
... context
.... facilityType 0..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (extensible)
.... practiceSetting 0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (extensible)
.... sourcePatientInfo 0..1Reference(CH Core Patient EPR)Patient demographics from source

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.typeextensibleDocumentEntryTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categoryextensibleDocumentEntryClassCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.content.attachment.languageextensibleDocumentEntryLanguageCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatextensibleDocumentEntryFormatCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityTypeextensibleDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingextensibleDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.practiceSettingCode

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-2warningDocumentReference.content.attachment.contentTypeThe codes from the following ValueSet shall be used if one of them can be applied (aka 'extensible'): http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
: memberOf('http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*CHCoreDocumentReferenceCH Core DocumentReference EPR
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... category Σ1..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (extensible)
... subject Σ1..1Reference(CH Core Patient EPR)Who/what is the subject of the document
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... date Σ1..1instantWhen this document reference was created
... author Σ1..*Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson)Who and/or what authored the document
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... authenticator 0..1Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | CH Core Organization EPR)Who/what authenticated the document
... custodian 0..1Reference(CH Core Organization EPR)Organization which maintains the document
... securityLabel Σ1..*CodeableConceptDocument security-tags
Binding: DocumentEntry.confidentialityCode (extensible)
... content Σ1..*BackboneElementDocument referenced
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment Σ1..1AttachmentWhere to access the document
..... contentType ΣC1..1codeMime 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
ch-docref-2: The codes from the following ValueSet shall be used if one of them can be applied (aka 'extensible'): http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language Σ1..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (extensible)
Example General: en-AU
..... url Σ1..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... format Σ1..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.typeextensibleDocumentEntryTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categoryextensibleDocumentEntryClassCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.securityLabelextensibleDocumentEntryConfidentialityCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentTyperequiredMime 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.languageextensibleDocumentEntryLanguageCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatextensibleDocumentEntryFormatCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe 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-docref-2warningDocumentReference.content.attachment.contentTypeThe codes from the following ValueSet shall be used if one of them can be applied (aka 'extensible'): http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
: memberOf('http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType')
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*CHCoreDocumentReferenceCH Core DocumentReference EPR
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier Σ0..1IdentifierMaster Version Specific Identifier
... identifier Σ0..*IdentifierOther identifiers for the document
... status ?!Σ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... docStatus Σ0..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.

... type Σ1..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (extensible)
... category Σ1..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (extensible)
... subject Σ1..1Reference(CH Core Patient EPR)Who/what is the subject of the document
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... date Σ1..1instantWhen this document reference was created
... author Σ1..*Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | Device | CH Core Patient EPR | RelatedPerson)Who and/or what authored the document
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... authenticator 0..1Reference(CH Core Practitioner EPR | CH Core PractitionerRole EPR | CH Core Organization EPR)Who/what authenticated the document
... custodian 0..1Reference(CH Core Organization EPR)Organization which maintains the document
... relatesTo Σ0..*BackboneElementRelationships to other documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ1..1Reference(CH Core DocumentReference)Target of the relationship
... description Σ0..1stringHuman-readable description
... securityLabel Σ1..*CodeableConceptDocument security-tags
Binding: DocumentEntry.confidentialityCode (extensible)
... content Σ1..*BackboneElementDocument referenced
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment Σ1..1AttachmentWhere to access the document
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType ΣC1..1codeMime 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
ch-docref-2: The codes from the following ValueSet shall be used if one of them can be applied (aka 'extensible'): http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language Σ1..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (extensible)
Example General: en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url Σ1..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created
.... format Σ1..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (extensible)
... context Σ0..1BackboneElementClinical context of document
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... encounter 0..*Reference(CH Core Encounter | EpisodeOfCare)Context of the document content
.... event 0..*CodeableConceptMain clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period Σ0..1PeriodTime of service that is being documented
.... facilityType 0..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (extensible)
.... practiceSetting 0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (extensible)
.... sourcePatientInfo 0..1Reference(CH Core Patient EPR)Patient demographics from source
.... related 0..*Reference(Resource)Related identifiers or resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
DocumentReference.typeextensibleDocumentEntryTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categoryextensibleDocumentEntryClassCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.classCode
DocumentReference.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DocumentReference.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleDocumentEntryConfidentialityCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentTyperequiredMime 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.languageextensibleDocumentEntryLanguageCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatextensibleDocumentEntryFormatCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeextensibleDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingextensibleDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.practiceSettingCode

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe 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-docref-2warningDocumentReference.content.attachment.contentTypeThe codes from the following ValueSet shall be used if one of them can be applied (aka 'extensible'): http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
: memberOf('http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType')
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron