API Change (21.11): Expose Original Documents Via API

Summary: Added support for the retrieval of the original document that was uploaded with all pages returned in a single call.

Products: Platform Services

Available: 21.11 Release

Highlights: Affected API endpoints support the retrieval of the original document for the following document classes:

  1. Clinical Document
  2. Imaging Result
  3. Lab result
  4. Admin
     

Overview

Endpoint(s) affected:  

Existing endpoints:

  • GET /patients/{patientid}/documents/clinicaldocument/{clinicaldocumentid}
  • GET /patients/{patientid}/documents/imagingresult/{imagingresultid}
  • GET /patients/{patientid}/documents/labresult/{labresultid}
  • GET /patients/{patientid}/documents/admin/{adminid}

New endpoints that will be added during the 21.11 Release:

  • GET /patients/{patientid}/documents/clinicaldocument/{clinicaldocumentid}/originaldocument
  • GET /patients/{patientid}/documents/imagingresult/{imagingresultid}/originaldocument
  • GET /patients/{patientid}/documents/labresult/{labresultid}/originaldocument
  • GET /patients/{patientid}/documents/admin/{adminid}/originaldocument
     

Is this a breaking change: No 

 

What is changing

Support to retrieve original uploaded or faxed documents. This change is not applicable to scanned documents or documents received through other sources like interface. Original uploaded and faxed documents are retrieved even if providers have manipulated or split them into multiple documents. 

Why we’re making the change

Enhance document-related APIs to improve metadata availability and bring parity with athenaNet UI.

What will current users of the endpoint need to update in their code

No action needed.

What will happen if users of the endpoint do not update their code

N/A.

Link to Developer Portal documentation 

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

On this Page