Open Dental Forum

DerekR

Gotcha - not a sexy approach when we're making the regular call to GET /patients/Simple to keep our records up to date. Sounds like we'll need to add a call in to check for deleted status. Dumb question - why not include in that endpoint? Why filter it out? Thanks! That is a completely valid questi...

DerekR

This feature request is complete and is available in version 24.3.26.

See https://www.opendental.com/site/apipayments.html for more information.

Thanks!

DerekR

Good morning notsosuperman1,

This feature request to add the ability to set/update procedurelogs.ProcStatus to "Cn", "EC", or "R" is currently in development.

I estimate 2-3 weeks before it is completed.

Thanks!

DerekR

Hello. I'd like to request you please add the following fields to the ProcedureLogs API. The items in bold are the priority. I've attached screenshot for Get vs. Post vs. Put. Get is the priority for my use case. Thank you! ClaimNote DateEntryC DateTP SiteNum HideGraphics ProcTime ProcTimeEnd Billi...

DerekR

Thanks - you may want to clarify that as your documentation doesn't mention that the value isn't saved and just used to calculate. PayAmt: This or NumberOfPayments is required. The amount due per payment plan charge. NumberOfPayments: This or PayAmt is required. The total number of payments in the ...

DerekR

Hello, I updated the Open Dental software and was able to fetch tooth initials data. Would you know how to get the tooth nomenclature ? I read that it was related to the preferences but I could not find the "PrefName" associated with this config when calling the preferences GET endpoint. Or maybe t...

DerekR

Good morning saskia, Payplan.NumberOfPayments is a field that was used for the Old Payment Plans . Old Payment Plans, formerly Patient Payment Plans, are a deprecated feature. Additional Old Payment Plans cannot be created. Existing Old Payment Plans can still be returned with API PayPlans GET (mult...

DerekR

Is there a way i could pull only unpaid procedures of a patient using procedurelogs? Regards Sendhil Good Morning Sendhil, To determine if a procedurelog is unpaid, you will need to use PaySplits GET and ClaimProcs GET to check for a payments or insurance payments. We will add the ability to filter...

DerekR

Good morning beacondental, Please provide me some guidance on how to fetch the balance amount from the treatment plan module of Open Dental software. To obtain the data shown in the treatment plan module, I would recommend following the steps we have listed in this previous forum post: Billing Estim...

DerekR

The Recalls POST and PUT feature requests have been completed.

These methods are available as of beta version 24.2.31. Please see https://www.opendental.com/site/apirecalls.html for more information.

DerekR

You can submit insurance adjustments by using the ClaimProcs POST InsAdjust, or ClaimProcs PUT InsAdjust methods. See API ClaimProcs for more information.

DerekR

I believe toothinitial is the table you are referring to. We do have a ToothInitials GET method that allows you to obtain the table rows filtered by PatNum.

DerekR

I recommend using the User Query to retrieve the appointment from the database. The ClinicNum should be identical to what is being returned via the API.

DerekR

The ClinicNum associate with an appointment can be set to any clinic, regardless of the operatory associated with the appointment. When using Appointments POST (create) without specifying a ClinicNum, the default value will match the appointments patient.ClinicNum up to version 24.2.22. In version 2...

DerekR

Hello DerekR When we are updating ClaimProcs to NoBillIns we are getting BadRequest with message "Cannot change NoBillIns when ClaimProc is attached to a claim." So Is there any api available to remove claim proc from claim? Hello shripati.ukirde, Once a claimproc is associated with a claim, the on...

DerekR

graham_mueller wrote: ↑
Thu Aug 29, 2024 7:29 pm
Would be happy to see a GET Appointments/Planned or etc, though.

Appointments GET (multiple) allowes filtering the results by AptStatus.

DerekR

If I'm understanding you (and the data I'm seeing), it appears that the appointments that are linked to the PlannedAppointments do not ever have a NextAptNum, but there are appointments that are linked to *those* appointments via the NextAptNum. So if PlannedAppointment has Appointment 1 linked to ...

DerekR

Trying to understand Planned Procedures now as well. I have a patient that has six items in the Planned Appointment view. Four of the six are "complete" in the OD UI. What is used to mark this? The PlannedAppt table has four columns, I initially expected that AptNum would be empty for incomplete me...

DerekR

I think ProcFee is intended to just be the raw sum of the Proc Codes? Procedure.ProcFee is the the billable fee of the procedure based on the fee schedule. Default fees are entered in the Procedure Code List. ClaimProc.PatNum = PatPlan.PatNum & ClaimProc.InsSubNum = PatPlan.InsSubNum? Yes, that wil...

DerekR

Procedure.ProcFee vs ClaimProc.BaseEst - Are these values (always?) the same? No, these values are not always the same. You can see our DB Schema for the difference between ProcedureLog.ProcFee and ClaimProc.BaseEst . More information can be found in our documentation: Procedure Codes , Procedure a...

DerekR

When attaching production to the Payment Plan you can select adjustments, completed procedures, and treatment planned procedures.

More information can be found here: Payment Plan

DerekR

USE CASE : Reschedule an existing scheduled appointment. ISSUE : Appointment AptDateTime and Op is updated; however, the new ProvNum is ignored. EXAMPLE : PUT /api/v1/appointments/[AptNum] { "AptDateTime": [New AptDateTime], "ProvNum": [New ProvNum], "Op": [New OpNum] } https://www.opendental.com/s...

DerekR

Good afternoon! Thanks for the quick response - good to know which field I'm looking at but struggling to understand how the values work. I think "Pattern": "//XXXX//" Means 2 x 5 minutes assist time, followed by 4 x 5 minutes doctor time followed by 2 x 5 minutes assist time? For a total of 40 min...

DerekR

Good Afternoon Saskia,

An appointments length is stored in the Pattern field of the appointment table. See the Appointment Table Schema for more information.

Thanks!

DerekR

Good Afternoon Omar, We recommend using the GETs before hand to obtain the original InsPlan.PlanNote and InsSub.SubscNote, and then append the additions you would like to make on the end. It is also worth mentioning that both of those note fields in the JSON body will allow "\n" or "\r\n" to be used...

DerekR

We have completed the second part of your Feature Request. ClockEvents GET has been added with GET (single) and GET (multiple) endpoints. This is available in our latest beta, version 24.1.11.

DerekR

The last feature request, to sign a saved treatment plan, has been completed. TreatPlans PUT (update) allows you to sign a treatplan for both the patient and the practice. For more information, see https://www.opendental.com/site/apitreatplans.html This method is available as of beta version 24.1.10.

DerekR

Good Morning beacondental,

Yes, it is possible for a procedurelog to not be attached to an appointment. When using ProcedureLogs POST, set ProcStatus to "TP", and do not specify an AptNum. Please see API ProcedureLogs for more information.

Thanks!

DerekR

Good Morning, The behavior you are describing is what we would expect. When using Documents POST Upload our documentation states that the document needs to be clicked from within Open Dental to finish the file creation and note removal. Upload the actual file as rawBase64. Specify the extension of t...

DerekR

We have completed this enhancement.

IsAsync has been added to Queries POST and is available starting in version 23.3.26. When IsAsync is set to "true", the file transfer will continue asynchronously.

See https://www.opendental.com/site/apiqueries.html for more information.

Thanks!

DerekR

This feature request is complete.

RefAttaches PUT and RefAttaches DELETE are available starting in version 23.3.26.

See https://www.opendental.com/site/apirefattaches.html for more information.

Thanks!

DerekR

Good Morning,

The last item, marking a treatplan as "signed", is nearing the final stages of development. I would estimate it will be completed within 2-3 weeks. We will update this thread once it is complete.

Thanks!

DerekR

As for the API referral objects being returned, we can enhancement them to include the "IsPreferred" field. This request will be added to our development list. We have also added the ability to filter by "IsPreferred" to this request. What sort of timeline should I expect for items on this list? AP...

DerekR

Good Afternoon, The documentation page lists all of the currently possible query params and JSON body fields with each of our method calls. Referrals GET does not currently have any query params, but you can request to add new ones to our development list. Which fields would you like to filter the r...

DerekR

When an appointment is deleted and removed from the appointment table, an entry is made in the histappointment table indicating that the appointment was deleted when the HistApptAction field equals "Deleted". See HistAppointments GET (multiple) for more details. Another option would be to utilize AP...

DerekR

Good Morning, You are correct. If the customer's database has replication turned on and you use Appointments GET (multiple), you would get the appointments from all three sites. In this situation we would typically recommend filtering by ClinicNum to only obtain the appointments from a single site a...

DerekR

Good Morning Sendhil,

We have added this enhancement to ProcedureLogs GET (multiple) to our development list. It will allow filtering procedurelogs that have been added or changed within a date range specified in the request.

Thanks!

DerekR

Good Morning,

ClaimProcs GET includes the claimprocs that are used for adjustments to insurance benefits.

DerekR wrote: ↑
Tue Nov 28, 2023 9:27 am
Adjustments to insurance benefits are stored in the database using the ClaimProc object, with a Status of "Adjustment".

DerekR

Good Morning, We are unable to duplicate the behavior you are describing. Is this only happening for a single claimproc? Have you been able to update FeeBilled successfully for any other claimprocs? Can you please include the actual response you are receiving so that we can assist you further. Thanks!

DerekR

Good Morning, We have discussed this thoroughly and have decided that we will Add Payments PUT to our development list. This method will allow you to update the PayType, CheckNum, BankBranch, and PayNote fields. To assist with your workflow, we recommend creating Payment Type Definitions such as "A...

DerekR

This feature request is complete.

Payments PUT is available starting in version 23.3.11.
Payments GET has been enhanced to now allow PayType as a search parameter starting in version 23.3.11.

See https://www.opendental.com/site/apipayments.html for more information.

Thanks!

DerekR

This feature request is complete. FeeScheds POST and PUT are available starting in version 23.3.7. See https://www.opendental.com/site/apifeescheds.html for more information. Fees GET (single and multiple), POST, PUT, and DELETE are available starting in version 23.3.11. See https://www.opendental.c...

DerekR

Good Morning beacondental, Adjustments to insurance benefits are stored in the database using the ClaimProc object, with a Status of "Adjustment". To accomplish your goal, you can use ClaimProcs GET, ClaimProcs POST InsAdjust, and ClaimProcs PUT InsAdjust. The documentation for these methods can be ...

DerekR

Good Morning beacondental, Thank you, this was very helpful! You will need to use ProcedureLogs POST to accomplish this goal. The request body should be similar to the following. The key information you need is the PatNum for the patient you want, the ProcDate you want this procedure to appear when ...

DerekR

API feature requests are started in the order in which they are received and will become available in the current beta version upon time of completion. We currently have roughly two dozen requests ahead of this one. I would estimate somewhere in the 6-8 week range. We will update this thread when th...

DerekR

Please clarify what you mean by "TP Codes".

It sounds like you need to create a procedure for a patient, which you can do by using ProcedureLogs POST with a ProcStatus of "TP".

DerekR

Can you please clarify what you mean by "TP Codes". If you are referring to a treatment planned procedure , you can use ProcedureLogs POST with a ProcStauts of "TP". If you are referring to a procedure code , you can use ProcedureCodes POST , but those are the the list of codes that are used when cr...

DerekR

Good Morning beacondental,

ProcTps, are copies of ProcedureLogs, that are only used for saved treatment plans. They are created automatically when using TreatPlans POST Saved to create a saved treatment plan.

Thanks!

DerekR

One of the feature requests, ProcTPs DELETE, has been completed. This method allows you to delete a proctp associated with a saved treatment plan for a patient via the API. For more information, see https://www.opendental.com/site/apiproctps.html This method is available as of beta version 23.3.10. ...

DerekR

Good Morning saskia, We are unable to reproduce the issue you are describing, where you are sending a request to Payments POST, with a PayType specified, but the PayType ends up being the API default. It is also our understanding that the API response shows the PayType you specified, but when you ch...

DerekR

Good Morning rinse-dental,

Adding PatternSecondary to the API Appointments resource, and allowing it to be set in Appointments POST / PUT has been added to our development list.

Thanks!

DerekR

Good Morning beacondental, From our API Implementation page, in the "Data Types" section, we have listed that the JSON serializer may have issues with complex text. Our API methods are intended to match the functionality of Open Dental, including how whitespaces and special characters are handled. W...

DerekR

Good Morning omar22,

This feature request is currently in development. I would estimate that it will be completed in roughly 6 - 7 weeks.

Thanks!

DerekR

Good Morning adam25123, We do not have a Schedules POST method. When looking for open appointment slots, we tend to recommend using Appointments GET Slots or Appointments GET multiple, alongside Schedules GET. The core reason for this is the many different ways that dental offices utilize blockouts....

DerekR

Open Dental software does not allow for mass updates except in very specific situations (such as completing procedures on a completed appointment). The API behaves similarly.

DerekR

The slowness issue should be resolved as of 9:30am PDT.

DerekR

Good Morning,

Some customers are experiencing slowness and we are currently investigating the issue. We sincerely appreciate you letting us know.

DerekR

Good morning PBECKER, TreatPlanAttaches GET returns a list of treatplanattaches for a single treatplan with a TPStatus of "Active" or "Inactive" only . The treatplanattach table is a linker table. If you require the procedure data, you will need to use the ProcNum from the treatplanattach to then ob...

DerekR

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 are describing. ProcTPs GET does return these fields as thes...

DerekR

Good Afternoon gBrown, Claim attachments are stored in A to Z Folder and not in the database. You can use Documents GET and then Documents POST DownloadSftp to find and retrieve these attachments. See https://www.opendental.com/site/apidocuments.html for more information. You can also use Queries PU...

DerekR

The feature request to enhance ClaimProcs GET has been completed and is available in our beta version 23.2.16. This method will now allow you to filter the list of ClaimProcs by the "ProcNum" field. Please see https://www.opendental.com/site/apiclaimprocs.html for more information.

DerekR

Clicking the "Replacements" button from the Program Link Output File window, will give you a list of all supported replacement fields. Please see https://opendental.com/manual/programli ... tfile.html for more information. Thanks!

DerekR

Three new ClaimPayments methods have been completed, which include ClaimPayments PUT, ClaimPayments GET (single), and ClaimPayments GET (multiple). ClaimPayments PUT will allow you to update various fields including the note field from this request. These methods are available as of beta version 23....

DerekR

Good Morning, We have discussed this thoroughly and have decided that we will Add Payments PUT to our development list. This method will allow you to update the PayType, CheckNum, BankBranch, and PayNote fields. To assist with your workflow, we recommend creating Payment Type Definitions such as "Ac...

DerekR

The feature request to enhance our ProcedureCodes Resource to include the field NoBillIns has been completed and is available in our beta version, 23.2.10. NoBillIns will now be returned as a field in ProcedureCodes GET, and can be set in ProcedureCodes POST. Please see https://www.opendental.com/si...

DerekR

The feature request to enhance ClaimProcs PUT has been completed and is available in our beta version, 23.2.10. This method will now allow the NoBillIns field of a claimproc to be updated. Please see https://www.opendental.com/site/apiclaimprocs.html for more information.

DerekR

To create a claim with $0 procedures, the dental office must have the preference, "Creating claims with $0 procedures" set to either "Allow" or "Warn". Then that claim can be finalized by using the Claims PUT and ClaimProcs PUT methods. Please see https://www.opendental.com/site/apiclaims.html and h...

DerekR

Good Morning, When using Claims POST, you can create a claim with a $0 procedure only if the dental office has the preference, "Creating claims with $0 procedures" set to either "Allow" or "Warn". If the dental office has this preference set to "Block", the API will honor this preference and not all...

DerekR

The feature request for ClaimProcs POST InsAdjust has been completed and is available in our beta version, 23.2.5. This method will allow the creation of a ClaimProc that is acting as an insurance adjustment. Documentation can be found at https://www.opendental.com/site/apiclaimprocs.html.

DerekR

The feature request for Claims POST has been completed and is available in our beta version, 23.2.5. This method will allow the creation of a Primary, Secondary, or PreAuth Claim. Documentation can be found at https://www.opendental.com/site/apiclaims.html.

DerekR

Good morning rinse-dental,

We have added this enhancement for Appointments POST (create) to our development list. It will update the the DateScheduled in the recall table when an appointment is created with a Recall procedure. We will update this thread when this request is completed.

DerekR

Good Morning Craig_,

We have just released a new beta version (23.2) on July 31st. The previous beta (23.1) has now become stable. Please see our Previous Versions page for more information. https://opendentalsoft.com:1943/ODBugTr ... sions.aspx

DerekR

Good Morning beacondental, We will look into the possibility of adding Payments PUT. The fields "Receipt", "PaymentSource", "ProcessStatus", and "IsCcComplete" are all complex and never set by the user. We will discuss these fields as a Team and update this thread once we have reached a decision. To...

DerekR

Good Afternoon beacondental,

Payments POST, as well as every API method, does not support interaction with any third party integrations that exist in Open Dental.

DerekR

Hello beacondental, The relationship to an insurance subscriber is stored in the PatPlan table. We currently have PatPlans GET, PUT, and POST which should assist with your workflow. Please See https://www.opendental.com/site/apipatplans.html for more information. This post from SLeon might also be h...

DerekR

Hello beacondental, ProcedureLogs GET (Single) has already been added to our development list. We will also add to our development list the enhancement to ClaimProcs GET to use 'ProcNum' as a parameter. It will return all of the ClaimProcs associated with the specified 'ProcNum'. We will update this...

DerekR

Good Morning beacondental, Our PUT methods do allow you to update a single field at a time since all the fields we list are optional. ProcedureLogs PUT allows you provide the ProcNum and only update the ProvNum field. Please see https://www.opendental.com/site/apiprocedurelogs.html for more informat...

DerekR

Good Morning,

Claims POST is in the final stages of development, and I expect it to be completed in a couple weeks. We will update this thread as soon as it is available.

DerekR

Good Morning, The best option for finding a relationship between the provider and employee table is the userod table. It contains a FK to both provider and employee, but it is worth noting that it is possible to have multiple userods attached to a single provider. See https://www.opendental.com/Open...

DerekR

The API is not able to get EOBs attached to individual claims. EOBs are stored in the OpenDentImages\EOBs folder, and utilize the eobattach table which links them with the claimpayment table. A claim payment can be made for multiple claims, and thus there is no direct correlation between the EOB’s a...

DerekR

We have completed one of these feature requests. The ProcedureLogs DELETE method can now delete procedures with a ProcStatus of C, "Complete". The enhancement to this method is available starting in our beta version (23.1.11). See: https://www.opendental.com/site/apiprocedurelogs.html for more infor...

DerekR

We have completed this feature request. Patients POST and PUT methods now support setting DateFirstVisit. The enhancements to these methods are available starting in version 22.4.42.

See: https://www.opendental.com/site/apipatients.html for more information.

DerekR

Good Morning,

Thank you for thoroughly describing your use case. We will develop a way for you to update the NoBillIns field on a ClaimProc. We will update this thread with more information on the update to ClaimProcs PUT as it nears completion.

DerekR

Good morning,

We have confirmed the issue with Patient.DateFirstVisit is not populating when using Appointments POST. We have added this to our development list and will update this thread with our progress.

DerekR

We have completed this feature request. ProcedureLogs PUT/POST will now allow the ProcStatus to be set as EO (Existing Other Provider). This feature is available in version 22.4.25.

For more information, see https://www.opendental.com/site/apiprocedurelogs.html.

DerekR

Send an email to vendor.relations@opendental.com and they can add the permission for you.

DerekR

Good Morning,

The Zip field is returned in both Patients GET (single) and Patients GET Simple. The API Team will discuss adding the Zip field to Patients GET (multiple) at our next API team meeting and update this thread with a decision.

https://www.opendental.com/site/apipatients.html

DerekR

The API team will make a decision and update this thread early next week.

DerekR

Good Morning,

We will discuss adding BlockOutType to Appointments GET Slots at our next API team meeting.

DerekR

A new method, TreatPlans GET, has been added. This returns all of the TreatPlans that meet a set of search criteria. https://www.opendental.com/site/apiaccountmodules.html This method is available as of beta version 22.4.16. Additionally, two other methods have been created related to Treatment Plan...

DerekR

The last of these requested features has been completed. 1. Tasks Tasks PUT has been completed. This method will update an existing Task and allows changing of select fields. Documentation can be found at https://www.opendental.com/site/apitasks.html 2. AutoNotes Previously Completed. 3. QuickPasteN...

DerekR

We have completed one of the above feature requests. 1. Tasks Tasks PUT is in development. 2. AutoNotes Previously Completed. 3. QuickPasteNotes Previously Completed. 4. ProcedureCodes Previously Completed. 5. Claims Claims PUT: Previously Completed. ClaimProcs PUT: Previously Completed. ClaimPaymen...

DerekR

The Payments POST (create) method now accepts an isPrepayment parameter. When set to "true" It will create of a single Payment and PaySplit that is not attached to any procedure or adjustments for a patient. This feature is available in version 22.4.8. See https://www.opendental.com/site/apipayments...

DerekR

We have completed two of the above feature requests. 1. Tasks Tasks PUT is in development. 2. AutoNotes Previously Completed. 3. QuickPasteNotes Previously Completed. 4. ProcedureCodes Previously Completed. 5. Claims Claims PUT has been completed. This method will update an existing Claim and allows...

DerekR

The position of the planned appointments is stored in the ItemOrder column of the PlannedAppt table. At this time the information would need to be retrieved using PUT queries/ShortQuery.

See the documentation for the Queries resources https://www.opendental.com/site/apiqueries.html.

DerekR

Hello shripati.ukirde,

We have fixed the issue you described in your post above. Not specifying a value for OrthoTotalM in your Claims PUT (update) request will no longer set it to 0 as one would expect. This change will be available starting in versions 22.2.54 and 22.3.25.

DerekR

Hello rinse-rey, When rescheduling any broken/unscheduled appointment in Open Dental, the appointment object is simply updated and put back on the Appointment Module. To perform this behavior with the API, we recommend using our Appointments PUT (update) on the broken scheduled appointment. You woul...

DerekR

We have completed this feature request. Patients GET (single / Simple) and Patients POST (create) will now display the DateFirstVisit for the patient(s). These methods will be available starting in our beta version (22.3.19). For more information, see https://www.opendental.com/site/apipatients.html.

DerekR

We have completed this feature request. Our Appointments GET and Appointments POST methods will now display the NextAptNum for the appointment(s). These methods will be available starting in our next beta version (22.3.19) which is estimated to be released within the next week. For more information,...

DerekR

The final requested feature has been completed. 1. A new method, AccountModules GET Aging, has been added. This returns all of the Aging information for a patient and their family. For more information please see: https://www.opendental.com/site/apiaccountmodules.html 2-5. (Previously completed) Thi...

DerekR

Patients GET Simple now supports filtering by the Gender and Position fields. This will be available in the next beta update (version 22.3.6). Details can be found in our updated documentation: https://www.opendental.com/site/apipatients.html.

DerekR

1. (Currently in development) 2. (Previously completed) 3. A new method, ClaimProcs GET, has been added. This returns all of the Claimprocs for a patient or claim. For more information please see: https://www.opendental.com/site/apiclaimprocs.html 4-5. (Previously completed) This new method will be ...

DerekR

1. (Currently in development) 2. (Previously completed) 3. (Currently in development) 4. A new method, Payments GET, has been added. This returns all of the payments for a patient on or after a certain date. For more information please see: https://www.opendental.com/site/apipayments.html 5. (Previo...

Search found 103 matches