Getting ProgNotes by edit date

For requests or help with our API
Post Reply
dannybess
Posts: 6
Joined: Thu Jan 23, 2025 5:47 pm

Getting ProgNotes by edit date

Post by dannybess » Fri Jan 24, 2025 2:00 pm

We’re currently facing an issue with retrieving ProgNotes through the OD API. It appears that ProgNotes can only be accessed on a patient-by-patient basis (i.e. chartmodules/{pat_num}/ProgNotes), which forces us to ingest the data one patient at a time. This approach makes it challenging to keep our data fully synced.

For other data types like appointments and treatment plans, we can fetch them at the practice level and filter by entries that were added or updated after a specific timestamp, which is much more efficient.

Does anyone know of a technique, workaround, or API feature that would allow us to retrieve patient ProgNotes/commlogs at a larger scale or based on a timestamp? Any insights or suggestions would be greatly appreciated!

Thanks in advance!

SLeon
Posts: 583
Joined: Mon Mar 01, 2021 10:00 am

Re: Getting ProgNotes by edit date

Post by SLeon » Fri Jan 24, 2025 2:17 pm

Good afternoon. I moved your question into the appropriate forum for visibility.

The ChartModules GET ProgNotes endpoint returns the data displayed in the ProgNotes grid within Open Dental's Chart Module. This data is simply the compilation of different tables that have that patient's data. These tables are listed in the API documentation:
ObjectType: The type of object being displayed: Appointment, Commlog, Task, Email, LabCase, Rx, or Sheet.
You can get obtain this data without a PatNum constraint by using either a GET method (such as LabCases GET) or a query (with Queries PUT ShortQuery).

dannybess
Posts: 6
Joined: Thu Jan 23, 2025 5:47 pm

Re: Getting ProgNotes by edit date

Post by dannybess » Fri Jan 24, 2025 2:51 pm

Thanks for the reply! I'm specifically looking to get Commlogs (https://www.opendental.com/site/apicommlogs.html).

However, we are ingesting data for a lot of patients - so it gets pretty slow for us to re-ingest all commlogs for every patient anytime we want to check if there has been a new Commlog.

I know TreatPlans has a SecDateTEdit param that lets us get all TreatPlans, for all patients, that have been edited past a certain timestamp. We were wondering if there would be a way to do this for Commlogs (such that we can just, for instance, ingest all Commlogs that have been written today, without needing to re-ingest all previous Commlogs).

SLeon
Posts: 583
Joined: Mon Mar 01, 2021 10:00 am

Re: Getting ProgNotes by edit date

Post by SLeon » Fri Jan 24, 2025 3:23 pm

The "timestamp" column for the Commlog table is called DateTStamp. This date field is automatically updated whenever a change is made to the row (including insertion).

We can add this field to the API response for Commlogs, as well as add a DateTStamp parameter filtering. I have added this to our development list.

In the meantime, you can write a query to leverage this column and use the ShortQuery method I mentioned above.

dannybess
Posts: 6
Joined: Thu Jan 23, 2025 5:47 pm

Re: Getting ProgNotes by edit date

Post by dannybess » Sat Jan 25, 2025 11:00 am

Great, thank you for adding that request - ShortQuery is working for now!

On that note, is there anywhere I can see all available tables? Wondering if I can query https://www.opendental.com/manual/chartbig.html somehow to get a list of completed / scheduled procedures per tooth.

SLeon
Posts: 583
Joined: Mon Mar 01, 2021 10:00 am

Re: Getting ProgNotes by edit date

Post by SLeon » Mon Jan 27, 2025 8:47 am

dannybess wrote:
Sat Jan 25, 2025 11:00 am
... is there anywhere I can see all available tables?
Open Dental's database schema can be found here.

dannybess
Posts: 6
Joined: Thu Jan 23, 2025 5:47 pm

Re: Getting ProgNotes by edit date

Post by dannybess » Mon Jan 27, 2025 3:20 pm

Got it, thanks! It looks like `toothgriddef`, `toothgridcol`, and `toothgridcell` are relevant - but these tables are empty. Curious where OD queries the information from which is displayed in the Chart Module odontogram?

dannybess
Posts: 6
Joined: Thu Jan 23, 2025 5:47 pm

Re: Getting ProgNotes by edit date

Post by dannybess » Mon Jan 27, 2025 3:26 pm

Ah, sorry, just looked at the `procedurelog` schema. I'm guessing it just constructs a query against this?

JTS
Posts: 48
Joined: Thu Aug 18, 2022 12:56 pm

Re: Getting ProgNotes by edit date

Post by JTS » Mon Apr 07, 2025 3:26 pm

We have completed this feature request. Commlogs GET now allows filtering by DateTStamp, and it shows the DateTStamps of returned Commlogs as well. We've also added a GET single, and adjusted the existing PatNum filter to be optional.

This functionality is available as of beta version 25.1.13. Please see https://www.opendental.com/site/apicommlogs.html for more information.

Post Reply