CH EMED EPR
1.0.1-ci-build - ci-build Switzerland flag

CH EMED EPR, published by CARA. This guide is not an authorized publication; it is the continuous build for version 1.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/CARA-ch/ch-emed-epr/ and changes regularly. 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.1-ci-build
Draft as of 2024-04-05 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 C 0..* CHEMEDDocumentMedicationTreatmentPlan CH EMED Medication Treatment Plan Document
bundle-composition-same-id: The bundle and the composition resources must have the same identifier.
... id D 0..1 id ✕ This element is not supported
... meta
.... extension D 0..* Extension ✕ This element is not supported
.... versionId D 0..1 id ✕ This element is not supported
.... lastUpdated D 0..1 instant ✕ This element is not supported
.... source D 0..1 uri ✕ This element is not supported
.... security D 0..* Coding ✕ This element is not supported
.... tag D 0..* Coding ✕ This element is not supported
... implicitRules 0..0
... identifier
.... extension D 0..* Extension ✕ This element is not supported
.... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
.... type D 0..1 CodeableConcept ✕ This element is not supported
.... value C 1..1 string The value that is unique
urn-uuid-invariant: The value shall be an URN-encoded UUID ('urn:uuid:00000000-0000-0000-0000-000000000000')
.... period D 0..1 Period ✕ This element is not supported
.... assigner D 0..1 Reference(CH EMED EPR Organization) ✕ This element is not supported
... total 0..0
... link D 0..* BackboneElement ✕ This element is not supported
... entry 3..* BackboneElement Entry in the bundle - will have a resource or information
.... id D 0..1 string ✕ This element is not supported
.... modifierExtension 0..0
.... link 0..0
.... fullUrl 1..1 uri URN-encoded UUID for resource
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Composition 1..1 BackboneElement Medication treatment plan composition
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1 CHEMEDEPRCompositionMedicationTreatmentPlan CH EMED Medication Treatment Plan Composition
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Patient 1..* BackboneElement The patient targeted by this medication treatment plan
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1 CHEMEDEPRPatient CH Core Patient EPR (to include the patient in an EPR document)
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Practitioner 0..* BackboneElement Entry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1 CHEMEDEPRPractitioner CH EMED Practitioner
.... search 0..0
.... request 0..0
.... response 0..0
... entry:PractitionerRole 0..* BackboneElement Entry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1 CHEMEDEPRPractitionerRole CH EMED PractitionerRole
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Organization 0..* BackboneElement Entry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1 CHEMEDEPROrganization CH EMED Organization
.... search 0..0
.... request 0..0
.... response 0..0
... entry:RelatedPerson 0..* BackboneElement Entry 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..* BackboneElement Entry 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 D 0..* BackboneElement ✕ This element is not supported
.... modifierExtension 0..0
.... link 0..0
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Location D 0..* BackboneElement ✕ This element is not supported
.... modifierExtension 0..0
.... link 0..0
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Binary 0..* BackboneElement Entry 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..* BackboneElement Details about the medication introduced in the treatment plan
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1 CHEMEDEPRMedicationStatement CH EMED MedicationStatement (MTP and basis)
.... search 0..0
.... request 0..0
.... response 0..0
... entry:ObsBodyWeight 0..1 BackboneElement Entry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1 CHEMEDEPRObservationBodyWeight Measurements and simple assertions
.... search 0..0
.... request 0..0
.... response 0..0
... signature D 0..1 Signature ✕ 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 C 0..* CHEMEDDocumentMedicationTreatmentPlan CH EMED Medication Treatment Plan Document
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
bundle-composition-same-id: The bundle and the composition resources must have the same identifier.
... id Σ 0..1 id ✕ This element is not supported
... language 0..1 code ✕ This element is not supported
Binding: CommonLanguages (preferred): A human language.

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


Required Pattern: official
.... type Σ 0..1 CodeableConcept ✕ 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..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value ΣC 1..1 string The value that is unique
ch-core-doc-2: The identifier must be an UUID
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..1 Period ✕ This element is not supported
.... assigner Σ 0..1 Reference(CH EMED EPR Organization) ✕ This element is not supported
... timestamp Σ 1..1 instant The document's creation date and time
... link Σ 0..* BackboneElement ✕ This element is not supported
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry ΣC 3..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string ✕ This element is not supported
..... fullUrl ΣC 1..1 uri URN-encoded UUID for resource
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
.... entry:Composition ΣC 1..1 BackboneElement Medication treatment plan composition
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 CHEMEDEPRCompositionMedicationTreatmentPlan CH EMED Medication Treatment Plan Composition
.... entry:Patient ΣC 1..* BackboneElement The patient targeted by this medication treatment plan
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 CHEMEDEPRPatient CH Core Patient EPR (to include the patient in an EPR document)
.... entry:Practitioner ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 CHEMEDEPRPractitioner CH EMED Practitioner
.... entry:PractitionerRole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 CHEMEDEPRPractitionerRole CH EMED PractitionerRole
.... entry:Organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 CHEMEDEPROrganization CH EMED Organization
.... entry:RelatedPerson ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 RelatedPerson A person that is related to a patient, but who is not a direct target of care
.... entry:Device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 Device Item used in healthcare
.... entry:Encounter ΣC 0..* BackboneElement ✕ This element is not supported
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 CHCoreEncounter CH Core Encounter
.... entry:Location ΣC 0..* BackboneElement ✕ This element is not supported
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 CHCoreLocation CH Core Location
.... entry:Binary ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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 ΣC 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
..... resource 1..1 Binary Pure binary content defined by a format other than FHIR
.... entry:MedicationStatement ΣC 1..* BackboneElement Details about the medication introduced in the treatment plan
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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 ΣC 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
..... resource 1..1 CHEMEDEPRMedicationStatement CH EMED MedicationStatement (MTP and basis)
.... entry:ObsBodyWeight ΣC 0..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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 ΣC 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
..... resource 1..1 CHEMEDEPRObservationBodyWeight Measurements and simple assertions
... signature Σ 0..1 Signature ✕ 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:')
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()
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 C 0..* CHEMEDDocumentMedicationTreatmentPlan CH EMED Medication Treatment Plan Document
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
bundle-composition-same-id: The bundle and the composition resources must have the same identifier.
... id Σ 0..1 id ✕ This element is not supported
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension ✕ This element is not supported
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id ✕ This element is not supported
.... lastUpdated Σ 0..1 instant ✕ This element is not supported
.... source Σ 0..1 uri ✕ 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..1 code ✕ This element is not supported
Binding: CommonLanguages (preferred): A human language.

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


Required Pattern: official
.... type Σ 0..1 CodeableConcept ✕ 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..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value ΣC 1..1 string The value that is unique
ch-core-doc-2: The identifier must be an UUID
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..1 Period ✕ This element is not supported
.... assigner Σ 0..1 Reference(CH EMED EPR Organization) ✕ This element is not supported
... type Σ 1..1 code document
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Fixed Value: document
... timestamp Σ 1..1 instant The document's creation date and time
... link Σ 0..* BackboneElement ✕ This element is not supported
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry ΣC 3..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string ✕ This element is not supported
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl ΣC 1..1 uri URN-encoded UUID for resource
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
..... resource Σ 0..1 Resource A resource in the bundle
.... entry:Composition ΣC 1..1 BackboneElement Medication treatment plan composition
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CHEMEDEPRCompositionMedicationTreatmentPlan CH EMED Medication Treatment Plan Composition
.... entry:Patient ΣC 1..* BackboneElement The patient targeted by this medication treatment plan
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CHEMEDEPRPatient CH Core Patient EPR (to include the patient in an EPR document)
.... entry:Practitioner ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CHEMEDEPRPractitioner CH EMED Practitioner
.... entry:PractitionerRole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CHEMEDEPRPractitionerRole CH EMED PractitionerRole
.... entry:Organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CHEMEDEPROrganization CH EMED Organization
.... entry:RelatedPerson ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 RelatedPerson A person that is related to a patient, but who is not a direct target of care
.... entry:Device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 Device Item used in healthcare
.... entry:Encounter ΣC 0..* BackboneElement ✕ This element is not supported
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CHCoreEncounter CH Core Encounter
.... entry:Location ΣC 0..* BackboneElement ✕ This element is not supported
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CHCoreLocation CH Core Location
.... entry:Binary ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl ΣC 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
..... resource 1..1 Binary Pure binary content defined by a format other than FHIR
.... entry:MedicationStatement ΣC 1..* BackboneElement Details about the medication introduced in the treatment plan
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl ΣC 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
..... resource 1..1 CHEMEDEPRMedicationStatement CH EMED MedicationStatement (MTP and basis)
.... entry:ObsBodyWeight ΣC 0..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl ΣC 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
..... resource 1..1 CHEMEDEPRObservationBodyWeight Measurements and simple assertions
... signature Σ 0..1 Signature ✕ 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:')
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()
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 C 0..* CHEMEDDocumentMedicationTreatmentPlan CH EMED Medication Treatment Plan Document
bundle-composition-same-id: The bundle and the composition resources must have the same identifier.
... id D 0..1 id ✕ This element is not supported
... meta
.... extension D 0..* Extension ✕ This element is not supported
.... versionId D 0..1 id ✕ This element is not supported
.... lastUpdated D 0..1 instant ✕ This element is not supported
.... source D 0..1 uri ✕ This element is not supported
.... security D 0..* Coding ✕ This element is not supported
.... tag D 0..* Coding ✕ This element is not supported
... implicitRules 0..0
... identifier
.... extension D 0..* Extension ✕ This element is not supported
.... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
.... type D 0..1 CodeableConcept ✕ This element is not supported
.... value C 1..1 string The value that is unique
urn-uuid-invariant: The value shall be an URN-encoded UUID ('urn:uuid:00000000-0000-0000-0000-000000000000')
.... period D 0..1 Period ✕ This element is not supported
.... assigner D 0..1 Reference(CH EMED EPR Organization) ✕ This element is not supported
... total 0..0
... link D 0..* BackboneElement ✕ This element is not supported
... entry 3..* BackboneElement Entry in the bundle - will have a resource or information
.... id D 0..1 string ✕ This element is not supported
.... modifierExtension 0..0
.... link 0..0
.... fullUrl 1..1 uri URN-encoded UUID for resource
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Composition 1..1 BackboneElement Medication treatment plan composition
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1 CHEMEDEPRCompositionMedicationTreatmentPlan CH EMED Medication Treatment Plan Composition
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Patient 1..* BackboneElement The patient targeted by this medication treatment plan
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1 CHEMEDEPRPatient CH Core Patient EPR (to include the patient in an EPR document)
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Practitioner 0..* BackboneElement Entry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1 CHEMEDEPRPractitioner CH EMED Practitioner
.... search 0..0
.... request 0..0
.... response 0..0
... entry:PractitionerRole 0..* BackboneElement Entry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1 CHEMEDEPRPractitionerRole CH EMED PractitionerRole
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Organization 0..* BackboneElement Entry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1 CHEMEDEPROrganization CH EMED Organization
.... search 0..0
.... request 0..0
.... response 0..0
... entry:RelatedPerson 0..* BackboneElement Entry 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..* BackboneElement Entry 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 D 0..* BackboneElement ✕ This element is not supported
.... modifierExtension 0..0
.... link 0..0
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Location D 0..* BackboneElement ✕ This element is not supported
.... modifierExtension 0..0
.... link 0..0
.... search 0..0
.... request 0..0
.... response 0..0
... entry:Binary 0..* BackboneElement Entry 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..* BackboneElement Details about the medication introduced in the treatment plan
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1 CHEMEDEPRMedicationStatement CH EMED MedicationStatement (MTP and basis)
.... search 0..0
.... request 0..0
.... response 0..0
... entry:ObsBodyWeight 0..1 BackboneElement Entry in the bundle - will have a resource or information
.... modifierExtension 0..0
.... link 0..0
.... resource 1..1 CHEMEDEPRObservationBodyWeight Measurements and simple assertions
.... search 0..0
.... request 0..0
.... response 0..0
... signature D 0..1 Signature ✕ 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 C 0..* CHEMEDDocumentMedicationTreatmentPlan CH EMED Medication Treatment Plan Document
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
bundle-composition-same-id: The bundle and the composition resources must have the same identifier.
... id Σ 0..1 id ✕ This element is not supported
... language 0..1 code ✕ This element is not supported
Binding: CommonLanguages (preferred): A human language.

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


Required Pattern: official
.... type Σ 0..1 CodeableConcept ✕ 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..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value ΣC 1..1 string The value that is unique
ch-core-doc-2: The identifier must be an UUID
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..1 Period ✕ This element is not supported
.... assigner Σ 0..1 Reference(CH EMED EPR Organization) ✕ This element is not supported
... timestamp Σ 1..1 instant The document's creation date and time
... link Σ 0..* BackboneElement ✕ This element is not supported
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry ΣC 3..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string ✕ This element is not supported
..... fullUrl ΣC 1..1 uri URN-encoded UUID for resource
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
.... entry:Composition ΣC 1..1 BackboneElement Medication treatment plan composition
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 CHEMEDEPRCompositionMedicationTreatmentPlan CH EMED Medication Treatment Plan Composition
.... entry:Patient ΣC 1..* BackboneElement The patient targeted by this medication treatment plan
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 CHEMEDEPRPatient CH Core Patient EPR (to include the patient in an EPR document)
.... entry:Practitioner ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 CHEMEDEPRPractitioner CH EMED Practitioner
.... entry:PractitionerRole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 CHEMEDEPRPractitionerRole CH EMED PractitionerRole
.... entry:Organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 CHEMEDEPROrganization CH EMED Organization
.... entry:RelatedPerson ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 RelatedPerson A person that is related to a patient, but who is not a direct target of care
.... entry:Device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 Device Item used in healthcare
.... entry:Encounter ΣC 0..* BackboneElement ✕ This element is not supported
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 CHCoreEncounter CH Core Encounter
.... entry:Location ΣC 0..* BackboneElement ✕ This element is not supported
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 CHCoreLocation CH Core Location
.... entry:Binary ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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 ΣC 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
..... resource 1..1 Binary Pure binary content defined by a format other than FHIR
.... entry:MedicationStatement ΣC 1..* BackboneElement Details about the medication introduced in the treatment plan
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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 ΣC 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
..... resource 1..1 CHEMEDEPRMedicationStatement CH EMED MedicationStatement (MTP and basis)
.... entry:ObsBodyWeight ΣC 0..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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 ΣC 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
..... resource 1..1 CHEMEDEPRObservationBodyWeight Measurements and simple assertions
... signature Σ 0..1 Signature ✕ 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:')
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()
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 C 0..* CHEMEDDocumentMedicationTreatmentPlan CH EMED Medication Treatment Plan Document
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
bundle-composition-same-id: The bundle and the composition resources must have the same identifier.
... id Σ 0..1 id ✕ This element is not supported
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension ✕ This element is not supported
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id ✕ This element is not supported
.... lastUpdated Σ 0..1 instant ✕ This element is not supported
.... source Σ 0..1 uri ✕ 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..1 code ✕ This element is not supported
Binding: CommonLanguages (preferred): A human language.

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


Required Pattern: official
.... type Σ 0..1 CodeableConcept ✕ 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..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value ΣC 1..1 string The value that is unique
ch-core-doc-2: The identifier must be an UUID
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..1 Period ✕ This element is not supported
.... assigner Σ 0..1 Reference(CH EMED EPR Organization) ✕ This element is not supported
... type Σ 1..1 code document
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Fixed Value: document
... timestamp Σ 1..1 instant The document's creation date and time
... link Σ 0..* BackboneElement ✕ This element is not supported
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry ΣC 3..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string ✕ This element is not supported
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl ΣC 1..1 uri URN-encoded UUID for resource
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
..... resource Σ 0..1 Resource A resource in the bundle
.... entry:Composition ΣC 1..1 BackboneElement Medication treatment plan composition
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CHEMEDEPRCompositionMedicationTreatmentPlan CH EMED Medication Treatment Plan Composition
.... entry:Patient ΣC 1..* BackboneElement The patient targeted by this medication treatment plan
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CHEMEDEPRPatient CH Core Patient EPR (to include the patient in an EPR document)
.... entry:Practitioner ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CHEMEDEPRPractitioner CH EMED Practitioner
.... entry:PractitionerRole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CHEMEDEPRPractitionerRole CH EMED PractitionerRole
.... entry:Organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CHEMEDEPROrganization CH EMED Organization
.... entry:RelatedPerson ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 RelatedPerson A person that is related to a patient, but who is not a direct target of care
.... entry:Device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 Device Item used in healthcare
.... entry:Encounter ΣC 0..* BackboneElement ✕ This element is not supported
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CHCoreEncounter CH Core Encounter
.... entry:Location ΣC 0..* BackboneElement ✕ This element is not supported
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CHCoreLocation CH Core Location
.... entry:Binary ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl ΣC 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
..... resource 1..1 Binary Pure binary content defined by a format other than FHIR
.... entry:MedicationStatement ΣC 1..* BackboneElement Details about the medication introduced in the treatment plan
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl ΣC 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
..... resource 1..1 CHEMEDEPRMedicationStatement CH EMED MedicationStatement (MTP and basis)
.... entry:ObsBodyWeight ΣC 0..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... fullUrl ΣC 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ch-core-doc-1: The fullUrl must be an absolute URL server address or an UUID
..... resource 1..1 CHEMEDEPRObservationBodyWeight Measurements and simple assertions
... signature Σ 0..1 Signature ✕ 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:')
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()
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