Get Appointment Detail

Overview

get_appointment_detail retrieves detailed information about a specific FHIR Appointment resource. An LLM/agent should call this tool when a patient wants more information about a particular appointment. It requires the appointment_id and returns full details including location, practitioner, and status.

Required Parameters

appointment_id (string)

  • The appointment ID stored in FHIR (from get_appointments).

Optional Parameters

person_id (string)

  • Default: None
  • The b.well FHIR Person ID (bwellClientFhirPersonId). Optional for the default patient.

debug (boolean)

  • Default: false
  • Whether to display debugging information.

Returns

Returns an AppointmentDetail object with:

  • id (string, optional) — Appointment ID.
  • status (string, optional) — Appointment status.
  • start (string, optional) — Start date/time.
  • end (string, optional) — End date/time.
  • timezone (string, optional) — Timezone.
  • visit_reason_text (string, optional) — Reason for the visit.
  • appointment_dat (string, optional) — Appointment DAT identifier.
  • location (object, optional) — Location details: name, address_line, city, state, postal_code, phone.
  • practitioner (object, optional) — Practitioner details: full_name, specialty.

Unlike most other scheduling tools, this return model does not extend the shared base result model, so it does not include result, error, urls, meta, or debug fields.

Notes

  • This tool is typically used after get_appointments to get full detail on a specific appointment from the list.


Did this page help you?