Find available appointments

get

https://au-api.halaxy.com/main/Appointment/$find

The $find operation generates a list of available appointments from the Slot Resources. It will use the Online booking preferences to ensure that the available times adhere to buffer time, lead time and advance booking limit.

ℹ️
Context
In Halaxy, Online Booking Preferences are set individually per practitioner at each location.
Keep in mind that the Online Booking Preferences of each practitioner also influences the results of this request.
To find or learn more about these settings, see: Manage online booking preferences

Query Params

start

string

required

Appointment start

end

string

required

Appointment end

practitioner-role

string

Appointment practitioner-role

practitioner

string

Appointment practitioner

organization

string

Appointment organization

duration

string

required

Appointment duration

show

string

enum

Appointment show

Allowed:

emergency

boolean

Ignores lead time to show all available times for emergency appointments

apply-buffer-time

boolean

Applies buffer time to show all available times

_sort

string

enum

Each item in the comma-separated list is a search parameter, optionally with a ' - ' prefix. The prefix indicates decreasing order; in its absence, the parameter is applied in increasing order.

Allowed:

Headers

string

enum

Defaults to application/fhir+json

Generated from available response content types

Allowed:

Responses

403

Forbidden

404

Resource not found

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/fhir+json

application/json

Context

200Appointment resource