22.7 Bi-weekly: Updated and New Endpoints: Populate Patient Education Content Via API

Summary

These endpoints will allow users to gather additional information on the patient education resources provided to patients via athenaClinicals. The additional information includes:

  • A PDF of the patient education content provided to the patient
  • The vendor who generated the specific patient education
  • The code the vendor uses for the specific patient education
  • The language of the specific patient education

Products

athenaClinicals

Roles

Management/Technical

Available

July 27, 2022

Highlights

These enhancements will affect the following endpoints: 

  1. GET /patients/{patientid}/documents/patientinfo will populate the following new attributes:
    • vendorcodetype – Name of the vendor who created the patient education 
    • vendorcode – Vendor-specific code of the patient education 
    • language – Language in which the patient education was provided
    • handoutpdf - A link to the endpoint to fetch the patient education PDF
  2. GET /patients/{patientid}/documents/patientinfo/{patientinfoid}/handoutpdf will allow you to get a PDF of the patient education content affiliated with the patient education order.

Setup

  • N/A

Is this a breaking change?

No, this is not a breaking change

Endpoints affected

  • GET /patients/{patientid}/documents/patientinfo

New Endpoint(s)

  • GET /patients/{patientid}/documents/patientinfo/{patientinfoid}/handoutpdf

Resources

Refer to the following resources for more information:

  • (Coming Soon!)

Overview

What is changing

We are adding attributes to the GET /patients/{patientid}/documents/patientinfo endpoint as well as adding the GET/patients/{patientid}/documents/patientinfo/{patientinfoid}/handoutpdf endpoint. 

Why we're making the change

This allows vendors to get the patient education content as well as additional details about the content that was provided to patients through athenaClinicals. This allows better patient education consistency while patients utilize vendor applications. 

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

This includes additional attributes in the GET /patients/{patientid}/documents/patientinfo endpoint:

  • If a vendor does not want to use the attribute no code changes are required.
  • If a vendor would like to use this attribute they will need to update their code to utilize this attribute. 

If a vendor would like to gather the patient education PDFs they will need to make an additional call to the GET/patients/{patientid}/documents/patientinfo/{patientinfoid}/handoutpdf endpoint. 

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

Nothing
 

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