Appointment
The Appointment API feature allows the user to book a patient appointment with the provider, reschedule an existing appointment, cancel an existing appointment. This feature also allows the user to delete an existing appointment time slot of the Provider so that no patient can book an appointment in that time slot.
The Appointment Changed Subscription feature will allow the user to retrieve changes to appointments (generally scheduled, cancelled, check-in) or changes to the provider appointment slots. The user will need to subscribe. For more information about subscriptions, please refer Changed Data Subscriptions.
The athena Telehealth Room feature retrieves details for a valid native athenaTelehealth appointment. Be aware that the invite link is to an unauthenticated web app. Clients should first check if their appointment is a native athenaTelehealth appointment by using our single appointment endpoint GET /appointments/{appointmentid}, our appointment changed data subscription GET /appointments/changed, or our booked appointment slots endpoint GET /appointments/booked. The patient url and join token are only valid on the day of the appointment. Please communicate the device check link (https://telehealth.px.athena.io/device-check) in your patient messaging.
Endpoints
- Primary
-
Subscription
Book appointment
Input Parameters
Expand all❙ required
❙ Request Body
Expand allOutput Parameters
Expand allGet appointment details
Input Parameters
Expand all❙ required
Output Parameters
Expand allCancel appointment
Input Parameters
Expand all❙ required
❙ Request Body
Expand allOutput Parameters
Expand allReschedule appointment
Input Parameters
Expand all❙ required
❙ Request Body
Expand allOutput Parameters
Expand allGets the appointment id tied to the confirmation hash in the appointment confirmation email
Input Parameters
Expand all❙ required
Output Parameters
Expand allRetrieve athenaone telehealth invite url.
Input Parameters
Expand all❙ required
Output Parameters
Expand allGet list of changes in appointment slots based on subscribed events
Input Parameters
Expand all❙ required
Output Parameters
Expand allGet list of appointment slot change subscription(s)
Input Parameters
Expand all❙ required
Output Parameters
Expand allSubscribe to all/specific change events for appointment slots
Input Parameters
Expand all❙ required
❙ Request Body
Expand allOutput Parameters
Expand allUnsubscribe to all/specific change events for appointment slots
Input Parameters
Expand all❙ required
Output Parameters
Expand allGet list of appointment slot change events to which you can subscribe
Input Parameters
Expand all❙ required