New APIs Needed

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

New APIs Needed

Post by mandmdiet » Wed Dec 01, 2021 12:14 pm

Hello friends, we've been slowly working through our application requirements to determine our API needs and we have some new formal requests we would like to make for the Open Dental API.

Request 1: Update Patient

Use Case

We have a requirement in our application to be able to update patients via an API call. The workflow would look like this:
  1. We use ShortQuery to display patient information from Open Dental to a user.
  2. The user determines a patient field needs to be updated.
  3. We use the Open Dental API to update patients in Open Dental (this is the new API request we're making).
Request Details

We would like to request that the existing patient Update API be updated to include the ability for us to update the patient’s Address2, SecProv, ChartNumber, PreferContactMethod, PreferConfirmMethod, TxtMsgOk, Language and DateTStamp.

---------------------------------------------------------------------------------------------------------------------------------

Request 2: Update Patient Plan Information

Use Case

We have a requirement in our application to be able to update a patient’s plan via an API call. The workflow would look like this:
  1. We use ShortQuery to display patient plan information from Open Dental to a user.
  2. The user determines a patient plan field needs to be updated.
  3. We use the Open Dental API to update patient’s plans in Open Dental (this is the new API request we're making).
Request Details

We would like to be able to update fields in both the patientplans and inssub tables. Here are the fields we need to be able to update: patientplans.PatNum, patientplans.Ordinal, patientplans.PatID, patientplans.Relationship, patientplans.InsSubNum, inssub.Subscriber, inssub.DateEffective, inssub.DateTerm, inssub.Releaseinfo, inssub.AssignBen and inssub.SubscriberID.

---------------------------------------------------------------------------------------------------------------------------------

Request 3: Update Claim

Use Case

We have a requirement in our application to be able to update claim fields via an API call. The workflow would look like this:
  1. New Claim Created.
  2. We find and bring the new claim into our application and display it to the user (using ShortQuery)
  3. We use the Open Dental API to update claim details in Open Dental (this is the new API request we're making).
Request Details

We need to update the following fields on a claim: ProvTreat, ProvBill, PriorAuthorizationNumber, PlaceService, IsProsthesis, PriorDate, IsOrtho, OrthoDate, OrthoTotalM, AccidentRelated, AccidentST, ClaimNote, PlanNum, PlanNum2, InsSubNum, InsSubNum2 and ClinicNum. We anticipate possibly needing to update these fields in the future as well: PatNum, ClaimStatus, DateReceived, ClaimFee, ClaimType and ClaimForm.

---------------------------------------------------------------------------------------------------------------------------------

Request 4: Add/Update Carrier

Use Case

We have a requirement in our application to be able to update a patient’s insurance plan’s carrier fields via an API call. The workflow would look like this:
  1. We find and bring the patient’s insurance carrier details into our application along with insurance plans. (using ShortQuery)
  2. We use the Open Dental API to update patient’s insurance carrier details in Open Dental (this is the new API request we're making).
  3. Users also need to be able to add a new Carrier (POST).
Request Details

There is no API to add or update carriers in open dental. We want to update CarrierName, Phone, Address, Address2, City, State, Zip, ElectID, NoSendElect and IsHidden as part of POST & PUT request body.

POST Example: /carriers - Returns newly added CarrierNum along with other fields in the Response body
PUT Example: /carriers/16

---------------------------------------------------------------------------------------------------------------------------------

Request 5: Add/Update Employer

Use Case

We have a requirement in our application to be able to update a patient’s insurance plan’s employer fields via an API call. The workflow would look like this:
  1. While updating patient insurance details, a user can update Patient employer details too.
  2. We find and bring the patient’s insurance employer details into our application along with insurance plans. (using ShortQuery)
  3. We use the Open Dental API to update patient’s insurance employer details in Open Dental (this is the new API request we're making).
  4. Users also need to be able to create a new Employer.
Request Details

There is no API to add or update employers in open dental. We want to update just EmpName as part of the POST & PUT request body.

POST Example: /employers - Returns newly added EmpNum with EmpName in Response Body
PUT Example: /employers/16

---------------------------------------------------------------------------------------------------------------------------------

Request 6: Update Clinic

Use Case

We have a requirement in our application to be able to update a clinic’s information before submitting a claim via an API call. The workflow would look like this:
  1. We find and bring the clinic details into our application along with the claim. (using ShortQuery)
  2. A user determines that clinic information needs to be updated before the claim can be sent.
  3. We use the Open Dental API to update clinic details in Open Dental (this is the new API request we're making).
  4. Users also need to be able add a new clinic.
Request Details
There is currently no API available to update clinics. We need to be able to update Description, Abbr, PayToAddress, PayToAddress2, PayToCity, PayToState, PayToZip, Phone, BillingAddress, BillingAddress2, BillingCity, BillingState, BillingZip and IsHidden as part of the PUT request body.

PUT Example: /clinics/16

Please let me know if I can answer any additional questions about this request. Thank you so much!

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

Re: New APIs Needed

Post by SLeon » Wed Dec 01, 2021 3:50 pm

Thank you, mandmdiet, for this list of API feature requests. Your Use Cases for each new method are extremely helpful in the implementation process. We will discuss these items at our API development meeting tomorrow and update you shortly.

User avatar
jordansparks
Site Admin
Posts: 5739
Joined: Sun Jun 17, 2007 3:59 pm
Location: Salem, Oregon
Contact:

Re: New APIs Needed

Post by jordansparks » Thu Dec 02, 2021 6:39 pm

#2: There are certain fields that it would not make sense to be able to edit. For example, patplan.PatNum and patplan.InsSubNum. Instead of changing these two fields, you would either POST PatPlans or DELETE PatPlans. The rest of the fields make sense.
#3: Similar issue as above with claim.PlanNum, claim.InsSubNum. With claim.ClinicNum, it must always match the procedures, so of course you can't edit that. Basically, just look in the UI. If you can change it there, then it makes sense to allow it in the API.

Those are extensive requests. I really didn't anticipate anyone wanting to make such deep changes. But that's ok. We will add these as fast as we possibly can, on the order of days to a week or two.
Jordan Sparks, DMD
http://www.opendental.com

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

Re: New APIs Needed

Post by mandmdiet » Mon Dec 06, 2021 2:48 pm

Thanks so much Jordan. We have a few more we expect to make in the coming weeks and months as well. We appreciate you and your team being so quick and willing to help.

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

Re: New APIs Needed

Post by SLeon » Fri Dec 10, 2021 11:19 am

The first of these requested features is complete.

1. The Patients PUT method now supports updating Address2, SecProv, ChartNumber, PreferContactMethod, PreferConfirmMethod, TxtMsgOk, and Language fields. DateTStamp is not an editable field but is updated automatically when any other field is updated. These changes are available in our latest beta version, 21.4.8.
2. (Updating PatPlans and Inssubs is currently in development)
3. (Updating Claims is currently in development)

For more information on Patients PUT, please see the API section of our manual: https://www.opendental.com/site/apipatients.html

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

Re: New APIs Needed

Post by SLeon » Tue Dec 14, 2021 8:42 am

Another requested feature has been completed.

1. (Previously completed)
2. Two new methods, PatPlans PUT and InsSubs PUT, have been added for updating patient plan information. Details below.
3. (Updating Claims is currently in development)
4. (Creating/Updating Carriers is currently in development)

PatPlans PUT allows the updating of the InsSubNum, Ordinal, Relationship, and PatID fields. The option to set the PatID field has also been added to PatPlans POST. For more information see our documentation: https://www.opendental.com/site/apipatplans.html.

InsSubs PUT allows the updating of all requested fields. We have also added the option to set the ReleaseInfo and AssignBen fields with InsSubs POST. More details can be found here: https://www.opendental.com/site/apiinssubs.html.

These will be available in our next beta version, 21.4.9, which is estimated to be released within the next week.

manish.bhalodi.tech9
Posts: 7
Joined: Tue Nov 16, 2021 7:25 am

Re: New APIs Needed

Post by manish.bhalodi.tech9 » Wed Dec 15, 2021 2:36 am

Thank you @SLeon for such quick help. You guys are awesome. Keep it up.

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

Re: New APIs Needed

Post by SLeon » Mon Jan 03, 2022 3:52 pm

Three more of these requested features have been completed.

1-2. (Previously completed)
3. A new method, Claims PUT (update), has been added. See https://www.opendental.com/site/apiclaims.html.
4. Two new methods, Carriers POST and Carriers PUT, have been added. See https://www.opendental.com/site/apicarriers.html.
5. (Add/Update Employer is currently in development)
6. A new method, Clinics PUT, has been added. See https://www.opendental.com/site/apiclinics.html.

All four of these methods are available as of version 21.4.12.

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

Re: New APIs Needed

Post by SLeon » Wed Jan 12, 2022 8:41 am

The last of these requested features has been completed.

1-4. (Previously completed)
5. Two new methods Employers POST and Employers PUT have been implemented. See https://www.opendental.com/site/apiemployers.html.
6. (Previously completed)

These methods will be available in version 21.4.16, which is estimated to be released later this week.

shripati.ukirde
Posts: 10
Joined: Wed Apr 06, 2022 4:24 am

Re: New APIs Needed

Post by shripati.ukirde » Tue Nov 15, 2022 1:37 am

Hello,
We are facing an issue while updating the claim. OrthoTotalM is set to 0 if we don't pass the value in Claims PUT (update) request.
As per the details looks like this field is optional, but it is not working correctly. Could you please help us to resolve this issue?

DerekR
Posts: 79
Joined: Wed Aug 31, 2022 1:13 pm

Re: New APIs Needed

Post by DerekR » Thu Nov 17, 2022 2:29 pm

Hello shripati.ukirde,

We have fixed the issue you described in your post above. Not specifying a value for OrthoTotalM in your Claims PUT (update) request will no longer set it to 0 as one would expect. This change will be available starting in versions 22.2.54 and 22.3.25.

shripati.ukirde
Posts: 10
Joined: Wed Apr 06, 2022 4:24 am

Re: New APIs Needed

Post by shripati.ukirde » Sun Nov 20, 2022 10:34 pm

Hello DerekR,
Thanks for the update, I will update once this stable version is released.
DerekR wrote:
Thu Nov 17, 2022 2:29 pm
Hello shripati.ukirde,

We have fixed the issue you described in your post above. Not specifying a value for OrthoTotalM in your Claims PUT (update) request will no longer set it to 0 as one would expect. This change will be available starting in versions 22.2.54 and 22.3.25.

Post Reply