Summary: Additional file metadata elements can now be returned for documents pertaining to a patient. The metadata returned includes:
- fileextension [new] - The file extension of this document
- filesize [new] - The file size of this document (unit in bytes)
- originalfilename [new] - The original file name of this document
- createddatetime [existing] - Date/Time (ISO 8601) the document was created
Products: Platform Services
Available: 21.11 Release
Highlights: The new API endpoints return additional file metadata elements for the following classes when retrieving documents pertaining to a patient:
- Clinical Document
- Imaging Result
- Lab result
- Admin
Overview
Endpoint(s) affected:
- GET /patients/{patientid}/documents/clinicaldocument
- GET /patients/{patientid}/documents/imagingresult
- GET /patients/{patientid}/documents/labresult
- GET /patients/{patientid}/documents/admin
- GET /patients/{patientid}/documents
Is this a breaking change: No
What is changing
Support to gather additional document upload metadata. Applicable for uploaded documents only. Returned metadata includes:
- fileextension [new] - The file extension of this document
- filesize [new] - The file size of this document (unit in bytes)
- originalfilename [new] - The original file name of this document
- createddatetime [existing] - Date/Time (ISO 8601) the document was created
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
- GET /patients/{patientid}/documents/clinicaldocument
- GET /patients/{patientid}/documents/imagingresult
- GET /patients/{patientid}/documents/labresult
- GET /patients/{patientid}/documents/admin
- GET /patients/{patientid}/documents