Page 1 of 1

API not found. Requesting new APIs

Posted: Tue Nov 29, 2022 5:12 am
by dhru95
Hello team,
For our application, we need to be able to insert the following to OpenDental Database. Is there anyway API can be added for the following:


- Insert Group Number for patient
- Insert downgrades for insurance procedure codes
- Insert patient insurance history to see what procedure was already performed for patient

Re: API not found. Requesting new APIs

Posted: Tue Nov 29, 2022 8:20 am
by SLeon
Good morning,

1. The Group Number is a field in the insplan table. Are you wanting to just update this field or are you wanting to create a new insurance plan?

2. Which type of downgrade are you trying to perform? On a procedure for a specific insurance plan, or universally for all insurance plans?

3. Could you please clarify what you mean by, "Insert patient insurance history to see what procedure was already performed for patient"? Are you wanting to insert new information into the database, or simply retrieve a list of completed procedures, etc.?

Re: API not found. Requesting new APIs

Posted: Tue Nov 29, 2022 8:33 am
by dhru95
Thank you for the quick reply.

My response is followed:

1. Just update the field for an existing plan
2. On a procedure for an existing specific insurance plan
3. I’m looking to update patient insurance history into the chart

Re: API not found. Requesting new APIs

Posted: Tue Nov 29, 2022 9:00 am
by SLeon
1. We can create InsPlans PUT to update the GroupNum (and other fields).

2. We will also add a way to insert downgrades for specific insurance plans with SubstitutionLinks POST.

3. If you are referring to the main grid in the Chart Modules, that information is automatically generated from many different tables. Inserting a procedure for a patient will appear here, for example. You can retrieve this information through the API with ChartModules GET ProgNotes (See https://www.opendental.com/site/apichartmodules.html).

Re: API not found. Requesting new APIs

Posted: Tue Nov 29, 2022 10:25 am
by dhru95
Do we have to formally put in a request for these to be added?

1. Insplans PUT
2. SubstitutionLinks POST

Re: API not found. Requesting new APIs

Posted: Tue Nov 29, 2022 10:28 am
by SLeon
Nope, I have already added them to our development list. We will update this thread with our progress.

Re: API not found. Requesting new APIs

Posted: Tue Nov 29, 2022 11:37 am
by PBECKER
Jordan/Sarah and Team

If a PUT method can be added that would help greatly.

Goal: Update Ins patient plan details for any fields.

please

-Pedro

Re: API not found. Requesting new APIs

Posted: Tue Nov 29, 2022 11:52 am
by SLeon
A patient's insurance plan information is available in the PatPlan table. You can use PatPlan PUT to change some of these fields (see https://www.opendental.com/site/apipatplans.html). Are there any other fields you need us to add to this method?

Re: API not found. Requesting new APIs

Posted: Wed Nov 30, 2022 5:02 am
by dhru95
As of now, we only need to add groupName, groupNum, PlanNote, FeeSched, and PlanType - as a PUT in InsPlan

Thank you so much!!

Re: API not found. Requesting new APIs

Posted: Fri Dec 02, 2022 4:18 am
by dhru95
Hi - I am sorry to bother you all - I was just wondering if the request for the InsPlan and the substitutionlink API was possible and what the timeline would be to be able to use this API.

Thank you so much in advance!

Re: API not found. Requesting new APIs

Posted: Fri Dec 02, 2022 8:31 am
by SLeon
Good morning.

It's not a bother. I added those two methods to our development list on Tuesday. I would estimate that they will be implemented in a couple of weeks, but I will update this thread with our progress.

Re: API not found. Requesting new APIs

Posted: Fri Dec 02, 2022 9:52 am
by dhru95
Good morning. That sounds great, thank you so much for the update!

I hope to hear from you again soon. Have a great weekend!

Re: API not found. Requesting new APIs

Posted: Mon Dec 05, 2022 6:14 am
by dhru95
@sLeon -
1. I came across the FamilyModules API and I see it has the all required fields - groupName, groupNum, PlanNote, FeeSched, and PlanType.
Can we have the option to add/update these fields through FamilyModules PUT instead of Insplans PUT? Let me know your thoughts. Thank you.

Re: API not found. Requesting new APIs

Posted: Tue Dec 06, 2022 8:36 am
by SLeon
Good morning,

Some of our API methods, such as FamilyModules GET, return information that is displayed via Open Dental's UI. Many times, this information is a compilation of data stored in several database tables. This is especially true in the case of FamilyModules GET, as it gathers information from InsSub, PatPlan, Carrier, InsPlan, FeeSched, and Employer tables, and reducing the number of API calls developers need to make.

For that reason, the UI-based API methods are read-only. The only way to update the information returned is to update the corresponding table. You would use PatPlans PUT to update the Ordinal field of the patient's PatPlan, which would then be reflected in your next FamilyModules GET request.

The InsPlans PUT we added to our development list last week will allow you to update the fields you are after.

Re: API not found. Requesting new APIs

Posted: Tue Dec 06, 2022 9:24 am
by dhru95
Good morning,

@SLeon that makes perfect sense, thank you so much for the thorough explanation.

I look forward to the InsPlan PUT and substitiutionlink POST.

Thanks!
Dhru

Re: API not found. Requesting new APIs

Posted: Tue Dec 06, 2022 2:18 pm
by dhru95
@SLeon - also for the InsPlan PUT, I'd like to request being able to update MonthRenew. This is because some plans have benefit periods of calendar year, while others have service years at different months, and I'd like to be able to update that in OpenDental for some insurance plans.

I apologize for not mentioning this in the beginning of this post.

Thank you so much!

Re: API not found. Requesting new APIs

Posted: Tue Dec 06, 2022 2:26 pm
by SLeon
Thank you for letting us know, Dhru. I have updated your feature request on our list.

Re: API not found. Requesting new APIs

Posted: Tue Dec 06, 2022 2:28 pm
by dhru95
I appreciate that very much SLeon. Have a great night!

Re: API not found. Requesting new APIs

Posted: Fri Dec 09, 2022 11:19 am
by JTS
Two new methods, InsPlans GET and InsPlans PUT, have been implemented. InsPlans GET will allow you to retrieve a list of InsPlans from the insplan table. InsPlans PUT will let you edit an existing InsPlan, and allows changing the following fields: GroupName, GroupNum, PlanNote, FeeSched, PlanType, and MonthRenew.
These methods are available in our beta version, 22.3.30. For more information, please see: https://www.opendental.com/site/apiinsplans.html

Re: API not found. Requesting new APIs

Posted: Mon Dec 12, 2022 4:08 am
by dhru95
That is amazing! Thank you so much for implementing so quick. I look forward to hearing back on the substitutionlink POST.

Thank you and have an amazing week.

Re: API not found. Requesting new APIs

Posted: Wed Dec 14, 2022 4:51 am
by dhru95
Hi I am sorry to bother you again. I was just wondering if you could provide me a rough timeline for when the substitutionlink POST would be in production? Thank you so much!

Re: API not found. Requesting new APIs

Posted: Wed Dec 14, 2022 8:04 am
by justine
Development requests are completed in the order we receive them. There are a few ahead of you at the moment, but a rough guess would be approximately 2-3 weeks.

We will update this post as soon as it is available.

Thanks!

Re: API not found. Requesting new APIs

Posted: Thu Dec 15, 2022 7:17 am
by dhru95
Awesome, thanks so much Justine!!

Re: API not found. Requesting new APIs

Posted: Wed Dec 28, 2022 8:31 am
by SLeon
Good morning,

The SubstitutionLink POST feature request has been completed. It will be available in our next beta version, 22.4.5.

Re: API not found. Requesting new APIs

Posted: Sat Dec 31, 2022 5:52 am
by dhru95
Great! Thank you so much, happy new year!!

Re: API not found. Requesting new APIs

Posted: Wed Jan 04, 2023 11:51 am
by rinse-rey
Hello there, these features are super helpful. Is it possible to add a Post(create) InsPlan? I only see Get and Put.

Re: API not found. Requesting new APIs

Posted: Wed Jan 04, 2023 1:11 pm
by SLeon
Yes we can add a POST method for the InsPlan resource for you to insert Insurance Plans. I have added this to our development list.

Re: API not found. Requesting new APIs

Posted: Mon Jan 09, 2023 7:08 am
by dhru95
Hi - do you have a link for the substitutionlink documentation? Ty!

Re: API not found. Requesting new APIs

Posted: Wed Jan 11, 2023 8:26 am
by rinse-rey
Hi OD team.

Do you have any ETA for POST method for the InsPlan ?

Re: API not found. Requesting new APIs

Posted: Wed Jan 11, 2023 10:16 am
by SLeon
There are a few API requests in line before InsPlans POST. I would estimate that it will be implemented in roughly three weeks time.

Re: API not found. Requesting new APIs

Posted: Sun Jan 15, 2023 11:23 am
by dhru95
Hi,

Thank you for adding the SubstitutionLink documentation! I would also like to request the DELETE, GET and PUT functions. The reason is that some dental offices have default downgrades pre-loaded when a new plan is added, and we would like the option to update them by either the PUT function, or just DELETE the preloaded default downgrades (being able to DELETE substitutionlink by PlanNum).

Thank you!

Re: API not found. Requesting new APIs

Posted: Mon Jan 16, 2023 8:55 am
by SLeon
Good morning,

Yes, we can add GET, PUT, and DELETE methods for SubstitutionLinks. This has been added to our development list.

Re: API not found. Requesting new APIs

Posted: Wed Jan 18, 2023 6:19 am
by dhru95
Great, thank you. Do you know when the 22.4 full version will be released for dental clinics to update to?

Re: API not found. Requesting new APIs

Posted: Wed Jan 18, 2023 9:07 am
by SLeon
Good morning,

Open Dental's version 22.4 is currently in beta. While dental offices are able to update to this version, most will stay on our newest non-beta ("stable") version, currently 22.3. Because 22.4 was just released a few weeks ago, you can expect it to be out of beta within the next few months.

Re: API not found. Requesting new APIs

Posted: Wed Jan 25, 2023 9:37 am
by omar22
Great, thank you. I have another question, sorry to be a bother. If an insurance plan for an existing patient is dropped and a new one is added, is there a query that I can run to be able to tell any changes to the patient's insurance plan, independent of the PlanNum, since that changes when new insurance is added. Thanks so much again!

I guess in simpler terms what I am looking for is a way to be able to run a query for the date/time a new PlanNum is added for a patient, or when a subscriberID is changed . Is this possible?

Re: API not found. Requesting new APIs

Posted: Wed Jan 25, 2023 10:45 am
by SLeon
Good morning,

Insurance plans are stored in the InsPlan table and patients are linked/subscribed to them via the InsSub table. A row is deleted from the InsSub table when the patient drops an insurance plan, and a new one is inserted when they subscribe to another (as you mention).

The SecDateEntry column of the InsSub table will show you when the patient subscribed to this plan. The SecDateTEdit column will change whenever a change is made to any field in this table (including SubscriberID). You can also refine your search by patient (Subscriber), depending on your needs.

The API method InsSubs GET is currently in development but you could use Queries PUT ShortQuery in the meantime to read from this table.

Re: API not found. Requesting new APIs

Posted: Wed Jan 25, 2023 2:23 pm
by omar22
You are incredibly helpful. Thank you so much for that thorough explanation.

Re: API not found. Requesting new APIs

Posted: Tue Jan 31, 2023 8:29 am
by dhru95
SLeon wrote:
Wed Jan 18, 2023 9:07 am
Good morning,

Open Dental's version 22.4 is currently in beta. While dental offices are able to update to this version, most will stay on our newest non-beta ("stable") version, currently 22.3. Because 22.4 was just released a few weeks ago, you can expect it to be out of beta within the next few months.
Hi, would it be possible to request that certain features can work in the 22.3 version of open dental, even if they were created after? For example, benefits PUT and DELETE, Substitutionlink API, etc. are only available version 22.4 or later - can that be available for the 22.3 version of open dental too?
I know I ask for ALOT haha but I really do appreciate you very much.
Thank you!

Re: API not found. Requesting new APIs

Posted: Tue Jan 31, 2023 8:52 am
by SLeon
Good morning,

Unfortunately we are unable to release new features beyond our beta version.

Re: API not found. Requesting new APIs

Posted: Thu Feb 16, 2023 9:09 am
by omar22
SLeon wrote:
Wed Jan 11, 2023 10:16 am
There are a few API requests in line before InsPlans POST. I would estimate that it will be implemented in roughly three weeks time.
Hi I just wanted to follow up on this. Thank you!!

Re: API not found. Requesting new APIs

Posted: Thu Feb 16, 2023 9:15 am
by SLeon
InsPlan POST is in the final stage of development. I will update this thread within the next day on its progress.

Re: API not found. Requesting new APIs

Posted: Mon Feb 20, 2023 12:50 pm
by omar22
Thank you! Is there a way to also add an existing InsPlan to a patient with the current available APIs?

Re: API not found. Requesting new APIs

Posted: Mon Feb 20, 2023 1:18 pm
by SLeon
InsPlan POST feature request is complete. It will be available in our next beta version.

@Omar22, Yes. Use InsSubs POST to subscribe a patient to an existing InsPlan.

Re: API not found. Requesting new APIs

Posted: Tue Feb 21, 2023 6:27 am
by omar22
great thank you!

Re: API not found. Requesting new APIs

Posted: Wed Feb 22, 2023 11:05 am
by omar22
SLeon wrote:
Mon Feb 20, 2023 1:18 pm
InsPlan POST feature request is complete. It will be available in our next beta version.

@Omar22, Yes. Use InsSubs POST to subscribe a patient to an existing InsPlan.
Is there a way to add relationship to subscriber via API? Thank you for your quick replies!!

Also - is it possible to add SubscNote to inssub POST and PUT?

And for SubstitutionLinks - on the Open Dental UI, I am able to check off "Don't Substitute Codes". Is there a way to do this via the API? - i believe in the documentation it says this can be achieved by making the CodeSubstNone=1 in the insplan table, but wasn't sure if there was a way to do it via the API.

I know I am asking for alot of things, but I cannot express how grateful I am for all of your help, thanks again :)

Re: API not found. Requesting new APIs

Posted: Wed Feb 22, 2023 12:54 pm
by SLeon
Good afternoon,

By "relationship" are you referring to "Self", "Spouse", "Child", etc? If so, you will want to use our PatPlans resource and supply the Relationship field in your PatPlans POST/PUT request.

Yes, we can add SubscNote to InsSubs POST/PUT methods. I have added this to our development list.

The "Don't Substitute Codes" checkbox is unique to each insurance plan (stored in InsPlan.CodeSubstNone). We can add this field to the InsPlan POST/PUT methods so you can set this via the API. I have added this to our development list as well.

We are happy to answer any other questions you may have, Omar.

Re: API not found. Requesting new APIs

Posted: Wed Feb 22, 2023 3:25 pm
by omar22
you guys really are incredible.. thank you so much :))))))

Re: API not found. Requesting new APIs

Posted: Thu Mar 02, 2023 10:19 am
by omar22
SLeon wrote:
Wed Feb 22, 2023 12:54 pm
Good afternoon,

By "relationship" are you referring to "Self", "Spouse", "Child", etc? If so, you will want to use our PatPlans resource and supply the Relationship field in your PatPlans POST/PUT request.

Yes, we can add SubscNote to InsSubs POST/PUT methods. I have added this to our development list.

The "Don't Substitute Codes" checkbox is unique to each insurance plan (stored in InsPlan.CodeSubstNone). We can add this field to the InsPlan POST/PUT methods so you can set this via the API. I have added this to our development list as well.

We are happy to answer any other questions you may have, Omar.
Is there any way I can add a new InsPlan, then link that newly created insplan with a new patient I create? I ask this because I am trying to create new patients and add new InsPlans to those specific patients, and I am not sure how to get the plannum of the new insplan I add so that it's directly related to the new patient I create. sorry if this is confusing.

It's comparable to how in the UI when you add a new insurance for a patient, you have the option to "Create New Plan if Needed", rather than changing for all subscribers, or picking the plan from list for example.

Re: API not found. Requesting new APIs

Posted: Tue Mar 07, 2023 8:34 am
by SLeon
Good morning Omar,

The form you are referring to inserts rows into the insplan, inssub, and patplan tables. To add a new insurance plan for a patient and "Create New Plan if Needed" via the API you will do the following:
  1. Use Patients POST to create a new patient.
  2. If you don't already have the data cached, use Carriers GET to determine which carrier the new plan will be under.
  3. Use InsPlans POST to create a new insurance plan. You will use the CarrierNum from Step 2 in your JSON.
  4. Use InsSubs POST to subscribe the patient to this new insurance plan. You will use the PatNum from Step 1 and the PlanNum from Step 3.
  5. Finally, use PatPlans POST to indicate plan coverage for the patient. You will use the PatNum from Step 1 and the InsSubNum from Step 4.

Re: API not found. Requesting new APIs

Posted: Fri Mar 10, 2023 8:49 am
by JTS
omar22 wrote:
Wed Feb 22, 2023 11:05 am
Also - is it possible to add SubscNote to inssub POST and PUT?
The SubscNote field has been added as an optional field in the InsSubs POST (create) and InsSubs PUT (update) methods.

This is available as of beta version 22.4.26. For more information, see https://www.opendental.com/site/apiinssubs.html.

Re: API not found. Requesting new APIs

Posted: Tue Mar 14, 2023 7:12 am
by omar22
SLeon wrote:
Tue Mar 07, 2023 8:34 am
Good morning Omar,

The form you are referring to inserts rows into the insplan, inssub, and patplan tables. To add a new insurance plan for a patient and "Create New Plan if Needed" via the API you will do the following:
  1. Use Patients POST to create a new patient.
  2. If you don't already have the data cached, use Carriers GET to determine which carrier the new plan will be under.
  3. Use InsPlans POST to create a new insurance plan. You will use the CarrierNum from Step 2 in your JSON.
  4. Use InsSubs POST to subscribe the patient to this new insurance plan. You will use the PatNum from Step 1 and the PlanNum from Step 3.
  5. Finally, use PatPlans POST to indicate plan coverage for the patient. You will use the PatNum from Step 1 and the InsSubNum from Step 4.
this is very helpful tysm!!

Re: API not found. Requesting new APIs

Posted: Thu Mar 16, 2023 8:13 am
by SLeon
rinse-rey wrote:
Wed Jan 04, 2023 11:51 am
Hello there, these features are super helpful. Is it possible to add a Post(create) InsPlan? I only see Get and Put.
The InsPlans POST method is complete and is available now in versions 22.4.24 and later.
dhru95 wrote:
Sun Jan 15, 2023 11:23 am
Thank you for adding the SubstitutionLink documentation! I would also like to request the DELETE, GET and PUT functions.
SubstitutionLinks GET, PUT, and DELETE methods are also complete. These methods are available now in versions 22.4.25 and later.

We have also created InsSubs GET (single/multiple) to better support insurance workflows via the API. This is available now in version 22.4.28.

Re: API not found. Requesting new APIs

Posted: Fri Mar 17, 2023 11:02 am
by omar22
SLeon wrote:
Thu Mar 16, 2023 8:13 am
rinse-rey wrote:
Wed Jan 04, 2023 11:51 am
Hello there, these features are super helpful. Is it possible to add a Post(create) InsPlan? I only see Get and Put.
The InsPlans POST method is complete and is available now in versions 22.4.24 and later.
dhru95 wrote:
Sun Jan 15, 2023 11:23 am
Thank you for adding the SubstitutionLink documentation! I would also like to request the DELETE, GET and PUT functions.
SubstitutionLinks GET, PUT, and DELETE methods are also complete. These methods are available now in versions 22.4.25 and later.

We have also created InsSubs GET (single/multiple) to better support insurance workflows via the API. This is available now in version 22.4.28.
Awesome thanks! Do you know when the 22.4 version will be out of beta and if it will include the "InsPlan.CodeSubstNone"
Thank you!!

Re: API not found. Requesting new APIs

Posted: Fri Mar 17, 2023 12:35 pm
by SLeon
I estimate that 22.4 will be out of beta in roughly a month's time. The InsPlan.CodeSubstNone feature request is in the final stages of development and will be included.

Re: API not found. Requesting new APIs

Posted: Fri Mar 17, 2023 2:33 pm
by omar22
SLeon wrote:
Fri Mar 17, 2023 12:35 pm
I estimate that 22.4 will be out of beta in roughly a month's time. The InsPlan.CodeSubstNone feature request is in the final stages of development and will be included.
awesome, thank you so much

Re: API not found. Requesting new APIs

Posted: Wed Mar 22, 2023 11:02 am
by SLeon
omar22 wrote:
Wed Feb 22, 2023 11:05 am
... on the Open Dental UI, I am able to check off "Don't Substitute Codes". Is there a way to do this via the API? - i believe in the documentation it says this can be achieved by making the CodeSubstNone=1 in the insplan table...
InsPlan.CodeSubstNone has been added to InsPlans GET, POST, and PUT methods. This will be available in our latest beta version (22.4.31).

Re: API not found. Requesting new APIs

Posted: Wed Mar 29, 2023 1:08 pm
by omar22
SLeon wrote:
Wed Mar 22, 2023 11:02 am
omar22 wrote:
Wed Feb 22, 2023 11:05 am
... on the Open Dental UI, I am able to check off "Don't Substitute Codes". Is there a way to do this via the API? - i believe in the documentation it says this can be achieved by making the CodeSubstNone=1 in the insplan table...
InsPlan.CodeSubstNone has been added to InsPlans GET, POST, and PUT methods. This will be available in our latest beta version (22.4.31).
Awesome, thanks!! I can't wait until the full version of 22.4 is available :)

Re: API not found. Requesting new APIs

Posted: Thu Apr 06, 2023 8:59 am
by omar22
SLeon wrote:
Fri Mar 17, 2023 12:35 pm
I estimate that 22.4 will be out of beta in roughly a month's time. The InsPlan.CodeSubstNone feature request is in the final stages of development and will be included.
Hi! I am so sorry to bother you again with this, I was just wondering if you had a date for when 22.4 will be out of beta? My potential customers keep asking :lol:

Thank you in advance :)