CH EMED EPR
1.0.0 - trial-use Switzerland flag

This page is part of the FHIR eMedication exchange formats for the implementation effort of CARA within its EPR community (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: MTP Document

Official URL: http://fhir.ch/ig/ch-emed-epr/StructureDefinition/ch-emed-epr-document-medicationtreatmentplan Version: 1.0.0
Draft as of 2024-01-26 Computable Name: CHEMEDEPRDocumentMedicationTreatmentPlan

Copyright/Legal: CC0-1.0

Definition of the bundle for the medication treatment plan document

Usage:

Formal Views of Profile Content

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

This structure is derived from CHEMEDDocumentMedicationTreatmentPlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*CHEMEDDocumentMedicationTreatmentPlanCH EMED Medication Treatment Plan Document
bundle-composition-same-id: The bundle and the composition resources must have the same identifier.
... id D0..1id✕ This element is not supported
... meta
.... extension D0..*Extension✕ This element is not supported
.... versionId D0..1id✕ This element is not supported
.... lastUpdated D0..1instant✕ This element is not supported
.... source D0..1uri✕ This element is not supported
.... security D0..*Coding✕ This element is not supported
.... tag D0..*Coding✕ This element is not supported
... implicitRules 0..0
... identifier
.... extension D0..*Extension✕ This element is not supported
.... use 0..1codeusual | official | temp | secondary | old (If known)
Required Pattern: official
.... type D0..1CodeableConcept✕ This element is not supported
.... value C1..1stringThe value that is unique
urn-uuid-invariant: The value shall be an URN-encoded UUID ('urn:uuid:00000000-0000-0000-0000-000000000000')
.... period D0..1Period✕ This element is not supported
.... assigner D0..1Reference(CH EMED EPR Organization)✕ This element is not supported
... total 0..0
... link D0..*BackboneElement✕ This element is not supported
... entry 3..*BackboneElementEntry in the bundle - will have a resource or information
.... id D0..1string✕ This element is not supported
.... modifierExtension 0..0
.... link 0..0
.... fullUrl 1..1uriURN-encoded UUID for resource
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Composition 1..1BackboneElementMedication treatment plan composition
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1CHEMEDEPRCompositionMedicationTreatmentPlanCH EMED Medication Treatment Plan Composition
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Patient 1..*BackboneElementThe patient targeted by this medication treatment plan
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1CHEMEDEPRPatientCH Core Patient EPR (to include the patient in an EPR document)
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Practitioner 0..*BackboneElementEntry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1CHEMEDEPRPractitionerCH EMED Practitioner
.... search 0..0
.... request 0..0
.... response 0..0
... entry:PractitionerRole 0..*BackboneElementEntry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1CHEMEDEPRPractitionerRoleCH EMED PractitionerRole
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Organization 0..*BackboneElementEntry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1CHEMEDEPROrganizationCH EMED Organization
.... search 0..0
.... request 0..0
.... response 0..0
... entry:RelatedPerson 0..*BackboneElementEntry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Device 0..*BackboneElementEntry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Encounter D0..*BackboneElement✕ This element is not supported
.... modifierExtension 0..0
.... link 0..0
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Location D0..*BackboneElement✕ This element is not supported
.... modifierExtension 0..0
.... link 0..0
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Binary 0..*BackboneElementEntry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... search 0..0
.... request 0..0
.... response 0..0
... entry:MedicationStatement 1..*BackboneElementDetails about the medication introduced in the treatment plan
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1CHEMEDEPRMedicationStatementCH EMED MedicationStatement (MTP and basis)
.... search 0..0
.... request 0..0
.... response 0..0
... entry:ObsBodyWeight 0..1BackboneElementEntry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1CHEMEDEPRObservationBodyWeightMeasurements and simple assertions
.... search 0..0
.... request 0..0
.... response 0..0
... signature D0..1Signature✕ This element is not supported

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
bundle-composition-same-iderrorBundleThe bundle and the composition resources must have the same identifier.
: identifier.single() = entry[0].resource.identifier.single()
urn-uuid-invarianterrorBundle.identifier.valueThe value shall be an URN-encoded UUID ('urn:uuid:00000000-0000-0000-0000-000000000000')
: $this.matches('^urn:uuid:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*CHEMEDDocumentMedicationTreatmentPlanCH EMED Medication Treatment Plan Document
bundle-composition-same-id: The bundle and the composition resources must have the same identifier.
... id Σ0..1id✕ This element is not supported
... language 0..1code✕ This element is not supported
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... identifier Σ1..1IdentifierPersistent identifier for the bundle
.... extension 0..*Extension✕ This element is not supported
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
.... type Σ0..1CodeableConcept✕ This element is not supported
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value ΣC1..1stringThe value that is unique
urn-uuid-invariant: The value shall be an URN-encoded UUID ('urn:uuid:00000000-0000-0000-0000-000000000000')
Example General: 123456
Example CH Core: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
.... period Σ0..1Period✕ This element is not supported
.... assigner Σ0..1Reference(CH EMED EPR Organization)✕ This element is not supported
... timestamp Σ1..1instantThe document's creation date and time
... link Σ0..*BackboneElement✕ This element is not supported
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... Slices for entry ΣC3..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... id 0..1string✕ This element is not supported
..... fullUrl ΣC1..1uriURN-encoded UUID for resource
.... entry:Composition ΣC1..1BackboneElementMedication treatment plan composition
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource 1..1CHEMEDEPRCompositionMedicationTreatmentPlanCH EMED Medication Treatment Plan Composition
.... entry:Patient ΣC1..*BackboneElementThe patient targeted by this medication treatment plan
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource C1..1CHEMEDEPRPatientCH Core Patient EPR (to include the patient in an EPR document)
.... entry:Practitioner ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource C1..1CHEMEDEPRPractitionerCH EMED Practitioner
.... entry:PractitionerRole ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource 1..1CHEMEDEPRPractitionerRoleCH EMED PractitionerRole
.... entry:Organization ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource C1..1CHEMEDEPROrganizationCH EMED Organization
.... entry:RelatedPerson ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource 1..1RelatedPersonA person that is related to a patient, but who is not a direct target of care
.... entry:Device ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource 1..1DeviceItem used in healthcare
.... entry:Encounter ΣC0..*BackboneElement✕ This element is not supported
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource 1..1CHCoreEncounterCH Core Encounter
.... entry:Location ΣC0..*BackboneElement✕ This element is not supported
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource 1..1CHCoreLocationCH Core Location
.... entry:Binary ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... fullUrl ΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1BinaryPure binary content defined by a format other than FHIR
.... entry:MedicationStatement ΣC1..*BackboneElementDetails about the medication introduced in the treatment plan
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... fullUrl ΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1CHEMEDEPRMedicationStatementCH EMED MedicationStatement (MTP and basis)
.... entry:ObsBodyWeight ΣC0..1BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... fullUrl ΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource C1..1CHEMEDEPRObservationBodyWeightMeasurements and simple assertions
... signature Σ0..1Signature✕ This element is not supported

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bundle.identifier.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Bundle.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Bundle.typerequiredFixed Value: document
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Composition.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Patient.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Practitioner.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:PractitionerRole.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Organization.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:RelatedPerson.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Device.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Encounter.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Location.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Binary.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:MedicationStatement.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:ObsBodyWeight.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Organization, Bundle.entry:RelatedPerson, Bundle.entry:Device, Bundle.entry:Encounter, Bundle.entry:Location, Bundle.entry:Binary, Bundle.entry:MedicationStatement, Bundle.entry:ObsBodyWeightmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Organization, Bundle.entry:RelatedPerson, Bundle.entry:Device, Bundle.entry:Encounter, Bundle.entry:Location, Bundle.entry:Binary, Bundle.entry:MedicationStatement, Bundle.entry:ObsBodyWeightfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
bundle-composition-same-iderrorBundleThe bundle and the composition resources must have the same identifier.
: identifier.single() = entry[0].resource.identifier.single()
ch-core-doc-1errorBundle.entry.fullUrl, Bundle.entry:Binary.fullUrl, Bundle.entry:MedicationStatement.fullUrl, Bundle.entry:ObsBodyWeight.fullUrlThe fullUrl must be an absolute URL server address or an UUID
: startsWith('http') or startsWith('urn:uuid:') = true
ch-core-doc-2errorBundle.identifier.valueThe identifier must be an UUID
: startsWith('urn:uuid:')
ch-pat-1errorBundle.entry:Patient.resourceAt least one HumanName with given and family name must be provided.
: name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-2warningBundle.entry:Patient.resourcegender unknown is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
ch-pract-1errorBundle.entry:Practitioner.resourceIf a HumanName is provided, at least one HumanName must have a given and family name.
: name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pract-2warningBundle.entry:Practitioner.resourcegender unknown is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
dom-2errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf 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-4errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf 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-5errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceA 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()
obs-6errorBundle.entry:ObsBodyWeight.resourcedataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorBundle.entry:ObsBodyWeight.resourceIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
org-1errorBundle.entry:Organization.resourceThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
urn-uuid-invarianterrorBundle.identifier.valueThe value shall be an URN-encoded UUID ('urn:uuid:00000000-0000-0000-0000-000000000000')
: $this.matches('^urn:uuid:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*CHEMEDDocumentMedicationTreatmentPlanCH EMED Medication Treatment Plan Document
bundle-composition-same-id: The bundle and the composition resources must have the same identifier.
... id Σ0..1id✕ This element is not supported
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*Extension✕ This element is not supported
Slice: Unordered, Open by value:url
.... versionId Σ0..1id✕ This element is not supported
.... lastUpdated Σ0..1instant✕ This element is not supported
.... source Σ0..1uri✕ This element is not supported
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*Coding✕ This element is not supported
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*Coding✕ This element is not supported
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... language 0..1code✕ This element is not supported
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*Extension✕ This element is not supported
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
.... type Σ0..1CodeableConcept✕ This element is not supported
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value ΣC1..1stringThe value that is unique
urn-uuid-invariant: The value shall be an URN-encoded UUID ('urn:uuid:00000000-0000-0000-0000-000000000000')
Example General: 123456
Example CH Core: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
.... period Σ0..1Period✕ This element is not supported
.... assigner Σ0..1Reference(CH EMED EPR Organization)✕ This element is not supported
... type Σ1..1codedocument
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Fixed Value: document
... timestamp Σ1..1instantThe document's creation date and time
... link Σ0..*BackboneElement✕ This element is not supported
.... 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
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... Slices for entry ΣC3..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... id 0..1string✕ This element is not supported
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl ΣC1..1uriURN-encoded UUID for resource
..... resource Σ0..1ResourceA resource in the bundle
.... entry:Composition ΣC1..1BackboneElementMedication treatment plan composition
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1CHEMEDEPRCompositionMedicationTreatmentPlanCH EMED Medication Treatment Plan Composition
.... entry:Patient ΣC1..*BackboneElementThe patient targeted by this medication treatment plan
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource C1..1CHEMEDEPRPatientCH Core Patient EPR (to include the patient in an EPR document)
.... entry:Practitioner ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource C1..1CHEMEDEPRPractitionerCH EMED Practitioner
.... entry:PractitionerRole ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1CHEMEDEPRPractitionerRoleCH EMED PractitionerRole
.... entry:Organization ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource C1..1CHEMEDEPROrganizationCH EMED Organization
.... entry:RelatedPerson ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1RelatedPersonA person that is related to a patient, but who is not a direct target of care
.... entry:Device ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1DeviceItem used in healthcare
.... entry:Encounter ΣC0..*BackboneElement✕ This element is not supported
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1CHCoreEncounterCH Core Encounter
.... entry:Location ΣC0..*BackboneElement✕ This element is not supported
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1CHCoreLocationCH Core Location
.... entry:Binary ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl ΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1BinaryPure binary content defined by a format other than FHIR
.... entry:MedicationStatement ΣC1..*BackboneElementDetails about the medication introduced in the treatment plan
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl ΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1CHEMEDEPRMedicationStatementCH EMED MedicationStatement (MTP and basis)
.... entry:ObsBodyWeight ΣC0..1BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl ΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource C1..1CHEMEDEPRObservationBodyWeightMeasurements and simple assertions
... signature Σ0..1Signature✕ This element is not supported

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Bundle.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bundle.identifier.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Bundle.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Bundle.typerequiredFixed Value: document
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Composition.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Composition.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Patient.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Patient.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Practitioner.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Practitioner.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:PractitionerRole.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:PractitionerRole.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Organization.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Organization.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:RelatedPerson.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:RelatedPerson.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Device.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Device.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Encounter.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Encounter.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Location.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Location.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Binary.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Binary.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:MedicationStatement.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:MedicationStatement.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:ObsBodyWeight.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:ObsBodyWeight.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Organization, Bundle.entry:RelatedPerson, Bundle.entry:Device, Bundle.entry:Encounter, Bundle.entry:Location, Bundle.entry:Binary, Bundle.entry:MedicationStatement, Bundle.entry:ObsBodyWeightmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Organization, Bundle.entry:RelatedPerson, Bundle.entry:Device, Bundle.entry:Encounter, Bundle.entry:Location, Bundle.entry:Binary, Bundle.entry:MedicationStatement, Bundle.entry:ObsBodyWeightfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
bundle-composition-same-iderrorBundleThe bundle and the composition resources must have the same identifier.
: identifier.single() = entry[0].resource.identifier.single()
ch-core-doc-1errorBundle.entry.fullUrl, Bundle.entry:Binary.fullUrl, Bundle.entry:MedicationStatement.fullUrl, Bundle.entry:ObsBodyWeight.fullUrlThe fullUrl must be an absolute URL server address or an UUID
: startsWith('http') or startsWith('urn:uuid:') = true
ch-core-doc-2errorBundle.identifier.valueThe identifier must be an UUID
: startsWith('urn:uuid:')
ch-pat-1errorBundle.entry:Patient.resourceAt least one HumanName with given and family name must be provided.
: name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-2warningBundle.entry:Patient.resourcegender unknown is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
ch-pract-1errorBundle.entry:Practitioner.resourceIf a HumanName is provided, at least one HumanName must have a given and family name.
: name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pract-2warningBundle.entry:Practitioner.resourcegender unknown is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
dom-2errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf 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-4errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf 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-5errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceA 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()
obs-6errorBundle.entry:ObsBodyWeight.resourcedataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorBundle.entry:ObsBodyWeight.resourceIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
org-1errorBundle.entry:Organization.resourceThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
urn-uuid-invarianterrorBundle.identifier.valueThe value shall be an URN-encoded UUID ('urn:uuid:00000000-0000-0000-0000-000000000000')
: $this.matches('^urn:uuid:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$')

Differential View

This structure is derived from CHEMEDDocumentMedicationTreatmentPlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*CHEMEDDocumentMedicationTreatmentPlanCH EMED Medication Treatment Plan Document
bundle-composition-same-id: The bundle and the composition resources must have the same identifier.
... id D0..1id✕ This element is not supported
... meta
.... extension D0..*Extension✕ This element is not supported
.... versionId D0..1id✕ This element is not supported
.... lastUpdated D0..1instant✕ This element is not supported
.... source D0..1uri✕ This element is not supported
.... security D0..*Coding✕ This element is not supported
.... tag D0..*Coding✕ This element is not supported
... implicitRules 0..0
... identifier
.... extension D0..*Extension✕ This element is not supported
.... use 0..1codeusual | official | temp | secondary | old (If known)
Required Pattern: official
.... type D0..1CodeableConcept✕ This element is not supported
.... value C1..1stringThe value that is unique
urn-uuid-invariant: The value shall be an URN-encoded UUID ('urn:uuid:00000000-0000-0000-0000-000000000000')
.... period D0..1Period✕ This element is not supported
.... assigner D0..1Reference(CH EMED EPR Organization)✕ This element is not supported
... total 0..0
... link D0..*BackboneElement✕ This element is not supported
... entry 3..*BackboneElementEntry in the bundle - will have a resource or information
.... id D0..1string✕ This element is not supported
.... modifierExtension 0..0
.... link 0..0
.... fullUrl 1..1uriURN-encoded UUID for resource
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Composition 1..1BackboneElementMedication treatment plan composition
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1CHEMEDEPRCompositionMedicationTreatmentPlanCH EMED Medication Treatment Plan Composition
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Patient 1..*BackboneElementThe patient targeted by this medication treatment plan
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1CHEMEDEPRPatientCH Core Patient EPR (to include the patient in an EPR document)
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Practitioner 0..*BackboneElementEntry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1CHEMEDEPRPractitionerCH EMED Practitioner
.... search 0..0
.... request 0..0
.... response 0..0
... entry:PractitionerRole 0..*BackboneElementEntry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1CHEMEDEPRPractitionerRoleCH EMED PractitionerRole
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Organization 0..*BackboneElementEntry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1CHEMEDEPROrganizationCH EMED Organization
.... search 0..0
.... request 0..0
.... response 0..0
... entry:RelatedPerson 0..*BackboneElementEntry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Device 0..*BackboneElementEntry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Encounter D0..*BackboneElement✕ This element is not supported
.... modifierExtension 0..0
.... link 0..0
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Location D0..*BackboneElement✕ This element is not supported
.... modifierExtension 0..0
.... link 0..0
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Binary 0..*BackboneElementEntry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... search 0..0
.... request 0..0
.... response 0..0
... entry:MedicationStatement 1..*BackboneElementDetails about the medication introduced in the treatment plan
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1CHEMEDEPRMedicationStatementCH EMED MedicationStatement (MTP and basis)
.... search 0..0
.... request 0..0
.... response 0..0
... entry:ObsBodyWeight 0..1BackboneElementEntry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1CHEMEDEPRObservationBodyWeightMeasurements and simple assertions
.... search 0..0
.... request 0..0
.... response 0..0
... signature D0..1Signature✕ This element is not supported

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
bundle-composition-same-iderrorBundleThe bundle and the composition resources must have the same identifier.
: identifier.single() = entry[0].resource.identifier.single()
urn-uuid-invarianterrorBundle.identifier.valueThe value shall be an URN-encoded UUID ('urn:uuid:00000000-0000-0000-0000-000000000000')
: $this.matches('^urn:uuid:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*CHEMEDDocumentMedicationTreatmentPlanCH EMED Medication Treatment Plan Document
bundle-composition-same-id: The bundle and the composition resources must have the same identifier.
... id Σ0..1id✕ This element is not supported
... language 0..1code✕ This element is not supported
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... identifier Σ1..1IdentifierPersistent identifier for the bundle
.... extension 0..*Extension✕ This element is not supported
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
.... type Σ0..1CodeableConcept✕ This element is not supported
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value ΣC1..1stringThe value that is unique
urn-uuid-invariant: The value shall be an URN-encoded UUID ('urn:uuid:00000000-0000-0000-0000-000000000000')
Example General: 123456
Example CH Core: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
.... period Σ0..1Period✕ This element is not supported
.... assigner Σ0..1Reference(CH EMED EPR Organization)✕ This element is not supported
... timestamp Σ1..1instantThe document's creation date and time
... link Σ0..*BackboneElement✕ This element is not supported
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... Slices for entry ΣC3..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... id 0..1string✕ This element is not supported
..... fullUrl ΣC1..1uriURN-encoded UUID for resource
.... entry:Composition ΣC1..1BackboneElementMedication treatment plan composition
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource 1..1CHEMEDEPRCompositionMedicationTreatmentPlanCH EMED Medication Treatment Plan Composition
.... entry:Patient ΣC1..*BackboneElementThe patient targeted by this medication treatment plan
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource C1..1CHEMEDEPRPatientCH Core Patient EPR (to include the patient in an EPR document)
.... entry:Practitioner ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource C1..1CHEMEDEPRPractitionerCH EMED Practitioner
.... entry:PractitionerRole ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource 1..1CHEMEDEPRPractitionerRoleCH EMED PractitionerRole
.... entry:Organization ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource C1..1CHEMEDEPROrganizationCH EMED Organization
.... entry:RelatedPerson ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource 1..1RelatedPersonA person that is related to a patient, but who is not a direct target of care
.... entry:Device ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource 1..1DeviceItem used in healthcare
.... entry:Encounter ΣC0..*BackboneElement✕ This element is not supported
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource 1..1CHCoreEncounterCH Core Encounter
.... entry:Location ΣC0..*BackboneElement✕ This element is not supported
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... resource 1..1CHCoreLocationCH Core Location
.... entry:Binary ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... fullUrl ΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1BinaryPure binary content defined by a format other than FHIR
.... entry:MedicationStatement ΣC1..*BackboneElementDetails about the medication introduced in the treatment plan
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... fullUrl ΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1CHEMEDEPRMedicationStatementCH EMED MedicationStatement (MTP and basis)
.... entry:ObsBodyWeight ΣC0..1BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... fullUrl ΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource C1..1CHEMEDEPRObservationBodyWeightMeasurements and simple assertions
... signature Σ0..1Signature✕ This element is not supported

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bundle.identifier.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Bundle.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Bundle.typerequiredFixed Value: document
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Composition.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Patient.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Practitioner.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:PractitionerRole.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Organization.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:RelatedPerson.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Device.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Encounter.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Location.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Binary.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:MedicationStatement.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:ObsBodyWeight.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Organization, Bundle.entry:RelatedPerson, Bundle.entry:Device, Bundle.entry:Encounter, Bundle.entry:Location, Bundle.entry:Binary, Bundle.entry:MedicationStatement, Bundle.entry:ObsBodyWeightmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Organization, Bundle.entry:RelatedPerson, Bundle.entry:Device, Bundle.entry:Encounter, Bundle.entry:Location, Bundle.entry:Binary, Bundle.entry:MedicationStatement, Bundle.entry:ObsBodyWeightfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
bundle-composition-same-iderrorBundleThe bundle and the composition resources must have the same identifier.
: identifier.single() = entry[0].resource.identifier.single()
ch-core-doc-1errorBundle.entry.fullUrl, Bundle.entry:Binary.fullUrl, Bundle.entry:MedicationStatement.fullUrl, Bundle.entry:ObsBodyWeight.fullUrlThe fullUrl must be an absolute URL server address or an UUID
: startsWith('http') or startsWith('urn:uuid:') = true
ch-core-doc-2errorBundle.identifier.valueThe identifier must be an UUID
: startsWith('urn:uuid:')
ch-pat-1errorBundle.entry:Patient.resourceAt least one HumanName with given and family name must be provided.
: name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-2warningBundle.entry:Patient.resourcegender unknown is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
ch-pract-1errorBundle.entry:Practitioner.resourceIf a HumanName is provided, at least one HumanName must have a given and family name.
: name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pract-2warningBundle.entry:Practitioner.resourcegender unknown is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
dom-2errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf 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-4errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf 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-5errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceA 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()
obs-6errorBundle.entry:ObsBodyWeight.resourcedataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorBundle.entry:ObsBodyWeight.resourceIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
org-1errorBundle.entry:Organization.resourceThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
urn-uuid-invarianterrorBundle.identifier.valueThe value shall be an URN-encoded UUID ('urn:uuid:00000000-0000-0000-0000-000000000000')
: $this.matches('^urn:uuid:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*CHEMEDDocumentMedicationTreatmentPlanCH EMED Medication Treatment Plan Document
bundle-composition-same-id: The bundle and the composition resources must have the same identifier.
... id Σ0..1id✕ This element is not supported
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*Extension✕ This element is not supported
Slice: Unordered, Open by value:url
.... versionId Σ0..1id✕ This element is not supported
.... lastUpdated Σ0..1instant✕ This element is not supported
.... source Σ0..1uri✕ This element is not supported
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*Coding✕ This element is not supported
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*Coding✕ This element is not supported
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... language 0..1code✕ This element is not supported
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*Extension✕ This element is not supported
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
.... type Σ0..1CodeableConcept✕ This element is not supported
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value ΣC1..1stringThe value that is unique
urn-uuid-invariant: The value shall be an URN-encoded UUID ('urn:uuid:00000000-0000-0000-0000-000000000000')
Example General: 123456
Example CH Core: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
.... period Σ0..1Period✕ This element is not supported
.... assigner Σ0..1Reference(CH EMED EPR Organization)✕ This element is not supported
... type Σ1..1codedocument
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Fixed Value: document
... timestamp Σ1..1instantThe document's creation date and time
... link Σ0..*BackboneElement✕ This element is not supported
.... 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
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... Slices for entry ΣC3..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... id 0..1string✕ This element is not supported
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl ΣC1..1uriURN-encoded UUID for resource
..... resource Σ0..1ResourceA resource in the bundle
.... entry:Composition ΣC1..1BackboneElementMedication treatment plan composition
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1CHEMEDEPRCompositionMedicationTreatmentPlanCH EMED Medication Treatment Plan Composition
.... entry:Patient ΣC1..*BackboneElementThe patient targeted by this medication treatment plan
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource C1..1CHEMEDEPRPatientCH Core Patient EPR (to include the patient in an EPR document)
.... entry:Practitioner ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource C1..1CHEMEDEPRPractitionerCH EMED Practitioner
.... entry:PractitionerRole ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1CHEMEDEPRPractitionerRoleCH EMED PractitionerRole
.... entry:Organization ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource C1..1CHEMEDEPROrganizationCH EMED Organization
.... entry:RelatedPerson ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1RelatedPersonA person that is related to a patient, but who is not a direct target of care
.... entry:Device ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1DeviceItem used in healthcare
.... entry:Encounter ΣC0..*BackboneElement✕ This element is not supported
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1CHCoreEncounterCH Core Encounter
.... entry:Location ΣC0..*BackboneElement✕ This element is not supported
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1CHCoreLocationCH Core Location
.... entry:Binary ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl ΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1BinaryPure binary content defined by a format other than FHIR
.... entry:MedicationStatement ΣC1..*BackboneElementDetails about the medication introduced in the treatment plan
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl ΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1CHEMEDEPRMedicationStatementCH EMED MedicationStatement (MTP and basis)
.... entry:ObsBodyWeight ΣC0..1BackboneElementEntry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... fullUrl ΣC1..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
..... resource C1..1CHEMEDEPRObservationBodyWeightMeasurements and simple assertions
... signature Σ0..1Signature✕ This element is not supported

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Bundle.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Bundle.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Bundle.identifier.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Bundle.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Bundle.typerequiredFixed Value: document
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Composition.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Composition.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Patient.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Patient.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Practitioner.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Practitioner.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:PractitionerRole.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:PractitionerRole.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Organization.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Organization.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:RelatedPerson.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:RelatedPerson.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Device.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Device.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Encounter.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Encounter.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Location.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Location.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:Binary.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:Binary.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:MedicationStatement.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:MedicationStatement.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:ObsBodyWeight.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:ObsBodyWeight.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Organization, Bundle.entry:RelatedPerson, Bundle.entry:Device, Bundle.entry:Encounter, Bundle.entry:Location, Bundle.entry:Binary, Bundle.entry:MedicationStatement, Bundle.entry:ObsBodyWeightmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:Composition, Bundle.entry:Patient, Bundle.entry:Practitioner, Bundle.entry:PractitionerRole, Bundle.entry:Organization, Bundle.entry:RelatedPerson, Bundle.entry:Device, Bundle.entry:Encounter, Bundle.entry:Location, Bundle.entry:Binary, Bundle.entry:MedicationStatement, Bundle.entry:ObsBodyWeightfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
bundle-composition-same-iderrorBundleThe bundle and the composition resources must have the same identifier.
: identifier.single() = entry[0].resource.identifier.single()
ch-core-doc-1errorBundle.entry.fullUrl, Bundle.entry:Binary.fullUrl, Bundle.entry:MedicationStatement.fullUrl, Bundle.entry:ObsBodyWeight.fullUrlThe fullUrl must be an absolute URL server address or an UUID
: startsWith('http') or startsWith('urn:uuid:') = true
ch-core-doc-2errorBundle.identifier.valueThe identifier must be an UUID
: startsWith('urn:uuid:')
ch-pat-1errorBundle.entry:Patient.resourceAt least one HumanName with given and family name must be provided.
: name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pat-2warningBundle.entry:Patient.resourcegender unknown is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
ch-pract-1errorBundle.entry:Practitioner.resourceIf a HumanName is provided, at least one HumanName must have a given and family name.
: name.where(family.exists() and given.exists()).count()>0 or name.empty()
ch-pract-2warningBundle.entry:Practitioner.resourcegender unknown is currently not used in Switzerland in eCH and the EPR
: gender.empty() or gender!='unknown'
dom-2errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf 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-4errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf 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-5errorBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:Composition.resource, Bundle.entry:Patient.resource, Bundle.entry:Practitioner.resource, Bundle.entry:PractitionerRole.resource, Bundle.entry:Organization.resource, Bundle.entry:RelatedPerson.resource, Bundle.entry:Device.resource, Bundle.entry:Encounter.resource, Bundle.entry:Location.resource, Bundle.entry:MedicationStatement.resource, Bundle.entry:ObsBodyWeight.resourceA 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()
obs-6errorBundle.entry:ObsBodyWeight.resourcedataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorBundle.entry:ObsBodyWeight.resourceIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
org-1errorBundle.entry:Organization.resourceThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
urn-uuid-invarianterrorBundle.identifier.valueThe value shall be an URN-encoded UUID ('urn:uuid:00000000-0000-0000-0000-000000000000')
: $this.matches('^urn:uuid:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$')

 

Other representations of profile: CSV, Excel, Schematron