HL7 Czech Hospital Discharge 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/hdr/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: Encounter: Obligations

This profile defines obligations for an Encounter in FHIR for the purpose 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
Encounter		0..*	CZ_EncounterHdr	An interaction during which services are provided to the patient This profile also imposes the profile Encounter (HDR)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	Status of this Hospital stay Binding: In-patient Encounter Status Value Set (required)
class	OΣ	1..1	Coding	Classification of patient encounter Binding: Encounter Class Value Set (extensible) Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
subject	Σ	1..1	Reference(Patient (CZ core))	The patient present at the encounter
Slices for participant	Σ	0..*	BackboneElement	List of participants involved in the encounters Slice: Unordered, Open by value:type
participant:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
participant:admitter	Σ	0..*	BackboneElement	Admitting professional
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ADM
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
participant:discharger	Σ	0..*	BackboneElement	Discharging professional
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: DIS
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
participant:referrer	Σ	0..*	BackboneElement	Referring professional
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: REF
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
period		1..1	Period	The start and end time of this encounter.
start	OΣC	0..1	dateTime	Starting time with inclusive boundary Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
end	OΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
serviceProvider		1..1	Reference(Organization (CZ core))	The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.status	Base	required	In-patient Encounter Status Value Set	📦0.1.0-ballot	HL7 Europe Hospital Discharge Report v0.1
Encounter.class	Base	extensible	Encounter Class Value Set	📦0.1.0-ballot	HL7 Europe Hospital Discharge Report v0.1
Encounter.participant:admitter.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Encounter.participant:discharger.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Encounter.participant:referrer.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management	text.`div`.exists()
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 CZ_EncounterHdr

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	CZ_EncounterHdr	An interaction during which services are provided to the patient This profile also imposes the profile Encounter (HDR)
class	O	1..1	Coding	Classification of patient encounter Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
period
start	O	0..1	dateTime	Starting time with inclusive boundary Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
end	O	0..1	dateTime	End time with inclusive boundary, if not ongoing Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
reasonCode
text	O	0..1	string	Plain text representation of the concept Obligations Actor SHOULD:populate-if-known Creator_L2 SHOULD:display Consumer_L2
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	CZ_EncounterHdr	An interaction during which services are provided to the patient This profile also imposes the profile Encounter (HDR)
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier(s) by which this encounter is known
status	?!Σ	1..1	code	Status of this Hospital stay Binding: In-patient Encounter Status Value Set (required)
statusHistory		0..*	BackboneElement	List of past encounter statuses
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
status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period		1..1	Period	The time that the episode was in the specified status
class	OΣ	1..1	Coding	Classification of patient encounter Binding: Encounter Class Value Set (extensible) Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
classHistory		0..*	BackboneElement	List of past encounter classes
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
class		1..1	Coding	inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
period		1..1	Period	The time that the episode was in the specified class
type	Σ	0..*	CodeableConcept	Specific type of Hospital stay Binding: In-patient Encounter Type Value Set (example)
serviceType	Σ	0..1	CodeableConcept	Specific type of service. Binding: ServiceType (example): Broad categorization of the service that is to be provided.
priority		0..1	CodeableConcept	Encounter priority Binding: Admission Urgency Value Set (preferred)
subject	Σ	1..1	Reference(Patient (CZ core))	The patient present at the encounter
episodeOfCare	Σ	0..*	Reference(EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
basedOn		0..*	Reference(ServiceRequest)	The request for which this encounter has been made
Slices for participant	Σ	0..*	BackboneElement	List of participants involved in the encounters Slice: Unordered, Open by value:type
participant:All Slices				Content/Rules for all slices
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
type	Σ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period		0..1	Period	Period of time during the encounter that the participant participated
individual	Σ	0..1	Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | RelatedPerson)	Persons involved in the encounter other than the patient
participant:admitter	Σ	0..*	BackboneElement	Admitting professional
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
type	Σ	1..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ADM
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
period		0..1	Period	Period of time during the encounter that the participant participated
individual	Σ	0..1	Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | RelatedPerson)	Persons involved in the encounter other than the patient
participant:discharger	Σ	0..*	BackboneElement	Discharging professional
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
type	Σ	1..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: DIS
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
period		0..1	Period	Period of time during the encounter that the participant participated
individual	Σ	0..1	Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | RelatedPerson)	Persons involved in the encounter other than the patient
participant:referrer	Σ	0..*	BackboneElement	Referring professional
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
type	Σ	1..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: REF
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
period		0..1	Period	Period of time during the encounter that the participant participated
individual	Σ	0..1	Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | RelatedPerson)	Persons involved in the encounter other than the patient
appointment	Σ	0..*	Reference(Appointment)	The appointment that scheduled this encounter
period		1..1	Period	The start and end time of this encounter.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	OΣC	0..1	dateTime	Starting time with inclusive boundary Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
end	OΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
length		0..1	Duration	Quantity of time the encounter lasted (less time absent)
reasonCode	Σ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: Condition Value Set (preferred)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	OΣ	0..1	string	Plain text representation of the concept Obligations Actor SHOULD:populate-if-known Creator_L2 SHOULD:display Consumer_L2
reasonReference	Σ	0..*	Reference(Observation | Condition | Procedure)	Reason the encounter takes place (reference)
diagnosis	Σ	0..*	BackboneElement	The list of diagnosis relevant to this encounter, see comment
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
condition	Σ	1..1	Reference(Condition (HDR CZ))	The diagnosis or procedure relevant to the encounter
use		0..1	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
rank		0..1	positiveInt	Ranking of the diagnosis (for each role type)
account		0..*	Reference(Account)	The set of accounts that may be used for billing for this Encounter
hospitalization		0..1	BackboneElement	Details about the admission to a healthcare service
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
preAdmissionIdentifier		0..1	Identifier	Pre-admission identifier
origin		0..1	Reference(Location | Organization)	The location/organization from which the patient came before admission
admitSource		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer). Binding: AdmitSource (preferred): From where the patient was admitted.
reAdmission		0..1	CodeableConcept	The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
destination		0..1	Reference(Organization (CZ core) | Location (CZ core))	Location/organization to which the patient is discharged
dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition.
location		0..*	BackboneElement	Locations where the patient stayed
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
location		1..1	Reference(Location (CZ core))	Location the encounter takes place
status		0..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
physicalType		0..1	CodeableConcept	The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location.
period		0..1	Period	Location period
serviceProvider		1..1	Reference(Organization (CZ core))	The organization (facility) responsible for this encounter
partOf		0..1	Reference(Encounter)	Another Encounter this encounter is part of
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Encounter.status	Base	required	In-patient Encounter Status Value Set	📦0.1.0-ballot	HL7 Europe Hospital Discharge Report v0.1
Encounter.statusHistory.​status	Base	required	EncounterStatus	📍4.0.1	FHIR Std.
Encounter.class	Base	extensible	Encounter Class Value Set	📦0.1.0-ballot	HL7 Europe Hospital Discharge Report v0.1
Encounter.classHistory.​class	Base	extensible	ActEncounterCode	📍3.0.0	THO v6.5
Encounter.type	Base	example	In-patient Encounter Type Value Set	📦0.1.0-ballot	HL7 Europe Hospital Discharge Report v0.1
Encounter.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Encounter.priority	Base	preferred	Admission Urgency Value Set	📦0.1.0-ballot	HL7 Europe Hospital Discharge Report v0.1
Encounter.participant.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Encounter.participant:admitter.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Encounter.participant:discharger.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Encounter.participant:referrer.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Encounter.reasonCode	Base	preferred	Condition Value Set	📦0.1.0-ballot	HL7 Europe Hospital Discharge Report v0.1
Encounter.diagnosis.​use	Base	preferred	DiagnosisRole	📍4.0.1	FHIR Std.
Encounter.hospitalization.​admitSource	Base	preferred	Admit source	📍4.0.1	FHIR Std.
Encounter.hospitalization.​reAdmission	Base	example	hl7VS-re-admissionIndicator	📦2.0.0	THO v6.5
Encounter.hospitalization.​dietPreference	Base	example	Diet	📍4.0.1	FHIR Std.
Encounter.hospitalization.​specialCourtesy	Base	preferred	Special courtesy	📍4.0.1	FHIR Std.
Encounter.hospitalization.​specialArrangement	Base	preferred	Special arrangements	📍4.0.1	FHIR Std.
Encounter.hospitalization.​dischargeDisposition	Base	example	Discharge disposition	📍4.0.1	FHIR Std.
Encounter.location.status	Base	required	EncounterLocationStatus	📍4.0.1	FHIR Std.
Encounter.location.physicalType	Base	example	Location type	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management	text.`div`.exists()
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 CZ_EncounterHdr

Summary

Maturity: 0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	CZ_EncounterHdr	An interaction during which services are provided to the patient This profile also imposes the profile Encounter (HDR)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	Status of this Hospital stay Binding: In-patient Encounter Status Value Set (required)
class	OΣ	1..1	Coding	Classification of patient encounter Binding: Encounter Class Value Set (extensible) Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
subject	Σ	1..1	Reference(Patient (CZ core))	The patient present at the encounter
Slices for participant	Σ	0..*	BackboneElement	List of participants involved in the encounters Slice: Unordered, Open by value:type
participant:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
participant:admitter	Σ	0..*	BackboneElement	Admitting professional
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ADM
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
participant:discharger	Σ	0..*	BackboneElement	Discharging professional
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: DIS
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
participant:referrer	Σ	0..*	BackboneElement	Referring professional
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: REF
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
period		1..1	Period	The start and end time of this encounter.
start	OΣC	0..1	dateTime	Starting time with inclusive boundary Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
end	OΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
serviceProvider		1..1	Reference(Organization (CZ core))	The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.status	Base	required	In-patient Encounter Status Value Set	📦0.1.0-ballot	HL7 Europe Hospital Discharge Report v0.1
Encounter.class	Base	extensible	Encounter Class Value Set	📦0.1.0-ballot	HL7 Europe Hospital Discharge Report v0.1
Encounter.participant:admitter.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Encounter.participant:discharger.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Encounter.participant:referrer.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management	text.`div`.exists()
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()

Differential View

This structure is derived from CZ_EncounterHdr

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	CZ_EncounterHdr	An interaction during which services are provided to the patient This profile also imposes the profile Encounter (HDR)
class	O	1..1	Coding	Classification of patient encounter Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
period
start	O	0..1	dateTime	Starting time with inclusive boundary Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
end	O	0..1	dateTime	End time with inclusive boundary, if not ongoing Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
reasonCode
text	O	0..1	string	Plain text representation of the concept Obligations Actor SHOULD:populate-if-known Creator_L2 SHOULD:display Consumer_L2
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	CZ_EncounterHdr	An interaction during which services are provided to the patient This profile also imposes the profile Encounter (HDR)
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier(s) by which this encounter is known
status	?!Σ	1..1	code	Status of this Hospital stay Binding: In-patient Encounter Status Value Set (required)
statusHistory		0..*	BackboneElement	List of past encounter statuses
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
status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period		1..1	Period	The time that the episode was in the specified status
class	OΣ	1..1	Coding	Classification of patient encounter Binding: Encounter Class Value Set (extensible) Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
classHistory		0..*	BackboneElement	List of past encounter classes
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
class		1..1	Coding	inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter.
period		1..1	Period	The time that the episode was in the specified class
type	Σ	0..*	CodeableConcept	Specific type of Hospital stay Binding: In-patient Encounter Type Value Set (example)
serviceType	Σ	0..1	CodeableConcept	Specific type of service. Binding: ServiceType (example): Broad categorization of the service that is to be provided.
priority		0..1	CodeableConcept	Encounter priority Binding: Admission Urgency Value Set (preferred)
subject	Σ	1..1	Reference(Patient (CZ core))	The patient present at the encounter
episodeOfCare	Σ	0..*	Reference(EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
basedOn		0..*	Reference(ServiceRequest)	The request for which this encounter has been made
Slices for participant	Σ	0..*	BackboneElement	List of participants involved in the encounters Slice: Unordered, Open by value:type
participant:All Slices				Content/Rules for all slices
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
type	Σ	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period		0..1	Period	Period of time during the encounter that the participant participated
individual	Σ	0..1	Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | RelatedPerson)	Persons involved in the encounter other than the patient
participant:admitter	Σ	0..*	BackboneElement	Admitting professional
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
type	Σ	1..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: ADM
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
period		0..1	Period	Period of time during the encounter that the participant participated
individual	Σ	0..1	Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | RelatedPerson)	Persons involved in the encounter other than the patient
participant:discharger	Σ	0..*	BackboneElement	Discharging professional
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
type	Σ	1..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: DIS
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
period		0..1	Period	Period of time during the encounter that the participant participated
individual	Σ	0..1	Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | RelatedPerson)	Persons involved in the encounter other than the patient
participant:referrer	Σ	0..*	BackboneElement	Referring professional
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
type	Σ	1..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: REF
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
period		0..1	Period	Period of time during the encounter that the participant participated
individual	Σ	0..1	Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | RelatedPerson)	Persons involved in the encounter other than the patient
appointment	Σ	0..*	Reference(Appointment)	The appointment that scheduled this encounter
period		1..1	Period	The start and end time of this encounter.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	OΣC	0..1	dateTime	Starting time with inclusive boundary Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
end	OΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Obligations Actor SHALL:able-to-populate Creator_L1 SHALL:display Consumer_L1 SHALL:able-to-populate Creator_L2 SHALL:display Consumer_L2
length		0..1	Duration	Quantity of time the encounter lasted (less time absent)
reasonCode	Σ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: Condition Value Set (preferred)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	OΣ	0..1	string	Plain text representation of the concept Obligations Actor SHOULD:populate-if-known Creator_L2 SHOULD:display Consumer_L2
reasonReference	Σ	0..*	Reference(Observation | Condition | Procedure)	Reason the encounter takes place (reference)
diagnosis	Σ	0..*	BackboneElement	The list of diagnosis relevant to this encounter, see comment
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
condition	Σ	1..1	Reference(Condition (HDR CZ))	The diagnosis or procedure relevant to the encounter
use		0..1	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
rank		0..1	positiveInt	Ranking of the diagnosis (for each role type)
account		0..*	Reference(Account)	The set of accounts that may be used for billing for this Encounter
hospitalization		0..1	BackboneElement	Details about the admission to a healthcare service
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
preAdmissionIdentifier		0..1	Identifier	Pre-admission identifier
origin		0..1	Reference(Location | Organization)	The location/organization from which the patient came before admission
admitSource		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer). Binding: AdmitSource (preferred): From where the patient was admitted.
reAdmission		0..1	CodeableConcept	The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
destination		0..1	Reference(Organization (CZ core) | Location (CZ core))	Location/organization to which the patient is discharged
dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition.
location		0..*	BackboneElement	Locations where the patient stayed
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
location		1..1	Reference(Location (CZ core))	Location the encounter takes place
status		0..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
physicalType		0..1	CodeableConcept	The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location.
period		0..1	Period	Location period
serviceProvider		1..1	Reference(Organization (CZ core))	The organization (facility) responsible for this encounter
partOf		0..1	Reference(Encounter)	Another Encounter this encounter is part of
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Encounter.status	Base	required	In-patient Encounter Status Value Set	📦0.1.0-ballot	HL7 Europe Hospital Discharge Report v0.1
Encounter.statusHistory.​status	Base	required	EncounterStatus	📍4.0.1	FHIR Std.
Encounter.class	Base	extensible	Encounter Class Value Set	📦0.1.0-ballot	HL7 Europe Hospital Discharge Report v0.1
Encounter.classHistory.​class	Base	extensible	ActEncounterCode	📍3.0.0	THO v6.5
Encounter.type	Base	example	In-patient Encounter Type Value Set	📦0.1.0-ballot	HL7 Europe Hospital Discharge Report v0.1
Encounter.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Encounter.priority	Base	preferred	Admission Urgency Value Set	📦0.1.0-ballot	HL7 Europe Hospital Discharge Report v0.1
Encounter.participant.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Encounter.participant:admitter.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Encounter.participant:discharger.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Encounter.participant:referrer.​type	Base	extensible	Participant type	📍4.0.1	FHIR Std.
Encounter.reasonCode	Base	preferred	Condition Value Set	📦0.1.0-ballot	HL7 Europe Hospital Discharge Report v0.1
Encounter.diagnosis.​use	Base	preferred	DiagnosisRole	📍4.0.1	FHIR Std.
Encounter.hospitalization.​admitSource	Base	preferred	Admit source	📍4.0.1	FHIR Std.
Encounter.hospitalization.​reAdmission	Base	example	hl7VS-re-admissionIndicator	📦2.0.0	THO v6.5
Encounter.hospitalization.​dietPreference	Base	example	Diet	📍4.0.1	FHIR Std.
Encounter.hospitalization.​specialCourtesy	Base	preferred	Special courtesy	📍4.0.1	FHIR Std.
Encounter.hospitalization.​specialArrangement	Base	preferred	Special arrangements	📍4.0.1	FHIR Std.
Encounter.hospitalization.​dischargeDisposition	Base	example	Discharge disposition	📍4.0.1	FHIR Std.
Encounter.location.status	Base	required	EncounterLocationStatus	📍4.0.1	FHIR Std.
Encounter.location.physicalType	Base	example	Location type	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management	text.`div`.exists()
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 CZ_EncounterHdr

Summary

Maturity: 0