Open Dental

We have reached out to the developer and determined that the two dental offices in question had eConnectors on an older version not supported by Open Dental's API, which is only available in version 21.1 and later. We are going to improve our error messages to better reflect the specific issue that ...

Based on the scenario you provided, I would expect the JSON results you included. You mention that Provider 18 is only available 0800-1100 even though they are scheduled 0800-1900? Is this because you have appointments during the 1100-1900 time frame? I also noticed a date in the url of your API met...

Marek,

The Documents POST Upload bug with the blank document description has been fixed. It will be available in 21.4.22.

Yes, the PatientNotes PUT method only allows the setting of those three fields. However, the "Service" column would simple for us to add if requested.

We will add a new method to split claims via the API. It has been added to our development list and we will start implementing it fairly shortly.

I am glad you've got it working. That leads me to believe that there might have been an issue with the dental office's eConnector. When that is the case, it returns a 400 error and a "An error has occurred on the server" message. To others that may encounter this issue, I would first make sure the e...

Thank you for the intended use case and notes for this method. It is very helpful in the implementation process. We will discuss claim splitting at our next API meeting and update this thread by tomorrow.

By not specifying a Provider in Appointments GET Slots, the search will use the dental office's Practice Default Provider. I will update our documentation to reflect this. Additionally, I have added two provider schedules to our demo database. One provider has a ProvNum of 1 (who is also the Practic...

What is the specific error message you are getting with the 400 BadRequest error? This will describe a number of SQL-related issues with the query you are trying to run. For example, your SQL command should be "SELECT * FROM patient" (not plural "patients"). You are likely getting the an error messa...

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 f...

Thank you! As we work with the implementation we noticed two more fields that we used to set in our integration, but we can't find them in current API: 1. Possibility to set Position field on a patient when updating/creating (especially updating) 2. Option to provide DateCreated field when upload...

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 i...

This issue was determined to be Python-related and has been resolved. In this instance the label for the JSON string needed to be changed from 'data' to 'json', shown below. ShortQuerysite = "https://api.opendental.com/api/v1/queries/ShortQuery" results = requests.put(ShortQuerysite, headers = heade...

Your JSON formatting looks correct. You can always test against our demo database with our testing credentials to confirm (See https://www.opendental.com/site/apisetup.html). That specific error message is most often seen when there is an issue with the dental office's eConnector. Usually this due t...

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 desir...

A fix for the Documents POST Upload bug has been implemented. Now only one file will show in the Image Module tree. This will be available in our next update.

1. The ICEName and the ICEPhone can already be set by using PatientNotes PUT. See https://www.opendental.com/site/apipatientnotes.html.
2. We consider this a bug and are currently looking into the issue.

The last of these requested features has been completed. 1-4. (Previously completed) 5. Two new methods Employers POST and Employers PUT have been implemented. See https://www.opendental.com/site/apiemployers.html. 6. (Previously completed) These methods will be available in version 21.4.16, which i...

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 ...

The minimum stable versions of Open Dental are

HL7 - Version 6.7
FHIR - Version 16.3

Also, Open Dental's own API was released in version 21.1. More details can be found here https://www.opendental.com/site/apispecification.html

Three more of these requested features have been completed. 1-2. (Previously completed) 3. A new method, Claims PUT (update), has been added. See https://www.opendental.com/site/apiclaims.html. 4. Two new methods, Carriers POST and Carriers PUT, have been added. See https://www.opendental.com/site/a...

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.

The API allows retrieving documents via DocNum with Documents POST DownloadSftp. The document will be downloaded to the sftp site you specify. For more information, please see our documentation: https://www.opendental.com/site/apidocuments.html.

Poonam,

How are you requesting this list of patients? Are you using the Patients GET (multiple), Queries POST, or Queries PUT ShortQuery API method?

We have just finished integrating our API documentation into our Open Dental web manual. The new link for API specifications can be found here: https://www.opendental.com/site/apispecification.html.

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...

We no longer recommend removing the <UserLow> and <PasswordLow> tags in the OpenDentalWebConfig.xml file. The API Queries POST and Queries PUT can now be run without setting up special SQL users or modifying the config file. Please see our updated documentation for details: https://www.opendental.co...

Another requested feature has been completed. 1. (Previously completed) 2. Two new methods, PatPlans PUT and InsSubs PUT, have been added for updating patient plan information. Details below. 3. (Updating Claims is currently in development) 4. (Creating/Updating Carriers is currently in development)...

The first of these requested features is complete. 1. The Patients PUT method now supports updating Address2, SecProv, ChartNumber, PreferContactMethod, PreferConfirmMethod, TxtMsgOk, and Language fields. DateTStamp is not an editable field but is updated automatically when any other field is update...

The first of the two recent feature requests is complete. The Position field has been implemented for both the Patients PUT and Patients POST methods. These are available now in our latest beta version 21.4.8. For more information about this method, please see the API section of our manual: https://...

1. Yes, the Position field for patients can be added to Patients PUT and Patients POST methods.
2. Yes, we can add DateCreated as an optional field in Documents POST UploadSftp.

Both of these items have been added to our development list and you can expect an update on our progress shortly.

1. Yes, the dental office can map any definition (where defintion.Category=2) to these eConfirmation statuses. 2. The dental office does not need to sign up for eConfirmations to set these preferences, but using the "confirmVal" field in appointments PUT Confirm is meant for offices that do. In most...

There are two distinct fields for an appointment that describe a status: Confirmed and AptStatus. Confirmed Confirmed describes the confirmation status of the appointment. It is the result of the dental office's attempt to contact the patient to confirm their appointment. This is a definition where ...

Thank you, mandmdiet, for this list of API feature requests. Your Use Cases for each new method are extremely helpful in the implementation process. We will discuss these items at our API development meeting tomorrow and update you shortly.

The PriProv and SecProv fields have been added to Patients GET (single) results. SecProv has also been added to the results of Patients GET Simple.

These will be available in our next beta version (21.3.28) which is estimated to be released within the next week.

We can easily add the PriProv value to the return result in Patients GET (single). This has been added to our development list and should be available rather soon. The Patients GET (multiple) uses the exact query used search for patients within Open Dental. This is why it returns a priProvAbbr but n...

Two new API Permissions have been added. The first is called Payments and is required to use the existing Payments POST method. The second is PayPlans and is required to use the existing PayPlans POST method. Both of these methods were previously under the AllOthers permission, but have been changed...

The final items from this list of requested features are complete. We have added MedicationPats GET and POST to allow the reading and creating of medications that are attached to a specified patient. To facilitate the management of medications that can be assigned to patients, Medication GET and POS...

The new method Appointments PUT Break is complete. This is the only way appointments should be marked as "Broken" through the API. It will be available in our next beta version (21.3.22) which is estimated to be released later this week. Please see our updated documentation for more information on t...

The next items on the requested features list have been implemented. 1-6. (Previously done) 7. Methods for AllergyDefs GET and POST have been added, although these will rarely be used. 8. Allergies POST has been added. Developers will use this method in most cases, as it will automatically create/in...

Along with changing the AptStatus to "Broken", multiple things can occur when an appointment is broken in Open Dental. For example, certain procedure codes can be added to the appointment. These options are set up by the dental office. Because more than just the AptStatus of the appointment is affec...

Yes, an API request will return appointments of any AptStatus. More information on planned appointments can be found here https://www.opendental.com/manual213/apptplanned.html. PtNote/PtNoteCompleted appointments are described at the bottom of this page https://www.opendental.com/manual213/apptspati...

I apologize for the misunderstanding. The AptStatus field can be used to change the status of the appointment to "Broken". This can be done with the Appointments PUT method. I will update our documentation to give more details on this and other fields for that method.

Unfortunately, when a Web Sched appointment (either NewPat or ExistingPat) is made, the specific defNumApptType is only stored as string in its Note field. While this would be visible through an API request, the Note can easily be overwritten by the dental office, and is therefore an unreliable way ...

A customer needs to update their version of Open Dental to update their eConnector. They are able to update to and use our latest beta version right now, if they so choose. If the office does not want to update to a beta version but still use this new method, they will need to wait until version 21....

Appointments GET WebSched will indicate the eServiceLogType of the appointments returned. This is how you can tell how the appointment was scheduled originally ("NewPat", "ExistingPat", etc). Note that this field will be "None" if not scheduled through WebSched. The defNumApptType is a definition.De...

Yes, the Etrans component is happening behind the scenes as we discussed. I will add this information to the documentation for clarity. The version of the customer's eConnector determines the API methods that can be accessed. For example, once they update it to 21.3.16, this Claims PUT Status method...

Claims PUT Status has been completed and will be available in the next beta update (version 21.3.16). Details can be found in our updated documentation (https://www.opendental.com/resources/OpenDentalAPI.pdf). Please let me know if does not entirely cover your use cases.

Patients GET Simple now supports filtering by the PriProv field. This will be available in the next beta update (version 21.3.16). Details can be found in our updated documentation (https://www.opendental.com/resources/OpenDentalAPI.pdf).

This has been added to our development list. We will add a new method for updating the ClaimStatus on a specific claim to Sent. It will include the DateSent and DateSentOrig as fields that can be specified in the JSON. The API method will also handle the Etrans insertion automatically, as well.

For Documents POST DownloadSftp, the API response will wait to return until the SFTP action is finished. This could be a successful upload, or a failure due to invalid SFTP credentials, etc. You will receive an error message describing the failure in the response if the SFTP action was unsuccessful....

I have moved your question over to our API forums and answered it there (viewtopic.php?f=9&t=7616).

We received this question on another forum and I am answering it here for better visibility. Does the GET Patients (multiple) endpoint in the new API allow a Get of all Patients attached to a Primary Provider. In the Schema details for 21.1 the Patients section has a PriProv field, but when I did a ...

The queries executed with the Queries PUT ShortQuery method need to be read-only, so it will not allow direct updates to the claim table. We will need to implement an API method to do this. Please visit the API forums to make a feature request, so that we can develop exactly what you are looking for.

Another item from this requested feature list has been implemented. 1-5. (Previously done) 6. PayPlan POST is a new method that allows the creation of a patient payment plan for a specified dollar amount. All plan terms (such as APR, delayed interest/payments, and charge frequency) are fully support...

Appointments GET WebSched is a new method that gets a list of all appointments, indicating which were made through the WebSched service. You can use the eServiceLogType field to determine if it is a Web Sched "NewPat" or "ExistingPat" appointment. More information can be found on our updated documen...

Development on Userods GET was just completed. It be will available in version 21.3.13, which is estimated to be released early next week.

A developer recently contacted me with the following question and I am moving it here for better visibility. Would "email" be included in the data returned from Providers GET? After testing, we found that "email" was not returned. Our system requires email for all users and was hoping you could help...

Three more items from this requested features list have been implemented. 1-4.(previously done) 5. RefAttaches POST is a new method that attaches a patient to any referral source, either by name or ReferralNum. A second method, Referrals GET, has also been added to view all referral sources for the ...

We have added support for the DateTStamp parameter to Providers GET. Details can be found in our updated documentation here https://www.opendental.com/resources/OpenDentalAPI.pdf.

The grant needs to be for the ''@'localhost' user, not to the 'root'@'localhost' user. You also only need to set the SELECT permission to use the Queries PUT ShortQuery API method.

The ShortQuery method will use the ''@localhost MySql user for your database. This ''@localhost user has no permissions granted by default, so you just need to grant that MySql user SELECT privileges to be able to run your query.

The difference is that Patients GET was released in version 21.1 and Queries PUT ShortQuery is in version 21.2. Because your eConnector is on version 21.1, you cannot access the ShortQuery method until you update it to 21.2. Our documentation indicates which version each API method was released just...

The method Appointments PUT Confirm has been recently expanded to support all appointment confirmation statuses. This will allow you to set the status to "Broken" to indicate a cancellation, or to any other ApptConfirm status the office has setup, via a defNum. The original confirmVal field is used ...

With your eConnector on that version, you should be able to use any API method that was released in 21.1, such as Patients GET. Which method are you using when you get this error?

A new method, PatientNotes GET, now provides this functionality. It returns the patient's ICEName, ICEPhone, and Medical summary note. These fields can also be updated with PatientNotes PUT method, if desired. More details can be found in our updated documentation https://www.opendental.com/resource...

The three following items have been implemented from the list above. 1. Appointments PUT Confirm now supports all ApptConfirmed status types and can be set via DefNum. 2. (previously done) 3. Recalls PUT Status is a new method that allows updating the status on recall reminders. 4. PatientNotes PUT ...

Your Authorization header appears to be formatted correctly. This type of error message generally points to an issue with the eConnector. What version is your eConnector on?

Jason, The field DateTStamp found in many of the API methods is the timestamp you are looking for. It is the exact server time that row in the database was last modified. The ability to specify the DateTStamp as a search paramater for patients already exists in the newer Patients GET Simple method. ...

A new API method, Patients GET Simple, has been added and supports filtering patients by DateTStamp. Details can be found in our updated documentation (https://www.opendental.com/resources/OpenDentalAPI.pdf).

These patients appear to be from the our demo database for the API. In your API requests, are you using your own credentials in the Authorization header or the test ones from the documentation?

A developer recently emailed us the following API feature requests. The API forums are the best place for communication on requested features, so we are moving these items here for better visibility. 1. Appointment Confirm - we need more statuses, we use it not only to confirm, but also to mark pati...

For your first two questions, the API utilizes paging to return large result sets. See the Pagination section in our documentation for details. https://www.opendental.com/resources/OpenDentalAPI.pdf. There is a maximum limit of 100 results, but you can specify an offset. API methods that include Dat...

Whether clinics are enabled are not is stored as a preference so you can utilize the Preferences GET method for this. The PrefName is called EasyNoClinics, where a value of 0 indicates that clinics are enabled.

The Confirmed field is tied to the eServices Automated Messaging feature, if the office has set that up. More information can be found here https://opendental.com/manual/confirmationstatus.html. Currently the API does not support cancelling an appointment, only rescheduling, but we can look into this.

The API offers the Queries POST and Queries PUT ShortQuery methods as a way to obtain information not directly available through other API methods. Emergency contact information is stored in the PatientNote table, more details here: https://www.opendental.com/OpenDentalDocumentation21-1.xml#patientn...

I am glad to hear you were able to get GET SlotsWebSched working! The appointment type is not currently a field that is returned when using GET appointments, but is clearly necessary for this workflow. I will add this to our development list. Do you have any remaining questions/concerns about using ...

The ClinicNum is not the external ID of a practice. Information on the clinic table can be found on our Database Documentation page https://www.opendental.com/OpenDentalDocumentation21-1.xml. If a practice has multiple physical locations, they can choose to enable and utilize the Clinics feature, as...

The defNumApptType parameter for GET /appointments/SlotsWebSched is defined in our documentation as "definition.DefNum where definition.Category=42 (NewPat) or 51 (ExistingPat)". These are the AppointmentTypes specifically associated with the Web Scheduling eService. You can send the following API r...

We can absolutely implement an API method for this. Expect this to be available very soon!

The ShortQuery method will use the ''@localhost MySql user for your database by default, unless you have specifically set up a different UserLow (which is rare). This ''@localhost user has no permissions granted by default, so you just need to grant that MySql user SELECT privileges to be able to ru...

The API is up and running, are you still experiencing this issue? If so, what resource(s) does your script call?

Search found 482 matches