API Documentation
API Reference
- POSTCoverage Lookup
- POSTGenerate potential visit from service bundle
- POSTVisit time options for existing visit
- POSTVisit time options for potential visit
- POSTClinician options for existing visit at existing time
- POSTClinician options for potential visit over date range
- POSTClinician Options for Potential Visit at Proposed Time
- POSTCreate Visit
- GETGet Visit
- PATCHEdit Visit
- POSTCreate Visit Request
- GETGet Visit Request
- PATCHEdit Visit Request
- POSTCreate Patient
- GETGet Patient
- PATCHEdit Patient
- GETList Services
- GETList Service Bundles
- POSTCreate Clinician
- GETGet Clinician
- PATCHEdit Clinician
- GETList Clinicians
- POSTCreate Shift
- GETList all shifts
- GETGet Shift
- PATCHEdit Shift
- POSTCreate Shift Block
- GETList Shift Blocks
- GETGet Shift Block
- PATCHEdit Shift Block
- DELDelete Shift Block
- POSTCreate Territory
- GETList Territories
- PATCHEdit Territory
- GETGet Territory
- POSTCreate Qualification
- GETList Qualifications
- GETGet Qualification
- PATCHEdit Qualification
- DELDelete Qualification
- GETList Payers
- POSTCreate Care Team
- GETList Care Teams
- GETGet Care Team
- PATCHEdit Care Team
- POSTGenerate download link for document
- POSTCreate Visit Reservation
- DELDelete Reservation
API Reference
Create Visit Reservation
Creates a hold on clinicians’ schedules for a visit you plan to book soon.
POST
/
visit-reservations
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/visit-reservations \
--header 'Content-Type: application/json' \
--data '{
"potential_visit": {
"service_area_id": "a2b34371-99d2-4e7e-9d05-dc56e168b2aa",
"zip_code": "12345",
"start_datetime": "2024-02-20T10:00:00",
"clinician_appointments": [
{
"clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
"is_virtual": true,
"clinician_id": "ea49694e-953a-4c5a-b944-6dfaf9d08fa2",
"start_offset_minutes": 123,
"duration_override_minutes": 123
}
],
"encounters": [
{
"clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
"services": [
{
"service_id": "d0e8a28b-ebb2-4b3f-b934-890b1bc4e857"
}
]
}
],
"created_from_service_bundle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"expiry_datetime": "2024-02-20T11:00:00"
}'
{
"visit_reservation_id": "bbde9f02-f44d-4ef0-924f-204674be2d62"
}
Body
application/json
Response
201
application/json
Visit Reservation Created
The response is of type object
.
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/visit-reservations \
--header 'Content-Type: application/json' \
--data '{
"potential_visit": {
"service_area_id": "a2b34371-99d2-4e7e-9d05-dc56e168b2aa",
"zip_code": "12345",
"start_datetime": "2024-02-20T10:00:00",
"clinician_appointments": [
{
"clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
"is_virtual": true,
"clinician_id": "ea49694e-953a-4c5a-b944-6dfaf9d08fa2",
"start_offset_minutes": 123,
"duration_override_minutes": 123
}
],
"encounters": [
{
"clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
"services": [
{
"service_id": "d0e8a28b-ebb2-4b3f-b934-890b1bc4e857"
}
]
}
],
"created_from_service_bundle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"expiry_datetime": "2024-02-20T11:00:00"
}'
{
"visit_reservation_id": "bbde9f02-f44d-4ef0-924f-204674be2d62"
}
Assistant
Responses are generated using AI and may contain mistakes.