Search found 48 matches

by SLeon
Thu Nov 18, 2021 11:44 am
Forum: API
Topic: PriProv field is 0 in GET Patients & GET Patients/{patientNumber} API
Replies: 5
Views: 1117

Re: PriProv field is 0 in GET Patients & GET Patients/{patientNumber} API

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.
by SLeon
Wed Nov 17, 2021 11:10 am
Forum: API
Topic: PriProv field is 0 in GET Patients & GET Patients/{patientNumber} API
Replies: 5
Views: 1117

Re: PriProv field is 0 in GET Patients & GET Patients/{patientNumber} API

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...
by SLeon
Tue Nov 09, 2021 9:21 am
Forum: API
Topic: Two New API Permissions
Replies: 0
Views: 1295

Two New API Permissions

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...
by SLeon
Tue Nov 09, 2021 9:12 am
Forum: API
Topic: API Features Requested
Replies: 6
Views: 4152

Re: API Features Requested

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...
by SLeon
Mon Nov 01, 2021 12:03 pm
Forum: API
Topic: Cancelling appointments
Replies: 10
Views: 5354

Re: Cancelling appointments

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...
by SLeon
Mon Oct 18, 2021 12:14 pm
Forum: API
Topic: API Features Requested
Replies: 6
Views: 4152

Re: API Features Requested

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...
by SLeon
Wed Oct 13, 2021 2:51 pm
Forum: API
Topic: Cancelling appointments
Replies: 10
Views: 5354

Re: Cancelling appointments

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...
by SLeon
Mon Oct 11, 2021 2:23 pm
Forum: API
Topic: Appointment statuses Planned, PtNote and PtNoteCompleted
Replies: 2
Views: 1497

Re: Appointment statuses Planned, PtNote and PtNoteCompleted

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...
by SLeon
Fri Oct 08, 2021 1:24 pm
Forum: API
Topic: Cancelling appointments
Replies: 10
Views: 5354

Re: Cancelling appointments

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.
by SLeon
Fri Oct 08, 2021 9:08 am
Forum: API
Topic: Categories and appointment service types question
Replies: 16
Views: 5310

Re: Categories and appointment service types question

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 ...
by SLeon
Thu Oct 07, 2021 2:47 pm
Forum: API
Topic: API Request: Updating a Claim
Replies: 10
Views: 2683

Re: API Request: Updating a Claim

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....
by SLeon
Wed Oct 06, 2021 2:51 pm
Forum: API
Topic: Categories and appointment service types question
Replies: 16
Views: 5310

Re: Categories and appointment service types question

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...
by SLeon
Wed Oct 06, 2021 2:00 pm
Forum: API
Topic: API Request: Updating a Claim
Replies: 10
Views: 2683

Re: API Request: Updating a Claim

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...
by SLeon
Tue Oct 05, 2021 8:16 am
Forum: API
Topic: API Request: Updating a Claim
Replies: 10
Views: 2683

Re: API Request: Updating a Claim

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.
by SLeon
Tue Oct 05, 2021 8:12 am
Forum: API
Topic: Patients List by Provider
Replies: 3
Views: 2104

Re: Patients List by Provider

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).
by SLeon
Tue Sep 28, 2021 9:10 am
Forum: API
Topic: API Request: Updating a Claim
Replies: 10
Views: 2683

Re: API Request: Updating a Claim

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.
by SLeon
Tue Sep 28, 2021 8:03 am
Forum: API
Topic: Documents POST DownloadSftp - sync or async?
Replies: 1
Views: 1551

Re: Documents POST DownloadSftp - sync or async?

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....
by SLeon
Mon Sep 27, 2021 10:32 am
Forum: Developers
Topic: Patients List - API question
Replies: 1
Views: 1345

Re: Patients List - API question

I have moved your question over to our API forums and answered it there (viewtopic.php?f=9&t=7616).
by SLeon
Mon Sep 27, 2021 10:31 am
Forum: API
Topic: Patients List by Provider
Replies: 3
Views: 2104

Patients List by Provider

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 ...
by SLeon
Mon Sep 27, 2021 10:08 am
Forum: Developers
Topic: Update claim table using shortquery api
Replies: 2
Views: 1469

Re: Update claim table using shortquery api

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.
by SLeon
Fri Sep 24, 2021 3:33 pm
Forum: API
Topic: API Features Requested
Replies: 6
Views: 4152

Re: API Features Requested

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...
by SLeon
Fri Sep 24, 2021 3:20 pm
Forum: API
Topic: Categories and appointment service types question
Replies: 16
Views: 5310

Re: Categories and appointment service types question

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...
by SLeon
Fri Sep 24, 2021 1:35 pm
Forum: API
Topic: Email addresses for Providers
Replies: 2
Views: 1679

Re: Email addresses for Providers

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.
by SLeon
Wed Sep 22, 2021 12:31 pm
Forum: API
Topic: Email addresses for Providers
Replies: 2
Views: 1679

Email addresses for Providers

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...
by SLeon
Thu Sep 16, 2021 10:09 am
Forum: API
Topic: API Features Requested
Replies: 6
Views: 4152

Re: API Features Requested

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 ...
by SLeon
Thu Sep 16, 2021 9:46 am
Forum: API
Topic: Request for API surfacing of timestamps
Replies: 2
Views: 2046

Re: Request for API surfacing of timestamps

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.
by SLeon
Fri Sep 03, 2021 8:35 am
Forum: Developers
Topic: Developer Portal Access
Replies: 21
Views: 4804

Re: Developer Portal Access

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.
by SLeon
Thu Sep 02, 2021 10:35 am
Forum: Developers
Topic: Developer Portal Access
Replies: 21
Views: 4804

Re: Developer Portal Access

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.
by SLeon
Thu Sep 02, 2021 8:27 am
Forum: Developers
Topic: Developer Portal Access
Replies: 21
Views: 4804

Re: Developer Portal Access

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...
by SLeon
Wed Sep 01, 2021 1:42 pm
Forum: API
Topic: Cancelling appointments
Replies: 10
Views: 5354

Re: Cancelling appointments

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 ...
by SLeon
Wed Sep 01, 2021 8:06 am
Forum: Developers
Topic: Developer Portal Access
Replies: 21
Views: 4804

Re: Developer Portal Access

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?
by SLeon
Tue Aug 31, 2021 1:46 pm
Forum: API
Topic: Power of attorney query
Replies: 3
Views: 2800

Re: Power of attorney query

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...
by SLeon
Tue Aug 31, 2021 1:42 pm
Forum: API
Topic: API Features Requested
Replies: 6
Views: 4152

Re: API Features Requested

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 ...
by SLeon
Tue Aug 31, 2021 1:08 pm
Forum: Developers
Topic: Developer Portal Access
Replies: 21
Views: 4804

Re: Developer Portal Access

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?
by SLeon
Fri Aug 27, 2021 9:19 am
Forum: API
Topic: Request for API surfacing of timestamps
Replies: 2
Views: 2046

Re: Request for API surfacing of timestamps

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. ...
by SLeon
Fri Aug 20, 2021 10:38 am
Forum: API
Topic: GET Patients altered after the specified date and time
Replies: 4
Views: 3508

Re: GET Patients altered after the specified date and time

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).
by SLeon
Fri Aug 20, 2021 8:25 am
Forum: API
Topic: Retreiving test patients
Replies: 2
Views: 2443

Re: Retreiving test patients

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?
by SLeon
Mon Aug 16, 2021 3:48 pm
Forum: API
Topic: API Features Requested
Replies: 6
Views: 4152

API Features Requested

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...
by SLeon
Tue Aug 10, 2021 1:21 pm
Forum: API
Topic: GET multiple appointments pagesize and offset
Replies: 2
Views: 2320

Re: GET multiple appointments pagesize and offset

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...
by SLeon
Fri Aug 06, 2021 2:30 pm
Forum: API
Topic: Categories and appointment service types question
Replies: 16
Views: 5310

Re: Categories and appointment service types question

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.
by SLeon
Thu Aug 05, 2021 8:44 am
Forum: API
Topic: Cancelling appointments
Replies: 10
Views: 5354

Re: Cancelling appointments

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.
by SLeon
Wed Aug 04, 2021 12:36 pm
Forum: API
Topic: Power of attorney query
Replies: 3
Views: 2800

Re: Power of attorney query

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...
by SLeon
Tue Aug 03, 2021 8:53 am
Forum: API
Topic: Categories and appointment service types question
Replies: 16
Views: 5310

Re: Categories and appointment service types question

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 ...
by SLeon
Thu Jul 29, 2021 1:58 pm
Forum: API
Topic: ClinicNum question
Replies: 1
Views: 2587

Re: ClinicNum question

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...
by SLeon
Thu Jul 29, 2021 11:07 am
Forum: API
Topic: Categories and appointment service types question
Replies: 16
Views: 5310

Re: Categories and appointment service types question

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...
by SLeon
Wed Jul 28, 2021 2:21 pm
Forum: API
Topic: GET Patients altered after the specified date and time
Replies: 4
Views: 3508

Re: GET Patients altered after the specified date and time

We can absolutely implement an API method for this. Expect this to be available very soon!
by SLeon
Tue Jul 27, 2021 8:59 am
Forum: Developers
Topic: ShortQuery
Replies: 5
Views: 2922

Re: ShortQuery

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...
by SLeon
Mon Mar 01, 2021 11:07 am
Forum: Developers
Topic: sudden server error
Replies: 1
Views: 4580

Re: sudden server error

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