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
Edit Visit Request
Edit a Visit Request.
We do not support editing a canceled Visit Request.
PATCH
/
visit-requests
/
{id}
curl --request PATCH \
--url https://api.axlehealth.com/api/v2-stable/visit-requests/{id} \
--header 'Content-Type: application/json' \
--data '{
"fulfillment_window": {
"earliest_start_datetime": "2023-11-11T05:31:56Z",
"latest_end_datetime": "2023-11-30T05:31:56Z"
},
"clinician_appointments_to_add": [
{
"clinician_appointment_id": "d7cd00da-8491-4adb-b980-15d445e0afb6",
"clinician_id": "56253eae-4226-4e00-a25b-877c763575e3"
}
],
"encounters_to_add": [
{
"clinician_appointment_id": "d7cd00da-8491-4adb-b980-15d445e0afb6",
"services": [
{
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
],
"clinician_appointments_to_edit": [
{
"clinician_appointment_id": "57ff0529-07f6-4d3a-8290-dee8fd52e235",
"clinician_id": "6fbb12a5-c61a-4dc6-b5d2-b64ec18fad86"
}
],
"encounters_to_edit": [
{
"clinician_appointment_id": "57ff0529-07f6-4d3a-8290-dee8fd52e235",
"services": [
{
"service_id": "bdf701aa-94e6-49c1-9972-839f7b41a6e5"
}
]
}
],
"clinician_appointments_to_delete": [
{
"clinician_appointment_id": "612edc36-e095-425b-ac83-f97039ae8590"
}
],
"encounters_to_delete": [
{
"clinician_appointment_id": "a1086b76-4c5a-4ad0-97d7-5a576408b65c"
}
],
"state": "PENDING",
"address": {
"line1": "321 Niam Ts.",
"line2": "Apt 11-11",
"city": "The City",
"state": "AZ",
"zip_code": "10027"
},
"clinic_id": "93eb2c98-950d-4245-a5b0-9186b1359237",
"priority": "HIGH",
"external_id": "RGZ-91B",
"metadata": {}
}'
This response does not have an example.
Body
application/json
Response
200
Visit request edited successfully
curl --request PATCH \
--url https://api.axlehealth.com/api/v2-stable/visit-requests/{id} \
--header 'Content-Type: application/json' \
--data '{
"fulfillment_window": {
"earliest_start_datetime": "2023-11-11T05:31:56Z",
"latest_end_datetime": "2023-11-30T05:31:56Z"
},
"clinician_appointments_to_add": [
{
"clinician_appointment_id": "d7cd00da-8491-4adb-b980-15d445e0afb6",
"clinician_id": "56253eae-4226-4e00-a25b-877c763575e3"
}
],
"encounters_to_add": [
{
"clinician_appointment_id": "d7cd00da-8491-4adb-b980-15d445e0afb6",
"services": [
{
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
],
"clinician_appointments_to_edit": [
{
"clinician_appointment_id": "57ff0529-07f6-4d3a-8290-dee8fd52e235",
"clinician_id": "6fbb12a5-c61a-4dc6-b5d2-b64ec18fad86"
}
],
"encounters_to_edit": [
{
"clinician_appointment_id": "57ff0529-07f6-4d3a-8290-dee8fd52e235",
"services": [
{
"service_id": "bdf701aa-94e6-49c1-9972-839f7b41a6e5"
}
]
}
],
"clinician_appointments_to_delete": [
{
"clinician_appointment_id": "612edc36-e095-425b-ac83-f97039ae8590"
}
],
"encounters_to_delete": [
{
"clinician_appointment_id": "a1086b76-4c5a-4ad0-97d7-5a576408b65c"
}
],
"state": "PENDING",
"address": {
"line1": "321 Niam Ts.",
"line2": "Apt 11-11",
"city": "The City",
"state": "AZ",
"zip_code": "10027"
},
"clinic_id": "93eb2c98-950d-4245-a5b0-9186b1359237",
"priority": "HIGH",
"external_id": "RGZ-91B",
"metadata": {}
}'
This response does not have an example.
Assistant
Responses are generated using AI and may contain mistakes.