# Encounter

Canonical page: https://docs.ovok.com/api/fhir/r4/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.

| **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 [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Identifier(s) by which this encounter is known |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled + |
| <span id="element-status-history"></span>`statusHistory` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | List of past encounter statuses |
| <span id="element-class"></span>`class` | [Coding](/fhir-elements/complex/coding) | `1..1` | Classification of patient encounter |
| <span id="element-class-history"></span>`classHistory` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | List of past encounter classes |
| <span id="element-type"></span>`type` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Specific type of encounter |
| <span id="element-service-type"></span>`serviceType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Specific type of service |
| <span id="element-priority"></span>`priority` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Indicates the urgency of the encounter |
| <span id="element-subject"></span>`subject` | [Reference](/fhir-elements/complex/reference) | `0..1` | The patient or group present at the encounter |
| <span id="element-episode-of-care"></span>`episodeOfCare` | [Reference](/fhir-elements/complex/reference) | `0..*` | Episode(s) of care that this encounter should be recorded against |
| <span id="element-based-on"></span>`basedOn` | [Reference](/fhir-elements/complex/reference) | `0..*` | The ServiceRequest that initiated this encounter |
| <span id="element-participant"></span>`participant` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | List of participants involved in the encounter |
| <span id="element-appointment"></span>`appointment` | [Reference](/fhir-elements/complex/reference) | `0..*` | The appointment that scheduled this encounter |
| <span id="element-period"></span>`period` | [Period](/fhir-elements/complex/period) | `0..1` | The start and end time of the encounter |
| <span id="element-length"></span>`length` | [Duration](/fhir-elements/complex/duration) | `0..1` | Quantity of time the encounter lasted (less time absent) |
| <span id="element-reason-code"></span>`reasonCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Coded reason the encounter takes place |
| <span id="element-reason-reference"></span>`reasonReference` | [Reference](/fhir-elements/complex/reference) | `0..*` | Reason the encounter takes place (reference) |
| <span id="element-diagnosis"></span>`diagnosis` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | The list of diagnosis relevant to this encounter |
| <span id="element-account"></span>`account` | [Reference](/fhir-elements/complex/reference) | `0..*` | The set of accounts that may be used for billing for this Encounter |
| <span id="element-hospitalization"></span>`hospitalization` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..1` | Details about the admission to a healthcare service |
| <span id="element-location"></span>`location` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | List of locations where the patient has been |
| <span id="element-service-provider"></span>`serviceProvider` | [Reference](/fhir-elements/complex/reference) | `0..1` | The organization (facility) responsible for this encounter |
| <span id="element-part-of"></span>`partOf` | [Reference](/fhir-elements/complex/reference) | `0..1` | Another Encounter this encounter is part of |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `account` | reference | The set of accounts that may be used for billing for this Encounter |
| `appointment` | reference | The appointment that scheduled this encounter |
| `based-on` | reference | The ServiceRequest that initiated this encounter |
| `class` | token | Classification of patient encounter |
| `date` | date | Multiple 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  |
| `diagnosis` | reference | The diagnosis or procedure relevant to the encounter |
| `episode-of-care` | reference | Episode(s) of care that this encounter should be recorded against |
| `identifier` | token | Multiple 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  |
| `length` | quantity | Length of encounter in days |
| `location` | reference | Location the encounter takes place |
| `location-period` | date | Time period during which the patient was present at the location |
| `part-of` | reference | Another Encounter this encounter is part of |
| `participant` | reference | Persons involved in the encounter other than the patient |
| `participant-type` | token | Role of participant in encounter |
| `patient` | reference | Multiple 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  |
| `practitioner` | reference | Persons involved in the encounter other than the patient |
| `reason-code` | token | Coded reason the encounter takes place |
| `reason-reference` | reference | Reason the encounter takes place (reference) |
| `service-provider` | reference | The organization (facility) responsible for this encounter |
| `special-arrangement` | token | Wheelchair, translator, stretcher, etc. |
| `status` | token | planned \| arrived \| triaged \| in-progress \| onleave \| finished \| cancelled + |
| `subject` | reference | The patient or group present at the encounter |
| `type` | token | Multiple 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 [#reference]

Official FHIR R4 spec: [Encounter](https://hl7.org/fhir/R4/encounter.html).  
Maturity: Trial Use 2 (FMM 2).
