MedNet interface implementation guide
0.15.0 - CI Build

MedNet interface implementation guide - Local Development build (v0.15.0). See the Directory of published versions

Resource Profile: MedNet Interface (MNI) - DocumentReference

Official URL: https://mednet.swiss/fhir/StructureDefinition/mni-documentReference Version: 0.15.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.

This structure is derived from CHCoreDocumentReference

Summary

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

Slices

This structure defines the following Slices:

  • The element DocumentReference.type.coding is sliced based on the values of value:system, value:code
  • The element DocumentReference.category.coding is sliced based on the values of value:system, value:code

This structure is derived from CHCoreDocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*CHCoreDocumentReferenceMedNet Interface (MNI) - DocumentReference
... id S0..1stringThe 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 S1..1codeFixed value: current
Fixed Value: current
... type S0..1CodeableConceptKind of document (LOINC if possible)
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed S1..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code S1..1codesee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
...... display S0..1stringsee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed S0..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code S1..1codesee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
...... display S0..1stringsee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
..... coding:esanita S0..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: https://www.esanita.ch
...... code S1..1codeShould be set if the document has to be uploaded to the EPD
Fixed Value: epd
... content S1..*BackboneElementDocument referenced
.... attachment S1..1AttachmentWhere to access the document
..... contentType S1..1codeMime type of the content, with charset etc.
..... data S0..1base64BinaryData inline, base64ed
..... url S0..1urlUri where the data can be found
..... size S0..1unsignedIntNumber of bytes of content (if url provided)
..... hash S0..1base64BinaryHash of the data (sha-1, base64ed)
..... title S0..1stringLabel to display in place of the data
..... creation S0..1dateTimeDate attachment was first created

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*CHCoreDocumentReferenceMedNet Interface (MNI) - DocumentReference
... id SΣ0..1stringThe 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..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier Σ0..1IdentifierMaster Version Specific Identifier
... identifier Σ0..*IdentifierOther identifiers for the document
... status ?!SΣ1..1codeFixed value: current
Binding: DocumentReferenceStatus (required): The status of the document reference.


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

... type SΣ0..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred): Precise type of clinical document.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed SΣ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codesee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
...... display SΣ0..1stringsee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... category SΣ0..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (preferred): High-level kind of a clinical document at a macro level.


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed SΣ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codesee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
...... display SΣ0..1stringsee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:esanita SΣ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://www.esanita.ch
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeShould be set if the document has to be uploaded to the EPD
Fixed Value: epd
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject Σ0..1Reference(CH Core Patient Profile | CH Core Practitioner Profile | Group | Device)Who/what is the subject of the document
... date Σ0..1instantWhen 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..1Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile | CH Core Organization Profile)Who/what authenticated the document
... custodian 0..1Reference(CH Core Organization Profile)Organization which maintains the document
... relatesTo Σ0..*BackboneElementRelationships to other documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

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


... content SΣ1..*BackboneElementDocument referenced
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment SΣ1..1AttachmentWhere to access the document
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣI1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (preferred)
Example General: en-AU
..... data S0..1base64BinaryData inline, base64ed
..... url SΣ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash SΣ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title SΣ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ0..1dateTimeDate attachment was first created
.... format Σ0..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (preferred): Document Format Codes.

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


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

.... practiceSetting 0..1CodeableConceptAdditional 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..1Reference(CH Core Patient Profile)Patient demographics from source
.... related 0..*Reference(Resource)Related identifiers or resources

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*CHCoreDocumentReferenceMedNet Interface (MNI) - DocumentReference
... id Σ0..1stringThe 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 ?!Σ1..1codeFixed value: current
Binding: DocumentReferenceStatus (required): The status of the document reference.


Fixed Value: current
... type Σ0..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred): Precise type of clinical document.

.... coding:snomed Σ1..*CodingCode defined by a terminology system
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code Σ1..1codesee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
..... display Σ0..1stringsee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
.... coding:snomed Σ0..*CodingCode defined by a terminology system
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code Σ1..1codesee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
..... display Σ0..1stringsee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
.... coding:esanita Σ0..*CodingCode defined by a terminology system
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://www.esanita.ch
..... code Σ1..1codeShould be set if the document has to be uploaded to the EPD
Fixed Value: epd
... content Σ1..*BackboneElementDocument referenced
.... attachment Σ1..1AttachmentWhere to access the document
..... contentType ΣI1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

..... data 0..1base64BinaryData inline, base64ed
..... url Σ0..1urlUri where the data can be found
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
..... creation Σ0..1dateTimeDate attachment was first created

doco Documentation for this format

This structure is derived from CHCoreDocumentReference

Summary

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

Slices

This structure defines the following Slices:

  • The element DocumentReference.type.coding is sliced based on the values of value:system, value:code
  • The element DocumentReference.category.coding is sliced based on the values of value:system, value:code

Differential View

This structure is derived from CHCoreDocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*CHCoreDocumentReferenceMedNet Interface (MNI) - DocumentReference
... id S0..1stringThe 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 S1..1codeFixed value: current
Fixed Value: current
... type S0..1CodeableConceptKind of document (LOINC if possible)
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed S1..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code S1..1codesee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
...... display S0..1stringsee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed S0..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code S1..1codesee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
...... display S0..1stringsee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
..... coding:esanita S0..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: https://www.esanita.ch
...... code S1..1codeShould be set if the document has to be uploaded to the EPD
Fixed Value: epd
... content S1..*BackboneElementDocument referenced
.... attachment S1..1AttachmentWhere to access the document
..... contentType S1..1codeMime type of the content, with charset etc.
..... data S0..1base64BinaryData inline, base64ed
..... url S0..1urlUri where the data can be found
..... size S0..1unsignedIntNumber of bytes of content (if url provided)
..... hash S0..1base64BinaryHash of the data (sha-1, base64ed)
..... title S0..1stringLabel to display in place of the data
..... creation S0..1dateTimeDate attachment was first created

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*CHCoreDocumentReferenceMedNet Interface (MNI) - DocumentReference
... id SΣ0..1stringThe 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..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier Σ0..1IdentifierMaster Version Specific Identifier
... identifier Σ0..*IdentifierOther identifiers for the document
... status ?!SΣ1..1codeFixed value: current
Binding: DocumentReferenceStatus (required): The status of the document reference.


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

... type SΣ0..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentEntry.typeCode (preferred): Precise type of clinical document.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed SΣ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codesee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
...... display SΣ0..1stringsee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.typeCode.html
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... category SΣ0..*CodeableConceptCategorization of document
Binding: DocumentEntry.classCode (preferred): High-level kind of a clinical document at a macro level.


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:snomed SΣ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codesee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
...... display SΣ0..1stringsee http://fhir.ch/ig/ch-epr-term/ValueSet-DocumentEntry.classCode.html
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:esanita SΣ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://www.esanita.ch
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeShould be set if the document has to be uploaded to the EPD
Fixed Value: epd
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject Σ0..1Reference(CH Core Patient Profile | CH Core Practitioner Profile | Group | Device)Who/what is the subject of the document
... date Σ0..1instantWhen 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..1Reference(CH Core Practitioner Profile | CH Core Practitioner Role Profile | CH Core Organization Profile)Who/what authenticated the document
... custodian 0..1Reference(CH Core Organization Profile)Organization which maintains the document
... relatesTo Σ0..*BackboneElementRelationships to other documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

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


... content SΣ1..*BackboneElementDocument referenced
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment SΣ1..1AttachmentWhere to access the document
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣI1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: DocumentEntry.languageCode (preferred)
Example General: en-AU
..... data S0..1base64BinaryData inline, base64ed
..... url SΣ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash SΣ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title SΣ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ0..1dateTimeDate attachment was first created
.... format Σ0..1CodingFormat/content rules for the document
Binding: DocumentEntry.formatCode (preferred): Document Format Codes.

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


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

.... practiceSetting 0..1CodeableConceptAdditional 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..1Reference(CH Core Patient Profile)Patient demographics from source
.... related 0..*Reference(Resource)Related identifiers or resources

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
DocumentReference.languagepreferredCommonLanguages
Max Binding: AllLanguages
DocumentReference.statusrequiredFixed Value: current
DocumentReference.docStatusrequiredCompositionStatus
DocumentReference.typepreferredDocumentEntryTypeCode
DocumentReference.categorypreferredDocumentEntryClassCode
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
DocumentReference.securityLabelpreferredDocumentEntryConfidentialityCode
DocumentReference.content.attachment.contentTyperequiredMime Types
DocumentReference.content.attachment.languagepreferredDocumentEntryLanguageCode
DocumentReference.content.formatpreferredDocumentEntryFormatCode
DocumentReference.context.eventexampleActCode
DocumentReference.context.facilityTypepreferredDocumentEntryHealthcareFacilityTypeCode
DocumentReference.context.practiceSettingpreferredDocumentEntryPracticeSettingCode

Constraints

IdGradePathDetailsRequirements
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-1errorDocumentReference.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.masterIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.docStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.type.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.type.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.type.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.type.coding:snomedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.type.coding:snomed.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.type.coding:snomed.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.type.coding:snomed.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.type.coding:snomed.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.type.coding:snomed.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.type.coding:snomed.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.type.coding:snomed.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.type.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.category.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.category.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.category.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.category.coding:snomedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.category.coding:snomed.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.category.coding:snomed.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.category.coding:snomed.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.category.coding:snomed.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.category.coding:snomed.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.category.coding:snomed.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.category.coding:snomed.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.category.coding:esanitaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.category.coding:esanita.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.category.coding:esanita.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.category.coding:esanita.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.category.coding:esanita.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.category.coding:esanita.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.category.coding:esanita.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.category.coding:esanita.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.category.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.authenticatorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.custodianAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.relatesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.relatesTo.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.relatesTo.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.relatesTo.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.relatesTo.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.relatesTo.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.relatesTo.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.securityLabelAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.contentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.content.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.content.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.content.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.content.attachmentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content.attachment.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.content.attachment.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.content.attachment.contentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ch-docref-1warningDocumentReference.content.attachment.contentTypeThe following ValueSet is preferred: http://fhir.ch/ig/ch-epr-term/ValueSet/DocumentEntry.mimeType
: exists()
ele-1errorDocumentReference.content.attachment.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content.attachment.dataAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content.attachment.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content.attachment.sizeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content.attachment.hashAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content.attachment.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content.attachment.creationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content.formatAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.contextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.context.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.context.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.context.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.context.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.context.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.context.eventAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.context.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.context.facilityTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.context.practiceSettingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.context.sourcePatientInfoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.context.relatedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())