Update appointment (A034, FHIR STU3)

Overview

Use this endpoint to cancel an appointment that is booked into a directly-bookable service. Appointments made to directly-bookable services always have a date and time. You can only ever update the current appointment, i.e. an appointment that is related to a service on the current shortlist and the most recent appointment made.

Currently, this endpoint only allows cancellation of an appointment as an update. Future developments may permit further updates.

To cancel the referral, use [[HYPERLINK_A036]].

Supported security patterns

• Healthcare worker, user-restricted access

Pre-requisites

In order to use this endpoint you must be an authenticated e-RS user and use one of the following e-RS roles:

• REFERRING_CLINICIAN
• REFERRING_CLINICIAN_ADMIN

You must use [[HYPERLINK_A004]] to retrieve reference data from the set APPOINTMENT-CANCELLATION-REASON.

To find out which reference data from this set can be used to cancel an appointment, filter as follows:

• usage must be CANCEL,
• businessFunction must be REFERRING_CLINICIAN or REFERRING_CLINICIAN_ADMIN (depending which authenticated user will be performing the action),
• effectiveFrom must be in the past, and
• effectiveTo must not be in the past

Both the appointment reference, and version, are needed to update an appointment:

You must use [[HYPERLINK_A005]] to obtain the current appointment reference (via Extension-eRS-Appointment-Reference-1).

You must use [[HYPERLINK_A038]] to obtain the current appointment and get the current appointment's version.

Use case

As an authenticated user

I need to update the current appointment

So that I can manage the patients care appropriately.

Related endpoints

You can retrieve the reference data needed to cancel an appointment by using [[HYPERLINK_A004]]. This contains "reasons" for cancellation.

You can check if you currently can cancel the appointment by checking [[HYPERLINK_A029]].

You must use [[HYPERLINK_A005]] to obtain the current appointment reference (via Extension-eRS-Appointment-Reference-1) .

You must use [[HYPERLINK_A038]] to obtain the current appointment and get the current appointment's version.

You can use [[HYPERLINK_A031]] after updating an appointment, to create a new shortlist of services. After changing a shortlist, you may be able to [[HYPERLINK_A016]].

Known Issues

1. The Participant.type attribute is being mapped as a single type for this endpoint. As per the Appointment FHIR profile, this attribute should be an array. See our problems and fixes section for more information.
2. The participant of an Appointment references a value set. As per the Appointment FHIR profile, this attribute should be a coding system. See our problems and fixes section for more information.