Get a clinician's diary
get_clinician_agendaFetch a clinician's diary for up to 45 days, listing bookings and availability/unavailability intervals in time order, with optional patient contact details.
Instructions
A clinician's diary for a date range (at most 45 days inclusive, as the API documents): bookings, availability intervals and unavailability intervals in time order, each with start and end time, location and services. Bookings carry the patient's name; the patient's contact details, date of birth, NHS number and address, and the booking's free-text information, only with include_contact_details. Availability shows the schedule, not bookable times: use find_availability for those.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | Yes | Last date to include, YYYY-MM-DD (inclusive; at most 45 days after start_date) | |
| start_date | Yes | First date to include, YYYY-MM-DD | |
| clinician_id | Yes | ||
| include_contact_details | No | Include patient contact details, date of birth, NHS number, address, payor details and the booking's information fields, and stop redacting email addresses, phone numbers, NHS-number-shaped digit groups and UK postcodes typed into names and other text |