Entity: Encounter

Class Diagram

Encounter

Display

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

Please see the manual for more information.

Mappings

 

HL7 API

FHIR API

(Customer boxes support full CRUD)

Web

Custom REST API

 

(event based updates)

Facade (STU3)

Aggregated (R4)

 

 

Summary of interactions

Create

A01/A02/A03/A05/A14/A08

 

 

 

 

Read

 

/Encounter

 

Events & messages

 

Update

A01/A03/A05/A14

(A02 and A08 cannot be updated)

 

 

 

 

Delete

A11/A12/A13/A38/A27

(A08 cannot be deleted)

 

 

 

 

Entity: Encounter

Encounter ID String

A unique ID identifying this encounter. This ID will not change even if the encounter is modified.

 

Encounter.id

 

Not shown.

 

External Encounter ID String

The ID assigned to this encounter by the source system.

PV1-19.1 (ADT)

 

 

Not shown.

 

Entity: Encounter Event - Extends: Data Point

Type Enum

  • PRE_ADMIT

  • PENDING_ADMIT

  • ADMIT

  • TRANSFER

  • DISCHARGE

  • UPDATE

 

 

 

The type is reflected in the message contents.

 

Class Enum

  • IN_PATIENT

  • OUT_PATIENT

  • AMBULATORY

  • EMERGENCY

  • HOME

  • FIELD

  • DAYTIME

  • VIRTUAL

  • OTHER

PV1-2.1 (ADT)

Encounter.class
Encounter.classHistory

 

The class of the most recent event is shown, other classes are not shown.

 

Timestamp Timestamp

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)

EVN-3.1 (ADT)

EVN-6.1 (ADT)

PV1-45.1 (ADT)

PV2-8.1 (ADT)

Encounter.period

 

The timestamp is reflected in the message contents, except for UPDATE messages.

 

Location String

A brief description of the location of the event.

PV1-3.9 (ADT)

Encounter.location

 

Shown.

 

Entity: External Participant

Role Enum

  • ATTENDER

  • REFERRER

  • CONSULTANT

The role is determined automatically by the field in which the participant’s name is provided.

Encounter.participant

 

Shown.

 

Name String

The name of the participant.

PV1-7 (ADT)
PV1-8 (ADT)
PV1-9 (ADT)

Encounter.participant

 

Shown.

 

Â