Estonian Base Implementation Guide, published by HL7 Estonia. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7EE/ig-ee-base/ and changes regularly. See the Directory of published versions

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

Resource Profile: EEBase Encounter

Encounter is an interaction between a patient and healthcare provider(s) to provide healthcare service(s) or assess a patient’s health status. There are many types of encounters (such as ambulatory, inpatient, home visits, emergency and the like) which is the reason why the resource encompasses the lifecycle from pre-admission to the actual encounter (for ambulatory encounters) and admission, stay and discharge (for inpatient encounters). Encounter is primarily used to record information about the actual activities that occurred, where Appointment is used to record planned activities.

Usage:

• Refer to this Resource Profile: EEBase Encounter and EEBase Observation
• Examples for this Resource Profile: Encounter/EncounterPatient1

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Encounter

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modeOfArrival		0..1	Coding	The method that the patient arrived at the facility. URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival profiled by https://fhir.ee/StructureDefinition/ee-mode-of-arrival Binding: Mode Of Arrival (extensible)
associatedEncounter		0..1	Reference(Encounter)	Associated Encounter URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
status	S	1..1	code	planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
class	S	0..*	CodeableConcept	Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter Class (extensible)
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: Act Priority (extensible)
serviceType		0..*	CodeableReference(EEBase HealthcareService)	Specific type of service
subject		0..1	Reference(Group | EEBase Patient)	The patient or group related to this encounter
episodeOfCare		0..*	Reference(EEBase EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
partOf		0..1	Reference(EEBase Encounter)	Reference to previous encounter
serviceProvider		0..1	Reference(EEBase Organization)	The organization (facility) responsible for this encounter
participant
actor		0..1	Reference(EEBase Practitioner | EEBase PractitionerRole | EEBase RelatedPerson)	The individual, device, or service participating in the encounter
reason
value		0..*	CodeableReference(Condition | DiagnosticReport | EEBase Observation | ImmunizationRecommendation | Procedure)	Reason the encounter takes place (core or reference)
admission
origin		0..1	Reference(EEBase Location | EEBase Organization)	The location/organization from which the patient came before admission
destination		0..1	Reference(EEBase Location | EEBase Organization)	Location/organization to which the patient is discharged
location
location		1..1	Reference(EEBase Location)	Location the encounter takes place
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Encounter.class	extensible	EEBaseEncounterClass https://fhir.ee/ValueSet/ee-encounter-class from this IG
Encounter.priority	extensible	EEBaseActPriority https://fhir.ee/ValueSet/ee-act-priority from this IG

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modeOfArrival		0..1	Coding	The method that the patient arrived at the facility. URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival profiled by https://fhir.ee/StructureDefinition/ee-mode-of-arrival Binding: Mode Of Arrival (extensible)
associatedEncounter		0..1	Reference(Encounter)	Associated Encounter URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter.
class	SΣ	0..*	CodeableConcept	Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter Class (extensible)
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: Act Priority (extensible)
serviceType	Σ	0..*	CodeableReference(EEBase HealthcareService)	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
subject	Σ	0..1	Reference(Group | EEBase Patient)	The patient or group related to this encounter
episodeOfCare	Σ	0..*	Reference(EEBase EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
partOf		0..1	Reference(EEBase Encounter)	Reference to previous encounter
serviceProvider		0..1	Reference(EEBase Organization)	The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|5.0.0 from the FHIR Standard
Encounter.class	extensible	EEBaseEncounterClass https://fhir.ee/ValueSet/ee-encounter-class from this IG
Encounter.priority	extensible	EEBaseActPriority https://fhir.ee/ValueSet/ee-act-priority from this IG
Encounter.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modeOfArrival		0..1	Coding	The method that the patient arrived at the facility. URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival profiled by https://fhir.ee/StructureDefinition/ee-mode-of-arrival Binding: Mode Of Arrival (extensible)
associatedEncounter		0..1	Reference(Encounter)	Associated Encounter URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier(s) by which this encounter is known
status	?!SΣ	1..1	code	planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter.
class	SΣ	0..*	CodeableConcept	Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter Class (extensible)
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: Act Priority (extensible)
type	Σ	0..*	CodeableConcept	Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: EncounterType (example): A specific code indicating type of service provided
serviceType	Σ	0..*	CodeableReference(EEBase HealthcareService)	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
subject	Σ	0..1	Reference(Group | EEBase Patient)	The patient or group related to this encounter
subjectStatus		0..1	CodeableConcept	The current status of the subject in relation to the Encounter Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter.
episodeOfCare	Σ	0..*	Reference(EEBase EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
basedOn		0..*	Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest)	The request that initiated this encounter
careTeam		0..*	Reference(CareTeam)	The group(s) that are allocated to participate in this encounter
partOf		0..1	Reference(EEBase Encounter)	Reference to previous encounter
serviceProvider		0..1	Reference(EEBase Organization)	The organization (facility) responsible for this encounter
participant	ΣC	0..*	BackboneElement	List of participants involved in the encounter enc-1: A type must be provided when no explicit actor is specified enc-2: A type cannot be provided for a patient or group participant
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	ΣC	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
actor	ΣC	0..1	Reference(EEBase Practitioner | EEBase PractitionerRole | EEBase RelatedPerson)	The individual, device, or service participating in the encounter
appointment	Σ	0..*	Reference(Appointment)	The appointment that scheduled this encounter
virtualService		0..*	VirtualServiceDetail	Connection details of a virtual service (e.g. conference call)
actualPeriod		0..1	Period	The actual start and end time of the encounter
plannedStartDate		0..1	dateTime	The planned start date/time (or admission date) of the encounter
plannedEndDate		0..1	dateTime	The planned end date/time (or discharge date) of the encounter
length		0..1	Duration	Actual quantity of time the encounter lasted (less time absent)
reason	Σ	0..*	BackboneElement	The list of medical reasons that are expected to be addressed during the episode of care
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
use	Σ	0..*	CodeableConcept	What the reason value should be used for/as Binding: EncounterReasonUse (example)
value	Σ	0..*	CodeableReference(Condition | DiagnosticReport | EEBase Observation | ImmunizationRecommendation | Procedure)	Reason the encounter takes place (core or reference) Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
diagnosis	Σ	0..*	BackboneElement	The list of diagnosis relevant to this encounter
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	Σ	0..*	CodeableReference(Condition)	The diagnosis relevant to the encounter Binding: ConditionProblemDiagnosisCodes (example)
use		0..*	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents.
account		0..*	Reference(Account)	The set of accounts that may be used for billing for this Encounter
dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc Binding: SpecialArrangements (preferred): Special arrangements.
specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
admission		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(EEBase Location | EEBase 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	Indicates that the patient is being re-admitted Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this admission encounter.
destination		0..1	Reference(EEBase Location | EEBase Organization)	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	List of locations where the patient has been
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(EEBase Location)	Location the encounter takes place
status		0..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
form		0..1	CodeableConcept	The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) Binding: LocationForm (example): Physical form of the location.
period		0..1	Period	Time period during which the patient was present at the location
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|5.0.0 from the FHIR Standard
Encounter.class	extensible	EEBaseEncounterClass https://fhir.ee/ValueSet/ee-encounter-class from this IG
Encounter.priority	extensible	EEBaseActPriority https://fhir.ee/ValueSet/ee-act-priority from this IG
Encounter.type	example	EncounterType http://hl7.org/fhir/ValueSet/encounter-type from the FHIR Standard
Encounter.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard
Encounter.subjectStatus	example	EncounterSubjectStatus http://hl7.org/fhir/ValueSet/encounter-subject-status from the FHIR Standard
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Encounter.reason.use	example	EncounterReasonUse http://hl7.org/fhir/ValueSet/encounter-reason-use from the FHIR Standard
Encounter.reason.value	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Encounter.diagnosis.condition	example	ConditionProblemDiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard
Encounter.diagnosis.use	preferred	EncounterDiagnosisUse http://hl7.org/fhir/ValueSet/encounter-diagnosis-use from the FHIR Standard
Encounter.dietPreference	example	EncounterDiet http://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard
Encounter.specialArrangement	preferred	SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard
Encounter.specialCourtesy	preferred	SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard
Encounter.admission.admitSource	preferred	AdmitSource http://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard
Encounter.admission.reAdmission	example	Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092
Encounter.admission.dischargeDisposition	example	DischargeDisposition http://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard
Encounter.location.status	required	EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|5.0.0 from the FHIR Standard
Encounter.location.form	example	LocationForm http://hl7.org/fhir/ValueSet/location-form from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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())
enc-1	error	Encounter.participant	A type must be provided when no explicit actor is specified : actor.exists() or type.exists()
enc-2	error	Encounter.participant	A type cannot be provided for a patient or group participant : actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not()
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Encounter

Cannot invoke "Object.hashCode()" because "key" is null

Differential View

This structure is derived from Encounter

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modeOfArrival		0..1	Coding	The method that the patient arrived at the facility. URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival profiled by https://fhir.ee/StructureDefinition/ee-mode-of-arrival Binding: Mode Of Arrival (extensible)
associatedEncounter		0..1	Reference(Encounter)	Associated Encounter URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
status	S	1..1	code	planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
class	S	0..*	CodeableConcept	Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter Class (extensible)
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: Act Priority (extensible)
serviceType		0..*	CodeableReference(EEBase HealthcareService)	Specific type of service
subject		0..1	Reference(Group | EEBase Patient)	The patient or group related to this encounter
episodeOfCare		0..*	Reference(EEBase EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
partOf		0..1	Reference(EEBase Encounter)	Reference to previous encounter
serviceProvider		0..1	Reference(EEBase Organization)	The organization (facility) responsible for this encounter
participant
actor		0..1	Reference(EEBase Practitioner | EEBase PractitionerRole | EEBase RelatedPerson)	The individual, device, or service participating in the encounter
reason
value		0..*	CodeableReference(Condition | DiagnosticReport | EEBase Observation | ImmunizationRecommendation | Procedure)	Reason the encounter takes place (core or reference)
admission
origin		0..1	Reference(EEBase Location | EEBase Organization)	The location/organization from which the patient came before admission
destination		0..1	Reference(EEBase Location | EEBase Organization)	Location/organization to which the patient is discharged
location
location		1..1	Reference(EEBase Location)	Location the encounter takes place
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Encounter.class	extensible	EEBaseEncounterClass https://fhir.ee/ValueSet/ee-encounter-class from this IG
Encounter.priority	extensible	EEBaseActPriority https://fhir.ee/ValueSet/ee-act-priority from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modeOfArrival		0..1	Coding	The method that the patient arrived at the facility. URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival profiled by https://fhir.ee/StructureDefinition/ee-mode-of-arrival Binding: Mode Of Arrival (extensible)
associatedEncounter		0..1	Reference(Encounter)	Associated Encounter URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter.
class	SΣ	0..*	CodeableConcept	Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter Class (extensible)
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: Act Priority (extensible)
serviceType	Σ	0..*	CodeableReference(EEBase HealthcareService)	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
subject	Σ	0..1	Reference(Group | EEBase Patient)	The patient or group related to this encounter
episodeOfCare	Σ	0..*	Reference(EEBase EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
partOf		0..1	Reference(EEBase Encounter)	Reference to previous encounter
serviceProvider		0..1	Reference(EEBase Organization)	The organization (facility) responsible for this encounter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|5.0.0 from the FHIR Standard
Encounter.class	extensible	EEBaseEncounterClass https://fhir.ee/ValueSet/ee-encounter-class from this IG
Encounter.priority	extensible	EEBaseActPriority https://fhir.ee/ValueSet/ee-act-priority from this IG
Encounter.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modeOfArrival		0..1	Coding	The method that the patient arrived at the facility. URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival profiled by https://fhir.ee/StructureDefinition/ee-mode-of-arrival Binding: Mode Of Arrival (extensible)
associatedEncounter		0..1	Reference(Encounter)	Associated Encounter URL: http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier(s) by which this encounter is known
status	?!SΣ	1..1	code	planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter.
class	SΣ	0..*	CodeableConcept	Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter Class (extensible)
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: Act Priority (extensible)
type	Σ	0..*	CodeableConcept	Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: EncounterType (example): A specific code indicating type of service provided
serviceType	Σ	0..*	CodeableReference(EEBase HealthcareService)	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
subject	Σ	0..1	Reference(Group | EEBase Patient)	The patient or group related to this encounter
subjectStatus		0..1	CodeableConcept	The current status of the subject in relation to the Encounter Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter.
episodeOfCare	Σ	0..*	Reference(EEBase EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
basedOn		0..*	Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest)	The request that initiated this encounter
careTeam		0..*	Reference(CareTeam)	The group(s) that are allocated to participate in this encounter
partOf		0..1	Reference(EEBase Encounter)	Reference to previous encounter
serviceProvider		0..1	Reference(EEBase Organization)	The organization (facility) responsible for this encounter
participant	ΣC	0..*	BackboneElement	List of participants involved in the encounter enc-1: A type must be provided when no explicit actor is specified enc-2: A type cannot be provided for a patient or group participant
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	ΣC	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
actor	ΣC	0..1	Reference(EEBase Practitioner | EEBase PractitionerRole | EEBase RelatedPerson)	The individual, device, or service participating in the encounter
appointment	Σ	0..*	Reference(Appointment)	The appointment that scheduled this encounter
virtualService		0..*	VirtualServiceDetail	Connection details of a virtual service (e.g. conference call)
actualPeriod		0..1	Period	The actual start and end time of the encounter
plannedStartDate		0..1	dateTime	The planned start date/time (or admission date) of the encounter
plannedEndDate		0..1	dateTime	The planned end date/time (or discharge date) of the encounter
length		0..1	Duration	Actual quantity of time the encounter lasted (less time absent)
reason	Σ	0..*	BackboneElement	The list of medical reasons that are expected to be addressed during the episode of care
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
use	Σ	0..*	CodeableConcept	What the reason value should be used for/as Binding: EncounterReasonUse (example)
value	Σ	0..*	CodeableReference(Condition | DiagnosticReport | EEBase Observation | ImmunizationRecommendation | Procedure)	Reason the encounter takes place (core or reference) Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
diagnosis	Σ	0..*	BackboneElement	The list of diagnosis relevant to this encounter
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	Σ	0..*	CodeableReference(Condition)	The diagnosis relevant to the encounter Binding: ConditionProblemDiagnosisCodes (example)
use		0..*	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents.
account		0..*	Reference(Account)	The set of accounts that may be used for billing for this Encounter
dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc Binding: SpecialArrangements (preferred): Special arrangements.
specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
admission		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(EEBase Location | EEBase 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	Indicates that the patient is being re-admitted Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this admission encounter.
destination		0..1	Reference(EEBase Location | EEBase Organization)	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	List of locations where the patient has been
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(EEBase Location)	Location the encounter takes place
status		0..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
form		0..1	CodeableConcept	The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) Binding: LocationForm (example): Physical form of the location.
period		0..1	Period	Time period during which the patient was present at the location
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Encounter.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|5.0.0 from the FHIR Standard
Encounter.class	extensible	EEBaseEncounterClass https://fhir.ee/ValueSet/ee-encounter-class from this IG
Encounter.priority	extensible	EEBaseActPriority https://fhir.ee/ValueSet/ee-act-priority from this IG
Encounter.type	example	EncounterType http://hl7.org/fhir/ValueSet/encounter-type from the FHIR Standard
Encounter.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard
Encounter.subjectStatus	example	EncounterSubjectStatus http://hl7.org/fhir/ValueSet/encounter-subject-status from the FHIR Standard
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
Encounter.reason.use	example	EncounterReasonUse http://hl7.org/fhir/ValueSet/encounter-reason-use from the FHIR Standard
Encounter.reason.value	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard
Encounter.diagnosis.condition	example	ConditionProblemDiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard
Encounter.diagnosis.use	preferred	EncounterDiagnosisUse http://hl7.org/fhir/ValueSet/encounter-diagnosis-use from the FHIR Standard
Encounter.dietPreference	example	EncounterDiet http://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard
Encounter.specialArrangement	preferred	SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard
Encounter.specialCourtesy	preferred	SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard
Encounter.admission.admitSource	preferred	AdmitSource http://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard
Encounter.admission.reAdmission	example	Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092
Encounter.admission.dischargeDisposition	example	DischargeDisposition http://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard
Encounter.location.status	required	EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|5.0.0 from the FHIR Standard
Encounter.location.form	example	LocationForm http://hl7.org/fhir/ValueSet/location-form from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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())
enc-1	error	Encounter.participant	A type must be provided when no explicit actor is specified : actor.exists() or type.exists()
enc-2	error	Encounter.participant	A type cannot be provided for a patient or group participant : actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not()
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Encounter

Cannot invoke "Object.hashCode()" because "key" is null

Other representations of profile: CSV, Excel, Schematron