Test Data for Cliniko
It is applicable when using Leyr credentials, as described in the EHR configuration guide.
If you'd like to use your own credentials or are going live, please refer to our Cliniko EHR setup guide.
Environment Overview
We have a fully integrated Sandbox for testing with Cliniko. All endpoints are functional and reflect real-world behavior, allowing you to test complete workflows from patient creation through medical notes and appointment management.
Common Workflows
Care Units Discovery
This is the typical entry point to the Leyr API. The care unit ID returned here is required for all subsequent API calls.
Call GET /care-units to discover available care units in your Cliniko account. Use any id from the response in the path parameter for other endpoints.
Patient Management
Create and retrieve patient information for use in appointment booking and medical record workflows.
Create Patient: Use POST /patients to create new patients. All standard patient fields are supported and will be reflected in your Cliniko system.
Get Patient: Use GET /patients/{patient_id} with any patient ID from your system, or from patients created via the API.
Availability
Discover available resources, services, and time slots for appointment booking.
Get Services: Call GET /healthcare-services to retrieve all available healthcare services configured in your Cliniko account.
Get Resources: Call GET /resources to get available practitioners and resources.
Get Time Slots: Use GET /timeslots with resource_id and/or healthcare_service_id from previous calls to find available appointment times.
/timeslots call without filtering parameters to see all available slots, then use resource_id or healthcare_service_id to narrow down results.Appointment Booking
Complete appointment lifecycle management using data from previous workflows.
Book Appointment: Use POST /appointments with a patient ID (from Patient Management) and time slot details (from Availability) to create appointments.
Get Appointments: Call GET /appointments to retrieve existing appointments. You can filter by patient, date range, or leave parameters empty to see all appointments.
Update Appointment: Use PATCH /appointments/{appointment_id} to modify existing appointments.
Cancel Appointment: Use PATCH /appointments/{appointment_id} to cancel appointments.
Medical Notes
Manage clinical notes associated with patients.
Get Medical Notes: Use GET /medical-notes with a patient ID to retrieve existing clinical notes.
Create Medical Note: Use POST /medical-notes to add new clinical notes for a patient.
Documents
Happy coding! 🙂