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
Creates a visit.
To see an example workflow, read Creating Your First Axle Visit.
By default, this endpoint validates the time and clinicians you have provided. This includes making sure the clinicians are Eligible to do the visit, Available at the chosen time, and that the time falls within the Service Area’s operating hours, and so on.
If you want to skip this validation, you can use the skip_everything
parameter to force the creation of the visit anyway. In the future, we may introduce fine-grained control over which validation rules are skipped; for now, we have the skip_everything
parameter to skip all validation rules.
POST
/
visits
Copy
Ask AI
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/visits \
--header 'Content-Type: application/json' \
--data '{
"service_area_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>"
},
"clinic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_datetime": "2023-11-07T05:31:56Z",
"duration_override_minutes": 123,
"timeslot_preferences": {
"preferred_windows": [
{}
]
},
"priority": "<string>",
"patient_appointments": [
{
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"patient_confirmation_status": "NONE",
"contact": {
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"email": "<string>"
}
}
],
"clinician_appointments": [
{
"clinician_appointment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_virtual": true,
"clinician_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_offset_minutes": 123,
"duration_override_minutes": 123
}
],
"created_from_service_bundle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"encounters": [
{
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clinician_appointment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"services": [
{
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
],
"external_id": "<string>",
"visit_reservation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"notes_for_clinicians": "<string>",
"notes_for_dashboard": "<string>",
"skip_validation": {
"skip_everything": true
}
}'
Copy
Ask AI
{
"visit_id": "bbde9f02-f44d-4ef0-924f-204674be2d62"
}
Body
application/json
Response
201 - application/json
Visit created successfully
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/visits \
--header 'Content-Type: application/json' \
--data '{
"service_area_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>"
},
"clinic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_datetime": "2023-11-07T05:31:56Z",
"duration_override_minutes": 123,
"timeslot_preferences": {
"preferred_windows": [
{}
]
},
"priority": "<string>",
"patient_appointments": [
{
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"patient_confirmation_status": "NONE",
"contact": {
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"email": "<string>"
}
}
],
"clinician_appointments": [
{
"clinician_appointment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_virtual": true,
"clinician_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_offset_minutes": 123,
"duration_override_minutes": 123
}
],
"created_from_service_bundle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"encounters": [
{
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clinician_appointment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"services": [
{
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
],
"external_id": "<string>",
"visit_reservation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"notes_for_clinicians": "<string>",
"notes_for_dashboard": "<string>",
"skip_validation": {
"skip_everything": true
}
}'
Copy
Ask AI
{
"visit_id": "bbde9f02-f44d-4ef0-924f-204674be2d62"
}
Assistant
Responses are generated using AI and may contain mistakes.