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 Patient
Edit a patient.
PATCH
/
patients
/
{id}
curl --request PATCH \
--url https://api.axlehealth.com/api/v2-stable/patients/{id} \
--header 'Content-Type: application/json' \
--data '{
"first_name": "<string>",
"last_name": "<string>",
"dob": "2023-12-25",
"sex": "M",
"external_id": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"addresses": [
{
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>"
}
],
"preferred_language": "<string>",
"communication_settings": {
"allows_automated_calls": true,
"allows_clinician_calls": true,
"allows_automated_sms": true,
"allows_clinician_sms": true,
"allows_automated_emails": true
},
"payers": [
{
"payer_id": "<string>"
}
],
"metadata": {}
}'
{}
Path Parameters
The UUID of the patient to retrieve.
Body
application/json
Response
200
application/json
Patient details retrieved successfully
The response is of type object
.
curl --request PATCH \
--url https://api.axlehealth.com/api/v2-stable/patients/{id} \
--header 'Content-Type: application/json' \
--data '{
"first_name": "<string>",
"last_name": "<string>",
"dob": "2023-12-25",
"sex": "M",
"external_id": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"addresses": [
{
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>"
}
],
"preferred_language": "<string>",
"communication_settings": {
"allows_automated_calls": true,
"allows_clinician_calls": true,
"allows_automated_sms": true,
"allows_clinician_sms": true,
"allows_automated_emails": true
},
"payers": [
{
"payer_id": "<string>"
}
],
"metadata": {}
}'
{}
Assistant
Responses are generated using AI and may contain mistakes.