Test Data for Speare
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 Speare EHR setup guide.
Environment Overview
We have our own dedicated test environment for Speare integration. This provides access to real Speare functionality while using specific test data configurations for reliable testing results.
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 Speare system. For testing, use the following care unit:
| emr_id |
|---|
| 51 |
Patient Management
Create and retrieve patient information for use in appointment booking workflows.
Create Patient: Use POST /patients to create new patients. Speare requires an address field when creating patients. All standard patient fields are supported and will be reflected in your Speare 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 Speare 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.
Appointment Booking
Create appointments 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.
Medical Notes
Documents
Happy coding! 🙂