Test Data for WebDoc
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 WebDoc EHR setup guide.
Environment Overview
When using Leyr credentials, you'll interact with a smart mock environment that fully replicates real WebDoc data models. All response structures and data formats match your production experience exactly. With your own credentials, you'll access the real WebDoc test environment with full functionality.
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 WebDoc system. 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 document management workflows.
Create Patient: Use POST /patients to create new patients. All standard patient fields are supported with realistic response data.
Get Patient: Use GET /patients/{patient_id} with any patient ID from patients created via the API or existing in your system.
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 WebDoc 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.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
Create clinical notes associated with patients, with retrieval functionality in development.
Create Medical Note: Use POST /medical-notes to add new clinical notes for a patient.
Documents
Create and upload documents for patient records, with retrieval functionality not yet available.
Create Document: Use POST /documents to upload or create new documents for patients.
Happy coding! 🙂