Bundle Outpatient Encounter Report (CZ) - HL7 Czech Outpatient Encounter Report Implementation Guide v0.1.0

HL7 Czech Outpatient Encounter Report Implementation Guide
0.1.0 - ci-build Czechia flag

HL7 Czech Outpatient Encounter Report Implementation Guide, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/amb/ and changes regularly. See the Directory of published versions

Resource Profile: Bundle Outpatient Encounter Report (CZ)

Official URL: https://hl7.cz/fhir/amb/StructureDefinition/cz-bundle-amb				Version: 0.1.0
Draft as of 2025-09-05				Computable Name: CZ_BundleAmb

Clinical document used to represent a Outpatient Encounter Report for the scope of this guide.

Usages:

This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Bundle	C	0..*	Bundle	Outpatient Encounter Report bundle Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-amb-1
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
identifier	Σ	1..1	Identifier	Instance identifier
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. Fixed Value: document
timestamp	Σ	1..1	instant	Instance identifier
Slices for entry	ΣC	2..*	BackboneElement	Entry resources in the Outpatient Encounter Report 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_CompositionAmb	Outpatient Encounter Report Composition
entry:patient	Σ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_PatientCore	Czech Patient (base)
entry:encounter	Σ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_Encounter	An interaction during which services are provided to the patient
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:practitionerRole	Σ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_PractitionerRoleCore	Czech Practitioner Role (core)
entry:organization	Σ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_OrganizationCore	Czech Organization (core)
signature	Σ	0..1	Signature	Report Digital Signature
type	Σ	1..*	Coding	Digital Signature Purposes Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.
when	Σ	1..1	instant	When was signed
who	Σ	1..1	Reference(Practitioner \| PractitionerRole \| RelatedPerson \| Patient \| Device \| Organization)	Who signed.
data		0..1	base64Binary	Signature content
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.type	required	Fixed 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:encounter.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:practitionerRole.request.method	required	HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb\|4.0.1` From the FHIR Standard
Bundle.entry:organization.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:encounter, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:organization	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:encounter, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:organization	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)
bdl-amb-1	error	Bundle	A document must have no additional Composition (including Composition subclass) resources besides the first. : entry.tail().where(resource is Composition).empty()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Bundle	C	0..*	Bundle	Outpatient Encounter Report bundle Constraints: bdl-amb-1
identifier		1..1	Identifier	Instance identifier
type		1..1	code	document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection Fixed Value: document
timestamp		1..1	instant	Instance identifier
link		0..0
Slices for entry		2..*	BackboneElement	Entry resources in the Outpatient Encounter Report 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_CompositionAmb	Outpatient Encounter Report Composition
entry:patient		1..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_PatientCore	Czech Patient (base)
entry:encounter		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_Encounter	An interaction during which services are provided to the patient
entry:practitioner		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_PractitionerCore	Czech Practitioner (core)
entry:practitionerRole		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_PractitionerRoleCore	Czech Practitioner Role (core)
entry:organization		0..*	BackboneElement	Entry in the bundle - will have a resource or information
resource		1..1	CZ_OrganizationCore	Czech Organization (core)
signature		0..1	Signature	Report Digital Signature
type		1..*	Coding	Digital Signature Purposes
when		1..1	instant	When was signed
who		1..1	Reference(Practitioner \| PractitionerRole \| RelatedPerson \| Patient \| Device \| Organization)	Who signed.
data		0..1	base64Binary	Signature content
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-amb-1	error	Bundle	A document must have no additional Composition (including Composition subclass) resources besides the first. : entry.tail().where(resource is Composition).empty()