Skip to main content

Encounter

Trial Use 4 Clinical — Care Provision

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

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/Encounter
InteractionMethodPath
ReadGET/fhir/R5/Encounter/[id]
VreadGET/fhir/R5/Encounter/[id]/_history/[vid]
UpdatePUT/fhir/R5/Encounter/[id]
PatchPATCH/fhir/R5/Encounter/[id]
DeleteDELETE/fhir/R5/Encounter/[id]
CreatePOST/fhir/R5/Encounter
SearchGET/fhir/R5/Encounter?...
HistoryGET/fhir/R5/Encounter/[id]/_history
Type-historyGET/fhir/R5/Encounter/_history

Top-level elements

ElementType(s)CardinalityDescription
identifierIdentifier0..*Identifier(s) by which this encounter is known
statuscode1..1planned
classCodeableConcept0..*Classification of patient encounter context - e.g. Inpatient, outpatient
priorityCodeableConcept0..1Indicates the urgency of the encounter
typeCodeableConcept0..*Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...)
serviceTypeCodeableReference0..*Specific type of service
subjectReference0..1The patient or group related to this encounter
subjectStatusCodeableConcept0..1The current status of the subject in relation to the Encounter
episodeOfCareReference0..*Episode(s) of care that this encounter should be recorded against
basedOnReference0..*The request that initiated this encounter
careTeamReference0..*The group(s) that are allocated to participate in this encounter
partOfReference0..1Another Encounter this encounter is part of
serviceProviderReference0..1The organization (facility) responsible for this encounter
participantBackboneElement0..*List of participants involved in the encounter
appointmentReference0..*The appointment that scheduled this encounter
virtualServiceVirtualServiceDetail0..*Connection details of a virtual service (e.g. conference call)
actualPeriodPeriod0..1The actual start and end time of the encounter
plannedStartDatedateTime0..1The planned start date/time (or admission date) of the encounter
plannedEndDatedateTime0..1The planned end date/time (or discharge date) of the encounter
lengthDuration0..1Actual quantity of time the encounter lasted (less time absent)
reasonBackboneElement0..*The list of medical reasons that are expected to be addressed during the episode of care
diagnosisBackboneElement0..*The list of diagnosis relevant to this encounter
accountReference0..*The set of accounts that may be used for billing for this Encounter
dietPreferenceCodeableConcept0..*Diet preferences reported by the patient
specialArrangementCodeableConcept0..*Wheelchair, translator, stretcher, etc
specialCourtesyCodeableConcept0..*Special courtesies (VIP, board member)
admissionBackboneElement0..1Details about the admission to a healthcare service
locationBackboneElement0..*List of locations where the patient has been

Resource-specific search parameters

ParameterTypeDescription
accountreferenceThe set of accounts that may be used for billing for this Encounter
appointmentreferenceThe appointment that scheduled this encounter
based-onreferenceThe ServiceRequest that initiated this encounter
careteamreferenceCareteam allocated to participate in the encounter
classtokenClassification of patient encounter
datedateWhen the event occurred
date-startdateThe actual start date of the Encounter
diagnosis-codetokenThe diagnosis or procedure relevant to the encounter (coded)
diagnosis-referencereferenceThe diagnosis or procedure relevant to the encounter (resource reference)
end-datedateThe actual end date of the Encounter
episode-of-carereferenceEpisode(s) of care that this encounter should be recorded against
identifiertokenAccount number
lengthquantityLength of encounter in days
locationreferenceLocation the encounter takes place
location-periodcompositeTime period during which the patient was present at the location
part-ofreferenceAnother Encounter this encounter is part of
participantreferencePersons involved in the encounter other than the patient
participant-typetokenRole of participant in encounter
patientreferenceThe entity that caused the expenses
practitionerreferencePersons involved in the encounter other than the patient
reason-codetokenReference to a concept (coded)
reason-referencereferenceReference to a resource (resource reference)
service-providerreferenceThe organization (facility) responsible for this encounter
special-arrangementtokenWheelchair, translator, stretcher, etc.
statustokenplanned
subjectreferenceThe patient or group present at the encounter
subject-statustokenThe current status of the subject in relation to the Encounter
typetokenE.g. patient, expense, depreciation

Reference

  • Official FHIR R5 spec: Encounter
  • Maturity: Trial Use 4 (FMM 4).