Overview

General API guidelines

Axle Health

Introduction

API URLs

Axle Health’s uses API keys for authentication.

Authentication

Axle currently sends webhooks for the following resources:

Webhooks

Creating Your First Axle Visit

Standard Objects

Lists all the [Service Area](/docs/api-overview/glossary/service-area)s that cover a given address, zip code, or [Clinic](/docs/api-overview/glossary/clinic), and return the associated [Service](/docs/api-overview/glossary/service)s and [Service Bundle](/docs/api-overview/glossary/service-bundle)s.

You can use this endpoint to check if a service is bookable at a certain address.

<Info> When creating a visit, remember that you won’t be able to mix and match services between service areas.</Info>


Coverage Lookup

Generates information about a [Potential Visit](/docs/api-overview/glossary/potential-visit) from a [Service Bundle](/docs/api-overview/glossary/service-bundle).

With this information, you will be able to create visits, fetch availability for a potential visit, etc.


Generate potential visit from service bundle

Returns visit time options for rescheduling an existing visit.  See [Availability](/docs/api-overview/glossary/avialability) for more details.


Visit time options for existing visit

Returns visit time options for a [Potential](/docs/api-overview/glossary/potential-visit) Visit. See [Availability](/docs/api-overview/glossary/avialability) for more details.


Visit time options for potential visit

Returns clinician options for the clinician appointments on an existing visit. See [Clinician](/docs/api-overview/glossary/clinician-option) options for more details.


Clinician options for existing visit at existing time

Returns clinician options for a [Potential Visit](/docs/api-overview/glossary/potential-visit) that would be [Eligible](/docs/api-overview/glossary/eligible) to perform the specified certain services at some point in a given date range.

This is useful for the [*Who, then when*](docs/api-overview/glossary/visit) workflow.


Clinician options for potential visit over date range

Returns clinician options for the clinician appointments on a [Potential](/docs/api-overview/glossary/potential-visit) Visit at a specific start time.  See [Clinician](/docs/api-overview/glossary/clinician-option) options for more details.


Clinician Options for Potential Visit at Proposed Time

Creates a visit.

To see an example workflow, read [Creating Your First Axle Visit](docs/api-overview/glossary/visit).

<Info>
By default, this endpoint validates the time and clinicians you have provided. This includes making sure the clinicians are [Eligible](/docs/api-overview/glossary/eligible) to do the visit, [Available](/docs/api-overview/glossary/available) at the chosen time, and that the time falls within the [Service Area](/docs/api-overview/glossary/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.
</Info>


Create Visit

Returns the full details about a [Visit](/docs/api-overview/glossary/visit).

Get Visit

Edits a visit and returns any failed validation rules.

To see example workflows, read [Editing a visit, and assigning the best clinicians](/docs/api-overview/glossary/visit).
<Info>
  We do not support adding or removing patient appointments after a visit has been created.
</Info>

<Info>
We do not support editing the `is_virtual` field of clinician appointments once created.
</Info>
<Info>
This endpoint largely uses PATCH semantics, not PUT semantics, including for deeply nested fields.

So for example, if a visit has multiple clinician appointments, and you want to change the duration of only one, you only have to provide element in the `clinician_appointments_to_edit` array.
</Info>


Edit Visit

Creates a Visit Request.

Visit requests are useful in the situation where we may have some information about 
a visit but not enough to actually instantiate a new visit model. This is where we 
would create a Visit Request instead. 


Create Visit Request

Returns the full details about a Visit Request.

Get Visit Request

Edit a Visit Request.

<Info>
We do not support editing a canceled Visit Request.
</Info>


Edit Visit Request

Creates a [Patient](/docs/api-overview/glossary/patient).

Create Patient

Get Patient

Edit Patient

Lists all of the services configured in your account.

List Services

Lists all of the service bundles configured in your account.

List Service Bundles

Creates a new clinician with the specified details.

Create Clinician

Retrieves the full details of a specified clinician. The clinician ID is required in the path.

Get Clinician

Edit Clinician

Returns a paginated list of clinicians configured in your account.

List Clinicians

Allows the creation of a new shift for a specified clinician.

Create Shift

Retrieves a list of all shifts configured in your account.

List all shifts

Retrieves the details of a shift identified by the given ID.

Get Shift

Updates the details of a shift identified by the given ID.

Edit Shift

Creates a shift block with the specified details and returns the unique identifier for the new shift block.

Create Shift Block

Retrieves a list of shift blocks configured in the system, including pagination details.

List Shift Blocks

Retrieves the details of a specific shift block identified by its ID.


Get Shift Block

Allows for updating specific fields of a shift block identified by its ID.
<Info>
If you need support for editing more shift block fields than just these, contact [techsupport@axlehealth.com](mailto:techsupport@axlehealth.com).

</Info>


Edit Shift Block

Deletes the shift block identified by its ID, making the clinician available for the time previously occupied by the shift block.

Delete Shift Block

Create Territory

<Tip>
For get information about a territories’ zip codes, use the [Get Territory](/docs/api-overview/glossary/territory) endpoint.
</Tip>


List Territories

Updates an existing territory with the provided data.

Edit Territory

Retrieves the details of a specific territory by its ID.

Get Territory

Creates a new qualification for clinicians.

Create Qualification

Retrieves a list of qualifications with pagination.

List Qualifications

Retrieves a specific qualification by its ID.

Get Qualification

Updates an existing qualification's details.

Edit Qualification

Qualifications are a part of Axle Health’s assignment workflow, and as such belong on both Services and Clinicians. When deleting a Qualification, the qualification will also be removed from the Services and Clinicians that reference the qualification you’re deleting.

We advise proceeding with caution.


Delete Qualification

Retrieves a list of payers configured in your account.

List Payers

Create Care Team

List Care Teams

Get Care Team

Edit Care Team

Get a link you can use to download a specified document.

The link will stay active for 5 minutes, after which it will expire, and you will have to request a new link.


Generate download link for document

Creates a hold on clinicians’ schedules for a visit you plan to book soon.


Create Visit Reservation

Deletes the hold on clinicians’ schedules.

It’s not necessary to call this, as the hold will automatically expire on its expiry date. But this way, you can delete it earlier than that.


Delete Reservation

Status

Trust Center

API Reference

Get Started

These are some of the objects in the Axle system.

Glossary

 **Visits** are the fundamental unit of scheduling in your organization. The capture the idea of one or more patients being seen at a specific time and location by one or more clinicians.

Visit

A **Patient** represents a person with a name, date of birth, and potentially other identifying information. One patient might be associated with many [Visits](/docs/api-overview/glossary/visit).

Patient

 **Clinicians** represent a healthcare professional, such as a nurse practitioner, medical assistant, or doctor renders [Services](/docs/api-overview/glossary/service) for a patient in the context of a visit.

Clinician

 **Patient Appointments** represent a patient’s connection to a visit. This includes details on how to contact the patient for that specific visit and **Patient Confirmation Status** for the chosen visit time. 

Patient Appointment

 **Clinician Appointments** represents clinician slots on a visit to be filled by a clinician.

Clinician Appointment

 **Encounters** represent a patient–QHP interaction.

Encounter

 **Services** are definitions of procedures a clinician can perform for a patient.

Service

**Service Bundles** represent commonly-used configurations of services and clinician appointments.

Service Bundle

A **Clinic** represents a building or other location where patients are served in a central location.

Clinic

**Service Areas** represent the rules for creating visits in a given [Clinic](/docs/api-overview/glossary/clinic) or set of [Territories](/docs/api-overview/glossary/territories). For example, the rules may specify the **Operating Hours** in which you want to see patients, how much buffer to leave between visits, etc.

Service Area

 **Territories** are named collection of zip codes. They represent a geographical region that can be associated with [Service Areas](/docs/api-overview/glossary/service-area) and [Shift](/docs/api-overview/glossary/shift).

Territory

 Pluralized form of [Territory](/docs/api-overview/glossary/territory).

Territories

 **Shifts** represent a block of time when a [Clinician](/docs/api-overview/glossary/clinician) is available to work and where. The “where” might be [Territories](/docs/api-overview/glossary/territories) that define [Mobile](/docs/api-overview/glossary/mobile) locations they can drive to, territories they can serve virtually, or [Clinic](/docs/api-overview/glossary/clinic)s they can drive to..

Shifts

 **Qualifications** are tags that represent legal or operational requirements clinicians must meet to perform a service. 

Qualification

 A [Patient](/docs/api-overview/glossary/patient)’s Care Team represents to a set of [Clinician](/docs/api-overview/glossary/clinician)s that are primarily responsible for the patient’s care.  

Care Team

Visits can be understood to have a **delivery model** based on the location of the patients and the location of the clinicians when services are being rendered.

Delivery model

 **Mobile** visits are visits that happen at a non-[Clinic](/docs/api-overview/glossary/clinic) address, such as a patient’s home, workplace, or other location where a patient will have services rendered to them. This is in contrast to an [In-clinic](/docs/api-overview/glossary/in-clinic) visit.

Mobile

In-clinic visits are visits that happen at at a [Clinic](/docs/api-overview/glossary/clinic). This is in contrast to a [Mobile](/docs/api-overview/glossary/mobile)visit.

In-clinic

 **Potential Visits** are information about a visit you may potentially create, namely, the service area, visit location, visit duration, clinician appointments, encounters, etc.

Potential Visit

 **Availability** refers to the options for start time options for a visit. 

Availability

 In the context of a [Clinician Appointment](docs/api-overview/glossary/clinician-appointment), clinicians can be:

Clinician options

See [Clinician options](/docs/api-overview/glossary/clinician-option).

Eligible

A clinician being **available** for a [Clinician Appointment](/docs/api-overview/glossary/clinician-appointment) on a visit means: 

Available

Response codes will always be one of the following:

HTTP response codes

For successful response codes (i.e., 200), the response shape will be as described in the API documentation for that endpoint.

Error responses

We may add new keys to any object in a response at any time. Your integration must ignore them.

Must-ignore policy

Standard Workflows

Editing a visit, and assigning the best clinicians

Axle Health optionally supports sending webhook signatures by including a Axle-Signature HTTP header in response to requests made to the API.

Getting Started

API Overview