We have a fully integrated Sandbox for testing with AthenaOne. Most endpoints are functional and reflect real-world behavior. The sandbox follows US healthcare regulations and data requirements.
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 AthenaOne system. Use any id from the response in the path parameter for other endpoints.
Known Test Care Unit ID: If testing with using your own credentials, you can use 195900 as care unit ID. Check AthenaOne setup guide for more details.
| care_unit_id |
|---|
| 195900 |
Create and retrieve patient information following US healthcare data requirements.
Create Patient: Use POST /patients to create new patients.
Get Patient: Use GET /patients/{patient_id} with any patient ID from your system or patients created via the API.
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 AthenaOne system.
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.Create and retrieve appointments.
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.
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.
Happy coding! 🙂