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.

 

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Book appointment
PUT
/v1/{practiceid}/appointments/{appointmentid}

Create a single appointment for specific patient

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

Request Body

Expand all

Output Parameters

Expand all
Example Code
Get appointment details
GET
/v1/{practiceid}/appointments/{appointmentid}

Retrieves the details of a specific appointment. Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see <a href="https://docs.athenahealth.com/api/resources/best-practices-and-troubles… Rollout of APIs</a> for more information if you are experiencing issues.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

Output Parameters

Expand all
Example Code
Reschedule appointment
PUT
/v1/{practiceid}/appointments/{appointmentid}/reschedule

Reschedules an existing appointment to a new timeslot provided by the patient

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

Output Parameters

Expand all
Example Code
Gets the appointment id tied to the confirmation hash in the appointment confirmation email
GET
/v1/{practiceid}/appointments/getappointmentidbyhash/{messagehash}

Gets the appointment id tied to the confirmation hash

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

Output Parameters

Expand all
Example Code
Retrieve athenaone telehealth invite url.
GET
/v1/{practiceid}/appointments/{appointmentid}/nativeathenatelehealthroom

Retrieve athenaone telehealth invite url. Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see <a href="https://docs.athenahealth.com/api/resources/best-practices-and-troubles… Rollout of APIs</a> for more information if you are experiencing issues.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all
Example Code
Get list of changes in appointment slots based on subscribed events
GET
/v1/{practiceid}/appointments/changed

Retrieves the list of changes in appointments or appointment slots Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see <a href="https://docs.athenahealth.com/api/resources/best-practices-and-troubles… Rollout of APIs</a> for more information if you are experiencing issues.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

Output Parameters

Expand all
Example Code
Unsubscribe to all/specific change events for appointment slots
Get list of appointment slot change events to which you can subscribe
GET
/v1/{practiceid}/appointments/changed/subscription/events

Retrieves list of events for appointments or an appointment slots

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all
Example Code