API not found. Requesting new APIs
API not found. Requesting new APIs
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
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
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.?
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
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
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
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).
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
Do we have to formally put in a request for these to be added?
1. Insplans PUT
2. SubstitutionLinks POST
1. Insplans PUT
2. SubstitutionLinks POST
Re: API not found. Requesting new APIs
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
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
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
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
As of now, we only need to add groupName, groupNum, PlanNote, FeeSched, and PlanType - as a PUT in InsPlan
Thank you so much!!
Thank you so much!!
Re: API not found. Requesting new APIs
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!
Thank you so much in advance!
Re: API not found. Requesting new APIs
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.
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
Good morning. That sounds great, thank you so much for the update!
I hope to hear from you again soon. Have a great weekend!
I hope to hear from you again soon. Have a great weekend!
Re: API not found. Requesting new APIs
@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.
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
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.
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
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
@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
Last edited by dhru95 on Tue Dec 06, 2022 3:09 pm, edited 1 time in total.
Re: API not found. Requesting new APIs
@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!
I apologize for not mentioning this in the beginning of this post.
Thank you so much!
Re: API not found. Requesting new APIs
Thank you for letting us know, Dhru. I have updated your feature request on our list.
Re: API not found. Requesting new APIs
I appreciate that very much SLeon. Have a great night!
Re: API not found. Requesting new APIs
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
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
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.
Thank you and have an amazing week.
Re: API not found. Requesting new APIs
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
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!
We will update this post as soon as it is available.
Thanks!
Re: API not found. Requesting new APIs
Awesome, thanks so much Justine!!
Re: API not found. Requesting new APIs
Good morning,
The SubstitutionLink POST feature request has been completed. It will be available in our next beta version, 22.4.5.
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
Great! Thank you so much, happy new year!!
Re: API not found. Requesting new APIs
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
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
Hi - do you have a link for the substitutionlink documentation? Ty!
Re: API not found. Requesting new APIs
Hi OD team.
Do you have any ETA for POST method for the InsPlan ?
Do you have any ETA for POST method for the InsPlan ?
Re: API not found. Requesting new APIs
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
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!
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
Good morning,
Yes, we can add GET, PUT, and DELETE methods for SubstitutionLinks. This has been added to our development list.
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
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
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.
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
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?
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
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.
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
You are incredibly helpful. Thank you so much for that thorough explanation.
Re: API not found. Requesting new APIs
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?SLeon wrote: ↑Wed Jan 18, 2023 9:07 amGood 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.
I know I ask for ALOT haha but I really do appreciate you very much.
Thank you!
Re: API not found. Requesting new APIs
Good morning,
Unfortunately we are unable to release new features beyond our beta version.
Unfortunately we are unable to release new features beyond our beta version.