Encounter

Trial Use 2 Clinical — Care Provision

An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/Encounter

Interaction	Method	Path
Read	GET	/fhir/R4/Encounter/[id]
Vread	GET	/fhir/R4/Encounter/[id]/_history/[vid]
Update	PUT	/fhir/R4/Encounter/[id]
Patch	PATCH	/fhir/R4/Encounter/[id]
Delete	DELETE	/fhir/R4/Encounter/[id]
Create	POST	/fhir/R4/Encounter
Search	GET	/fhir/R4/Encounter
History	GET	/fhir/R4/Encounter/[id]/_history

Top-level elements

Element	Type(s)	Cardinality	Description
identifier	Identifier	0..*	Identifier(s) by which this encounter is known
status	code	1..1	planned | arrived | triaged | in-progress | onleave | finished | cancelled + modifier
statusHistory	BackboneElement	0..*	List of past encounter statuses
class	Coding	1..1	Classification of patient encounter
classHistory	BackboneElement	0..*	List of past encounter classes
type	CodeableConcept	0..*	Specific type of encounter
serviceType	CodeableConcept	0..1	Specific type of service
priority	CodeableConcept	0..1	Indicates the urgency of the encounter
subject	Reference	0..1	The patient or group present at the encounter
episodeOfCare	Reference	0..*	Episode(s) of care that this encounter should be recorded against
basedOn	Reference	0..*	The ServiceRequest that initiated this encounter
participant	BackboneElement	0..*	List of participants involved in the encounter
appointment	Reference	0..*	The appointment that scheduled this encounter
period	Period	0..1	The start and end time of the encounter
length	Duration	0..1	Quantity of time the encounter lasted (less time absent)
reasonCode	CodeableConcept	0..*	Coded reason the encounter takes place
reasonReference	Reference	0..*	Reason the encounter takes place (reference)
diagnosis	BackboneElement	0..*	The list of diagnosis relevant to this encounter
account	Reference	0..*	The set of accounts that may be used for billing for this Encounter
hospitalization	BackboneElement	0..1	Details about the admission to a healthcare service
location	BackboneElement	0..*	List of locations where the patient has been
serviceProvider	Reference	0..1	The organization (facility) responsible for this encounter
partOf	Reference	0..1	Another Encounter this encounter is part of

Resource-specific search parameters

Parameter	Type	Description
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
account	string	http://hl7.org/fhir/SearchParameter/Encounter-account
appointment	string	http://hl7.org/fhir/SearchParameter/Encounter-appointment
based-on	string	http://hl7.org/fhir/SearchParameter/Encounter-based-on
class	string	http://hl7.org/fhir/SearchParameter/Encounter-class
date	string	http://hl7.org/fhir/SearchParameter/clinical-date
diagnosis	string	http://hl7.org/fhir/SearchParameter/Encounter-diagnosis
discharge-disposition	string	http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-discharge-disposition
episode-of-care	string	http://hl7.org/fhir/SearchParameter/Encounter-episode-of-care
identifier	string	http://hl7.org/fhir/SearchParameter/clinical-identifier
length	string	http://hl7.org/fhir/SearchParameter/Encounter-length
location	string	http://hl7.org/fhir/SearchParameter/Encounter-location
location-period	string	http://hl7.org/fhir/SearchParameter/Encounter-location-period
part-of	string	http://hl7.org/fhir/SearchParameter/Encounter-part-of
participant	string	http://hl7.org/fhir/SearchParameter/Encounter-participant
participant-type	string	http://hl7.org/fhir/SearchParameter/Encounter-participant-type
patient	string	http://hl7.org/fhir/SearchParameter/clinical-patient
practitioner	string	http://hl7.org/fhir/SearchParameter/Encounter-practitioner
reason-code	string	http://hl7.org/fhir/SearchParameter/Encounter-reason-code
reason-reference	string	http://hl7.org/fhir/SearchParameter/Encounter-reason-reference
service-provider	string	http://hl7.org/fhir/SearchParameter/Encounter-service-provider
special-arrangement	string	http://hl7.org/fhir/SearchParameter/Encounter-special-arrangement
status	string	http://hl7.org/fhir/SearchParameter/Encounter-status
subject	string	http://hl7.org/fhir/SearchParameter/Encounter-subject
type	string	http://hl7.org/fhir/SearchParameter/clinical-type

Reference

• Official FHIR R4 spec: Encounter
• Maturity: Trial Use 2 (FMM 2).