Front Door
Endpoints for front-of-house workflows: self-service and kiosk actions like generating an appointment booking link or checking a patient in on arrival, plus telephony system integrations such as looking up an inbound caller. Front Door builds on the base Transactional API: the same authentication and base URL apply.
Caller ID Lookup
Looks up patients by phone number. Returns all patients whose registered phone number matches, plus patients linked to a matching registered carer or contact. Suitable for inbound call identification.
Create Appointment Booking Link
Generates a public URL for self-service appointment booking. Provide either `requiredProcedures` (SNOMED CT coded) or both `appointmentServiceId` and `appointmentTypeId`, but not both; see Get Appointment Metadata for the available services, types and procedures.
Create Patient Request
Submits a patient request to Medicus on behalf of a patient. Use `medical` for clinical concerns and `admin` for administrative matters. A request is rejected if the organisation has that request type switched off or paused, or is closed or outside the opening hours it has configured for that type, matching the rules the patient portal applies.
List Called-in Appointments
Returns pending appointments at the given site whose arrival status is currently Called In, ordered by intended start time. An appointment drops off this list once its consultation starts, its called-in status is cleared, or it is marked as Did Not Attend.