Bundle: Imaging Order (CZ) - HL7 Czech Imaging Order IG v0.0.3

HL7 Czech Imaging Order IG, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.0.3 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/img-order/ and changes regularly. See the Directory of published versions

Resource Profile: Bundle: Imaging Order (CZ)

Official URL: https://hl7.cz/fhir/img-order/StructureDefinition/cz-bundleImageOrder		Version: 0.0.3
Standards status: Draft	Maturity Level: 0	Computable Name: CZ_BundleImageOrder
Copyright/Legal: HL7 CZ

Clinical document used to represent a Imaging Order for the scope of this guide.

Imaging order bundle is an electronic health record extract containing results of imaging from a subject of care, comprising at least the required elements of the imaging dataset.

Usages:

Examples for this Profile: Bundle/BundleKralikRTG

Formal Views of Profile Content

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

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Bundle	C	0..*	Bundle	Imaging Order Bundle Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, one-comp
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
identifier	Σ	1..1	Identifier	Business identifier for this Imaging order
type	Σ	1..1	code	document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: document
timestamp	Σ	1..1	instant	When the bundle was assembled
Slices for entry	ΣC	3..*	BackboneElement	Entry resource in the Imaging order bundle Slice: Unordered, Open by type:resource, profile:resource Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource	Σ	1..1	Resource	A resource in the bundle
entry:composition	ΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_CompositionImageOrder	Imaging Order Composition
entry:patient	ΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_PatientCore, CZ_PatientAnimal	Czech Patient (base)
entry:orderInformation	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_ImagingOrderInformation	A request for a service to be performed
entry:clinicalQuestion	ΣC	1..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_ClinicalQuestion	Detailed information about conditions, problems or diagnoses
entry:appointment	ΣC	0..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_Appointment	Imaging Order
entry:specimen	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_Specimen	Czech Specimen
entry:practitioner	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_PractitionerCore	Czech Practitioner (core)
entry:coverage	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_Coverage	Czech coverage
entry:medication	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_MedicationStatement	Czech Medication Statement
entry:condition	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_ConditionImage	Detailed information about conditions, problems or diagnoses
entry:allergyIntolerance	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_AllergyIntolerance	Czech Allergy Intolerance
entry:carePlan	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_CarePlanImage	Healthcare plan for patient or group
entry:observation	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_ObservationImage	Measurements and simple assertions
entry:device	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_DeviceObserver	Czech device
entry:attachment	ΣC	0..*	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	CZ_Attachment	Imaging Order
signature	Σ	0..1	CZ_Signature	Report Digital Signature
type	SΣ	1..*	Coding	Digital Signature Purposes Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.
when	SΣ	1..1	instant	When was signed
who	SΣ	1..1	Reference(Practitioner (CZ core) \| PractitionerRole (CZ core) \| RelatedPerson (CZ core) \| Device:Performer/Observer (CZ) \| MedicalDevice (CZ) \| Organization (CZ core) \| Patient (CZ core))	Who signed.
data	S	0..1	base64Binary	Signature content
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.type	required	Pattern Value: document `http://hl7.org/fhir/ValueSet/bundle-type\|4.0.1` From the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:composition.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:patient.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:orderInformation.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:clinicalQuestion.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:appointment.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:specimen.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:practitioner.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:coverage.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:medication.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:condition.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:allergyIntolerance.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:carePlan.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:observation.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:device.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:attachment.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.signature.type	preferred	SignatureTypeCodes `http://hl7.org/fhir/ValueSet/signature-type` From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.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-5	error	Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:orderInformation, Bundle.entry:clinicalQuestion, Bundle.entry:appointment, Bundle.entry:specimen, Bundle.entry:practitioner, Bundle.entry:coverage, Bundle.entry:medication, Bundle.entry:condition, Bundle.entry:allergyIntolerance, Bundle.entry:carePlan, Bundle.entry:observation, Bundle.entry:device, Bundle.entry:attachment	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl 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-8	error	Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:orderInformation, Bundle.entry:clinicalQuestion, Bundle.entry:appointment, Bundle.entry:specimen, Bundle.entry:practitioner, Bundle.entry:coverage, Bundle.entry:medication, Bundle.entry:condition, Bundle.entry:allergyIntolerance, Bundle.entry:carePlan, Bundle.entry:observation, Bundle.entry:device, Bundle.entry:attachment	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
one-comp	error	Bundle	A imaging order bundle SHALL include one and only one Composition : entry.resource.ofType(Composition).count() = 1

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Bundle	C	0..*	Bundle	Imaging Order Bundle Constraints: one-comp
identifier		1..1	Identifier	Business identifier for this Imaging order
type		1..1	code	document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection Required Pattern: document
timestamp		1..1	instant	When the bundle was assembled
total		0..0
link		0..0
Slices for entry		3..*	BackboneElement	Entry resource in the Imaging order bundle Slice: Unordered, Open by type:resource, profile:resource
entry:All Slices				Content/Rules for all slices
link		0..0
fullUrl		1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	Resource	A resource in the bundle
search		0..0
request		0..0
response		0..0
entry:composition		1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_CompositionImageOrder	Imaging Order Composition
entry:patient		1..1	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_PatientCore, CZ_PatientAnimal	Czech Patient (base)
entry:orderInformation		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_ImagingOrderInformation	A request for a service to be performed
entry:clinicalQuestion		1..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_ClinicalQuestion	Detailed information about conditions, problems or diagnoses
entry:appointment		0..1	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_Appointment	Imaging Order
entry:specimen		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_Specimen	Czech Specimen
entry:practitioner		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_PractitionerCore	Czech Practitioner (core)
entry:coverage		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_Coverage	Czech coverage
entry:medication		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_MedicationStatement	Czech Medication Statement
entry:condition		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_ConditionImage	Detailed information about conditions, problems or diagnoses
entry:allergyIntolerance		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_AllergyIntolerance	Czech Allergy Intolerance
entry:carePlan		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_CarePlanImage	Healthcare plan for patient or group
entry:observation		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_ObservationImage	Measurements and simple assertions
entry:device		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_DeviceObserver	Czech device
entry:attachment		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_Attachment	Imaging Order
signature		0..1	CZ_Signature	Report Digital Signature
type		1..*	Coding	Digital Signature Purposes
when		1..1	instant	When was signed
who		1..1	Reference(Practitioner (CZ core) \| PractitionerRole (CZ core) \| RelatedPerson (CZ core) \| Device:Performer/Observer (CZ) \| MedicalDevice (CZ) \| Organization (CZ core) \| Patient (CZ core))	Who signed.
data		0..1	base64Binary	Signature content
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
one-comp	error	Bundle	A imaging order bundle SHALL include one and only one Composition : entry.resource.ofType(Composition).count() = 1