Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Use case scope for rebook and cancel

Defines the envisiged use case scope for rebooking and cancel within the Standard

Cancel booking

  • The booking Consumer must be capable of cancelling any booking made by them, within the current consultation or after the consultation event, as in the outlined scenarios
  • The booking Consumer must retrieve the booking to be cancel from the booking Provider prior to cancellation to ensure they are working with the most upto date booking
  • The booking Consumer must provide visible confirmation to the user of the status returned by the booking Provider, i.e. whether the original booking was successfully cancelled
  • If the update fails the booking Provider must respond with the most appropriately aligned error as defined in the Specification
  • The booking Provider must store all previous versions of the booking
  • The booking Provider must not be required to inform the patient of the cancellation of the booking.  Business/clinical responsibility for informing the patient must remain with the booking Consumer
  • Any referral document, sent as part of a booking, should be decoupled from the booking when cancelled and not to be assumed a referral in its own right i.e. to ensure ‘booking only’ services are appropritely updated
  • Sufficient information around the cancelling process must be persisted to support the reporting and audit requirements

Rebook

  • The booking Consumer must be capable of rebooking any booking made by them, within the current consultation or after the consultation event, as in the outlined scenarios
  • If a callback occurs, after the consultation has been completed, prior to attempting a rebook the patient should be reassessed
  • The booking Consumer should make the new booking prior to cancelling any original booking, whether within the current consultation or after the consultation event
  • The booking Consumer must provide visible confirmation to the user of the status returned by the Provider, i.e.. whether the original booking was successfully cancelled and the new booking has been made successfully. 
  • The booking Provider must not be required to inform the patient of the cancellation, incurred as part of the rebooking process.  Business/clinical responsibility for informing the patient must remain with the booking Consumer
  • Sufficient information around the cancelling process must be persisted to support the reporting and audit requirements

All content is available under the Open Government Licence v3.0, except where otherwise stated