API Change (21.11): Enhanced Capability to Indicate Partially Administered Vaccines

Summary: This update adds a new flag to the endpoint output indicating if a vaccine dose was partially administered.  

  • Note: Partial administration of a vaccine does not apply to vaccines requiring multiple doses. Partial administration of a vaccine only refers to a case where the full, intended dose of a vaccine is not successfully administered.

Products: Clinicals

Available: 21.11 Release


  • New flag indicating partial administration


Endpoint(s) affected:  

  • GET /chart/{patientid}/vaccines  
  • GET /patients/{patientid}/documents/vaccine 

Is this a breaking change: No 


What is changing

A new flag will be added to the endpoint output indicating if a vaccine dose was partially administered. All other parameters remain unchanged. If API handling is not added for the partially administered flag, partially administered vaccines will look like administered vaccines.

Why we’re making the change

We’re making this change to enable quick and discrete documentation the vaccination status of patients. By clarifying the vaccine administration status, we’re taking the guess work out of confirming if a patient is fully vaccinated, or if they require follow up. This change is part of athenahealth, Inc.’s ongoing effort to meet the ONC’s 170.315(f)(1) certification, which ensures your practice can share important vaccination details with immunization registry information systems and can participate in quality payment incentive programs.

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

Update code to consider partially administered flag.

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

This change is additive. If no updates are made, the same fields will be returned as before the change.

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