API Change (21.11): Additional Supported Document Upload Types To Match The Athena UI For Document Endpoints

Summary: Previously, uploading documents using APIs was restricted to file types such as PDF and PNG. In this release, additional file types such as JPG, TIFF, BMP, GIF can now be uploaded via APIs. This change brings parity with the athenaNet UI - upload document workflow. 

Products: Platform Services

Available: 21.11 Release


Affected API endpoints now support the upload of additional file types for the following document classes:

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


Endpoint(s) affected: 

  • POST /patients/{patientid}/documents/clinicaldocument

  • POST /patients/{patientid}/documents/imagingresult
  • POST /patients/{patientid}/documents/labresult
  • POST /patients/{patientid}/documents/admin
  • POST /patients/{patientid}/documents

Is this a breaking change: No


What is changing

Support to upload additional file types such as JPG, TIFF, BMP, and GIF.

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


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

On this Page