Get Appointments

Overview

get_appointments lists the patient's existing appointments (FHIR Appointment bundle). An LLM/agent should call this tool when the patient wants to see their upcoming or past appointments. It returns appointment details including date/time, status, visit reason, location, and practitioner. Set is_past=true to see past appointments, or leave it unset/false for upcoming ones. Results support pagination via page_offset.

Optional Parameters

person_id (string)

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

page_offset (integer)

  • Default: 0
  • Page offset for pagination, starting at 0.

count (integer)

  • Default: None
  • Maximum number of appointments to return per page.

is_past (boolean)

  • Default: None
  • If true, returns past appointments. If false or unset, returns upcoming appointments.

debug (boolean)

  • Default: false
  • Whether to display debugging information.

Returns

Returns an AppointmentsListResult object with:

  • appointments (list, optional) — The list of appointments. Each entry is an appointment detail with fields such as id, status, start, end, timezone, visit_reason_text, appointment_dat, location (name, address line, city, state, postal code, phone), and practitioner (full name, specialty).
  • count (integer, optional) — Number of appointments returned.
  • Also includes the shared base result fields: result, error, urls, meta, and debug (the latter two populated only when debug=true).

Notes

  • This tool is the entry point for several flows: viewing appointments (optionally followed by get_appointment_detail for full detail on one appointment), canceling an appointment (get_appointmentsget_cancel_reasonscancel_appointment), and rescheduling an appointment (get_appointmentsget_scheduling_slotsreschedule_appointment).


Did this page help you?