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
Generate potential visit from service bundle
Generates information about a Potential Visit from a Service Bundle.
With this information, you will be able to create visits, fetch availability for a potential visit, etc.
POST
/
generate-potential-visit-from-service-bundle
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/generate-potential-visit-from-service-bundle \
--header 'Content-Type: application/json' \
--data '{
"service_area_id": "504969b7-1b55-4852-8f10-b7e137188b1b",
"address": {
"line1": "123 Main St",
"line2": "",
"city": "Anytown",
"state": "CA",
"zip_code": "12345"
},
"clinic_id": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
"patient_id": "e4c5371b-d421-4e41-aedc-9294fcd6323b",
"service_bundle_id": "1a52ddac-f526-4b56-ab5e-a7416c381812"
}'
{
"potential_visit": {
"service_area_id": "a2b34371-99d2-4e7e-9d05-dc56e168b2aa",
"address": {
"line1": "123 Main St",
"line2": "",
"city": "Anytown",
"state": "CA",
"zip_code": "12345"
},
"clinic_id": "<string>",
"duration_minutes": 60,
"clinician_appointments": [
{
"clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
"is_virtual": true,
"start_offset_minutes": 123,
"duration_override_minutes": 123,
"created_from_service_bundle_clinician_appointment_template_id": "2cd1c5c3-6e08-4673-b307-dc95ac4c4d3e"
}
],
"created_from_service_bundle_id": "e442baec-b574-49ce-8c7d-4d1400bab098",
"encounters": [
{
"patient_id": "e4c5371b-d421-4e41-aedc-9294fcd6323b",
"clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
"services": [
{
"service_id": "d0e8a28b-ebb2-4b3f-b934-890b1bc4e857"
}
]
}
]
}
}
Body
application/json
Response
200
application/json
Successful response
The response is of type object
.
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/generate-potential-visit-from-service-bundle \
--header 'Content-Type: application/json' \
--data '{
"service_area_id": "504969b7-1b55-4852-8f10-b7e137188b1b",
"address": {
"line1": "123 Main St",
"line2": "",
"city": "Anytown",
"state": "CA",
"zip_code": "12345"
},
"clinic_id": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
"patient_id": "e4c5371b-d421-4e41-aedc-9294fcd6323b",
"service_bundle_id": "1a52ddac-f526-4b56-ab5e-a7416c381812"
}'
{
"potential_visit": {
"service_area_id": "a2b34371-99d2-4e7e-9d05-dc56e168b2aa",
"address": {
"line1": "123 Main St",
"line2": "",
"city": "Anytown",
"state": "CA",
"zip_code": "12345"
},
"clinic_id": "<string>",
"duration_minutes": 60,
"clinician_appointments": [
{
"clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
"is_virtual": true,
"start_offset_minutes": 123,
"duration_override_minutes": 123,
"created_from_service_bundle_clinician_appointment_template_id": "2cd1c5c3-6e08-4673-b307-dc95ac4c4d3e"
}
],
"created_from_service_bundle_id": "e442baec-b574-49ce-8c7d-4d1400bab098",
"encounters": [
{
"patient_id": "e4c5371b-d421-4e41-aedc-9294fcd6323b",
"clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
"services": [
{
"service_id": "d0e8a28b-ebb2-4b3f-b934-890b1bc4e857"
}
]
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.