New API for Notes functionality

For requests or help with our API
Post Reply
ajaykodam
Posts: 34
Joined: Tue Aug 17, 2021 10:53 pm

New API for Notes functionality

Post by ajaykodam »

In our application, there is a requirement for integration with Open Dental notes. We would like to request the following functionality in the Open Dental API, as I don't see any APIs which support the functionality we currently need.

Request 1: Add custom tracking status history

Use Case -
- We import a claim into our application
- The user is able to add a note to the custom tracking status history for the claim in our application
- The user is able to edit a note in the custom tracking status history
- The note is created in the custom tracking status history for the claim

Request Details
- We would like to request the new API which will allow us to add to the custom tracking status history or update an existing custom tracking status history record.

Request 2: Insurance Payment note

Use Case -
- We import insurance payment details using the Open Dental API into our application
- The user adds notes to the payment
- The user updates notes on the payment
- Our application uses the Open Dental API to add the note to the payment in Open Dental

Request Details
- We would like to request a new API that will allow us to add a note to a payment or update an existing one.
SLeon
Posts: 605
Joined: Mon Mar 01, 2021 10:00 am

Re: New API for Notes functionality

Post by SLeon »

Good afternoon,

Thank you for describing your uses cases. We will add the following to our development list:
  • Claim tracking information is stored in the claimtracking table and has FKs to definition and claim tables. The latter two already have GET methods, so we will add ClaimTracking GET, POST, and PUT to complete the workflow in Request #1.
  • As for Request #2, our existing ClaimPayments POST method allows you to include a Note string. We will create a ClaimPayments PUT method to update the Note field on existing claim payments.
ajaykodam
Posts: 34
Joined: Tue Aug 17, 2021 10:53 pm

Re: New API for Notes functionality

Post by ajaykodam »

Thank you SLeon
ajaykodam
Posts: 34
Joined: Tue Aug 17, 2021 10:53 pm

Re: New API for Notes functionality

Post by ajaykodam »

Hi SLeon,

Any update on this notes request, when can be completed? and in which version we will get this functionality?

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

Re: New API for Notes functionality

Post by SLeon »

Good morning,

Both of your requests above are the next items in our development list. Both will likely start development in roughly a week and then completed within a couple weeks of that. I will update this thread as soon as the first item is completed, and include which version of Open Dental you will need to use it.
ajaykodam
Posts: 34
Joined: Tue Aug 17, 2021 10:53 pm

Re: New API for Notes functionality

Post by ajaykodam »

SLeon,

Thank you for the update.
JTS
Posts: 58
Joined: Thu Aug 18, 2022 12:56 pm

Re: New API for Notes functionality

Post by JTS »

A new ClaimTrackings resource has been implemented, which includes three new methods, ClaimTrackings GET, ClaimTrackings POST, and ClaimTrackings PUT. These methods will allow you to see, create, and update ClaimTracking status notes.
This resource and its methods are available as of beta version 23.2.5.0. For more information, please see: https://www.opendental.com/manual232/ap ... kings.html
DerekR
Posts: 103
Joined: Wed Aug 31, 2022 1:13 pm

Re: New API for Notes functionality

Post by DerekR »

Three new ClaimPayments methods have been completed, which include ClaimPayments PUT, ClaimPayments GET (single), and ClaimPayments GET (multiple). ClaimPayments PUT will allow you to update various fields including the note field from this request. These methods are available as of beta version 23.2.15. For more information, please see https://www.opendental.com/site/apiclaimpayments.html.
ajaykodam
Posts: 34
Joined: Tue Aug 17, 2021 10:53 pm

Re: New API for Notes functionality

Post by ajaykodam »

Thank you
Post Reply