---
title: "Entity: Encounter"
canonical: "https://wiki.patientsknowbest.com/space/api/3744497665/Entity%3A%20Encounter"
format: markdown
---
> Macro (toc)

# Class Diagram

<u>[Encounter](https://miro.com/app/board/uXjVMNRdh-g=/?share_link_id=207663707214)</u>

# Display

Encounters appear in the Events & messages page of a patient's record.

Please see[ ](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fevents-messages&sa=D&sntz=1&usg=AOvVaw3KGUcb-zsSj-WuyxgQ421v)<u>[the manual](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fevents-messages&sa=D&sntz=1&usg=AOvVaw3KGUcb-zsSj-WuyxgQ421v)</u> for more information.

# Mappings

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
|  | **HL7 API** | **FHIR API**<br>(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
|  | (event based updates) | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Summary of interactions** |
| Create | [A01](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365077971)/[A02](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012302)/[A03](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848574)/[A05](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848597)/[A14](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012440)/[A08](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848610) |  |  |  |  |
| Read |  | [/Encounter](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364946356) |  | [Events & messages](https://manual.patientsknowbest.com/patient/events-messages) |  |
| Update | [A01](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365077971)/[A03](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848574)/[A05](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848597)/[A14](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012440)<br>(A02 and A08 cannot be updated) |  |  |  |  |
| Delete | [A11](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848631)/[A12](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848666)/[A13](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3365012428)/[A38](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364848770)/[A27](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364946987)<br>(A08 cannot be deleted) |  |  |  |  |
| **Entity: Encounter** |
| **Encounter ID** `String`<br>A unique ID identifying this encounter. This ID will not change even if the encounter is modified. |  | [Encounter.id](http://fhir.patientsknowbest.com/structuredefinition/facade-encounter) |  | Not shown. |  |
| **External Encounter ID** `String`<br>The ID assigned to this encounter by the source system. | [PV1-19.1 (ADT)](http://dev.patientsknowbest.com/home/hl7-api/messages/adt-a01) |  |  | Not shown. |  |
| **Entity: Encounter Event - Extends: ****[Data Point](https://wiki.patientsknowbest.com/space/api/3750395905/Entity%3A+Data+Point)** |
| **Type** `Enum`<br>- PRE_ADMIT
- PENDING_ADMIT
- ADMIT
- TRANSFER
- DISCHARGE
- UPDATE |  |  |  | The type is reflected in the message contents. |  |
| **Class** `Enum`<br>- IN_PATIENT
- OUT_PATIENT
- AMBULATORY
- EMERGENCY
- HOME
- FIELD
- DAYTIME
- VIRTUAL
- OTHER | [PV1-2.1 (ADT)](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a01) | [Encounter.class](http://fhir.patientsknowbest.com/structuredefinition/facade-encounter)   
[Encounter.classHistory](http://fhir.patientsknowbest.com/structuredefinition/facade-encounter) |  | The class of the most recent event is shown, other classes are not shown. |  |
| **Timestamp** `Timestamp`<br>The relevant timestamp will vary depending on the type of message. For HL7 ADT messages this will normally be the timestamp of the relevant event. | [PV1-44.1 (ADT)](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a01)<br>[EVN-3.1 (ADT)](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a01)<br>[EVN-6.1 (ADT)](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a01)<br>[PV1-45.1 (ADT)](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a01)<br>[PV2-8.1 (ADT)](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a01) | [Encounter.period](http://fhir.patientsknowbest.com/structuredefinition/facade-encounter) |  | The timestamp is reflected in the message contents, except for UPDATE messages. |  |
| **Location** `String`<br>A brief description of the location of the event. | [PV1-3.9 (ADT)](http://dev.patientsknowbest.com/home/hl7-api/messages/adt-a01) | [Encounter.location](http://fhir.patientsknowbest.com/structuredefinition/facade-encounter) |  | Shown. |  |
| **Entity: External Participant** |
| **Role** `Enum`<br>- ATTENDER
- REFERRER
- CONSULTANT | The role is determined automatically by the field in which the participant’s name is provided. | [Encounter.participant](http://fhir.patientsknowbest.com/structuredefinition/facade-encounter) |  | Shown. |  |
| **Name** `String`<br>The name of the participant. | [PV1-7 (ADT)](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a01)  
[PV1-8 (ADT)](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a01)  
[PV1-9 (ADT)](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a01) | [Encounter.participant](http://fhir.patientsknowbest.com/structuredefinition/facade-encounter) |  | Shown. |  |