CH EPR mHealth (R4)
3.0.0 - DSTU3 Switzerland flag

This page is part of the CH EPR mHealth (R4) (v3.0.0: DSTU3) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: CH MHD DocumentReference Comprehensive

Official URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-mhd-documentreference-comprehensive Version: 3.0.0
Draft as of 2020-07-10 Computable Name: CHMhdDocumentReferenceComprehensive

Copyright/Legal: CC0-1.0

CH MHD Profile on CH Core DocumentReference

Usage:

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 C0..*CHCoreDocumentReferenceCH MHD DocumentReference Comprehensive
ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... deletionStatus S0..1CodingDeletion status of the document
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-deletionstatus
Binding: DocumentEntry.Ext.EprDeletionStatus (required)
... originalProviderRole S1..1CodingOriginal ProviderRole: This extra metadata attribute SHALL be set by the Document Source actor to the role value of the current user and SHALL NOT be updated by Update Initiator or Document Administrator actors.
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... identifier S0..*IdentifierOther identifiers for the document
... status S1..1codecurrent | superseded
... docStatus 0..0
... type S1..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (required)
... category S1..1CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (required)
... subject S1..1Reference(CH Core Patient) {r}Who/what is the subject of the document
... date S1..1instantWhen this document reference was created
... author S0..*Reference() {c}Who and/or what authored the document
... authenticator 0..1Reference() {c}Who/what authenticated the document
... custodian 0..0
... relatesTo S0..*BackboneElementRelationships to other documents
... description S0..1stringHuman-readable description
... securityLabel S1..*CodeableConceptDocument security-tags
Binding: DocumentEntry.confidentialityCode (required)
... content 1..1BackboneElementDocument referenced
.... attachment S1..1AttachmentWhere to access the document
..... contentType S1..1codeMime type of the content, with charset etc.
Binding: DocumentEntry.mimeType (required)
..... language S1..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (required)
..... data 0..0
..... url S1..1urlUri where the data can be found
..... size S0..1unsignedIntNumber of bytes of content (if url provided)
..... hash S0..1base64BinaryHash of the data (sha-1, base64ed)
..... title S0..1stringLabel to display in place of the data
..... creation S1..1dateTimeDate attachment was first created
.... format S1..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (required): Document Format Codes.

... context 1..1BackboneElementClinical context of document
.... period S0..1PeriodTime of service that is being documented
.... facilityType S1..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.

.... practiceSetting S1..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (required): Additional details about where the content was created (e.g. clinical specialty).

.... sourcePatientInfo S1..1Reference(CH Core Patient) {c}Patient demographics from source
.... related S0..*Reference(Resource)Related identifiers or resources
..... identifier S0..1IdentifierRequirements on XDS-I.b (Swiss context): When a Imaging Document Source provides a document to the Document Repository, it must provide the StudyInstanceUID, found in the to be registered KOS object, in the referenceIdList (urn:ihe:iti:xds:2013:referenceIdList) attribute of the documentEntry metadata.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.typerequiredDocumentEntryTypeCode
DocumentReference.categoryrequiredDocumentEntryClassCode
DocumentReference.securityLabelrequiredDocumentEntryConfidentialityCode
DocumentReference.content.attachment.contentTyperequiredDocumentEntryMimeType
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.languagerequiredDocumentEntryLanguageCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatrequiredDocumentEntryFormatCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityTyperequiredDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingrequiredDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.practiceSettingCode

Constraints

IdGradePath(s)DetailsRequirements
ch-mhderrorDocumentReferenceThe DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
: conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C0..*CHCoreDocumentReferenceCH MHD DocumentReference Comprehensive
ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... deletionStatus S0..1CodingDeletion status of the document
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-deletionstatus
Binding: DocumentEntry.Ext.EprDeletionStatus (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier S1..1OidIdentifierAn identifier intended for computation
... identifier SΣ0..*IdentifierOther identifiers for the document
... status ?!SΣ1..1codecurrent | superseded
Binding: DocumentReferenceStatus (required): The status of the document reference.

... type SΣ1..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (required)
... category SΣ1..1CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (required)
... subject SΣ1..1Reference(CH Core Patient) {r}Who/what is the subject of the document
... date SΣ1..1instantWhen this document reference was created
... author SΣ0..*Reference() {c}Who and/or what authored the document
... authenticator 0..1Reference() {c}Who/what authenticated the document
... relatesTo SΣ0..*BackboneElementRelationships to other documents
.... 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 SΣ0..1stringHuman-readable description
... securityLabel SΣ1..*CodeableConceptDocument security-tags
Binding: DocumentEntry.confidentialityCode (required)
... content Σ1..1BackboneElementDocument referenced
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment SΣ1..1AttachmentWhere to access the document
..... contentType SΣC1..1codeMime type of the content, with charset etc.
Binding: DocumentEntry.mimeType (required)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ1..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (required)
Example General: en-AU
..... url SΣ1..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash SΣ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title SΣ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ1..1dateTimeDate attachment was first created
.... format SΣ1..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (required): Document Format Codes.

... context Σ1..1BackboneElementClinical context of document
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... period SΣ0..1PeriodTime of service that is being documented
.... facilityType S1..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.

.... practiceSetting S1..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (required): Additional details about where the content was created (e.g. clinical specialty).

.... sourcePatientInfo S1..1Reference(CH Core Patient) {c}Patient demographics from source
.... related S0..*Reference(Resource)Related identifiers or resources
..... identifier SΣ0..1IdentifierRequirements on XDS-I.b (Swiss context): When a Imaging Document Source provides a document to the Document Repository, it must provide the StudyInstanceUID, found in the to be registered KOS object, in the referenceIdList (urn:ihe:iti:xds:2013:referenceIdList) attribute of the documentEntry metadata.

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.typerequiredDocumentEntryTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categoryrequiredDocumentEntryClassCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelrequiredDocumentEntryConfidentialityCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentTyperequiredDocumentEntryMimeType
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.languagerequiredDocumentEntryLanguageCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatrequiredDocumentEntryFormatCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityTyperequiredDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingrequiredDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-epr-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-epr-term/ValueSet/DocumentEntry.mimeType
: exists()
ch-mhderrorDocumentReferenceThe DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
: conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')
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 C0..*CHCoreDocumentReferenceCH MHD DocumentReference Comprehensive
ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.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
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... deletionStatus S0..1CodingDeletion status of the document
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-deletionstatus
Binding: DocumentEntry.Ext.EprDeletionStatus (required)
... originalProviderRole S1..1CodingOriginal ProviderRole: This extra metadata attribute SHALL be set by the Document Source actor to the role value of the current user and SHALL NOT be updated by Update Initiator or Document Administrator actors.
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier S1..1OidIdentifierAn identifier intended for computation
... identifier SΣ0..*IdentifierOther identifiers for the document
... status ?!SΣ1..1codecurrent | superseded
Binding: DocumentReferenceStatus (required): The status of the document reference.

... type SΣ1..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (required)
... category SΣ1..1CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (required)
... subject SΣ1..1Reference(CH Core Patient) {r}Who/what is the subject of the document
... date SΣ1..1instantWhen this document reference was created
... author SΣ0..*Reference() {c}Who and/or what authored the document
... authenticator 0..1Reference() {c}Who/what authenticated the document
... relatesTo SΣ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 SΣ0..1stringHuman-readable description
... securityLabel SΣ1..*CodeableConceptDocument security-tags
Binding: DocumentEntry.confidentialityCode (required)
... content Σ1..1BackboneElementDocument 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 SΣ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 SΣC1..1codeMime type of the content, with charset etc.
Binding: DocumentEntry.mimeType (required)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ1..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (required)
Example General: en-AU
..... url SΣ1..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash SΣ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title SΣ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ1..1dateTimeDate attachment was first created
.... format SΣ1..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (required): Document Format Codes.

... context Σ1..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 SΣ0..1PeriodTime of service that is being documented
.... facilityType S1..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.

.... practiceSetting S1..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (required): Additional details about where the content was created (e.g. clinical specialty).

.... sourcePatientInfo S1..1Reference(CH Core Patient) {c}Patient demographics from source
.... related S0..*Reference(Resource)Related identifiers or resources
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC0..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 SΣ0..1IdentifierRequirements on XDS-I.b (Swiss context): When a Imaging Document Source provides a document to the Document Repository, it must provide the StudyInstanceUID, found in the to be registered KOS object, in the referenceIdList (urn:ihe:iti:xds:2013:referenceIdList) attribute of the documentEntry metadata.
..... display Σ0..1stringText alternative for the resource

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.typerequiredDocumentEntryTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categoryrequiredDocumentEntryClassCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelrequiredDocumentEntryConfidentialityCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentTyperequiredDocumentEntryMimeType
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.languagerequiredDocumentEntryLanguageCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatrequiredDocumentEntryFormatCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTyperequiredDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingrequiredDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.practiceSettingCode
DocumentReference.context.related.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types

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()
ch-mhderrorDocumentReferenceThe DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
: conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')
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()

This structure is derived from CHCoreDocumentReference

Differential View

This structure is derived from CHCoreDocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C0..*CHCoreDocumentReferenceCH MHD DocumentReference Comprehensive
ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... deletionStatus S0..1CodingDeletion status of the document
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-deletionstatus
Binding: DocumentEntry.Ext.EprDeletionStatus (required)
... originalProviderRole S1..1CodingOriginal ProviderRole: This extra metadata attribute SHALL be set by the Document Source actor to the role value of the current user and SHALL NOT be updated by Update Initiator or Document Administrator actors.
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... identifier S0..*IdentifierOther identifiers for the document
... status S1..1codecurrent | superseded
... docStatus 0..0
... type S1..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (required)
... category S1..1CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (required)
... subject S1..1Reference(CH Core Patient) {r}Who/what is the subject of the document
... date S1..1instantWhen this document reference was created
... author S0..*Reference() {c}Who and/or what authored the document
... authenticator 0..1Reference() {c}Who/what authenticated the document
... custodian 0..0
... relatesTo S0..*BackboneElementRelationships to other documents
... description S0..1stringHuman-readable description
... securityLabel S1..*CodeableConceptDocument security-tags
Binding: DocumentEntry.confidentialityCode (required)
... content 1..1BackboneElementDocument referenced
.... attachment S1..1AttachmentWhere to access the document
..... contentType S1..1codeMime type of the content, with charset etc.
Binding: DocumentEntry.mimeType (required)
..... language S1..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (required)
..... data 0..0
..... url S1..1urlUri where the data can be found
..... size S0..1unsignedIntNumber of bytes of content (if url provided)
..... hash S0..1base64BinaryHash of the data (sha-1, base64ed)
..... title S0..1stringLabel to display in place of the data
..... creation S1..1dateTimeDate attachment was first created
.... format S1..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (required): Document Format Codes.

... context 1..1BackboneElementClinical context of document
.... period S0..1PeriodTime of service that is being documented
.... facilityType S1..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.

.... practiceSetting S1..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (required): Additional details about where the content was created (e.g. clinical specialty).

.... sourcePatientInfo S1..1Reference(CH Core Patient) {c}Patient demographics from source
.... related S0..*Reference(Resource)Related identifiers or resources
..... identifier S0..1IdentifierRequirements on XDS-I.b (Swiss context): When a Imaging Document Source provides a document to the Document Repository, it must provide the StudyInstanceUID, found in the to be registered KOS object, in the referenceIdList (urn:ihe:iti:xds:2013:referenceIdList) attribute of the documentEntry metadata.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DocumentReference.typerequiredDocumentEntryTypeCode
DocumentReference.categoryrequiredDocumentEntryClassCode
DocumentReference.securityLabelrequiredDocumentEntryConfidentialityCode
DocumentReference.content.attachment.contentTyperequiredDocumentEntryMimeType
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.languagerequiredDocumentEntryLanguageCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatrequiredDocumentEntryFormatCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityTyperequiredDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingrequiredDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.practiceSettingCode

Constraints

IdGradePath(s)DetailsRequirements
ch-mhderrorDocumentReferenceThe DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
: conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C0..*CHCoreDocumentReferenceCH MHD DocumentReference Comprehensive
ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... deletionStatus S0..1CodingDeletion status of the document
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-deletionstatus
Binding: DocumentEntry.Ext.EprDeletionStatus (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier S1..1OidIdentifierAn identifier intended for computation
... identifier SΣ0..*IdentifierOther identifiers for the document
... status ?!SΣ1..1codecurrent | superseded
Binding: DocumentReferenceStatus (required): The status of the document reference.

... type SΣ1..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (required)
... category SΣ1..1CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (required)
... subject SΣ1..1Reference(CH Core Patient) {r}Who/what is the subject of the document
... date SΣ1..1instantWhen this document reference was created
... author SΣ0..*Reference() {c}Who and/or what authored the document
... authenticator 0..1Reference() {c}Who/what authenticated the document
... relatesTo SΣ0..*BackboneElementRelationships to other documents
.... 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 SΣ0..1stringHuman-readable description
... securityLabel SΣ1..*CodeableConceptDocument security-tags
Binding: DocumentEntry.confidentialityCode (required)
... content Σ1..1BackboneElementDocument referenced
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment SΣ1..1AttachmentWhere to access the document
..... contentType SΣC1..1codeMime type of the content, with charset etc.
Binding: DocumentEntry.mimeType (required)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ1..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (required)
Example General: en-AU
..... url SΣ1..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash SΣ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title SΣ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ1..1dateTimeDate attachment was first created
.... format SΣ1..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (required): Document Format Codes.

... context Σ1..1BackboneElementClinical context of document
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... period SΣ0..1PeriodTime of service that is being documented
.... facilityType S1..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.

.... practiceSetting S1..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (required): Additional details about where the content was created (e.g. clinical specialty).

.... sourcePatientInfo S1..1Reference(CH Core Patient) {c}Patient demographics from source
.... related S0..*Reference(Resource)Related identifiers or resources
..... identifier SΣ0..1IdentifierRequirements on XDS-I.b (Swiss context): When a Imaging Document Source provides a document to the Document Repository, it must provide the StudyInstanceUID, found in the to be registered KOS object, in the referenceIdList (urn:ihe:iti:xds:2013:referenceIdList) attribute of the documentEntry metadata.

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.typerequiredDocumentEntryTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categoryrequiredDocumentEntryClassCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelrequiredDocumentEntryConfidentialityCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentTyperequiredDocumentEntryMimeType
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.languagerequiredDocumentEntryLanguageCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatrequiredDocumentEntryFormatCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityTyperequiredDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingrequiredDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-epr-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-epr-term/ValueSet/DocumentEntry.mimeType
: exists()
ch-mhderrorDocumentReferenceThe DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
: conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')
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 C0..*CHCoreDocumentReferenceCH MHD DocumentReference Comprehensive
ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.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
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... deletionStatus S0..1CodingDeletion status of the document
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-deletionstatus
Binding: DocumentEntry.Ext.EprDeletionStatus (required)
... originalProviderRole S1..1CodingOriginal ProviderRole: This extra metadata attribute SHALL be set by the Document Source actor to the role value of the current user and SHALL NOT be updated by Update Initiator or Document Administrator actors.
URL: http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier S1..1OidIdentifierAn identifier intended for computation
... identifier SΣ0..*IdentifierOther identifiers for the document
... status ?!SΣ1..1codecurrent | superseded
Binding: DocumentReferenceStatus (required): The status of the document reference.

... type SΣ1..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (required)
... category SΣ1..1CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (required)
... subject SΣ1..1Reference(CH Core Patient) {r}Who/what is the subject of the document
... date SΣ1..1instantWhen this document reference was created
... author SΣ0..*Reference() {c}Who and/or what authored the document
... authenticator 0..1Reference() {c}Who/what authenticated the document
... relatesTo SΣ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 SΣ0..1stringHuman-readable description
... securityLabel SΣ1..*CodeableConceptDocument security-tags
Binding: DocumentEntry.confidentialityCode (required)
... content Σ1..1BackboneElementDocument 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 SΣ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 SΣC1..1codeMime type of the content, with charset etc.
Binding: DocumentEntry.mimeType (required)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ1..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (required)
Example General: en-AU
..... url SΣ1..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash SΣ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title SΣ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ1..1dateTimeDate attachment was first created
.... format SΣ1..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (required): Document Format Codes.

... context Σ1..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 SΣ0..1PeriodTime of service that is being documented
.... facilityType S1..1CodeableConceptKind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.

.... practiceSetting S1..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (required): Additional details about where the content was created (e.g. clinical specialty).

.... sourcePatientInfo S1..1Reference(CH Core Patient) {c}Patient demographics from source
.... related S0..*Reference(Resource)Related identifiers or resources
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC0..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 SΣ0..1IdentifierRequirements on XDS-I.b (Swiss context): When a Imaging Document Source provides a document to the Document Repository, it must provide the StudyInstanceUID, found in the to be registered KOS object, in the referenceIdList (urn:ihe:iti:xds:2013:referenceIdList) attribute of the documentEntry metadata.
..... display Σ0..1stringText alternative for the resource

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.typerequiredDocumentEntryTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categoryrequiredDocumentEntryClassCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelrequiredDocumentEntryConfidentialityCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentTyperequiredDocumentEntryMimeType
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.languagerequiredDocumentEntryLanguageCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatrequiredDocumentEntryFormatCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTyperequiredDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingrequiredDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.practiceSettingCode
DocumentReference.context.related.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types

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()
ch-mhderrorDocumentReferenceThe DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
: conformsTo('https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.DocumentReference')
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()

This structure is derived from CHCoreDocumentReference

 

Other representations of profile: CSV, Excel, Schematron