22.7 Bi-weekly Release: Updated endpoints: Enable attachments when retrieving a clinical letter document

Summary

This feature allows vendors to retrieve attachments of letters.

Products

athenaClinicals, athenaClinicals for Hospitals & Health Systems

Roles

Management/Technical

Available

August 11, 2022

Highlights

We are making enhancements to GET/patients/{patientid}/documents/letter/{letterid} which will allow a vendor to retrieve the attachments of a specific clinical letter document.

Setup

  • N/A

Is this a breaking change

No, this is not a breaking change

Endpoints affected

  • GET /patients/{patientid}/documents/letter/{letterid}

New Endpoints

  • N/A

Resources

Refer to the following resources for more information:

What is changing

Vendors are now allowed to gather a clinical letter, including the letter attachments, to ensure the vendor has access to the letter in its entirety.

Why we’re making the change

We’re making this change to allow vendors to gather a clinical letter including the letter attachments to ensure the vendor has access to the letter in its entirety.

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

If current users would like to gather the attachments to a clinical letter document, they will need to make an additional API call using the link surfaced in the attachmentslink attribute.

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

This is not a breaking change, so nothing will happen if changes are not made.

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