Skip to main content

Encounter

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.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

InteractionMethodPath
ReadGET/fhir/R4/Encounter/[id]
VreadGET/fhir/R4/Encounter/[id]/_history/[vid]
UpdatePUT/fhir/R4/Encounter/[id]
PatchPATCH/fhir/R4/Encounter/[id]
DeleteDELETE/fhir/R4/Encounter/[id]
CreatePOST/fhir/R4/Encounter
SearchGET/fhir/R4/Encounter
HistoryGET/fhir/R4/Encounter/[id]/_history

Top-level elements​

ElementTypeCardinalityDescription
idstring0..1Logical id of this artifact
metaMeta0..1Metadata about the resource
implicitRulesuri0..1A set of rules under which this content was created
languagecode0..1Language of the resource content
textNarrative0..1Text summary of the resource, for human interpretation
containedResource0..*Contained, inline Resources
extensionExtension0..*Additional content defined by implementations
modifierExtensionExtension0..*Extensions that cannot be ignored
identifierIdentifier0..*Identifier(s) by which this encounter is known
statuscode1..1planned | arrived | triaged | in-progress | onleave | finished | cancelled +
statusHistoryBackboneElement0..*List of past encounter statuses
classCoding1..1Classification of patient encounter
classHistoryBackboneElement0..*List of past encounter classes
typeCodeableConcept0..*Specific type of encounter
serviceTypeCodeableConcept0..1Specific type of service
priorityCodeableConcept0..1Indicates the urgency of the encounter
subjectReference0..1The patient or group present at the encounter
episodeOfCareReference0..*Episode(s) of care that this encounter should be recorded against
basedOnReference0..*The ServiceRequest that initiated this encounter
participantBackboneElement0..*List of participants involved in the encounter
appointmentReference0..*The appointment that scheduled this encounter
periodPeriod0..1The start and end time of the encounter
lengthDuration0..1Quantity of time the encounter lasted (less time absent)
reasonCodeCodeableConcept0..*Coded reason the encounter takes place
reasonReferenceReference0..*Reason the encounter takes place (reference)
diagnosisBackboneElement0..*The list of diagnosis relevant to this encounter
accountReference0..*The set of accounts that may be used for billing for this Encounter
hospitalizationBackboneElement0..1Details about the admission to a healthcare service
locationBackboneElement0..*List of locations where the patient has been
serviceProviderReference0..1The organization (facility) responsible for this encounter
partOfReference0..1Another Encounter this encounter is part of

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
classtokenClassification of patient encounter
datedateMultiple Resources: AllergyIntolerance: Date first version of the resource instance was recorded ; CarePlan: Time period plan covers ; CareTeam: Time period team covers ; ClinicalImpression: When the assessment was documented ; Composition: Composition editing time ; Consent: When this Consent was created or indexed ; DiagnosticReport: The clinically relevant time of the report ; Encounter: A date within the period the Encounter lasted ; EpisodeOfCare: The provided date search value falls within the episode of care's period ; FamilyMemberHistory: When history was recorded or last updated ; Flag: Time period when flag is active ; Immunization: Vaccination (non)-Administration Date ; List: When the list was prepared ; Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period ; Procedure: When the procedure was performed ; RiskAssessment: When was assessment made? ; SupplyRequest: When the request was made
diagnosisreferenceThe diagnosis or procedure relevant to the encounter
episode-of-carereferenceEpisode(s) of care that this encounter should be recorded against
identifiertokenMultiple Resources: AllergyIntolerance: External ids for this item ; CarePlan: External Ids for this plan ; CareTeam: External Ids for this team ; Composition: Version-independent identifier for the Composition ; Condition: A unique identifier of the condition record ; Consent: Identifier for this record (external references) ; DetectedIssue: Unique id for the detected issue ; DeviceRequest: Business identifier for request/order ; DiagnosticReport: An identifier for the report ; DocumentManifest: Unique Identifier for the set of documents ; DocumentReference: Master Version Specific Identifier ; Encounter: Identifier(s) by which this encounter is known ; EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare ; FamilyMemberHistory: A search by a record identifier ; Goal: External Ids for this goal ; ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number ; Immunization: Business identifier ; List: Business identifier ; MedicationAdministration: Return administrations with this external identifier ; MedicationDispense: Returns dispenses with this external identifier ; MedicationRequest: Return prescriptions with this external identifier ; MedicationStatement: Return statements with this external identifier ; NutritionOrder: Return nutrition orders with this external identifier ; Observation: The unique id for a particular observation ; Procedure: A unique identifier for a procedure ; RiskAssessment: Unique identifier for the assessment ; ServiceRequest: Identifiers assigned to this order ; SupplyDelivery: External identifier ; SupplyRequest: Business Identifier for SupplyRequest ; VisionPrescription: Return prescriptions with this external identifier
lengthquantityLength of encounter in days
locationreferenceLocation the encounter takes place
location-perioddateTime 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
patientreferenceMultiple Resources: AllergyIntolerance: Who the sensitivity is for ; CarePlan: Who the care plan is for ; CareTeam: Who care team is for ; ClinicalImpression: Patient or group assessed ; Composition: Who and/or what the composition is about ; Condition: Who has the condition? ; Consent: Who the consent applies to ; DetectedIssue: Associated patient ; DeviceRequest: Individual the service is ordered for ; DeviceUseStatement: Search by subject - a patient ; DiagnosticReport: The subject of the report if a patient ; DocumentManifest: The subject of the set of documents ; DocumentReference: Who/what is the subject of the document ; Encounter: The patient or group present at the encounter ; EpisodeOfCare: The patient who is the focus of this episode of care ; FamilyMemberHistory: The identity of a subject to list family member history items for ; Flag: The identity of a subject to list flags for ; Goal: Who this goal is intended for ; ImagingStudy: Who the study is about ; Immunization: The patient for the vaccination record ; List: If all resources have the same subject ; MedicationAdministration: The identity of a patient to list administrations for ; MedicationDispense: The identity of a patient to list dispenses for ; MedicationRequest: Returns prescriptions for a specific patient ; MedicationStatement: Returns statements for a specific patient. ; NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement ; Observation: The subject that the observation is about (if patient) ; Procedure: Search by subject - a patient ; RiskAssessment: Who/what does assessment apply to? ; ServiceRequest: Search by subject - a patient ; SupplyDelivery: Patient for whom the item is supplied ; VisionPrescription: The identity of a patient to list dispenses for
practitionerreferencePersons involved in the encounter other than the patient
reason-codetokenCoded reason the encounter takes place
reason-referencereferenceReason the encounter takes place (reference)
service-providerreferenceThe organization (facility) responsible for this encounter
special-arrangementtokenWheelchair, translator, stretcher, etc.
statustokenplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
subjectreferenceThe patient or group present at the encounter
typetokenMultiple Resources: AllergyIntolerance: allergy | intolerance - Underlying mechanism (if known) ; Composition: Kind of composition (LOINC if possible) ; DocumentManifest: Kind of document set ; DocumentReference: Kind of document (LOINC if possible) ; Encounter: Specific type of encounter ; EpisodeOfCare: Type/class - e.g. specialist referral, disease management

Reference​

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