API Request

For requests or help with our API
Post Reply
PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

API Request

Post by PBECKER » Mon Jan 03, 2022 1:11 pm

Jordan its been awesome working with your team for many years, thank you!

Below are some new requirements for the Open Dental API, please let me know know if these can be added.

1. https://www.opendental.com/site/apidefinitions.html (Ability to create definitions) If you agree, we we would need the ability to first ensure that the definition does not yet exist.

2. https://www.opendental.com/site/apiproviders.html (Ability to create provider)If you agree, we we would need the ability to first ensure that the Provider does not yet exist.

3. https://www.opendental.com/site/apiapptfields.html (Ability to create ApptField) under Setup, Appointments, Appointment Field Defs

4. Ability to create Open Dental User

5. Ability to Enable and add (FHIR API Key) via API

6. Aging A/R report that is in Open Dental (Reports, Standard, Aging of A/R and select Generate Query) We have noticed the Aging of A/R query is sometimes different for some practices. Is this normal? Are there any API methods to pull(GET) these exact same query via the Open Dental API?

7. Get patients last visit date

Thank a TON Jordan

Pedro

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

Re: API Request

Post by jordansparks » Tue Jan 04, 2022 9:22 am

5. There has to be some way to identify which dental office you are interacting with. The way we came up with is that you create your customer key, and then you paste that into the UI on the customer's end. I can't think of any way to reduce the number of steps, which is what you seem to be trying to do. You can't put a customer key into a customer database unless you first know which customer.

6. What query are you talking about? Maybe you are using the Generate Query button at the LL of https://www.opendental.com/manual/reportaging.html ?

7. We can't just add this as a column when getting patients. The complexity would explode. How about if we supply Appointments GET for single patients. Results would look like https://www.opendental.com/manual/apptspatient.html
Jordan Sparks, DMD
http://www.opendental.com

PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

Re: API Request

Post by PBECKER » Tue Jan 04, 2022 3:56 pm

Hello Jordan

5. We see your point, sounds like this step will need to continue to be a manual step.

6. yes that is the correct generate query button. We're wondering is there a method to run a GET and retrieve the same results as the Generate button query produces?

7. we're ok with a GET of past appointments as long as there arent any date imitations on how far in the past we can run the GET. Example patient named John has an appointment tomorrow so we would like to lookup his last appointment that may have occurred 2 plus years ago.

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

Re: API Request

Post by jordansparks » Wed Jan 05, 2022 9:27 am

We've added all of this to our todo list, and it should be done relatively shortly.
Jordan Sparks, DMD
http://www.opendental.com

PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

Re: API Request

Post by PBECKER » Wed Jan 05, 2022 9:37 am

Thank you so much Jordan!

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

Re: API Request

Post by jordansparks » Wed Jan 05, 2022 9:49 am

5. I did think of a way, but it won't be easy. We've been toying with the idea of a "local API" for certain things. Instead of sending an API command to our server, you would send it directly to the local running copy of OD by using local port. OD would act as a web server and respond to your API request. This could be useful for certain situations where you want to interact immediately with the local copy of OD rather than the database. For example, you might want to tell OD to pop up a certain window or fill certain text on the screen. This local API could also be used to place the customer API key into OD in the first place. Maybe. With quite a bit of work on our end.

While I was typing this, I thought of another way. Your local app could create a text file of a particular name that contains the customer API key and maybe some other info like your software title. OD would then recognize this and pop up a user friendly window asking if it was ok with the user if this connection was turned on. This would completely relieve your staff from having to paste in the API key. One thing that might make this fail is if they installed OD in a non-standard location. Another problem might be if the program files folder doesn't allow you to paste in a new file, so we might have to come up with an alternate location.

This is brainstorming. I'll sleep on it, but the second scenario sounds fairly easy to implement.
Jordan Sparks, DMD
http://www.opendental.com

PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

Re: API Request

Post by PBECKER » Tue Jan 11, 2022 4:07 pm

5. its a tricky one for sure. would be nice to allow our installer package to enable and activate with key. Thank you Jordan

PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

Re: API Request

Post by PBECKER » Thu Jan 13, 2022 10:22 am

Hello Jordan

Sorry to ask are their any timelines on any of the requests?

specifically #7 last visit date

Thanks so much Jordan, we love Open Dental

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

Re: API Request

Post by jordansparks » Fri Jan 14, 2022 11:34 am

Another user had requested 10 items just before you, so we're still plowing through those. I moved #7 to the top of your group and we'll try to get to it right away.
Jordan Sparks, DMD
http://www.opendental.com

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

Re: API Request

Post by SLeon » Wed Jan 19, 2022 1:48 pm

Feature request #7 has been completed.

Appointments GET (multiple) has a new search parameter: PatNum. Supplying this will refine the list of appointments to that patient. You can determine the most recent appointment from this list. PatNum can be used alongside the other search parameters, if desired.

This new parameter will be available in our next beta version, 21.4.18, which is estimated to be released within the next week. See https://www.opendental.com/site/apiappointments.html for more details.

PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

Re: API Request

Post by PBECKER » Sun Feb 06, 2022 4:49 pm

Hello Leon

Are there any updates on the below remaining items

1. https://www.opendental.com/site/apidefinitions.html (Ability to create definitions)

2. https://www.opendental.com/site/apiproviders.html (Ability to create provider)

3. https://www.opendental.com/site/apiapptfields.html (Ability to create ApptField) under Setup, Appointments, Appointment Field Defs

4. Ability to create Open Dental User

6. Aging A/R report that is in Open Dental (Reports, Standard, Aging of A/R and select Generate Query) We have noticed the Aging of A/R query is sometimes different for some practices. Is this normal? Are there any API methods to pull(GET) these exact same query via the Open Dental API?

justine
Posts: 169
Joined: Tue Dec 28, 2021 7:59 am

Re: API Request

Post by justine » Thu Feb 10, 2022 9:36 am

Hello PBECKER,

Feature requests 1, 2, and 3 are currently in development. 4 and 6 are up next. We will post a reply here as soon as they are ready.

Thanks!

PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

Re: API Request

Post by PBECKER » Thu Feb 10, 2022 5:37 pm

Thank you so much Justine, greatly appreciated.

justine
Posts: 169
Joined: Tue Dec 28, 2021 7:59 am

Re: API Request

Post by justine » Tue Feb 15, 2022 11:48 am

PBECKER wrote:
Sun Feb 06, 2022 4:49 pm
2. https://www.opendental.com/site/apiproviders.html (Ability to create provider)
Hello PBECKER,

Request 2. is complete. Information about Providers POST can be found here: https://www.opendental.com/site/apiproviders.html

Providers POST will be available in version 21.4.24, which is estimated to be released later this week.

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

Re: API Request

Post by SLeon » Tue Mar 01, 2022 11:09 am

Another feature request has been completed:

1. (Currently in development)
2. (Previously completed)
3-4. (Currently in development)
5. (Previously completed)
6. A new method, Reports GET Aging, has been added. This returns the same information as the Aging A/R report in Open Dental and has an optional DateAsOf parameter. For more information see https://www.opendental.com/site/apireports.html.
7. (Previously completed)

This new method will be available in 21.4.27.

PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

Re: API Request

Post by PBECKER » Tue Mar 01, 2022 11:43 am

Thank you so much Sarah greatly appreciated.

Thank you for all that you do!

justine
Posts: 169
Joined: Tue Dec 28, 2021 7:59 am

Re: API Request

Post by justine » Wed Mar 02, 2022 11:52 am

PBECKER wrote:
Mon Jan 03, 2022 1:11 pm
3. https://www.opendental.com/site/apiapptfields.html (Ability to create ApptField) under Setup, Appointments, Appointment Field Defs
Hello PBECKER,

Request 3. is complete. Information about ApptFieldDefs can be found here: https://www.opendental.com/site/apiapptfielddefs.html

ApptFieldDefs GET and POST will be available in version 21.4.28.

PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

Re: API Request

Post by PBECKER » Wed Mar 02, 2022 12:08 pm

#ROCKIN

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

Re: API Request

Post by SLeon » Fri Mar 04, 2022 2:29 pm

Another feature request has been completed:

1. (Currently in development)
2-3. (Previously completed)
4. The new method Userod POST will create a new user and assign them to the specified UserGroup. See https://www.opendental.com/site/apiuserods.html for more information.
5-7. (Previously completed)

This new method will be available in 22.1.9 which is estimated to be released within the next week.

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

Re: API Request

Post by SLeon » Fri Apr 22, 2022 3:48 pm

The final requested feature has been completed:

1. Defintions POST will allow the creation of new Definitions. See https://www.opendental.com/site/apidefinitions.html for more information.
2-7. (Previously completed)

This new method is available now in version 22.1.24.

Post Reply