List scheduler availabilities

The ID of an AppointmentType. If given, only scheduler availabilities for that type of appointment will be listed.

Some appointments might not have a type at all, so this boolean flag determines if scheduler availabilities for such appointments will be listed or not.

The date/time to display scheduler availabilities, in ISO format, including timezone information. See the request sample in curl displayed at the side. This queryParameter should be passed twice, to specify a date/time range. Example: ?date=>2022-08-10T09:49:47-07:00&date=<2022-09-09T23:59:59-03:00 Notice the greater-than (>) and less-than (<) operators.

Filter the availabilities by the ID of a Facility where the doctor/provider may be seen by a patient.

Only display the availability that was chosen by the patient who answered this form. If a form template with type pre-scheduling is set in the scheduler settings, then Luma's scheduler UI will require the patient to answer those form template questions, store the answers in a patientForm object, and then redirect them to another page listing the availabilities to be scheduled. Once the patient picks an availability and books an appointment, Luma will update the availability with the patientForm ID.

Filter scheduler availabilities that were booked after patients answered the questions of this template ID. The field patientForm will only bring one availability that was chosen by the patient who answered that form. This field will bring multiple availabilities, because it does not refer to the form answers of a single patient, but rather, to the form template. Multiple patients may have seen the questions of a template.

Only display scheduler availabilities for the ID of the provider/doctor given on this query parameter.

Filter availabilities by status. It must be available, as other statuses were already booked or canceled.

How many items to fetch per page

Determines if the facility and the provider IDs will be replaced with objects detailing some of their properties. The populated IDs are the ones inside the response's response array, not on the root level of the response.

• facility ID will be replaced by an object containing: { _id, name, address, city, state, postcode, phone }, all strings.
• provider ID will be replaced by an object containing: { _id, name, lastname, firstname }, all strings.
• appointmentType ID is never populated.

Determines which property will be used to order the response. Currently the only option available is date.

Determines the direction in which the sorting will happen:

• ascending (earliest date to latest), or
• descending (latest date to earliest).