Appointment Notes

The Appointment Note feature allows the users to document free-form text associated with the appointment. This functionality provides the user to create, modify, retrieve or delete notes.

Once an appointment is booked, you can cancel or reschedule it using one of the following calls:

  • /appointments/{appointmentid}/cancel
  • /appointments/{appointmentid}/reschedule

If you cancel an appointment, the appointment notes associated with the cancelled appointment no longer show via the API unless you turn on the SHOWDELETED flag. If you schedule a new appointment that replaces the cancelled one (i.e., cancel and reschedule), the appointment notes move over to the new appointment.

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

Create appointment note

POST
/v1/{practiceid}/appointments/{appointmentid}/notes
Creates a note for a specific 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
appointmentid integer appointmentid
Content-Type string Content type of the payload

Output Parameters

Expand all
success string Returns true/false if the operation was successful
Example Code

Get all appointment notes

GET
/v1/{practiceid}/appointments/{appointmentid}/notes
Retrieves note details for a specific 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
appointmentid integer appointmentid
showdeleted boolean By default, we prevent deleted appointment notes from being returned via the API. This flag allows you to show deleted notes in the set of results returned.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
created string The time this note was created (mm/dd/yyyy hh24:mi:ss)
createdby string The user that created this note.
deleted string The time this note was deleted (mm/dd/yyyy hh24:mi:ss). Not present if not deleted.
deletedby string If deleted, the username who deleted this note.
displayonschedule string Determines if an appointment note displays on the homepage schedule view.
lastmodified string The time this note was updated (mm/dd/yyyy hh24:mi:ss), if the note has been updated.
lastmodifiedby string If the note has been modified, the username who last modified this note.
noteid string The ID for this note, for use with DELETE and PUT calls.
notetext string The text of the note itself.
Example Code

Update appointment note

PUT
/v1/{practiceid}/appointments/{appointmentid}/notes/{noteid}
Modifies the note details for 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 Permissioned Rollout of APIs 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

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

Output Parameters

Expand all
success string Returns true/false if the operation was successful
Example Code

Delete appointment note

DELETE
/v1/{practiceid}/appointments/{appointmentid}/notes/{noteid}
Deletes a note for a specific 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
appointmentid integer appointmentid
noteid integer noteid

Output Parameters

Expand all
success string Returns true/false if the operation was successful
Example Code