Get Cancel Reasons

Overview

get_cancel_reasons retrieves available cancellation reason codes (FHIR CodeSystem). An LLM/agent should call this tool before canceling an appointment, to get valid cancellation_reason_code values. It returns a list of reason codes with human-readable descriptions.

Optional Parameters

debug (boolean)

• Default: false
• Whether to display debugging information.

Returns

Returns a CancelAppointmentResult object. For this tool, the relevant field is:

• cancel_reasons (list, optional) — The available cancellation reasons. Each entry has:
  • code (string) — Cancellation reason code to pass to cancel_appointment.
  • display_text (string) — Human-readable cancellation reason.

The same result model also defines appointment_id and success fields (used by cancel_appointment), plus the shared base result fields result, error, urls, meta, and debug (the latter two populated only when debug=true); these are not the focus of this tool's response.

Notes

• This tool sits between get_appointments and cancel_appointment in the cancellation flow: get_appointments → get_cancel_reasons → cancel_appointment. The code values it returns should be passed as cancellation_reason_code to cancel_appointment.