Page 1 of 1

Events API Request: Report Deletion Events

Posted: Mon Jun 16, 2025 3:55 pm
by mandmdiet
Use Case
In our software we help users with claim submission tasks. Our software tracks claims that are ready to be submitted and that have been submitted so the users can observe responses.

We also have a lot of data related to the claims in our system to allow the users to interact with things like patients and plans, etc.

One issue we have is the need to know when objects from Open Dental have been deleted so that we can remove them from our system. However, since Open Dental doesn't have soft delete functionality for many of its tables it is very challenging for us to find records that have been deleted without putting a large load on the MySQL database.

To give an example of the trouble we run into right now that we're trying to avoid, currently if we have 100 claims in our system that users are interacting with and we want to know minute by minute if one of those claims has been deleted, we have to query the claim table for all 100 claims and, if we get fewer than 100 results, we can check which one(s) are missing and have therefore been deleted. For a table with many records like claims this query can be slow, and can be hard on the database and the resources of the Open Dental machine. It also needs to be done for several other tables which becomes a compounding issue.

Request

We were thinking it would be a great use of the Events API, if we could subscribe to events that would tell us when certain tables had records deleted. Is it possible for you to implement something like that for your API users? Here are the tables we would initially like to see deleted events for:
  • adjustment
  • appointment
  • carrier
  • claim
  • claimpayment
  • claimproc
  • claimtracking
  • clinic*
  • commlog
  • definition*
  • fee
  • feesched
  • insplan
  • inssub
  • insverify
  • patient
  • patientnote
  • patplan
  • payment
  • payplancharge
  • payplanlink
  • paysplit
  • perioexam
  • periomeasure
  • preference*
  • procedurecode
  • procedurelog
  • procnote
  • provider*
  • providercliniclink*
  • site*
  • tootinitial
*this table has few records and can probably be polled to find missing records (may not need an event)

Thank you for looking into this, we look forward to hearing back from you!

Re: Events API Request: Report Deletion Events

Posted: Fri Sep 05, 2025 10:22 am
by mandmdiet
Just a follow up on this to see if this is something the team would consider?

Re: Events API Request: Report Deletion Events

Posted: Mon Sep 08, 2025 1:59 pm
by justine
mandmdiet wrote: Mon Jun 16, 2025 3:55 pm Use Case
In our software we help users with claim submission tasks. Our software tracks claims that are ready to be submitted and that have been submitted so the users can observe responses.

We also have a lot of data related to the claims in our system to allow the users to interact with things like patients and plans, etc.

One issue we have is the need to know when objects from Open Dental have been deleted so that we can remove them from our system. However, since Open Dental doesn't have soft delete functionality for many of its tables it is very challenging for us to find records that have been deleted without putting a large load on the MySQL database.

To give an example of the trouble we run into right now that we're trying to avoid, currently if we have 100 claims in our system that users are interacting with and we want to know minute by minute if one of those claims has been deleted, we have to query the claim table for all 100 claims and, if we get fewer than 100 results, we can check which one(s) are missing and have therefore been deleted. For a table with many records like claims this query can be slow, and can be hard on the database and the resources of the Open Dental machine. It also needs to be done for several other tables which becomes a compounding issue.

Request

We were thinking it would be a great use of the Events API, if we could subscribe to events that would tell us when certain tables had records deleted. Is it possible for you to implement something like that for your API users? Here are the tables we would initially like to see deleted events for:
  • adjustment
  • appointment
  • carrier
  • claim
  • claimpayment
  • claimproc
  • claimtracking
  • clinic*
  • commlog
  • definition*
  • fee
  • feesched
  • insplan
  • inssub
  • insverify
  • patient
  • patientnote
  • patplan
  • payment
  • payplancharge
  • payplanlink
  • paysplit
  • perioexam
  • periomeasure
  • preference*
  • procedurecode
  • procedurelog
  • procnote
  • provider*
  • providercliniclink*
  • site*
  • tootinitial
*this table has few records and can probably be polled to find missing records (may not need an event)

Thank you for looking into this, we look forward to hearing back from you!
Hello mandmdiet,

You’re right that deletions are a difficult case. Open Dental doesn’t have soft delete functionality, and once a row is removed from most of these core tables it’s gone. That means there’s no way today for the API to notify you of those deletions in real time. We’ve communicated that limitation before, and it still applies here.

Internally, we’ve discussed possible long-term approaches. One idea could be a dedicated ApiSubscriptionDelete table, where deleted objects could be serialized as JSON and delivered through the Events API in a way similar to inserts and updates. That approach would avoid adding history tables across dozens of places, and it would only log deletions if there’s an active subscription.

But it’s important to note: building something like that would require significant changes inside OD itself, not just the API layer. The API’s role is to honor what OD does. The API doesn’t invent new behaviors that don’t exist in the software. Because of that, something at this scale may not be a free feature request.

This request is far too complex to make a decision on here in the forums. Please email us directly if you’d like to pursue it further so we can review it properly.

Thanks!

Re: Events API Request: Report Deletion Events

Posted: Tue Sep 09, 2025 11:14 am
by mandmdiet
OK, I appreciate that Justine, is there a particular email address I should send this request to?

Thank you

Re: Events API Request: Report Deletion Events

Posted: Tue Sep 09, 2025 11:31 am
by justine
mandmdiet wrote: Tue Sep 09, 2025 11:14 am OK, I appreciate that Justine, is there a particular email address I should send this request to?

Thank you
Hello mandmdiet,

You can find the email address for technical and implementation requests in the Contact Us section of the Developer Portal.

Thanks!