Appointment Reminders

The Appointment Reminder feature allows the user to manage information about the appointment reminders. Appointment reminders indicate to the practice when a patient should be scheduled for a future appointment. Appointment reminders created by the API require at least a patient, department, and approximate date (i.e., the date on or around which the appointment should be scheduled). A provider and appointment type can optionally be specified, along with a general note and specific patient instructions (i.e. instructions for the patient regarding their future appointment). Appointment reminders created by the Athena UI are not subject to the patient and department requirement (they can exist without those fields), and can be retrieved via the API, but not modified. Note that these are completely unrelated to Reminder Call, which is part of separate functionality within athenaNet.



Retrieving and Creating Appointment Reminders

Partners can retrieve all appointment reminders from specific departments within a practice or a single patient. Only one appointment reminder can be created per call in athenaNet. Partners are required to provide an approximate date to schedule the appointment and must include the department ID and the patient’s ID. Additional fields are also available to provide more information about the reminder. All appointment reminders that are created successfully generate an API response that includes an appointmentreminderid along with the value: 'Success: True.' Before creating new appointment reminders for patients, Partners should use the GET call to avoid duplicate appointment reminders.

 

Updating and Deleting Appointment Reminders

Partners are only able to update and delete appointment reminders that they have created via API. Partners cannot update/delete reminders that are created in athenaNet by other users or vendors. In order to edit/delete a document, Partners need the appointmentreminderid of the document they want to edit/delete. All appointment reminders that are updated/deleted successfully will generate an API response that includes an appointmentreminderid along with the value: 'Success: True.'

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Create appointment reminder
Get list of appointment reminders
Example Code
Update an appointment reminder for this practice.
Delete an appointment reminder for this practice.
DELETE
/v1/{practiceid}/appointments/appointmentreminders/{appointmentreminderid}

Results for deleting an appointment reminder for this practice.

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
Example Code