CH EPR FHIR (R4)
4.0.0-ballot - ballot Switzerland flag

This page is part of the CH EPR FHIR (R4) (v4.0.0-ballot: DSTU 4 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). 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-fhir/StructureDefinition/ch-mhd-documentreference-comprehensive Version: 4.0.0-ballot
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 C 0..* CHCoreDocumentReference CH MHD DocumentReference Comprehensive
ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... deletionStatus S 0..1 Coding Deletion status of the document
URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-deletionstatus
Binding: DocumentEntry.Ext.EprDeletionStatus (required)
.... originalProviderRole S 1..1 Coding Original 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-fhir/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... masterIdentifier S 1..1 OidIdentifier An identifier intended for computation
... identifier S 0..* Identifier Other identifiers for the document
... docStatus 0..0
... type S 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (required)
... category S 1..1 CodeableConcept Categorization of document
Binding: DocumentEntry.classCode (required)
... subject S 1..1 Reference(CH Core Patient) {r} Who/what is the subject of the document
... date S 1..1 instant When this document reference was created
... author S 0..* Reference() {c} Who and/or what authored the document
... authenticator 0..1 Reference() {c} Who/what authenticated the document
... custodian 0..0
... relatesTo S 0..* BackboneElement Relationships to other documents
... description S 0..1 string Human-readable description
... securityLabel S 1..* CodeableConcept Document security-tags
Binding: DocumentEntry.confidentialityCode (required)
... content 1..1 BackboneElement Document referenced
.... attachment S 1..1 Attachment Where to access the document
..... contentType S 1..1 code Mime type of the content, with charset etc.
Binding: DocumentEntry.mimeType (required)
..... language S 1..1 code Human language of the content (BCP-47)
Binding: DocumentEntry.languageCode (required)
..... data 0..0
..... url S 1..1 url Uri where the data can be found
..... size S 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash S 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title S 0..1 string Label to display in place of the data
..... creation S 1..1 dateTime Date attachment was first created
.... format S 1..1 Coding Format/content rules for the document
Binding: DocumentEntry.formatCode (required): Document Format Codes.

... context 1..1 BackboneElement Clinical context of document
.... period S 0..1 Period Time of service that is being documented
.... facilityType S 1..1 CodeableConcept Kind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.

.... practiceSetting S 1..1 CodeableConcept Additional 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 S 1..1 Reference(CH Core Patient) {c} Patient demographics from source
.... related S 0..* Reference(Resource) Related identifiers or resources
..... identifier S 0..1 Identifier Requirements 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-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.languagerequiredDocumentEntryLanguageCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatrequiredDocumentEntryFormatCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityTyperequiredDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingrequiredDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-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 C 0..* CHCoreDocumentReference CH MHD DocumentReference Comprehensive
ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... deletionStatus S 0..1 Coding Deletion status of the document
URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-deletionstatus
Binding: DocumentEntry.Ext.EprDeletionStatus (required)
.... originalProviderRole S 1..1 Coding Original 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-fhir/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Other identifiers for the document
... status ?!SΣ 1..1 code current | superseded
Binding: DocumentReferenceStatus (required): The status of the document reference.

... type SΣ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (required)
... category SΣ 1..1 CodeableConcept Categorization of document
Binding: DocumentEntry.classCode (required)
... subject SΣ 1..1 Reference(CH Core Patient) {r} Who/what is the subject of the document
... date SΣ 1..1 instant When this document reference was created
... author SΣ 0..* Reference() {c} Who and/or what authored the document
... authenticator 0..1 Reference() {c} Who/what authenticated the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ 1..1 Reference(CH Core DocumentReference) Target of the relationship
... description SΣ 0..1 string Human-readable description
... securityLabel SΣ 1..* CodeableConcept Document security-tags
Binding: DocumentEntry.confidentialityCode (required)
... content Σ 1..1 BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣ 1..1 Attachment Where to access the document
..... contentType SΣC 1..1 code Mime type of the content, with charset etc.
Binding: DocumentEntry.mimeType (required)
ch-docref-1: The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Human language of the content (BCP-47)
Binding: DocumentEntry.languageCode (required)
Example General: en-AU
..... url SΣ 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ 1..1 dateTime Date attachment was first created
.... format SΣ 1..1 Coding Format/content rules for the document
Binding: DocumentEntry.formatCode (required): Document Format Codes.

... context Σ 1..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... period SΣ 0..1 Period Time of service that is being documented
.... facilityType S 1..1 CodeableConcept Kind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.

.... practiceSetting S 1..1 CodeableConcept Additional 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 S 1..1 Reference(CH Core Patient) {c} Patient demographics from source
.... related S 0..* Reference(Resource) Related identifiers or resources
..... identifier SΣ 0..1 Identifier Requirements 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-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categoryrequiredDocumentEntryClassCode
http://fhir.ch/ig/ch-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-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentTyperequiredDocumentEntryMimeType
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.languagerequiredDocumentEntryLanguageCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatrequiredDocumentEntryFormatCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityTyperequiredDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingrequiredDocumentEntryPracticeSettingCode
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-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 C 0..* CHCoreDocumentReference CH MHD DocumentReference Comprehensive
ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... deletionStatus S 0..1 Coding Deletion status of the document
URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-deletionstatus
Binding: DocumentEntry.Ext.EprDeletionStatus (required)
.... originalProviderRole S 1..1 Coding Original 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-fhir/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier S 1..1 OidIdentifier An identifier intended for computation
... identifier SΣ 0..* Identifier Other identifiers for the document
... status ?!SΣ 1..1 code current | superseded
Binding: DocumentReferenceStatus (required): The status of the document reference.

... type SΣ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (required)
... category SΣ 1..1 CodeableConcept Categorization of document
Binding: DocumentEntry.classCode (required)
... subject SΣ 1..1 Reference(CH Core Patient) {r} Who/what is the subject of the document
... date SΣ 1..1 instant When this document reference was created
... author SΣ 0..* Reference() {c} Who and/or what authored the document
... authenticator 0..1 Reference() {c} Who/what authenticated the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ 1..1 Reference(CH Core DocumentReference) Target of the relationship
... description SΣ 0..1 string Human-readable description
... securityLabel SΣ 1..* CodeableConcept Document security-tags
Binding: DocumentEntry.confidentialityCode (required)
... content Σ 1..1 BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣ 1..1 Attachment Where to access the document
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣC 1..1 code Mime type of the content, with charset etc.
Binding: DocumentEntry.mimeType (required)
ch-docref-1: The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Human language of the content (BCP-47)
Binding: DocumentEntry.languageCode (required)
Example General: en-AU
..... url SΣ 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ 1..1 dateTime Date attachment was first created
.... format SΣ 1..1 Coding Format/content rules for the document
Binding: DocumentEntry.formatCode (required): Document Format Codes.

... context Σ 1..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(CH Core Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period SΣ 0..1 Period Time of service that is being documented
.... facilityType S 1..1 CodeableConcept Kind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.

.... practiceSetting S 1..1 CodeableConcept Additional 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 S 1..1 Reference(CH Core Patient) {c} Patient demographics from source
.... related S 0..* Reference(Resource) Related identifiers or resources
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type 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..1 Identifier Requirements 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..1 string Text 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-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categoryrequiredDocumentEntryClassCode
http://fhir.ch/ig/ch-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-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentTyperequiredDocumentEntryMimeType
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.languagerequiredDocumentEntryLanguageCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatrequiredDocumentEntryFormatCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTyperequiredDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingrequiredDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.practiceSettingCode
DocumentReference.context.related.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

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-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 C 0..* CHCoreDocumentReference CH MHD DocumentReference Comprehensive
ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... deletionStatus S 0..1 Coding Deletion status of the document
URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-deletionstatus
Binding: DocumentEntry.Ext.EprDeletionStatus (required)
.... originalProviderRole S 1..1 Coding Original 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-fhir/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... masterIdentifier S 1..1 OidIdentifier An identifier intended for computation
... identifier S 0..* Identifier Other identifiers for the document
... docStatus 0..0
... type S 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (required)
... category S 1..1 CodeableConcept Categorization of document
Binding: DocumentEntry.classCode (required)
... subject S 1..1 Reference(CH Core Patient) {r} Who/what is the subject of the document
... date S 1..1 instant When this document reference was created
... author S 0..* Reference() {c} Who and/or what authored the document
... authenticator 0..1 Reference() {c} Who/what authenticated the document
... custodian 0..0
... relatesTo S 0..* BackboneElement Relationships to other documents
... description S 0..1 string Human-readable description
... securityLabel S 1..* CodeableConcept Document security-tags
Binding: DocumentEntry.confidentialityCode (required)
... content 1..1 BackboneElement Document referenced
.... attachment S 1..1 Attachment Where to access the document
..... contentType S 1..1 code Mime type of the content, with charset etc.
Binding: DocumentEntry.mimeType (required)
..... language S 1..1 code Human language of the content (BCP-47)
Binding: DocumentEntry.languageCode (required)
..... data 0..0
..... url S 1..1 url Uri where the data can be found
..... size S 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash S 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title S 0..1 string Label to display in place of the data
..... creation S 1..1 dateTime Date attachment was first created
.... format S 1..1 Coding Format/content rules for the document
Binding: DocumentEntry.formatCode (required): Document Format Codes.

... context 1..1 BackboneElement Clinical context of document
.... period S 0..1 Period Time of service that is being documented
.... facilityType S 1..1 CodeableConcept Kind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.

.... practiceSetting S 1..1 CodeableConcept Additional 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 S 1..1 Reference(CH Core Patient) {c} Patient demographics from source
.... related S 0..* Reference(Resource) Related identifiers or resources
..... identifier S 0..1 Identifier Requirements 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-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.languagerequiredDocumentEntryLanguageCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatrequiredDocumentEntryFormatCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityTyperequiredDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingrequiredDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-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 C 0..* CHCoreDocumentReference CH MHD DocumentReference Comprehensive
ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... deletionStatus S 0..1 Coding Deletion status of the document
URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-deletionstatus
Binding: DocumentEntry.Ext.EprDeletionStatus (required)
.... originalProviderRole S 1..1 Coding Original 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-fhir/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier Other identifiers for the document
... status ?!SΣ 1..1 code current | superseded
Binding: DocumentReferenceStatus (required): The status of the document reference.

... type SΣ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (required)
... category SΣ 1..1 CodeableConcept Categorization of document
Binding: DocumentEntry.classCode (required)
... subject SΣ 1..1 Reference(CH Core Patient) {r} Who/what is the subject of the document
... date SΣ 1..1 instant When this document reference was created
... author SΣ 0..* Reference() {c} Who and/or what authored the document
... authenticator 0..1 Reference() {c} Who/what authenticated the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ 1..1 Reference(CH Core DocumentReference) Target of the relationship
... description SΣ 0..1 string Human-readable description
... securityLabel SΣ 1..* CodeableConcept Document security-tags
Binding: DocumentEntry.confidentialityCode (required)
... content Σ 1..1 BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣ 1..1 Attachment Where to access the document
..... contentType SΣC 1..1 code Mime type of the content, with charset etc.
Binding: DocumentEntry.mimeType (required)
ch-docref-1: The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Human language of the content (BCP-47)
Binding: DocumentEntry.languageCode (required)
Example General: en-AU
..... url SΣ 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ 1..1 dateTime Date attachment was first created
.... format SΣ 1..1 Coding Format/content rules for the document
Binding: DocumentEntry.formatCode (required): Document Format Codes.

... context Σ 1..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... period SΣ 0..1 Period Time of service that is being documented
.... facilityType S 1..1 CodeableConcept Kind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.

.... practiceSetting S 1..1 CodeableConcept Additional 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 S 1..1 Reference(CH Core Patient) {c} Patient demographics from source
.... related S 0..* Reference(Resource) Related identifiers or resources
..... identifier SΣ 0..1 Identifier Requirements 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-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categoryrequiredDocumentEntryClassCode
http://fhir.ch/ig/ch-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-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentTyperequiredDocumentEntryMimeType
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.languagerequiredDocumentEntryLanguageCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatrequiredDocumentEntryFormatCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.facilityTyperequiredDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingrequiredDocumentEntryPracticeSettingCode
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-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 C 0..* CHCoreDocumentReference CH MHD DocumentReference Comprehensive
ch-mhd: The DocumentReference needs to conform to IHE.MHD.Comprehensive.DocumentReference
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... deletionStatus S 0..1 Coding Deletion status of the document
URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-ext-deletionstatus
Binding: DocumentEntry.Ext.EprDeletionStatus (required)
.... originalProviderRole S 1..1 Coding Original 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-fhir/StructureDefinition/ch-ext-author-authorrole
Binding: DocumentEntry.originalProviderRole (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier S 1..1 OidIdentifier An identifier intended for computation
... identifier SΣ 0..* Identifier Other identifiers for the document
... status ?!SΣ 1..1 code current | superseded
Binding: DocumentReferenceStatus (required): The status of the document reference.

... type SΣ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (required)
... category SΣ 1..1 CodeableConcept Categorization of document
Binding: DocumentEntry.classCode (required)
... subject SΣ 1..1 Reference(CH Core Patient) {r} Who/what is the subject of the document
... date SΣ 1..1 instant When this document reference was created
... author SΣ 0..* Reference() {c} Who and/or what authored the document
... authenticator 0..1 Reference() {c} Who/what authenticated the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ 1..1 Reference(CH Core DocumentReference) Target of the relationship
... description SΣ 0..1 string Human-readable description
... securityLabel SΣ 1..* CodeableConcept Document security-tags
Binding: DocumentEntry.confidentialityCode (required)
... content Σ 1..1 BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SΣ 1..1 Attachment Where to access the document
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣC 1..1 code Mime type of the content, with charset etc.
Binding: DocumentEntry.mimeType (required)
ch-docref-1: The codes from the following ValueSet are 'preferred': http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Human language of the content (BCP-47)
Binding: DocumentEntry.languageCode (required)
Example General: en-AU
..... url SΣ 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ 1..1 dateTime Date attachment was first created
.... format SΣ 1..1 Coding Format/content rules for the document
Binding: DocumentEntry.formatCode (required): Document Format Codes.

... context Σ 1..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(CH Core Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period SΣ 0..1 Period Time of service that is being documented
.... facilityType S 1..1 CodeableConcept Kind of facility where patient was seen
Binding: DocumentEntry.healthcareFacilityTypeCode (required): XDS Facility Type.

.... practiceSetting S 1..1 CodeableConcept Additional 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 S 1..1 Reference(CH Core Patient) {c} Patient demographics from source
.... related S 0..* Reference(Resource) Related identifiers or resources
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type 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..1 Identifier Requirements 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..1 string Text 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-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categoryrequiredDocumentEntryClassCode
http://fhir.ch/ig/ch-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-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentTyperequiredDocumentEntryMimeType
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.mimeType
DocumentReference.content.attachment.languagerequiredDocumentEntryLanguageCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatrequiredDocumentEntryFormatCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTyperequiredDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingrequiredDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.practiceSettingCode
DocumentReference.context.related.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

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-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