Appointment UI Mapping

status

proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist

CANCELLED, ENTERED-IN-ERROR → CANCELLED

NOSHOW → DNA

PENDING → PENDING

BOOKED, PROPOSED, ARRIVED, FULFILLED, CHECKED-IN, WAITLIST → ACTIVE

Required

Status

1. Main ‘Appointments’ page:

   1. Status

2. Detailed ‘Appointments’ page

   1. Status

How each status displays:

1. noshow Displays as Did not attend

2. cancelled | entered-in-error: : Displays as Cancelled

3. pending: Displays as Pending

4. proposed | booked | arrived | fulfilled | checked-in | waitlist: Treated as Active (no status displayed)

Please note:

Additional status: ‘Reschedule in review' and ‘Cancellation in review’ displayed when an appointment change request is made on the UI.

Appointment is still stored as original status until ammended .

start

When appointment is to take place

Required

1. Main ‘Appointments’ page:

   1. Appointment start date & time displayed below appointment subject:
      Day DD Month YYYY
      HH:MM

2. Detailed ‘Appointments’ page

   1. Appointment start date & time is page header 1 :
      Day DD Month YYYY
      HH:MM am/pm

end

When appointment is to conclude

Required

Detailed ‘Appointments’ page

End date and time

Day DD Month YYYY HH:MM am / pm

appointmentType.coding[].display

The appointment Subject in PKB

Required

1. Main ‘Appointments’ page:

   1. Shown in Blue bold

2. Detailed ‘Appointments’ page

   1. Appointment subject h1 BOLD

Please note:

Subject displayed simply as ‘Appointment’ if not sent.

specialty.coding[].display

The specialty area / clinic

Optional

1. Main ‘Appointments’ page:

   1. Specialty:

2. Detailed ‘Appointments’ page

   1. Specialty

comment

Additional appointment specific details and/or guidance for patients.

Optional

Detailed ‘Appointments’ page

1. Description

participant[].actor.reference

participant[].actor.display

Add an attending clinician or professional

Display name of the participant

Optional

1. Main ‘Appointments’ page:

   1. Attendees:

2. Detailed ‘Appointments’ page

   1. Attendees

Please note:

Whilst discouraged, if sending as text only, please put the role in brackets, for example: Dr Jones (Consultant)

participant.actor.display

Provide appointment location

Required

1. Main ‘Appointments’ page:

   1. Location:

2. Detailed ‘Appointments’ page

   1. Location

Location (if actor is Location)

extension(url=...spoc).extension(url=...spoc-email).valueString

Single point of contact email

Optional

1. Detailed ‘Appointments’ page

   1. Booking team contact details

extension(url=...spoc).extension(url=...spoc-phone).valueString

Single point of contact phone

Optional

1. Detailed ‘Appointments’ page

   1. Booking team contact details

extension(url=...spoc).extension(url=...spoc-note).valueString

Single point of contact note

Optional

1. Detailed ‘Appointments’ page

   1. Booking team contact details

   2. Will be shown on seperate line below contact details

meta.security[].code

Security labels applied to this resource (Privacy)

Optional

Depending on privacy flag selected:

• General health

• Mental health

• Sexual health

• Social care

Please note: If no label is sent, it will default to general health

meta.lastUpdated

When the resource version last changed

Optional

1. Main ‘Appointments’ page (Information):

   1. Entered date: