Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 

HL7 API

FHIR API

REST API

Web (Patient)

Summary of interactions

Read

 

/Appointment

 

Appointments

Write

SIU S12  /S13  /S14  /S15  /S26
ADT A05  /A14  /A27  /A38

 

 

Appointments

Attributes

Type

Coding

The type of appointment.

SCH-8
ZSC-8

 

 

Appointment details page

Start Timestamp

Timestamp

When the appointment starts.

SCH-11.4
EVN-3.1 (ADT)
PV1-44.1 (ADT)
PV2-8.1 (ADT)

Appointment.start

 

Appointment listing page
Appointment details page

End Timestamp

Timestamp

When the appointment ends.

SCH-11.5

Appointment.end

 

Appointment details page

Subject

String

A brief reason for the appointment.

SCH-7.2
PV1-2.1 (ADT)

Appointment.reason

 

Appointment listings page
Appointment details page

Description

String

A longer explanation of the appointment.

NTE-3.1 (SIU)

Appointment.comment

 

Appointment details page

Location

String

Where the appointment is to be held.

PV1-3.9 (SIU)
PV1-3.9 (ADT)

Appointment.participant

 

Appointment details page

Status

Enum

  • ACTIVE

  • CANCELLED

  • DNA

SIU

Appointment.status

 

Appointment listings page

External Management URL

String

A deep link URL to an external appointment interface, where this appointment can be managed.

SIU

The presence of a link will enable the “Manage” option.

Entity: Appointment Participant

...