A004 - Retrieving appointment cancellation reasons

e-Referral Service (e-RS)
1

Hi would someone be able provide the definitive list for the AppointmentRequestCancellationReasonType fields that are returned when retrieving appointment cancellation reasons from the A004 reference data endpoint. The samples contain examples with “PROVIDER” and “PROVIDER_REJECT”, but it doesn’t state what else could be retrieved for “https://fhir.nhs.uk/STU3/CodeSystem/eRS-Concept-Properties-1#appointmentBookingCancellationReasonTy…”

2

Hi Sean thanks for your query,

Here is the definitive list:

  • PROVIDER - provider-initiated cancellation
  • PROVIDER_REJECT - provider rejection
  • PATIENT - patient-initiated cancellation
  • REFERRER - referer-initiated cancellation
  • UNKNOWN - unspecified

Hope this helps,

George

3

Thanks for your response

4

Hi looking at the responses we get back from the API we don’t see any reasons being returned for the above is that correct? This when validating against the INT API response for appointment cancelation reasons

5

Hi Sean,

This is correct and expected. REFERRER currently has no appointment cancellation reason assigned to it, so A004 doesn’t return it.

In practice, when a referrer cancels a patient’s appointment, the reason returned carries the PATIENT type ( a referrer cancels on behalf of the patient) rather than REFERRER, those reasons are simply made available to the referring-clinician business functions.

We would still recommend your integration handles REFERRER defensively, as it is a part of our published code and could be populated in the future, but you won’t see responses at present.

Hope that clears things up,

George