LUlumahealth
availabilities

Get availability by id

get/availabilities/{availabilitiesId}

Request

Path parameters

availabilityIdstring required

Response

Availability

_idstring

Luma's internal ID of an object.

userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

providerstring

Either the ID or a populated object referring to the provider/doctor for whom this scheduler availability is. Depending on the queryParameter populate, the ID might become an object containing: { _id, name, lastname, firstname }, all strings.

facilitystring

Either the ID or a populated object referring to the place/facility where a scheduler availability should take place. Depending on the queryParameter populate, the ID might become an object containing: { _id, name, address, city, state, postcode, phone }, all strings.

appointmentTypestring

The ID of an appointmentType describing the kind of appointment that might be scheduled for this availability.

datestring date-time

The exact start date/time of the availability, in ISO format, including timezone information. Example: 2022-09-09T23:59:59-03:00.

durationinteger

The duration of the availability, in minutes. Added to the date, you reach the endDate.

endDatestring date-time

The exact end date/time of the availability, in ISO format, including timezone information. Example: 2022-09-09T23:59:59-03:00. Calculated by adding the duration (in minutes) to the start date.

statusobject

The status of the availability.

offerstring

The ID of an offer made to a patient to schedule an appointment at an available date/time. If the patient scheduled the appointment themselves, through a scheduler page on the web, then the availability is marked as booked-pending. An offer is created behind the scenes as the bridge between Luma and the clinic's EHR system. It serves as a pre-scheduling request. Once the EHR confirms that such date/time is available, then the appointment is confirmed/booked, the availability is marked as booked, and the offer ID is stored on the availability.

lockedboolean

If true, then the availability cannot be booked by patients. It is still available for the clinic to book it. This is useful for the clinic to reserve a date/time for a patient who is not yet registered on Luma.

Changes

No recorded changes to this operation across all 6 revisions of this API.