Entity: Identifiers

HL7 API

FHIR API

Web

Custom REST API

(event based updates)

Facade (STU3)

Aggregated (R4)

Summary of interactions

Read

/Encounter

Events & messages

Write

A01/A02/A03/A05/A14/A08

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

External Encounter ID

String

The ID assigned to this encounter by the source system.

PV1-19.1 (ADT)

Entity: Encounter Event - Extends: Data Point

Type

Enum

• PRE_ADMIT

• PENDING_ADMIT

• ADMIT

• TRANSFER

• DISCHARGE

• UPDATE

Class

Enum

• IN_PATIENT

• OUT_PATIENT

• AMBULATORY

• EMERGENCY

• HOME

• FIELD

• DAYTIME

• VIRTUAL

• OTHER

PV1-2.1 (ADT)

Encounter.class
Encounter.classHistory

Inbox page
Conversation page

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

Conversation page

Entity: Location

Name

String

The name.

Description

String

A brief description.

PV1-3.9 (ADT)

Encounter.location

Conversation page

Address

String

The address.

Entity: External Participant

Role

Enum

• ATTENDER

• REFERRER

• CONSULTANT

Encounter.participant

Conversation page

Name

String

The name of the participant.

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

Encounter.participant

Conversation page