Appointment-GET

Description

A streamlined request for surfacing patient visit scheduling details including provider, location, timing, and telehealth workflow triggers for driving tailored frontend experiences and nuanced operational optimization in the healthcare setting.

Use Cases

Patient Reminder Apps: Build patient reminder apps
Provider Schedule Optimization: Identify visit duration overruns
Telehealth Workflow Launch: Initiate telehealth protocols
Referral Management: Check post-referral for conflicts
Resource Planning: Aggregate for planning

Request Sample

Athena

Elation

Canvas

cURL

JavaScript

Java

Python

Source Specific Details

EHR	APIs	mandatory filters	optional filters
Athena	`${url}/v1/${practiceId}/appointments/waitlist` `${url}/v1/${practiceId}/appointments/open?&departmentid=${departmentId}&ignoreschedulablepermission=true` `${url}/v1/${practiceId}/${departmentId}/fhir/dstu2/Appointment?practitioner=${practitionerId}` `${url}/v1/${practiceId}/patients/${patient}/appointments?showcancelled=true&showpast=true` `${url}/v1/${practiceId}/appointments/${appointment_id}`	patient practitioner	_id date scheduled-start-date ignore-restrictions appointment-type-id end-last-modified status start-last-modified patient scheduled-end-date count _offset end-date start-date sort-order include
Elation	`${url}/appointments` `${url}/recurring_event_groups`	patient practitioner	recurring date slot-type _count _offset
Canvas	`${url}/Appointment`	patient practitioner

Filters

FilterName	Description	Default Value	Allowed Values
_count	Pagination params
_id	The appointment ID. Per the FHIR spec, this is _id, not appointmentid as with other API calls.d
_offset	Pagination params. Athena: Starting point of entries; 0-indexed
appointment-type-id	Filter by appointment type ID.
appointmentId	The booked appointment ID of the appointment that this wait list entry would replace.
bookedonly	Filter to get only booked appointments
day-of-week-ids	One of "LOW", "NORMAL", or "HIGH", indicating the priorty of this wait list entry.
departmentId	Identifier for the department
end-date	End of the appointment search date range
end-last-modified	Identify appointments modified prior to this date/time
hour-from	The hour (24 hour clock) after which an appointment is desired by a patient. Inclusive.
hour-to	The hour (24 hour clock) before which an appointment is desired by a patient. Inclusive.
ignore-restrictions	When showing patient detail for appointments, the patient information for patients with record restrictions and blocked patients will not be shown
include	List of fields which needed to be shown in result
openonly	Filter to get only open appointments
patient	Patient reference for any fhir resource
practitioner	Practitioner reference for the any fhir resource
priority	A list (JSON array) of day of week IDs that are desired by the patient, with 1 being Sunday, and 7 being Saturday.
quorum	sets sync/async mode	true
reason-id	Filter by reason id
recurring	recurring event	false
scheduled-end-date	End of the appointment scheduled search date range
scheduled-start-date	Start of the appointment scheduled search date range (mm/dd/yyyy). Inclusive
slot-type	Appointment time slot type
sort-order	Sort order by appointment date
start-date	start of the appointment search date range
start-last-modified	Identify appointments modified after this date/time
status	The overall status of the appointment		waitlist

Appointment Export-POST

Appointment ID-DELETE