Open Dental Forum

Good morning, Yes, that is correct. ApiEvents will fire for any change to the appointment table (as the logic specifically queries for the DateTStamp). This includes queries in our update scripts, such as the ItemOrderPlanned column we added in the 24.2.1 conversion script. This was the only query r...

This issue has been resolved. All modes of the API are available again. See announcement on our main page https://www.opendental.com/index.html for the status of various eServices.

We are aware of an issue impacting eServices and customers' eConnectors. Applications utilizing an existing Local or Service API connection should not be impacted. I will update this thread once the issue is resolved.

Moved thread to API forum.

Information on how Insurance Verification works in Open Dental can be found here.

Please see my API-focused response on your cross post in our API Forums.

Good afternoon, Information on how Insurance Verification works in Open Dental can be found here . This data is stored in the InsVerify table. Patient eligibility uses the "PatientEnrollment" VerifyType. The FKey field for this VerifyType is the patplan.PatPlanNum. Adding the FKey field as parameter...

I realize failed to mention in my last post that I intended too further look into our screening logic to see what we can (safely) do. I will update this thread when I do. However, it is lower priority than API Feature Requests.

Good morning. The Open Dental API screens all payload queries in Queries POST and Queries PUT ShortQuery request to be read-only (or on temp tables). It also screens out SQL actions that are inappropriate to perform via the API, such as the SLEEP command. The reserved word "ROLE" is used to view, cr...

Open Dental will be performing maintenance on its network tonight at 06:00PM PDT. We do not expect an impact to Remote, Local, or Service API modes. See also the announcement on https://www.opendental.com.

Good morning, Using Queries POST for the requisite large data grabs and keeping them up-to-date with the table's GET method and timestamp filter is a great strategy. I think you will do well with this approach. DateTStamps Here is the link to our Database Schema . Descriptions of fields you find in ...

Good morning,

It sounds as though your network configuration and setting are blocking all SFTP (Port 22) traffic, not just from Open Dental. You should contact your IT administrator to sort this out.

Good morning,

There may be firewall or other network settings preventing you from connecting. Once you make sure your Sftp site is running, try to connect from the server to the Sftp site directly with another file transfer application (e.g. PuTTY, Filezilla, etc.).

Thank you for your patience on this request. We are able to create an endpoint for sending Claims, but it would only support DxC and EDS clearinghouses. Would you like us to add this to our development list?

Good morning, Issue 1: Unintended Deletion of All Benefits The code snippet you shared appears to loop through some list of benefits and calls the Benefits DELETE endpoint each time. The API does not mass delete benefits with this endpoint. All API POST, PUT, and DELETE methods create a SecurityLog ...

Good morning, The Patients GET Simple returns results sorted by PatNum (ascending). You are quite correct that if the API were to return unsorted results it would be difficult to get datasets complete/in sync. We call this "drift" in our documentation. Nearly all of our API GET endpoints sort by the...

No.

SLeon wrote: ↑
Tue Sep 17, 2024 7:55 am
You can email/call our Vendor Relations department if you have further billing questions.

Good morning, We do not restrict API Developers to using only one API Mode. Many developers' applications will utilize one Mode primarily, and failover to another in certain situations. Every enabled API Customer Key is always enabled for all three Modes (Local, Service, Remote). Pricing information...

Good morning,

Ummehani wrote: ↑
Mon Sep 09, 2024 12:51 am
...
it seems there might not be a built-in way to filter by a range of dates directly.
...

This is correct. You will need to write such a query and use the Queries POST or Queries PUT ShortQuery endpoint to obtain this data.

Good morning, As I understand it, you originally reported an issue of seeing appointments in clinics you don't expect. The API is returning what for me is an unexpected result... The suggestion to run a query is to determine if the API is returning the unexpected result or if the database itself con...

Good morning, The PlannedAppt table was dropped in 24.2. It was replaced with the ItemOrderPlanned field in the Appointment table. You can see this change in our schema here . Previously, there wasn't a way to obtain Planned Appointment data via the API outside of Queries PUT ShortQuery. Now you can...

Good morning,

I edited the sensitive information out of your post.

I would first check the permission settings of the the dental office machine where the AtoZ folder is located. The user you are trying to connect with may not have permissions to that directory.

Good afternoon,

We are going to add "Insert ERAs via the API" to our development list. However, this process is complex and will require us to research how we can support this. I will update this thread when we have a better idea of exactly how this would work, payload contents, etc.

This guide describes how to find openings where providers and operatories are available for booking appointments. Most scheduling applications will need to create or follow a similar algorithm, as dental offices can have schedules set up in a variety of ways. Note: We do not recommend the Appointmen...

Good morning, isn't being deprecated in version 24.2, it's just going to be removed at that point. The PlannedAppt table was deprecated in 24.2.0. This is our Beta version, currently. It fits the Wikipedia page you linked's description of deprecation, because we did not outright remove the concept o...

Good morning, First, I will link our documentation for pagination: Pagination For any method that returns a list of items, you will need to use pagination to get chunks of up to 100 items at a time. Use Limit and Offset. Limit is usually not specified, and it defaults to the hard limit of 100 items ...

I realize I didn't address your note about Appointments PUT Break not logging. I just called this endpoint for the above appointment and see a log created.

: AuditTrail_BrokenAppointment.png (7 KiB) Viewed 9713 times

Open Dental makes Audit Trail entries ("securitylog"s in the database) for actions that occur in Open Dental. These can include opening certain windows, logging off, or modifying the database. I know you said you haven't looked into what is specificly being logged, but I would encourage you to do so...

Good afternoon, An API endpoint to upload an EOB (and create an EOBAttach table row) is already on our development list. This endpoint will be called EOBAttaches POST UploadSFTP and will allow developers to transmit a file and create the database linkage to the associated ClaimPayment. Would this su...

Good afternoon, Short answer: Yes, they will survive a reboot. The general flow of our API Events is as follows: Store the current time for the database's server. Examine the Subscription.DateTimeStart and use it to query the desired table. We limit batches to 1000 elements. Create a payload and sen...

If you are experiencing issues with eClipboard, I recommend having the dental office call support.

This Feature Request is in development right now, and should be available fairly shortly. We will update this thread with the released version when it is complete.

Yes, customer and developer key strings are paired. At the time of customer key generation, they are associated with the developer account logged into that session of the Developer Portal. Additionally, the customer key string itself is unique. No other developer will have a customer with the same s...

Good morning, I have added Statements GET to our development list. Because our endpoints are based on table schema, the returned fields will be some or all of those found in the statement table . If a pdf was already generated for this statement in Open Dental, then this new Statements GET will retu...

Good morning,

Setting Prosthesis via the ProcedureLogs PUT endpoint is currently in development. We will update this thread when the feature request is complete.

Good afternoon,

LabCases GET/PUT/POST/DELETE is next on our development list. We will update this thread once it is complete.

Good morning,

The API does not currently have a Statements GET endpoint. We can add this to our development list, if you like.

You can use the Queries resource to run your query. The schema for the statement table can be found here.

Database health/support is outside of my expertise. I can point you to our MySQL manual page and suggest having the office call support.

You can see a list of eServices in our manual. However, because you describe the slowness only while using your application, I hypothesize it is more likely MySQL related than eConnector.

Are you still experiencing this issue? SLeon, Incidentally, for Antivirus, they are using Trend Micro and they are also using something called PRTG for network monitoring. I cannot speak to either of those causing problems with the eConnector specifically, but it is worth checking. Does the office e...

Good afternoon, Some anti-virus software applications will cause problems with the eConnector ( eConnector Troubleshooting ). You can check the logs for the eConnector (or the API Service, if using instead) to see if anything is listed there. You might also use the Slow Query Log Tool in your troubl...

Moving this topic to its own thread.

Many times Open dental will insert an object into the database at the beginning of the UI process, and then update it with the final details at the end. This pre-insertion is what you are seeing.

To ensure Database ApiEvents are working properly, you can programmatically employ this strategy: ... [*]For Database events, use Subscriptions GET a few times to see that the DateTimeStart is incremented by PollingSeconds. This will not occur if there is an issue processing the subscription due to ...

Customer Keys can only be made in the Developer Portal. From this forum post : ... The Developer Portal is secure, requiring a username and password. We would have to add this entirely new layer of validation to the current API model. The portal also requires active human interaction to log in and c...

Good morning, Yes, by the nature of how data is collected for the subscription, deleted rows cannot be sent in an ApiEvent. Open Dental will query the appointment table for rows with DateTStamp values equal to or greater than DateTimeStart (2022-11-28 15:04:31) The query can only return rows that ex...

A third-party application can safely obtain data from and insert data into a customer database using the Open Dental API. You can find more information on our API Specification page.

Good afternoon,

You are correct. There is not currently an API endpoint that submits claims to a clearinghouse.

We will research if this is something the API can do, and I will reply to this thread with more information in the next couple days.

I recommend you first start by following the eConnector Troubleshooting Steps listed in our manual. If you are unable to resolve this, you may need to contact your IT or call Open Dental support.

That is an interesting difference between MySQL version 5.5 and 10.5. You can easily get around this by SELECTing from your original query. SELECT subquery1.* FROM [subquery] as subquery1 UNION ALL SELECT subquery2.* FROM [subquery] as subquery2 Edited to add: In response to your other post, I agree...

Good afternoon, Your original post suggested there was an issue with the API's parsing of the queries. I replied that the API uses the exact method utilized by the User Query window in Open Dental. This is why I asked if you experienced the issue you described in the User Query Window with a user th...

I was not able to duplicate the described behavior in the User Query window . I created a UserOD belonging to a UserGroup that does not contain the "Command Query" permission. This is the result of running your query: UserQuery_NoCommandPermission.png Regardless, I recommend removing extraneous comm...

Because you mentioned ShortQuery, I am moving your thread to the API forums. The API Queries PUT ShortQuery endpoint utilizes the same logic that the User Query window does in Open Dental. Do you receive a similar error message when running this query in the UI (with a user that only has read-only q...

I've started a reply to this previously, but my response really boils down to two things: Early in the thread we discussed and agreed that large queries should be either 1) batched, or 2) replaced a lazy-loaded cache (leveraging Claims GET single/multiple). The rest of this discussion is either spec...

Thank you for answers to these questions. Because you are receiving a 504 error and not a 400 Bad Request "Result exceeds maximum content length" error, I can assure you that the response isn't failing because it is too large. As for the difference in size, there a couple reasons an API response wil...

It makes sense that the result of the query is small, as you are seeing a 504 timeout error and not a 400 Bad Request (with message) error. It also makes sense that limiting the scope of your query reduces the time it takes your query to execute. Any query made through the API will take longer to ex...

The 504 code corresponds to a "Gateway Timeout" error. By your description, the query is taking too long to execute. As mentioned in other places on our forum, the API servers have a 60 second timeout. If the execution of the query does not complete before the API server closes the connection, the c...

Yes. We will add this request to our development list.

Good morning, You can find general information on the Merge Patient Tool here . It states: After the merge is successfully completed: The status of the Patient to merge from will change to Archived. The patient can still be accessed via the Select Patient window by selecting Show Archived/Deceased/H...

I have added this to our development list.

All payments made via the API have a "PaymentSource" value of "API". You will not be able to mark these payment as coming from different sources, as they are made via the API. Is your request to be able to set ProcessStatus to OnlineProcessed?

Good morning, You will very likely determine an AptNum from one of the Appointments endpoints. In most use cases, you will use Appointments GET (multiple) and pass in the optional PatNum parameter to get all appointments for that patient. There are other parameters, such as AptStatus and date, you m...

Payments made via the API automatically have a ProcessStatus of OfficeProcessed, so you do not need to set this in the PUT.

This post from August suggests how you can use definitions to to otherwise categorize payments.

All eConnector should be working properly as of 11:30a.

We are aware of an issue impacting some customer's eConnectors. Applications utilizing the Local and Service API should not be impacted. I will update this thread once the issue is resolved.

Good morning,

We will add a new endpoint, Recalls PUT, to our development list. It will allow these three field to be set.

Good morning,

Open Dental does not produce any logs for ApiEvents. However, you can look at the DateTimeStart value of your subscription to see if it was processed correctly. This time will not update if the software was unable to successfully connect to you webhook site.

I was able to successfully use a trailing '/' character for the Patient table subscription as well. Please share any information you are able to find in your search, or if any other questions come up.

I was unable to duplicate the issue with the steps provided. Base Case: I updated a test dental office to the latest beta (24.1.28). I created a webhook.site url I made a subscription with this URL (no trailing '/') for the Appointment table. I made changes to an appointment via the UI and via a rem...

Good morning,

There have not been any changes to ApiEvent Url formatting/sending logic since the change you linked (22.3). Can you please describe the symptoms you are observing?

Good afternoon, Proposed addition: GET /inssubs/11 -- return specific plan GET /inssubs?CarrierNum=25&PlanType=p&IsHidden=false&Offset=100b -- return multiple plans I assume there is a typo and you want us to add ins plans GET functionality. We can add a GET (single) endpoint and add optional Carrie...

It sounds like you created a second code with "0210". From our Procedure Codes manual page: Note: Once created, a code can't be changed or deleted. Instead move it to an obsolete category. Moving it the an obsolete category will not prevent you from charting it, however, if you type in "0210" specif...

Entering an empty string value for a PatField in the Open Dental program results in the deletion of that row. Subscriptions work by querying the database for items in the table (eg patfields) that have changed since the last batch of events are sent. Specifically for the patfield table, the query gr...

This request is complete. It is available starting in versions 23.3.53 and 24.1.24.

Good morning, In your example JSON, the FeildType value is "StaticText". From our Sheet Field Types Manual Page : Static Text: Text information such as labels and large paragraphs. Also includes fields that can be inserted as static text so that resulting text is specific to the patient (e.g., patie...

All eConnectors should be functioning properly at this time.

We are aware of an issue impacting some customer's eConnectors. Applications utilizing the Local and Service API should not be impacted. I will update this thread once the issue is resolved. Also see announcement on our main page https://www.opendental.com/index.html.

Good morning, If you are using the Remote Mode of the API (i.e. using the eConnector), you can see common troubleshooting steps here . That page also contains the location of the eConnector's log files, which could indicate an issue. The analogous logs for the Service Mode of the API are found in th...

Good morning, I assume the SftpAddress is functioning properly if the other ~30 dental offices are able to successfully utilize it. Manually connecting from the Dental Office server (wherever the eConnector/APIService is installed) to the SftpAddress is the perfect first step. I have not experienced...

I would recommend checking out our Query Examples page to see if an existing one will work for you. There is insurance Used, Pending, and Remaining data returned in #1243, for example. You can also follow the instructions and link at the top of that page to request Open Dental's Query Team to write ...

Good afternoon, I would recommend a query to obtain this information. One of the advantages of this would be the ability to grab the information easily for list of patients. Calculations for populating the text boxes in your screenshot: AnnualMax - This is directly from the Benefit table (benefit.Mo...

Can you also add a DELETE function? What would be the ETA on these? Thank you Benefits DELETE already exists and has been available since version 22.4. The enhancement to Benefits to support CodeGroups just finished development today. You can expect it and the documentation to be released shortly i...

Good morning, Because calculating estimates is expensive computationally, Open Dental very intentionally only performs this logic when needed. This is why, as you said, it is described in our manual as a 'feature': "Estimated patient portion for attached procedures. (patient portion = gross producti...

Moving your API question to the API forum.

The Fam Urgent Fin Note is stored in the FamFinUrgNote field of the patient table on the family's guarantor. You can use the Patients GET (single) endpoint on the guarantor to obtain this information and Patients PUT to edit it.

Good afternoon Becker, As DerekR mentioned, the requirement for an Open Dental user to click an object after using the Documents POST Upload endpoint is not a bug. It is described in our documentation here: "The customer never sees this text, but when they later click on the document, the file is cr...

Good morning, Are you trying to use the Local or the Service mode of the API? Your URL uses port 30223, which would indcate the API Service, but you also mention running Open Dental as admin, which is necessary only for the Local mode. I would first recommend reading ang following the troubleshootin...

Good afternoon,

Could you please clarify if you would like to make statements via the API or if you are wanting to mark a statement made in Open Dental as "Sent" via the API? We do not have an endpoint for either in the API currently.

Yes. The machine where the OpenDentalEConnector.exe is installed and running will connect to your Sftp site. The eConnector is safe and all data transferred over its channel (to and from) is secure. More information on its encryption can be found in our manual.

Good morning, I understand that you are not seeing the results you expect when using Appointment GET Slots. I am the engineer who wrote this method, and am happy to clear up any issues. You are also welcome to email us at the email address found in the Developer Portal (click Contact Us). The latter...

Good afternoon, The Appointments GET Slots endpoint was released in the very first version of the API (21.1). As mentioned in its documentation, it is meant for dental offices for simple scheduling setups and works almost identically to the standard appointment search found within Open Dental. My ex...

Good afternoon,

Please try the troubleshooting steps found in our API Guide - Subscriptions and Events in the "Unable to see an event on your webhook service" section.

Let us know if you continue to have issues.

Thank you very much for this information. You are specifying a "principalAmount" value in your payload. You cannot set this value in the PayPlans POST Dynamic endpoint in the API. You also cannot specify a total loan amount for DPPs in Open Dental. Quoting our web manual , with additional underlinin...

Good morning, Yes, you can delete proccodes from a treatment plan (called ProcTPs in our schema) using the ProcTPs DELETE endpoint. This was completed in November and is available in versions 23.3.10 and later. One of the feature requests, ProcTPs DELETE, has been completed. This method allows you t...

Could you please elaborate on the following points for us to be able to answer your question? pricing on the procedure for what the patient owes is incorrect Are these created in OD or via the API? Are these Completed procedures? How is the "what the patient owes" incorrect and how are you making th...

Good morning, We have completed the first part of your Feature Request. Employees GET has been added with GET (single) and GET (multiple) endpoints. This is available in our latest beta, version 23.3.22. Development on ClockEvents GET will start soon, and we will update this thread once it is comple...

We have completed the above feature requests. 1-6. Already complete. 7-8. InsPlans GET - CopayFeeSched is now present in the return object. This field can now also be set in the PUT and POST method. This functionality is available in version 23.3.17 and later. 9. ProcedureLogs GET (multiple) - Clini...

You can set the fee amount for a specific procedure/fee schedule using the Fees POST and PUT endpoints.

We recommend you contact support for help with this issue.

Good morning, There is no field corresponding to "planned priority" in the appointments table, so we cannot add the field to the Appointments GET (single/multiple) endpoints. This information is in the PlannedAppt table, so I have added this GET to our development list. There is no corresponding fie...

I move this topic from the Main Forum to the API forums. The message, "ProcNum(s) ... are invalid for this patient." will occur when the procNums you supply are not valid for the PatNum you supplied. Are the corresponding procedures for the correct patient? Also, note the casing for "PatNum" and "Cl...

Good morning,

Posts previously in the "Plug-ins" category have been moved to the "Main Forum" and "Developers" categories.

I recommend calling support for help on this issue.

I am still unable to run your query (I replaced the aptnum in both this and the previous one) so I do appreciate you sharing the return payload. Our API methods are analogous to either SQL queries to a single table (Appointments GET) or a report shown in Open Dental's UI (AccountModules GET ServiceD...

Your 'Authorization' header in Local/Service API Modes will be the same as the 'Authorization" header you already use in your Remote API requests.

We have completed another feature request from the above list. 1-6. Already complete. 7. Currently in development. 8. Currently in development. 9. ProcedureLogs GET now has an optional ClinicNum parameter. This new functionality is available starting in version 23.3.13. 10. Currently in development.

Good morning, First, please see our documentation on the Local API and API Service. There is also a getting started guide on the API Service specifically. The Remote, Local, and Service modes of the API all use the same set of credentials for a dental office, there is no additional "registration" re...

Good morning, These are great questions and thank you for supplying the queries you are using. Get Patient Visits I ran your Patient Visits query in a local environment and the results are extremely similar to the output of the Appointments GET (multiple) endpoint with the optional PatNum parameter....

I do understand your concern, that keeping patient balance information up to date is computationally expensive. It is for this very reason that Open Dental does not run the aging logic each time a balance-impacting change is made. As you mention, doing so would be very complex. This is why most deve...

Would creating a way for you to subscribe to the procedurelog table be helpful? An event would trigger whenever a change was made to the table, be it from a dental office user or the API, and you would receive the webhook on your site with that row in the database. Your logic could then grab the pat...

Good afternoon, These are great questions and concerns that I am happy to elaborate upon. ApiEvents In addition to viewing the documentation you linked, I would recommend reading API Guide – Subscriptions and Events . It contains an extended description of ApiEvents, how they can be used, and some e...

Yes, Open Dental can run on Windows 11. Please see our Computer Requirements manual page for a full list of supported operating systems.

I moved your API question to the API section of our forum. The FamilyModule GET Insurance method returns information similar to what is displayed in Insurance Section of Open Dental's Family Module . There is more information on plan types on its manual page here Also, from our API documentation: .....

A few developers have recently emailed us with API feature requests. The API forums are the best place for these, so I am posting them here for visibility. 1. ScheduleOps GET - This new method was added in 23.2.27. 2. Appointments GET (multiple) - Add optional Op (operatory) parameter. This was comp...

API feature requests are started in the order in which they are received. I would estimate these to be completed in 6-8 weeks, and we will update this thread with our progress.

Good afternoon, Most of the data you are after is stored in the ClockEvent table. I would recommend referencing our schema here . We can add a ClockEvents GET endpoint to our development list. You will also need to obtain employee information from the Employee table, since the ClockEvent table only ...

Good morning, Thank you for that clarification. The commlog.CommType field was an Enumeration datatype and not a definition in Open Dental versions before 5.5.0. If the dental office was on an early version of Open Dental in the 2019-2020 time frame, that may explain the difference you are seeing. T...

Would it be possible in that workflow to keep a list of unassigned API keys handy (internally) that your staff can distribute to the customer?

Good afternoon, The version the dental office is on is stored in the preference table as "ProgramVersion". You can use Preferences GET or Queries PUT ShortQuery to obtain this value. It will be in the form of #.#.#.0 (eg 23.3.9.0). As far as generating keys, the current plan is to keep that to the D...

Good morning, The query ran in AccountModules GET Aging is large, complex, and takes longer to execute than most of our other endpoints for this reason. We limit this endpoint to a single patient for three reasons: Because this query takes longer to execute, calling it for multiple patients in a sin...

Good morning, There are antiquated records in the 'CommLog' table that contain 'commType' values that do not correspond to a 'CommLogType' (i.e., a definition entry with a 'Category' of 27). You are seeing old commlogs in the dental office's database that do not correspond to a CommLogType/Category=...

I have added these additional hooks to our list and we will update this thread once the is complete.

Note that the first of these four was completed in the original job. It was backported to 23.3.5, so the surrounding code will look different than your current version (22.4).

Good afternoon, The "confirmVal" options are confined to the ones listed to the documentation as a result of how they are mapped for eConfirmations. Each one corresponds to a preference set by the Dental Office. PrefName.ApptEConfirmStatusSent - "Sent" PrefName.ApptEConfirmStatusAccepted - "Confirme...

If we were to do everything via the API I think we'd first have to GET PatientBalances to get us a list of patients with balances, and then make another call (GET ServiceDateView) for each patient with a balance (often hundreds!). Or is there a more efficient way to get the data we're after? This d...

AccountModules GET Aging returns the same information found in the Aging grid at the top of the Account Module. From the Account Module page of our manual: ... Ins Est: Displays expected insurance payments for the entire family (estimated insurance payments + estimated write-offs). This number only ...

... Is there any more information on the service date view? ... The API method AccountModules GET ServiceDateView is directly based on the Service Date View in Open Dental. You will see in the link's screenshot that all charges on the account are detailed and you can determine what has been paid. Y...

Good morning, Both of the API methods you mention calculate and update account balances before returning. If you want to get the aging data for a family you can either: Run AccountModules GET Aging for each member of the family. (Recommended) Run Reports GET Aging and parse out only the patients in ...

I have added this to our list and will update this thread once it is complete. Thank you.

Good morning, I would like to address both of your concerns on transitioning to Dynamic Payment Plans: ... Speed - they want to get the payment setup quickly and get the patient out the door ... You can set up a Dynamic Payment Plan very quickly with the procedures that were Completed and/or Treatme...

Please see my reply on your cross-post of this question in "Advanced Topics".

Good morning,

From our manual:

Individual Annual Max - (Ins Used + Pending) = Remaining

You can incorporate the adjustments to insurance benefits entered in this form via the ClaimProc table. They will have a claimproc.Status of "Adjustment".

Dynamic Payment Plans must have some production associated with it to justify the total balance. You can attach Completed procedures, Treatment Planned procedures, and adjustments. What is the reason behind the dental office's practice of charging patients when no dental work has been done or planned?

Good morning, ... can it be used in a fire and forget style where we're not waiting on the query to run and the file to be uploaded thus making the timeout irrelevant? With some research this appears to be something we can do. We would add a parameter that you could choose to pass in for this behavi...

Yes, you can send your API requests en masse and they will be processed, in the order in which they are received, and throttled on our end. Depending on how you design your application, you may implement synchronous or asynchronous calls to suit your needs. Your use case of "sending out" communicati...

Yes, you would need to make one API call for each downgrade. You should only need to do this once, however, for each code. And that is assuming the dental office didn't set these up already.

Open Dental allows you to allocate an amount to a specific procedure via paysplit, not payment. The API will not support a PaySplits POST or PUT method. You can use Payments POST. This method allocates money on a FIFO basis. If you want to pay on a different basis, you can call Payments POST with th...

Good morning,

mardo wrote: ↑
Thu Oct 19, 2023 10:06 am
1) Post a payment that is allocated to procedures

See Payments POST documentation.

mardo wrote: ↑
Thu Oct 19, 2023 10:06 am
2) Post payments for insurance

See ClaimPayments POST documentation.

I want to make sure I understand your concern correctly. You are using the Queries POST Sftp endpoint and the request (query + document transfer) time is exceeding the server timeout. And your specific question is, "If my request times out, how do I know if the document was successfully created?" an...

The best email addresses to use for API communications are those located in the API's Developer Portal website. Click 'Contact Us' at the top after logging in. The second of these addresses is only available to API account holders and routes directly to the API team for technical questions.

Disruptions in API availability can be reported here or via email. When submitted via email, we are able to gather additional information such as which customers are impacted, etc. This can help us pinpoint the source to be the dental office's network, eConnector, or API itself. We are investigating...

1. Yes. The only way to remove items from a Saved Treatment Plan is by double-clicking the desired row and clicking the Delete button highlighted in this screenshot: TreatmentPlans_Save_ProcTPDelete.gif We will mimic this in ProcTPs DELETE. 2. This will take a few weeks to to develop and complete. 3...

Yes, we can add ProcTPs DELETE to our development list. Please remember that this would delete the ProcTP entry and not delete the original procedure and not delete the procedure code.

Once complete, all new API methods require the dental office to update to use the new feature.

Good morning, From your other Treatment Plan forum thread: TreatPlanAttaches GET does not have any parameters. I believe you are referring to the TreatPlans GET that does allow the parameter's of "Active" and "Saved". However TreatPlans GET never returns any of the procedure cost details that you ar...

Good morning,

This feature request is actively in development and will completed rather shortly.

Yes, we have added this to our development list. Commlogs POST will return the same fields as in the GET method (including the CommlogNum). We will update this thread once complete.

Good morning, The "Presenter" in Open Dental is from the UserNumPresenter field in the TreatPlan table. This can only be set on Saved treatment plans . We will add this field to the API method being developed to create Saved treatment plans. Here is an update on our progress for your Treatment Plan ...

Like the Definitions table, the CovCat table allows dental office to create customer Insurance Coverage categories. These will be unique to each dental office. We are in the process of developing CovCats GET for this purpose. In the meantime, you can use a Queries PUT ShortQuery request to see the l...

We are looking into this now. Can you please elaborate on the error you are receiving? A payload of the API requests that are and are not working would also be helpful. When you query for the CovCatNum, are you only using those that have "IsHidden" values of "false" for your Benefits POST requests?

Good morning, The verbiage in the error message mentions the customer's version because it is, by far, the most common source of failure when this issue occurs. Did you check the version of the method you are trying to use and the version of the dental office? This will let you know if the customer ...

Yes. The remaining feature requests are still on our development list. TreatPlanAttaches PUT and POST methods are in the final stages of development.

The API cannot run the mass Billing list logic performed in Open Dental. Our web manual indicates that the Billing/Finance Charges or Repeating Charges tools need to be ran prior to Billing. It is extremely database intensive the point that the OpenDentalService can be set to run this after hours, a...

You can use the existing Reports GET Aging to get the aging data for all the patients. You could form a list of patnums from those patients with a balance, and then run each one through the AccountModules GET ServiceDateView. Because the AccountModules GET ServiceDateView queries so much data (from ...

Open Dental attempts to release four minor versions per year, but that is not guaranteed. I would estimate that version 23.2 will no longer be in beta in a couple months.

Yes, we will look into how we can update the response of PayPlans POST (create) to match PayPlans POST Dynamic and our current patterns, without introducing a breaking change.

Maintenance was completed successfully at 18:53:26 PST. All modes of the API and the Developer Portal website are again available.

Open Dental will be performing scheduled maintenance on its API servers tonight at 18:00:00 PDT for approximately two hours. The Remote API and Developer Portal website will be unavailable during this time. Existing instances of the Local and Service API modes will be unaffected. We will update this...

We have completed the last feature requests in this thread. 1-2. Previously completed. 3. SheetDefs GET is complete. This method returns a list of sheetdefs, which can be utilized in our Sheets POST method. This available now in version 23.2.5. 4. Previously completed. 5. ApiEvents now include when ...

We apologize for the interruption of service from roughly 14:30 -20:30 PDT. Our internet provider experienced a severe outage in our region (cable cut) impacting Open Dental and thousands of others in our area. We have just come back online and the API is available. The Local and Service Modes of th...

We have completed two of the above feature requests. 1-2. Previously completed. 3. In Development. 4. Previously completed. 5. In Development. 6. SecurityLogs GET is complete and is available in versions 23.1.33 and later. 7. The ToothNumbers enhancement to the Documents resource is complete and ava...

Good afternoon Pedro,

No update on this feature request yet, development will start on it soon.

Good morning,

The API does not currently have a Payments PUT method. Which fields would you want to update for a payment?

We have complete one of the above feature requests.

1. Previously completed.
2. Sheets POST has been completed. It is available now in version 23.1.32.
3. In Development.
4. Previously completed.
5-8. In Development.

There are many way you could implement versioning in your software. A popular approach is to have a single version of your application up-to-date and scale its use by the dental office's version. Another is to maintain different versions of your software and distribute them to dental offices when th...

Good morning, We can add ProcedureLogs GET (Single) to our development list. It would return the single procedurelog associated with the specified procnum. However if your goal is to update an existing procedure you will only need the procnum, which it sounds like you already have. Can you please cl...

Good afternoon Omar, ClaimProcs POST InsAdjust is next in our development list, and I expect it to be complete a couple weeks after development begins. There are a lot of API feature requests currently in the pipeline, thank you for your patience as we work through them. We will update this thread a...

A couple developers have recently emailed us with API feature requests. The API forums are the best place for these, so I am posting them here for visibility. 1. Computers GET - This method will return the machine names of the workstations and devices that connect to Open Dental at the dental office...

Good morning Pedro,

Are you referring to the "Est. Patient Portion" value in the Appointment Edit window?

From our manual: Appointment Edit - Patient Info Grid:

: AppointmentEdit_PatientInfo_EstPatPortion.gif (30.77 KiB) Viewed 2012 times

Good morning, Both of your requests above are the next items in our development list. Both will likely start development in roughly a week and then completed within a couple weeks of that. I will update this thread as soon as the first item is completed, and include which version of Open Dental you ...

Re #3 - Save Treatment Plan:

I have added creating "Saved" treatment plans to your existing request. We will work on all of these in tandem to make sure they support your workflow. I will update this thread (soon) when I have more information for you on signatures.

Good morning Pedro, We are planning to provide API methods to support your entire workflow! 1. Create Treatment Plan - TreatPlans POST will allow you to do this. 2. Attach Procedure Codes to Treatment Plan . TreatPlanAttaches POST will allow you to do this for both "Active" and "Inactive" treatment ...

Good morning, The "Communications Log" grid in your second screenshot contains more than items in the commlog table. It also contains information for that patient from the emailmessage, formpat, and sheet tables. To get emails for a patient, you can use a query to select rows from that table using t...

Yes, we can add IsWebForm to Sheets GET. I have added this to our development list.

If by URL you are only referring to WebForms, then you can reference the IsWebForm field in the sheet table. You would use a query if you wanted to retrieve that field's information via the API.

Once saved in the database, all sheets appear the same in our software. What is your use case for needing to know how the sheet originated?

I have added this to our development list. We will update this thread once it is completed.

"ReportableName" is a field in the Sheetfield table. We can add it to SheetFields GET, if you like.

To clarify, I mean that there are roughly two dozen requests before these two (TreatPlans POST and TreatPlanAttaches POST) in line. Therefore we will start developing TreatPlans POST and TreatPlanAttaches POST after we've started/completed the other ~24 feature requests.

API feature requests are started in the order in which they are received. We currently have roughly two dozen requests ahead of this one. I would estimate somewhere in the 6-8 week range. These two methods will be developed together and released at the same time to make sure you can fully utilize th...

Good morning,

We will add TreatPlans POST to our development list. The design will be to allow you to create an Active or Inactive treatment plan without procedures. Then, we will also develop TreatPlanAttaches POST so you can add the procedures to the above (or any other) treatment plan.

I would double check your syntax and variable naming. Did you try to run this query in the User Query window of Open Dental?

I was able to run this query with the Public Demo dental office credentials without issue.

Moving to our Main forum as this is a question pertaining to our database schema and not the API. You can also contact support for further help.

Here is a link to our entire database schema that you can use to learn more about Sheets, etc.

Claims POST is currently in development.

The API will not support interactions with DXC (or any other third party) integrations that exist in Open Dental.

It is not clear to me if by, "...run a sample run on the local work stations" you are talking about the User Query window within Open Dental OR the Local mode of the API. It sounds like you are doing #1 and it is taking over two minutes. Have you tried #2 (either the Service or Local mode of the API...

beacondental wrote: ↑
Tue Jun 13, 2023 7:30 am
We have tried both ways for query that has 1800 lines of code and it gets timeout.

Are you saying that you tried the Local or Service mode of the API and got a timeout error? These run at the dental office level, not our API Servers, and therefore are not limited by the same timeout.

Can you please clarify, do you need to usernames of the patients or the username information for the dental office itself? What is your use case for the username?

Good morning,

Yes, we can add support for the OrthoRemainM field in Claims PUT. I have added this to our development list. I will update this thread once completed.

This item is next on our development list. I would expect this to be completed in the next couple weeks.

Good morning, The Remote mode of the Open Dental API has a timeout of 60 seconds. This protects both the API and dental offices in several ways. You can either: 1. Modify your query to execute in the necessary time. You can break the query into a few smaller ones and compile the information afterwar...

Good morning, Which Queries method are you trying to use: Queries POST or Queries PUT ShortQuery? Is the query you are running via the API and in Open Dental identical and to the same database? How long does the query take to execute in Open Dental? Is the dental office using Middle Tier with a lowe...

We have added downloading EOBs to our development list. As with downloading other files via the API, this new method will use an Sftp site hosted by the developer. See Documents POST DownloadSftp, Queries POST, and Sheets POST DownloadSftp for reference. The information in the eobattach table, such ...

We can create EOBAttaches GET that will get EOB attachment information by ClaimPaymentNum. This will get you the filename of the EOB you are after. I have added this to our development list.

Do you need to also download the EOB files, or just get the file information?

This feature has been requested previously and is already on our development list. Claim tracking information is stored in the claimtracking table and has FKs to definition and claim tables. The latter two already have GET methods, so we will add ClaimTracking GET, POST, and PUT. Please see this thr...

A member of our team was able to duplicate your described behavior. For us, it occurred when insurance has already paid the Annual Max (eg $1500) on received claim(s). Because ClaimProcs PUT InsAdjust is used to override all existing insurance pay amounts, passing in an InsUsed value of 163 conveys ...

ClaimProcs GET is an existing method. You can use the PatNum parameter to filter your results by a single patient. ClaimProcs PUT InsAdjust will create, modify, or delete insurance adjustment claimprocs depending on the situation. From our documentation, emphasis added: This adds or changes a claimp...

Good morning, We are investigating this issue and are not yet able to duplicate this behavior. Could you please confirm that "this sample patient had a maximum of 1500" means the patient's Insurance Plan has either an Individual or Family "Annual Max" value of $1500? Also, were there any other adjus...

You probably want to use our ClaimProcs PUT InsAdjust method.

Good afternoon, Thank you for describing your uses cases. We will add the following to our development list: Claim tracking information is stored in the claimtracking table and has FKs to definition and claim tables. The latter two already have GET methods, so we will add ClaimTracking GET, POST, an...

Paysplits are complex, which is why our Payments POST method takes care of them automatically, and based on dental office preferences. Manually assigning paysplits (either en masse or individually ) is left to users at the dental office. The need to run the Income Transfer Manager should be rare reg...

As you and the API documentation describe, the appointment search results in Open Dental and the Appointments GET Slots results are indeed different. A major reason for these differences is in the parameters required to run them. To use Open Dental's appointment search: An appointment must be on the...

We have added UserGroups GET and UserGroupAttaches GET to our development list.

The API security permission page you are referring to are for API key permissions, not for Open Dental user permissions. The documentation on that page has been updated to further indicate this. Basic user information can already be obtained via Userods GET . The remaining user permission informatio...

Images are stored in the documents table, so you can use an existing Documents POST method to do this: First, determine what the definition.DefNum is for "Patient Pictures" by using Definitions GET for Category=18 (/definitions?Category=18). Then, use Documents POST Upload or UploadSftp to upload th...

Search found 553 matches