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 Patient
Creates a Patient.
POST
/
patients
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/patients \
--header 'Content-Type: application/json' \
--data '{
"first_name": "John",
"last_name": "Doe",
"dob": "1988-05-03",
"sex": "M",
"external_id": null,
"email": "johndoe@example.com",
"phone": "+17443879659",
"addresses": [
{
"line1": "123 Main St",
"line2": "",
"city": "Los Angeles",
"state": "CA",
"zip_code": "81001"
}
],
"preferred_language": "en",
"communication_settings": {
"allows_automated_calls": false,
"allows_clinician_calls": true,
"allows_automated_sms": false,
"allows_clinician_sms": true,
"allows_automated_emails": false
},
"payers": [
{
"payer_id": "79b7c3c9-8e1a-44ec-94c4-f3b917eb5bb4"
}
]
}'
{
"patient_id": "89eac3c9-7e0e-44ec-94c4-f3bc17eb52f8"
}
Body
application/json
Response
201
application/json
Patient created successfully
The response is of type object
.
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/patients \
--header 'Content-Type: application/json' \
--data '{
"first_name": "John",
"last_name": "Doe",
"dob": "1988-05-03",
"sex": "M",
"external_id": null,
"email": "johndoe@example.com",
"phone": "+17443879659",
"addresses": [
{
"line1": "123 Main St",
"line2": "",
"city": "Los Angeles",
"state": "CA",
"zip_code": "81001"
}
],
"preferred_language": "en",
"communication_settings": {
"allows_automated_calls": false,
"allows_clinician_calls": true,
"allows_automated_sms": false,
"allows_clinician_sms": true,
"allows_automated_emails": false
},
"payers": [
{
"payer_id": "79b7c3c9-8e1a-44ec-94c4-f3b917eb5bb4"
}
]
}'
{
"patient_id": "89eac3c9-7e0e-44ec-94c4-f3bc17eb52f8"
}
Assistant
Responses are generated using AI and may contain mistakes.