Body
application/json
Response
Successful response with clinician options
The response is of type object
.
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/clinician-options/potential-visit/date-range \
--header 'Content-Type: application/json' \
--data '{
"search_window": {
"start_datetime": "2024-05-09T15:28:00Z",
"end_datetime": "2024-05-15T15:28:00Z"
},
"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": null,
"duration_override_minutes": 60,
"clinician_appointments": [
{
"clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
"is_virtual": true,
"start_offset_minutes": null,
"duration_override_minutes": null
}
],
"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"
}
]
}
]
},
"clinician_filters": [
{
"clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
"clinicians": [
{
"clinician_id": "bfa23251-4e6e-4ddb-9096-171750871787"
}
]
}
]
}'
{
"clinician_options": [
{
"clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
"eligible_clinicians": [
{
"clinician_id": "bfa23251-4e6e-4ddb-9096-171750871787"
}
]
}
]
}
Returns clinician options for a Potential Visit that would be Eligible to perform the specified certain services at some point in a given date range.
This is useful for the Who, then when workflow.
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/clinician-options/potential-visit/date-range \
--header 'Content-Type: application/json' \
--data '{
"search_window": {
"start_datetime": "2024-05-09T15:28:00Z",
"end_datetime": "2024-05-15T15:28:00Z"
},
"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": null,
"duration_override_minutes": 60,
"clinician_appointments": [
{
"clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
"is_virtual": true,
"start_offset_minutes": null,
"duration_override_minutes": null
}
],
"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"
}
]
}
]
},
"clinician_filters": [
{
"clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
"clinicians": [
{
"clinician_id": "bfa23251-4e6e-4ddb-9096-171750871787"
}
]
}
]
}'
{
"clinician_options": [
{
"clinician_appointment_id": "3b5123fe-a20a-4a21-a057-76f066730421",
"eligible_clinicians": [
{
"clinician_id": "bfa23251-4e6e-4ddb-9096-171750871787"
}
]
}
]
}
Successful response with clinician options
The response is of type object
.