New API Request

For requests or help with our API
Post Reply
mandmdiet
Posts: 113
Joined: Tue Aug 17, 2021 9:37 am

New API Request

Post by mandmdiet » Wed Mar 16, 2022 9:31 am

Hello again friends,

We would like to request a few new features in the Open Dental API. Hopefully these are small things for your team to tackle. Below are the details:

New API Request - Update Claim Date of Accident

We have a requirement in our application to be able to update the AccidentDate field on a claim.

Use Case
  1. A new claim is created in Open Dental
  2. We find and bring the new claim into our application using the Open Dental API
  3. A user determines that the date of the accident is incorrect or missing
  4. The user selects a date to apply to the date of accident field
  5. We use the Open Dental API to request that the AccidentDate field be updated to the newly selected value.
Request Details

There is already an endpoint in the Open Dental API called “Claims PUT” that allows us to update a claim. Our expectation is that this same endpoint be given the additional ability to also accept a value for and update the date of accident on the claim in Open Dental.

New API Request - Update Provider

We have a requirement in our application to be able to update the details of a provider in Open Dental.

Use Case
  1. A new claim is created in Open Dental
  2. We find and bring the new claim into our application using the Open Dental API
  3. A user determines that details on one of the providers associated with the claim is incorrect. For example, their State License, SSN or Specialty.
  4. The user corrects the field with the incorrect value
  5. We use the Open Dental API to request that Open Dental update the provider information with the new user-provided details.
Request Details

We request a Providers PUT endpoint be created that allows us to update the following fields of a provider:
  • PreferredName
  • Abbr
  • FName
  • LName
  • MI
  • Suffix
  • Specialty (We expect to pass DefNum here)
  • NationalProvId
  • StateLicense
  • SSN
  • UsingTIN
Note, at this time we don’t have a need to update other fields for providers, but as our application matures we may need to update additional fields. One could not go wrong by allowing that all provider fields be updatable in this method call

New API Request - Delete Claim

We have a requirement in our application to be able to delete a claim.

Use Case
  1. A new claim is created in Open Dental
  2. We find and bring the new claim into our application using the Open Dental API
  3. A user determines that this claim needs to be deleted
  4. The user clicks the Delete button in our application
  5. We use the Open Dental API to request that the claim be deleted
Request Details

We request that a Claim DELETE endpoint be created that allows us to request that a claim be deleted and that any checks or validations that currently run when a claim deletion is attempted in Open Dental also run when attempted through the API.

That's all of them!

We really appreciate all your help on all of these requests both here and those we've made in the past.

Thank you

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

Re: New API Request

Post by SLeon » Wed Mar 16, 2022 12:09 pm

These three feature requests have been added to our development list. Thank you again for being so thorough in describing your intended use cases.

mandmdiet
Posts: 113
Joined: Tue Aug 17, 2021 9:37 am

Re: New API Request

Post by mandmdiet » Mon Mar 21, 2022 9:40 am

Thank you SLeon!

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

Re: New API Request

Post by SLeon » Wed Apr 06, 2022 9:27 am

Two of these requested features are complete.

1. Claims PUT now allows setting the AccidentDate field of claims. See https://www.opendental.com/site/apiclaims.html for more information.

2. The new method Providers PUT allows changing the following fields: PreferredName, Abbr, FName, LName, MI, Suffix, Specialty (via DefNum), NationalProvId, StateLicense, SSN, and UsingTIN. More details can be found here https://www.opendental.com/site/apiproviders.html.

Both of these methods will be available in our next beta version 22.1.19, which is expected to be released within the next week.

The third request, Claims DELETE, is currently in development.

mandmdiet
Posts: 113
Joined: Tue Aug 17, 2021 9:37 am

Re: New API Request

Post by mandmdiet » Thu Apr 07, 2022 4:33 pm

Thank you so much!

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

Re: New API Request

Post by SLeon » Wed Apr 13, 2022 9:47 am

The last feature request is complete.

Claims DELETE will delete a claim via ClaimNum. This method is available in 22.1.21. For more information see https://www.opendental.com/site/apiclaims.html.

mandmdiet
Posts: 113
Joined: Tue Aug 17, 2021 9:37 am

Re: New API Request

Post by mandmdiet » Thu Apr 14, 2022 2:24 pm

Hurray! and Thank you.

Post Reply