Getting several documents for a patient at a time

[mandmdiet]

We have a use case where we want to perform some AI image processing on x-rays to create and attach additional metadata to an image. We have been looking at the API for pulling a patient's documents and have a few questions.

Here is the API in question: Documents POST DownloadSftp (https://www.opendental.com/site/apidocuments.html)

1. Is it possible to have a version of this API that will allow us to get all of a patient's documents at once?
2. Is it possible to have a version of this API that will allow us to get all of a patient's documents for a time range? For example, all documents in the past 3 weeks?
3. Are there any file size limits for this API?

Thanks

[justine]

We have a use case where we want to perform some AI image processing on x-rays to create and attach additional metadata to an image. We have been looking at the API for pulling a patient's documents and have a few questions.

Here is the API in question: Documents POST DownloadSftp (https://www.opendental.com/site/apidocuments.html)

1. Is it possible to have a version of this API that will allow us to get all of a patient's documents at once?
2. Is it possible to have a version of this API that will allow us to get all of a patient's documents for a time range? For example, all documents in the past 3 weeks?
3. Are there any file size limits for this API?

Thanks

Hello mandmdiet,

1. Is it possible to have a version of this API that will allow us to get all of a patient's documents at once?

Not at this time. However, we can enhance documents GET to no longer require a PatNum, which would allow you get all documents data at once.

2. Is it possible to have a version of this API that will allow us to get all of a patient's documents for a time range? For example, all documents in the past 3 weeks?

We can enhance documents GET to no longer require a PatNum. When doing this, we could add an optional DateCreated parameter. With both those filters, you could use documents GET to retrieve documents created on or after a specified date, for a specific patient. Or, only using DateCreated, you could get all documents created on or after a specified date, for all patients. After that, you would use documents POST DownloadSftp to get the documents by DocNum.

3. Are there any file size limits for this API?

File size limits do not apply to documents POST DownloadSftp endpoint.

Thanks!

[mandmdiet]

I am totally fine with looping through a list of documents from the GET API and pulling them one at a time, what I was concerned about is if the API traffic would be unacceptable to Open Dental. So, if you guys are OK with us looping through customers, grabbing their document meta data and then using that to grab all of their documents one at a time, and doing this for each patient for which we need these documents and for all practices we're connected to, then that is how we will handle this functionality for our application.