Visits have four main parts:

  1. Where (the location where the patient will receive services, and the Service Area the visit is booked under).
  2. What (the services to be performed).
  3. When (the start time of the visit).
  4. Who (the clinicians who will service the visit).

Let’s say you want to book a visit for a patient at a given Mobile address or clinic and already have the where figured out.

​
Figuring out the “what”

1. Use Coverage lookup to find the services and service bundles available at that location.

Service Areas define what Services and Service Bundles are available where. This endpoint returns a list of service areas that cover the location you specified.

You can then pick a service area (remember: you cannot mix and match services between service areas), and pick a set of services or a service bundle within it.

You can either pick a set of services (à la carte), or pick a service bundle (like picking a combo or prix fixe menu).

Let’s say you pick a service bundle. You then need to retrieve information about the combo you picked:

2. Use Generate potential visit from service bundle.

This endpoint will take a service bundle and return information about the service area, visit location, visit duration, clinician appointments, and encounters of a visit in a format compatible with the other endpoints.

With this information in hand, you’re ready to fetch start time and clinician options for the visit you want to book.

​
Figuring out the “who” and “when”

When, then who approach:

3. Use Visit time options for potential visit to find time options for a visit.

Pick one of the recommended time for the visit. Each time will have a corresponding clinician that has shifts scheduled in the Axle system.

4. Use Clinician options for potential visit at proposed time to get clinician options for that specific time.

Pick one of the recommended clinician options. At least one will be guaranteed to exist, since you picked a recommended time earlier.

Who, then when approach:

3. Use Clinician options for potential visit over date range to find clinician options for the visit.

4. Use Visit time options for potential visit with the clinician_filters field to find time options the visit with the selected clinicians.

Manual override approach:

If you don’t care about constraints like double booking, respecting the service area’s operating hours, etc., you can skip steps 3 and 4 above and jump directly to 5 below, specifying any clinician and start time option you want, and suppressing errors with the skip_validation flag.

​
Confirm everything

5. Use Create Visit to create the visit with a given time and clinician

Make sure to double-check all the details before finalizing the visit to avoid any scheduling conflicts or misunderstandings.

You will put together everything from the previous steps, and voilà, you have a visit.