A location represents a physical practice through which all patient interactions occur; e.g. patient communication, booking an appointment, new patient intake.
API access is provided on a per location basis. You will have to request access to each location through our partner portal.
Resources that exist within a location require that you provide a location id as a parameter in each request. Specifying a location id that doesn't exist within the institution will result in a 404 Not Found response.
Store Subdomains and Locations Ids
Since you will likely be providing the subdomain and location_id in your requests often and these values are unlikely to change, it is a good idea to periodically perform a GET request to
/locationsand store the response data for reuse.
Important Location Configuration Flags
| Attribute | Definition |
|---|---|
| map_by_operatory | If true, requires that bookings are performed taking operatory availability into account. |
| insert_appt_client | If true, appointments created with this location will be pushed into the integrated system. |
| appt_types_map_by_operatory | If true, appointment types map to operatories instead of providers |