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

CH Core (R4), published by HL7 Switzerland. This is not an authorized publication; it is the continuous build for version 3.1.0). 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: 3.1.0
Active as of 2023-05-10 Computable Name: CHCoreDocumentReference

Copyright/Legal: CC-BY-SA-4.0

Base definition for a document reference with the CH Core profiles.

Usage:

Formal Views of Profile Content

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

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceCH Core DocumentReference
... status 1..1codecurrent | superseded | entered-in-error
... type 0..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred)
... category 0..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (preferred)
... 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..1Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)Who/what authenticated the document
... custodian 0..1Reference(CH Core Organization)Organization which maintains the document
... relatesTo
.... target 1..1Reference(CH Core DocumentReference)Target of the relationship
... securityLabel 0..*CodeableConceptDocument security-tags
Binding: DocumentEntry.confidentialityCode (extensible)
... content
.... attachment
..... contentType C0..1codeMime type of the content, with charset etc.
ch-docref-1: The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
..... language 0..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (preferred)
.... format 0..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (preferred)
... context
.... encounter 0..*Reference(CH Core Encounter | EpisodeOfCare)Context of the document content
.... facilityType 0..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (preferred)
.... practiceSetting 0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (preferred)
.... sourcePatientInfo 0..1Reference(CH Core Patient)Patient demographics from source

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
DocumentReference.typepreferredDocumentEntryTypeCode
DocumentReference.categorypreferredDocumentEntryClassCode
DocumentReference.securityLabelextensibleDocumentEntryConfidentialityCode
DocumentReference.content.attachment.languagepreferredDocumentEntryLanguageCode
DocumentReference.content.formatpreferredDocumentEntryFormatCode
DocumentReference.context.facilityTypepreferredDocumentEntryHealthcareFacilityTypeCode
DocumentReference.context.practiceSettingpreferredDocumentEntryPracticeSettingCode

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
: exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceCH Core DocumentReference
... 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 Σ0..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (preferred)
... subject Σ0..1Reference(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..1Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)Who/what authenticated the document
... custodian 0..1Reference(CH Core Organization)Organization which maintains the document
... securityLabel Σ0..*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 ΣC0..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-epr-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (preferred)
Example General: en-AU
.... format Σ0..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DocumentReference.statusrequiredDocumentReferenceStatus
DocumentReference.typepreferredDocumentEntryTypeCode
DocumentReference.categorypreferredDocumentEntryClassCode
DocumentReference.securityLabelextensibleDocumentEntryConfidentialityCode
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
DocumentReference.content.attachment.languagepreferredDocumentEntryLanguageCode
DocumentReference.content.formatpreferredDocumentEntryFormatCode

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
: exists()
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..*DocumentReferenceCH Core DocumentReference
... 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 Σ0..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred)
... category Σ0..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (preferred)
... subject Σ0..1Reference(CH Core Patient | CH Core Practitioner | Group | Device)Who/what is the subject of the document
... date Σ0..1instantWhen 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..1Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)Who/what authenticated the document
... custodian 0..1Reference(CH Core Organization)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 Σ0..*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 ΣC0..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-epr-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (preferred)
Example General: en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url Σ0..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 Σ0..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (preferred)
... 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 (preferred)
.... practiceSetting 0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (preferred)
.... sourcePatientInfo 0..1Reference(CH Core Patient)Patient demographics from source
.... related 0..*Reference(Resource)Related identifiers or resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.statusrequiredDocumentReferenceStatus
DocumentReference.docStatusrequiredCompositionStatus
DocumentReference.typepreferredDocumentEntryTypeCode
DocumentReference.categorypreferredDocumentEntryClassCode
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
DocumentReference.securityLabelextensibleDocumentEntryConfidentialityCode
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
DocumentReference.content.attachment.languagepreferredDocumentEntryLanguageCode
DocumentReference.content.formatpreferredDocumentEntryFormatCode
DocumentReference.context.eventexampleActCode
DocumentReference.context.facilityTypepreferredDocumentEntryHealthcareFacilityTypeCode
DocumentReference.context.practiceSettingpreferredDocumentEntryPracticeSettingCode

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
: 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 DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceCH Core DocumentReference
... status 1..1codecurrent | superseded | entered-in-error
... type 0..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred)
... category 0..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (preferred)
... 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..1Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)Who/what authenticated the document
... custodian 0..1Reference(CH Core Organization)Organization which maintains the document
... relatesTo
.... target 1..1Reference(CH Core DocumentReference)Target of the relationship
... securityLabel 0..*CodeableConceptDocument security-tags
Binding: DocumentEntry.confidentialityCode (extensible)
... content
.... attachment
..... contentType C0..1codeMime type of the content, with charset etc.
ch-docref-1: The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
..... language 0..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (preferred)
.... format 0..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (preferred)
... context
.... encounter 0..*Reference(CH Core Encounter | EpisodeOfCare)Context of the document content
.... facilityType 0..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (preferred)
.... practiceSetting 0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (preferred)
.... sourcePatientInfo 0..1Reference(CH Core Patient)Patient demographics from source

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
DocumentReference.typepreferredDocumentEntryTypeCode
DocumentReference.categorypreferredDocumentEntryClassCode
DocumentReference.securityLabelextensibleDocumentEntryConfidentialityCode
DocumentReference.content.attachment.languagepreferredDocumentEntryLanguageCode
DocumentReference.content.formatpreferredDocumentEntryFormatCode
DocumentReference.context.facilityTypepreferredDocumentEntryHealthcareFacilityTypeCode
DocumentReference.context.practiceSettingpreferredDocumentEntryPracticeSettingCode

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
: exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceCH Core DocumentReference
... 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 Σ0..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (preferred)
... subject Σ0..1Reference(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..1Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)Who/what authenticated the document
... custodian 0..1Reference(CH Core Organization)Organization which maintains the document
... securityLabel Σ0..*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 ΣC0..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-epr-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (preferred)
Example General: en-AU
.... format Σ0..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DocumentReference.statusrequiredDocumentReferenceStatus
DocumentReference.typepreferredDocumentEntryTypeCode
DocumentReference.categorypreferredDocumentEntryClassCode
DocumentReference.securityLabelextensibleDocumentEntryConfidentialityCode
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
DocumentReference.content.attachment.languagepreferredDocumentEntryLanguageCode
DocumentReference.content.formatpreferredDocumentEntryFormatCode

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
: exists()
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..*DocumentReferenceCH Core DocumentReference
... 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 Σ0..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred)
... category Σ0..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (preferred)
... subject Σ0..1Reference(CH Core Patient | CH Core Practitioner | Group | Device)Who/what is the subject of the document
... date Σ0..1instantWhen 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..1Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)Who/what authenticated the document
... custodian 0..1Reference(CH Core Organization)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 Σ0..*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 ΣC0..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-epr-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (preferred)
Example General: en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url Σ0..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 Σ0..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (preferred)
... 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 (preferred)
.... practiceSetting 0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (preferred)
.... sourcePatientInfo 0..1Reference(CH Core Patient)Patient demographics from source
.... related 0..*Reference(Resource)Related identifiers or resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.statusrequiredDocumentReferenceStatus
DocumentReference.docStatusrequiredCompositionStatus
DocumentReference.typepreferredDocumentEntryTypeCode
DocumentReference.categorypreferredDocumentEntryClassCode
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
DocumentReference.securityLabelextensibleDocumentEntryConfidentialityCode
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
DocumentReference.content.attachment.languagepreferredDocumentEntryLanguageCode
DocumentReference.content.formatpreferredDocumentEntryFormatCode
DocumentReference.context.eventexampleActCode
DocumentReference.context.facilityTypepreferredDocumentEntryHealthcareFacilityTypeCode
DocumentReference.context.practiceSettingpreferredDocumentEntryPracticeSettingCode

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
: 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