Modifying Appointment Notes

For requests or help with our API
Post Reply
saravanan
Posts: 6
Joined: Fri Sep 23, 2022 9:01 am

Modifying Appointment Notes

Post by saravanan » Sun Sep 25, 2022 8:43 pm

Hello,

Our product have a use case to create appointment notes with additional information like the status of the patient in our system, so that the practice can know it directly without opening our system. For this, we need to update the existing appointment notes, in case of any change in our status of the patient in our system.

API "Appointments PUT Note" inserts the provided comment but does not replace the existing comments, for example when the user is in Active status, we would like to change it to Overdue when there is payment failures from our system. So we cannot use this API.

API "Appointments PUT (update)" provides a way to rewrite the notes, which solves our use case, but there is warning with the API -
"""It is rare to use this method. There would be complex issues involved. It is recommended to instead use Appointments PUT Note, PUT Confirm, and PUT Break."""

I would like to confirm if updating notes will raise complex issues? Is this a supported way to update?

Thanks,
Saravanan

SLeon
Posts: 476
Joined: Mon Mar 01, 2021 10:00 am

Re: Modifying Appointment Notes

Post by SLeon » Mon Sep 26, 2022 8:24 am

Good morning,

This is a great question. Updating only the Note field via our Appointments PUT (update) method is absolutely fine.

We caution using this method without a deeper understanding of our database scheme in most cases. An example is how changing an appointment's Status to "Broken" does not preform all of the same logic as using Appointments PUT Break. However, you can safely use Appointment PUT (update) to full replace the existing Note field of the appointment.

Post Reply