Test Data for Anita Systems
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 Anita Systems EHR setup guide.
Environment Overview
We have a partially integrated Sandbox for testing with Anita Systems. You can create patients and book appointments, but some endpoints like retrieving existing patients or appointments are not supported. This environment includes real data for resources, services, and time slots.
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. Use either care unit ID from the table below:
care_unit_id |
---|
L0_1 |
L0_2 |
We recommend using L0_1
as it typically has more test data associated with it (healthcare services, resources, time slots, etc).
Patient Management
Create new patients for appointment booking workflows. Note that patient retrieval is not supported in this environment.
Create Patient: Use POST
/patients to create test patients. You must provide a valid phone number in the phones
field as you'll receive SMS confirmation codes during the appointment booking process.
Availability
Discover available resources, services, and time slots for appointment booking.
Get Services: Call GET
/healthcare-services to retrieve available healthcare services.
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.
Appointment Booking
Create appointments using data from previous workflows. Note that appointment management features are limited.
Book Appointment: Use POST
/appointments with a patient ID (from Patient Management) and time slot details (from Availability) to create appointments. The response will show "status": "awaiting_confirmation"
and an SMS confirmation code will be sent to the patient's phone number.
Confirm Appointment: After booking, use PATCH
/appointments/{appointment_id} with the confirmation code from the SMS to confirm the appointment. The request body should include:
{
"confirmation": {
"code": "{code_from_sms}"
}
}
Once confirmed, the appointment status will change to "booked"
. For more details on the confirmation process, see our appointment confirmation guide.
Medical Notes
Documents
Happy coding! ๐