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
Get Visit Request
Returns the full details about a Visit Request.
GET
/
visit-requests
/
{id}
curl --request GET \
--url https://api.axlehealth.com/api/v2-stable/visit-requests/{id}
{
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fulfillment_window": {
"earliest_start_datetime": "2023-11-07T05:31:56Z",
"latest_end_datetime": "2023-11-07T05:31:56Z"
},
"clinician_appointments": [
{
"clinician_appointment_id": "51df646f-20ff-42d1-9a3f-ee3d643abb45",
"clinician_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
{
"clinician_appointment_id": "28015f69-f90e-4b0f-acd6-7174f50f8c59",
"clinician_id": "e0cb1c7e-5bde-43f6-b360-768c42f67752"
}
],
"encounters": [
{
"clinician_appointment_id": "51df646f-20ff-42d1-9a3f-ee3d643abb45",
"services": [
{
"service_id": "1877d60a-8395-461f-b871-722444fe3245"
}
]
},
{
"clinician_appointment_id": "28015f69-f90e-4b0f-acd6-7174f50f8c59",
"services": []
}
],
"state": "PENDING",
"address": {
"line1": "123 Main St.",
"line2": "",
"city": "The City",
"state": "CA",
"zip_code": "90026"
},
"clinic_id": "e27f6fc7-b672-4376-9dbe-cf37ff5531ed",
"priority": "STANDARD",
"external_id": "MSN-00100",
"metadata": {}
}
Path Parameters
The unique identifier for the Visit Request
Response
200 - application/json
Visit details retrieved successfully
The response is of type object
.
curl --request GET \
--url https://api.axlehealth.com/api/v2-stable/visit-requests/{id}
{
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fulfillment_window": {
"earliest_start_datetime": "2023-11-07T05:31:56Z",
"latest_end_datetime": "2023-11-07T05:31:56Z"
},
"clinician_appointments": [
{
"clinician_appointment_id": "51df646f-20ff-42d1-9a3f-ee3d643abb45",
"clinician_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
{
"clinician_appointment_id": "28015f69-f90e-4b0f-acd6-7174f50f8c59",
"clinician_id": "e0cb1c7e-5bde-43f6-b360-768c42f67752"
}
],
"encounters": [
{
"clinician_appointment_id": "51df646f-20ff-42d1-9a3f-ee3d643abb45",
"services": [
{
"service_id": "1877d60a-8395-461f-b871-722444fe3245"
}
]
},
{
"clinician_appointment_id": "28015f69-f90e-4b0f-acd6-7174f50f8c59",
"services": []
}
],
"state": "PENDING",
"address": {
"line1": "123 Main St.",
"line2": "",
"city": "The City",
"state": "CA",
"zip_code": "90026"
},
"clinic_id": "e27f6fc7-b672-4376-9dbe-cf37ff5531ed",
"priority": "STANDARD",
"external_id": "MSN-00100",
"metadata": {}
}
Assistant
Responses are generated using AI and may contain mistakes.