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 Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Create appointment reminder

POST
/v1/{practiceid}/appointments/appointmentreminders
Creates an appointment reminder to indicate to the practice when a patient should be scheduled for a future appointment.
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

practiceid integer practiceid
Content-Type string Content type of the payload

❙ Request Body

Expand all
appointmenttypeid integer An athenaNet appointment type ID.
approximatedate string The approximate date on which an appointment for this reminder should be scheduled.
departmentid integer An athenaNet department ID.
note string Miscellaneous notes for this reminder.
patientid integer An athenaNet patient ID.
patientinstructions string Patient instructions regarding this reminder.
providerid integer An athenaNet provider ID.

Output Parameters

Expand all
appointmentreminderid integer An athenaNet appointment reminder ID.
errormessage string If operation was unsuccessful, detail as to why.
success string Indicates whether creation of the appointment reminder was successful or not.
Example Code

Get list of appointment reminders

GET
/v1/{practiceid}/appointments/appointmentreminders
Retrieves a list appointment reminders for a specific department
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

practiceid integer practiceid
showdeleted boolean By default, we do not return reminders that have been deleted. Setting this to true will show all reminders regardless of status.
appointmenttypeid integer An athenaNet appointment type ID.
enddate string Find reminders for appointments whose approximate date is on or before this date.
departmentid integer An athenaNet department ID.
providerid integer An athenaNet provider ID.
startdate string Find reminders for appointments whose approximate date is on or after this date.
patientid integer An athenaNet patient ID.
limit integer Number of entries to return (default 100, max 5000)Please note that this endpoint has a different default than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
appointmentreminderid integer The athenaNet appointment reminder ID.
appointmenttypeid integer The athenaNet appointment type ID.
approximatedate string The approximate date on which an appointment for this reminder should be scheduled.
deleted string If set, the date on which this reminder was deleted.
departmentid integer The athenaNet department ID.
encounterid integer Appointment encounter ID.
note string Free-text notes entered by the practice about this reminder.
patientid integer The athenaNet patient ID.
patientinstructions string Free-text instructions for the patient entered by the practice for this reminder.
providerid integer The athenaNet provider ID.
status string Status of the reminder.
Example Code

Get list of appointment reminders

GET
/v1/{practiceid}/appointments/appointmentreminders/{appointmentreminderid}
Retrieves a list appointment reminders for a specific department
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

practiceid integer practiceid
appointmentreminderid integer appointmentreminderid

Output Parameters

Expand all
appointmentreminderid integer The athenaNet appointment reminder ID.
appointmenttypeid integer The athenaNet appointment type ID.
approximatedate string The approximate date on which an appointment for this reminder should be scheduled.
deleted string If set, the date on which this reminder was deleted.
departmentid integer The athenaNet department ID.
encounterid integer Appointment encounter ID.
note string Free-text notes entered by the practice about this reminder.
patientid integer The athenaNet patient ID.
patientinstructions string Free-text instructions for the patient entered by the practice for this reminder.
providerid integer The athenaNet provider ID.
status string Status of the reminder.
Example Code

Update an appointment reminder for this practice.

PUT
/v1/{practiceid}/appointments/appointmentreminders/{appointmentreminderid}
Results for updating an appointment reminder for this practice.
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

practiceid integer practiceid
appointmentreminderid integer appointmentreminderid
Content-Type string Content type of the payload

❙ Request Body

Expand all
appointmenttypeid integer An athenaNet appointment type ID.
approximatedate string The approximate date on which an appointment for this reminder should be scheduled.
note string Miscellaneous notes for this reminder.
patientinstructions string Patient instructions regarding this reminder.
providerid integer An athenaNet provider ID.
status string Status of the reminder.

Output Parameters

Expand all
errormessage string If operation was unsuccessful, detail as to why.
success string Indicates whether creation of the appointment reminder was successful or not.
Example Code

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 Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
appointmentreminderid integer appointmentreminderid

Output Parameters

Expand all
errormessage string If operation was unsuccessful, detail as to why.
success string Indicates whether creation of the appointment reminder was successful or not.
Example Code