Requests for new API endpoints and new fields for an existing endpoint

[phi.bui]

Hello,

We're working on a Web Application for our Call center for scheduling, view/add/update patient info, view insurance plan, etc. The current version of the Open Dental Cloud API have about 50% of what we need, we hope Open Dental team will consider to add the remaining API end points to help us with a full integration via OD Cloud API without having to make any separate calls to the Open dental database.

API Request Details:


1. View Patient's Chart details
a. - New endpoint(s) to view Chart info by Patient (PatNum)

• i. -- Details under the Patient Info section

• ii. -- Details under the All Information section (Show tab)

• iii. -- Details under the Chart Views section (Show tab)

2. View Patient's Current Insurance Plan(s) for existing patient (Family File)
a. - New endpoint to get a list of current insurance Plan(s) info by Patient (PatNum)


3. View Patient’s Total balance (individually and Family)
a. - New endpoint to get patient balance and family total balance by patient (PatNum)


4. System auto show popup alert ON selecting a patient/family in patient search screen
a. - New endpoint to get a list of alert/popup info by Patient (PatNum)

• i. -- Table Reference: popup

5. View Electronic Forms
a. - New endpoint to get a list of electronic forms info, and ability to download them by Patient (PatNum), similar to Documents endpoint.

• i. -- Table Reference : sheet, sheetDef, sheetfield, sheetfielddef

6. Existing endpoint: View Document by DocCategory
a. - Add DocCategory, and Name to Documents end point: GET /documents?PatNum=101

• i. -- Adding DocCategory and definition Name for DocCategory will allow us to filter out documents by this field.

Thank you for your considerations.

[SLeon]

Thank you for your requests for new API features.

1. The details under the Patient Info section are pulled from many different tables. Some of these items, like Allergies and MedicalSummary are already available through existing API methods. Which of these fields do you need for your web application? Similarly, there some Chart views are already available through the API, such getting commlogs with Commlogs GET.

2. Insurance plans are linked to patients with the InsSub table. We can create a new method, InsSub GET, to get details on all plans the patient is subscribed to, if this is what you are after.

3 and 4. Will be straightforward to implement.

5. We will discuss how we want to handle sheets for the API.

6. Will also be straightforward to implement.

[poonam]

Hi,
I am also looking for insurance detail by PatNum, could you please tell me the exact endpoint to retrieve that.
I checked https://www.opendental.com/site/apiinssubs.html but there is no Get method for the same.

Thanks,
Poonam

[justine]

Hi,
I am also looking for insurance detail by PatNum, could you please tell me the exact endpoint to retrieve that.
I checked https://www.opendental.com/site/apiinssubs.html but there is no Get method for the same.

Thanks,
Poonam

Hello poonam,
You can retrieve the information you are looking for by using a query. Please see: https://www.opendental.com/site/apiqueries.html
We will discuss the addition of InsSub GET in our next API development meeting.

Thank you.

[SLeon]

The first requested feature is complete.

1-3. (Currently in development)
4. The new method Popups GET will retrieve all patient, family, and superfamily popups for a given PatNum. For more information, please see https://www.opendental.com/site/apipopups.html. It is available as of version 21.4.12.

[SLeon]

The next requested feature is complete.

1-2. (Currently in development)
3. New fields have been added to Patients GET (single) and Patients GET Simple. EstBalance will indicate that patient's individual balance and BalTotal shows the patient's family total balance (if they are the guarantor for the family). See https://www.opendental.com/site/apipatients.html.
4. (Previously completed)
5-6. (Currently in development)

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

[phi.bui]

Thank you for your requests for new API features.

1. The details under the Patient Info section are pulled from many different tables. Some of these items, like Allergies and MedicalSummary are already available through existing API methods. Which of these fields do you need for your web application? Similarly, there some Chart views are already available through the API, such getting commlogs with Commlogs GET.

2. Insurance plans are linked to patients with the InsSub table. We can create a new method, InsSub GET, to get details on all plans the patient is subscribed to, if this is what you are after.

3 and 4. Will be straightforward to implement.

5. We will discuss how we want to handle sheets for the API.

6. Will also be straightforward to implement.

Hello,
Thank you for considering adding the requested features to the API.
For request feature

1. I am looking to pull information as in the screenshot above(3 red boxes). Could you confirm all of these info are available from current API version?



2. InsSub GET will get me a little details, about the affective and term date. I think I will need A GET for insPlan, and GET for carrier to get carrier's name and details information for that carrier.

Please let me know if you have any other questions.
Thanks again for adding these APIs to the OD Cloud.

[phi.bui]

The next requested feature is complete.

1-2. (Currently in development)
3. New fields have been added to Patients GET (single) and Patients GET Simple. EstBalance will indicate that patient's individual balance and BalTotal shows the patient's family total balance (if they are the guarantor for the family). See https://www.opendental.com/site/apipatients.html.
4. (Previously completed)
5-6. (Currently in development)

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

Wow, I am so happy to see your team is making great progress on the API.

For the request #3, I totally for get to ask, if it is possible to return the Patient Responsibility (how much that patient owed) for this end point? (https://www.opendental.com/site/apipatients.html). I apologize for not requesting this field in the original request.

Thanks for all you do!

[SLeon]

Yes. We are currently developing methods for returning the Patient Info grid and the All Information grid in red above.

The third red box, Chart Views, just filters what can be seen in the All Information grid and is set up differently by each dental office. Filtering functionality will be present in the All Information grid method, and will include fields represented by the checkboxes in the UI.

Yes, we can make Patient Responsibility available as well. It has been added to our development list.

[SLeon]

The next requested feature is complete.

1-2. (Currently in development)
3-4. (Previously completed)
5. (Currently in development)
6. Documents GET now returns two new fields: DocCategory (defintion.DefNum) and docCategory (definition.ItemName). See https://www.opendental.com/site/apidocuments.html for more details.

These new fields will be available in version 21.4.20, which is estimated to be released within the next week.

[justine]

2. View Patient's Current Insurance Plan(s) for existing patient (Family File)
a. - New endpoint to get a list of current insurance Plan(s) info by Patient (PatNum)

Request 2 is complete. You can retrieve this information using FamilyModules GET Insurance.
Please see: https://www.opendental.com/site/apifamilymodules.html

FamilyModules GET Insurance will be available in version 21.4.21.

[SLeon]

Another requested has been completed:

1. (currently in development)
2-4. (previously completed)
5. We have added a new method called Sheets GET that returns information on all the sheets for a given patient. See https://www.opendental.com/site/apisheets.html for more information. API methods to support downloading Sheets to an Sftp site and SheetDefs GET are still in development.
6. (previously completed)

This new method will be available in our next beta version, 21.4.25, which is estimated to be released within the next week.

[SLeon]

1. A new method, ChartModules GET ProgNotes, has been added and gets the Progress Notes for a patient. similar to how it shows in the Chart Module. See https://www.opendental.com/site/apichartmodules.html for more details. A method to get the Patient Info grid from the Chart Module is currently in development.
2-4. (previously completed)
5. (currently in development)
6. (previously completed)

This new method will be available in 21.4.27.

[SLeon]

For the request #3, I totally for get to ask, if it is possible to return the Patient Responsibility (how much that patient owed) for this end point? (https://www.opendental.com/site/apipatients.html).

We have added a new API method to get this information. AccountModules GET PatientBalances will return the patient portion for each member in a patient's family. For more information see https://www.opendental.com/site/apiaccountmodules.html.

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

[justine]

5. View Electronic Forms
a. - New endpoint to get a list of electronic forms info, and ability to download them by Patient (PatNum), similar to Documents endpoint.

• i. -- Table Reference : sheet, sheetDef, sheetfield, sheetfielddef

Hello phi.bui.

The first part of your request was completed with sheets GET and we are currently developing sheets POST DownloadSftp.

For the sake of clarity, exactly what electronic forms information do you want?

[phi.bui]

Hello,
Thank you for the update on the progress. We're super exited for these data available via the APIs.
As for the sheets, we're looking to pull electronic form details that the Patient filled out for HIPPA forms, Patient Registration, Medical History, Consents, etc.

I hope I answered your question, please let me know if you have any other questions.

Thanks again for your effort on making these apis available to consume.

[justine]

5. View Electronic Forms
a. - New endpoint to get a list of electronic forms info, and ability to download them by Patient (PatNum), similar to Documents endpoint.

• i. -- Table Reference : sheet, sheetDef, sheetfield, sheetfielddef

Hello phi.bui,

In addition to sheets GET, we have added sheets POST DownloadSftp. To retrieve the electronic forms you're after, first use sheets GET with the relevant PatNum, then use sheets POST DownloadSftp to download the pdf. For more information see: https://www.opendental.com/site/apisheets.html.

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

[SLeon]

1. (ChartModules GET PatientInfo is currently in development)
2-4. (previously completed)
5. SheetFields GET is complete. This will return all the fields on a given sheet.
6. (previously completed)

This method will be available in 22.1.10. See https://www.opendental.com/site/apisheetfields.html for more information.

[SLeon]

The final method for this list of requested features has been completed.

1. ChartModules GET PatientInfo will get information for the patient similar to how it appears in the Chart Module.
2-6. (previously completed)

This method will be available in 22.1.18. More information can be found at https://www.opendental.com/site/apichartmodules.html.

[phi.bui]

Hello,

We're working on add/edit appointment and realized the API doesn't have an option to set Appointment.Priority. Is it possible to add Priority for both POST and PUT /Appointments ?

Thank you!
Phi

[SLeon]

Yes, we can add the Priority field in Appointments PUT and POST. This has been added to our development list.

[SLeon]

The Priority field has been added as an optional field in the Appointments POST (create) and Appointments PUT (update) methods.

This will be available in our next beta version 22.1.22, which is estimated to be released within the next week. For more information on own Appointments methods, see https://www.opendental.com/site/apiappointments.html.