Appointment Waitlist
The Appointment waitlist feature allows the user to track patients who wish to see a provider, generally sooner than when a provider is currently available.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
-
Primary
Update appointment
waitlist
POST
/v1/{practiceid}/appointments/waitlist
Modify the wait list request details for a specific appointment
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
waitlistid
integer
The ID of the wait list entry that was created.
Example Code
Get appointment
waitlist
GET
/v1/{practiceid}/appointments/waitlist
Retrieves the list all waiting list request appointments for all patients
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
priority
string
One of "LOW", "NORMAL", or "HIGH", indicating the priorty of this wait list entry.
dayofweekids
array
A list (JSON array) of day of week IDs that are desired by the patient, with 1 being Sunday, and 7 being Saturday.
hourfrom
integer
The hour (24 hour clock) after which an appointment is desired by a patient. Inclusive.
patientid
integer
The patient ID of the patient who is on the wait list.
appointmentid
integer
The booked appointment ID of the appointment that this wait list entry would replace.
appointmenttypeid
integer
The appointment type ID of the desired appointment.
providerid
integer
The provider ID of the desired provider. This can be blank if any provider is acceptable.
departmentid
integer
The department ID of the desired department. This can be blank if any department is acceptable.
hourto
integer
The hour (24 hour clock) before which an appointment is desired by a patient. Inclusive.
limit
integer
Number of entries to return (default 1500, max 5000)
offset
integer
Starting point of entries; 0-indexed
Output Parameters
Expand all
appointmentid
integer
The booked appointment ID of the appointment that this wait list entry would replace.
appointmenttypeid
integer
The appointment type ID of the desired appointment.
created
string
The date and time that this wait list entry was created.
dayofweekids
integer
A list of day of week IDs that are desired by the patient, with 1 being Sunday, and 7 being Saturday.
departmentid
integer
The department ID of the desired department. This can be blank if any department is acceptable.
hourfrom
integer
The hour (24 hour clock) after which an appointment is desired by a patient. Inclusive.
hourto
integer
The hour (24 hour clock) before which an appointment is desired by a patient. Inclusive.
note
string
Practice-facing note about why the wait list entry exists.
patientid
integer
The patient ID of the patient who is on the wait list.
priority
string
One of "LOW", "NORMAL", or "HIGH", indicating the priorty of this wait list entry.
providerid
integer
The provider ID of the desired provider. This can be blank if any provider is acceptable.
waitlistid
integer
The wait list ID, used in other calls.
Example Code
Get appointment
waitlist
GET
/v1/{practiceid}/appointments/waitlist/{waitlistid}
Retrieves the list all waiting list request appointments for all patients
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
waitlistid
integer
waitlistid
Output Parameters
Expand all
appointmentid
integer
The booked appointment ID of the appointment that this wait list entry would replace.
appointmenttypeid
integer
The appointment type ID of the desired appointment.
created
string
The date and time that this wait list entry was created.
dayofweekids
integer
A list of day of week IDs that are desired by the patient, with 1 being Sunday, and 7 being Saturday.
departmentid
integer
The department ID of the desired department. This can be blank if any department is acceptable.
hourfrom
integer
The hour (24 hour clock) after which an appointment is desired by a patient. Inclusive.
hourto
integer
The hour (24 hour clock) before which an appointment is desired by a patient. Inclusive.
note
string
Practice-facing note about why the wait list entry exists.
patientid
integer
The patient ID of the patient who is on the wait list.
priority
string
One of "LOW", "NORMAL", or "HIGH", indicating the priorty of this wait list entry.
providerid
integer
The provider ID of the desired provider. This can be blank if any provider is acceptable.
waitlistid
integer
The wait list ID, used in other calls.
Example Code
Update a wait list
entry.
PUT
/v1/{practiceid}/appointments/waitlist/{waitlistid}
Generic success/error response
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
waitlistid
integer
waitlistid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
errormessage
string
If the operation failed, this will contain any error messages.
success
string
Whether the operation was successful.
Example Code
Remove an entry from the wait
list.
DELETE
/v1/{practiceid}/appointments/waitlist/{waitlistid}
Generic success/error response
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
waitlistid
integer
waitlistid
Output Parameters
Expand all
errormessage
string
If the operation failed, this will contain any error messages.
success
string
Whether the operation was successful.
Example Code