MedNet interface implementation guide
0.16.0 - CI Build

Publication Build: This will be filled in by the publication tooling

Resource Profile: MedNet Interface (MNI) - DocumentReference

Official URL: https://mednet.swiss/fhir/StructureDefinition/mni-documentReference Version: 0.16.0
Active as of 2022-06-13 Computable Name: MNIDocumentReference

Copyright/Legal: novcom AG

MedNet Interface (MNI) - DocumentReference Profile

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* CHCoreDocumentReference MedNet Interface (MNI) - DocumentReference
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred): Precise type of clinical document.

.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed SΣ 1..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code SΣ 1..1 code see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
...... display SΣ 0..1 string see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
... category SΣ 0..* CodeableConcept Categorization of document
Binding: DocumentEntry.classCode (preferred): High-level kind of a clinical document at a macro level.


.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed SΣ 0..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code SΣ 1..1 code see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
...... display SΣ 0..1 string see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
..... coding:esanita SΣ 0..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: https://www.esanita.ch
...... code SΣ 1..1 code Should be set if the document has to be uploaded to the EPD
Fixed Value: epd
... content SΣ 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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


ch-docref-1: The following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... data S 0..1 base64Binary Data inline, base64ed
..... url SΣ 0..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Σ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.statusrequiredFixed Value: current
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.typepreferredDocumentEntryTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categorypreferredDocumentEntryClassCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
: exists()
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CHCoreDocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* CHCoreDocumentReference MedNet Interface (MNI) - DocumentReference
... id S 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... status S 1..1 code Fixed value: current
Fixed Value: current
... type S 0..1 CodeableConcept Kind of document (LOINC if possible)
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed S 1..* Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code S 1..1 code see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
...... display S 0..1 string see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed S 0..* Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code S 1..1 code see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
...... display S 0..1 string see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
..... coding:esanita S 0..* Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: https://www.esanita.ch
...... code S 1..1 code Should be set if the document has to be uploaded to the EPD
Fixed Value: epd
... content S 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.
..... data S 0..1 base64Binary Data inline, base64ed
..... url S 0..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 0..1 dateTime Date attachment was first created

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* CHCoreDocumentReference MedNet Interface (MNI) - DocumentReference
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier Σ 0..* Identifier Other identifiers for the document
... status ?!SΣ 1..1 code Fixed value: current
Binding: DocumentReferenceStatus (required): The status of the document reference.


Fixed Value: current
... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.

... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred): Precise type of clinical 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
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed SΣ 1..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
...... display SΣ 0..1 string see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... category SΣ 0..* CodeableConcept Categorization of document
Binding: DocumentEntry.classCode (preferred): High-level kind of a clinical document at a macro level.


.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed SΣ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
...... display SΣ 0..1 string see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:esanita SΣ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: https://www.esanita.ch
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Should be set if the document has to be uploaded to the EPD
Fixed Value: epd
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject Σ 0..1 Reference(CH Core Patient Profile | CH Core Practitioner Profile | Group | Device) Who/what is the subject of the document
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile | CH Core Organization Profile | Device | CH Core Patient Profile | RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile | CH Core Organization Profile) Who/what authenticated the document
... custodian 0..1 Reference(CH Core Organization Profile) Organization which maintains the document
... relatesTo Σ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ 1..1 Reference(CH Core DocumentReference Profile) Target of the relationship
... description Σ 0..1 string Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: DocumentEntry.confidentialityCode (preferred): Security Labels from the Healthcare Privacy and Security Classification System.


... content SΣ 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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


ch-docref-1: The following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: DocumentEntry.languageCode (preferred)
Example General: en-AU
..... data S 0..1 base64Binary Data inline, base64ed
..... url SΣ 0..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Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentEntry.formatCode (preferred): Document Format Codes.

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


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

.... practiceSetting 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (preferred): Additional details about where the content was created (e.g. clinical specialty).

.... sourcePatientInfo 0..1 Reference(CH Core Patient Profile) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.statusrequiredFixed Value: current
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
DocumentReference.typepreferredDocumentEntryTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categorypreferredDocumentEntryClassCode
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.securityLabelpreferredDocumentEntryConfidentialityCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredDocumentEntryLanguageCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatpreferredDocumentEntryFormatCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypepreferredDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingpreferredDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.practiceSettingCode

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
: exists()
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CHCoreDocumentReference

Summary

Mandatory: 1 element(7 nested mandatory elements)
Must-Support: 24 elements
Fixed: 5 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of DocumentReference.type.coding
  • The element 2 is sliced based on the values of DocumentReference.category.coding

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* CHCoreDocumentReference MedNet Interface (MNI) - DocumentReference
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred): Precise type of clinical document.

.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed SΣ 1..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code SΣ 1..1 code see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
...... display SΣ 0..1 string see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
... category SΣ 0..* CodeableConcept Categorization of document
Binding: DocumentEntry.classCode (preferred): High-level kind of a clinical document at a macro level.


.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed SΣ 0..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code SΣ 1..1 code see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
...... display SΣ 0..1 string see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
..... coding:esanita SΣ 0..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: https://www.esanita.ch
...... code SΣ 1..1 code Should be set if the document has to be uploaded to the EPD
Fixed Value: epd
... content SΣ 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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


ch-docref-1: The following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... data S 0..1 base64Binary Data inline, base64ed
..... url SΣ 0..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Σ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.statusrequiredFixed Value: current
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.typepreferredDocumentEntryTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categorypreferredDocumentEntryClassCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.classCode
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
: exists()
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from CHCoreDocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* CHCoreDocumentReference MedNet Interface (MNI) - DocumentReference
... id S 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... status S 1..1 code Fixed value: current
Fixed Value: current
... type S 0..1 CodeableConcept Kind of document (LOINC if possible)
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed S 1..* Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code S 1..1 code see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
...... display S 0..1 string see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed S 0..* Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code S 1..1 code see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
...... display S 0..1 string see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
..... coding:esanita S 0..* Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: https://www.esanita.ch
...... code S 1..1 code Should be set if the document has to be uploaded to the EPD
Fixed Value: epd
... content S 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.
..... data S 0..1 base64Binary Data inline, base64ed
..... url S 0..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 0..1 dateTime Date attachment was first created

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* CHCoreDocumentReference MedNet Interface (MNI) - DocumentReference
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier Σ 0..* Identifier Other identifiers for the document
... status ?!SΣ 1..1 code Fixed value: current
Binding: DocumentReferenceStatus (required): The status of the document reference.


Fixed Value: current
... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.

... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred): Precise type of clinical 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
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed SΣ 1..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
...... display SΣ 0..1 string see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... category SΣ 0..* CodeableConcept Categorization of document
Binding: DocumentEntry.classCode (preferred): High-level kind of a clinical document at a macro level.


.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed SΣ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
...... display SΣ 0..1 string see http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:esanita SΣ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: https://www.esanita.ch
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Should be set if the document has to be uploaded to the EPD
Fixed Value: epd
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject Σ 0..1 Reference(CH Core Patient Profile | CH Core Practitioner Profile | Group | Device) Who/what is the subject of the document
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile | CH Core Organization Profile | Device | CH Core Patient Profile | RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile | CH Core Organization Profile) Who/what authenticated the document
... custodian 0..1 Reference(CH Core Organization Profile) Organization which maintains the document
... relatesTo Σ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ 1..1 Reference(CH Core DocumentReference Profile) Target of the relationship
... description Σ 0..1 string Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: DocumentEntry.confidentialityCode (preferred): Security Labels from the Healthcare Privacy and Security Classification System.


... content SΣ 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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


ch-docref-1: The following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: DocumentEntry.languageCode (preferred)
Example General: en-AU
..... data S 0..1 base64Binary Data inline, base64ed
..... url SΣ 0..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Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentEntry.formatCode (preferred): Document Format Codes.

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


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

.... practiceSetting 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (preferred): Additional details about where the content was created (e.g. clinical specialty).

.... sourcePatientInfo 0..1 Reference(CH Core Patient Profile) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.statusrequiredFixed Value: current
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
DocumentReference.typepreferredDocumentEntryTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.typeCode
DocumentReference.categorypreferredDocumentEntryClassCode
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.securityLabelpreferredDocumentEntryConfidentialityCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.confidentialityCode
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content.attachment.languagepreferredDocumentEntryLanguageCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.languageCode
DocumentReference.content.formatpreferredDocumentEntryFormatCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.formatCode
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypepreferredDocumentEntryHealthcareFacilityTypeCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode
DocumentReference.context.practiceSettingpreferredDocumentEntryPracticeSettingCode
http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.practiceSettingCode

Constraints

IdGradePath(s)DetailsRequirements
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
: exists()
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CHCoreDocumentReference

Summary

Mandatory: 1 element(7 nested mandatory elements)
Must-Support: 24 elements
Fixed: 5 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of DocumentReference.type.coding
  • The element 2 is sliced based on the values of DocumentReference.category.coding

 

Other representations of profile: CSV, Excel, Schematron