MedNet interface implementation guide
0.20.0 - CI Build

MedNet interface implementation guide - Downloaded Version 0.20.0 See the Directory of published versions

Resource Profile: MedNet Interface (MNI) - DocumentReference

Official URL: https://mednet.swiss/fhir/StructureDefinition/mni-documentReference Version: 0.20.0
Active as of 2025-12-19 Computable Name: MNIDocumentReference

Copyright/Legal: novcom AG

MedNet Interface (MNI) - DocumentReference Profile

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
Binding: DocumentReferenceStatus (required): The status of the document reference.
Fixed Value: current
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred)
.... Slices for coding Σ 1..* 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
.... 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.
Constraints: ch-docref-1
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

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred DocumentEntry.typeCode 📦3.3.0 CH Term v3.3
DocumentReference.category Base preferred DocumentEntry.classCode 📦3.3.0 CH Term v3.3
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ch-docref-1 warning DocumentReference.content.attachment.contentType The 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')
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If 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-4 error DocumentReference If 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-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CHCoreDocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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..0 A set of rules under which this content was created
... modifierExtension 0..0 Extension
... type S 0..1 CodeableConcept Kind of document (LOINC if possible)
.... Slices for coding 1..* 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
.... 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 & Constraints    Filter: Filtersdoco
.. 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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)
.... 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 Σ 1..* 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)
.... 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 | CH Core Practitioner | 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 | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | CH Core RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) Who/what authenticated the document
... custodian 0..1 Reference(CH Core Organization) 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) Target of the relationship
... description Σ 0..1 string Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: DocumentEntry.confidentialityCode (extensible)
... 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.
Constraints: ch-docref-1
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)
... 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 | 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)
.... practiceSetting 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (preferred)
.... sourcePatientInfo 0..1 Reference(CH Core Patient) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred DocumentEntry.typeCode 📦3.3.0 CH Term v3.3
DocumentReference.category Base preferred DocumentEntry.classCode 📦3.3.0 CH Term v3.3
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible DocumentEntry.confidentialityCode 📦3.3.0 CH Term v3.3
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred DocumentEntry.languageCode 📦3.3.0 CH Term v3.3
DocumentReference.content.​format Base preferred DocumentEntry.formatCode 📦3.3.0 CH Term v3.3
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.0
DocumentReference.context.​facilityType Base preferred DocumentEntry.healthcareFacilityTypeCode 📦3.3.0 CH Term v3.3
DocumentReference.context.​practiceSetting Base preferred DocumentEntry.practiceSettingCode 📦3.3.0 CH Term v3.3

Constraints

Id Grade Path(s) Description Expression
ch-docref-1 warning DocumentReference.content.attachment.contentType The 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')
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If 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-4 error DocumentReference If 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-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CHCoreDocumentReference

Summary

Mandatory: 1 element(8 nested mandatory elements)
Must-Support: 24 elements
Fixed: 5 elements
Prohibited: 2 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 & Constraints    Filter: Filtersdoco
.. 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
Binding: DocumentReferenceStatus (required): The status of the document reference.
Fixed Value: current
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred)
.... Slices for coding Σ 1..* 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
.... 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.
Constraints: ch-docref-1
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

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred DocumentEntry.typeCode 📦3.3.0 CH Term v3.3
DocumentReference.category Base preferred DocumentEntry.classCode 📦3.3.0 CH Term v3.3
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ch-docref-1 warning DocumentReference.content.attachment.contentType The 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')
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If 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-4 error DocumentReference If 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-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from CHCoreDocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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..0 A set of rules under which this content was created
... modifierExtension 0..0 Extension
... type S 0..1 CodeableConcept Kind of document (LOINC if possible)
.... Slices for coding 1..* 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
.... 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 & Constraints    Filter: Filtersdoco
.. 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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)
.... 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 Σ 1..* 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)
.... 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 | CH Core Practitioner | 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 | CH Core PractitionerRole | CH Core Organization | Device | CH Core Patient | CH Core RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) Who/what authenticated the document
... custodian 0..1 Reference(CH Core Organization) 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) Target of the relationship
... description Σ 0..1 string Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: DocumentEntry.confidentialityCode (extensible)
... 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.
Constraints: ch-docref-1
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)
... 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 | 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)
.... practiceSetting 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: DocumentEntry.practiceSettingCode (preferred)
.... sourcePatientInfo 0..1 Reference(CH Core Patient) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred DocumentEntry.typeCode 📦3.3.0 CH Term v3.3
DocumentReference.category Base preferred DocumentEntry.classCode 📦3.3.0 CH Term v3.3
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible DocumentEntry.confidentialityCode 📦3.3.0 CH Term v3.3
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred DocumentEntry.languageCode 📦3.3.0 CH Term v3.3
DocumentReference.content.​format Base preferred DocumentEntry.formatCode 📦3.3.0 CH Term v3.3
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.0
DocumentReference.context.​facilityType Base preferred DocumentEntry.healthcareFacilityTypeCode 📦3.3.0 CH Term v3.3
DocumentReference.context.​practiceSetting Base preferred DocumentEntry.practiceSettingCode 📦3.3.0 CH Term v3.3

Constraints

Id Grade Path(s) Description Expression
ch-docref-1 warning DocumentReference.content.attachment.contentType The 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')
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If 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-4 error DocumentReference If 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-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CHCoreDocumentReference

Summary

Mandatory: 1 element(8 nested mandatory elements)
Must-Support: 24 elements
Fixed: 5 elements
Prohibited: 2 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