API Change (21.7): Vaccine Information Statement (VIS) Documentation

Summary: We are updating two endpoints to comply with ONC 2015 CEHRT f(1) immunization registries, which require a vaccine administrator to specify which VISs were given to a patient, if multiple VISs are present for a vaccine.

Products: athenaClinicals

Available: 21.7 GA


  • This is a breaking change
  • Endpoints affected include: 
    • GET /chart/healthhistory/vaccine/changed 
    • GET /chart/{patientid}/vaccines


Endpoint(s) affected  

  • GET /chart/healthhistory/vaccine/changed 
  • GET /chart/{patientid}/vaccines 


Why we’re making the changes

Vaccine Information Statements (VISs) are information sheets produced by the CDC that explain both the benefits and risks of a vaccine-to-vaccine recipients. Federal law requires that healthcare staff provide a VIS to a patient, parent, or legal representative before each dose of certain vaccines.  The VIS given to the patient, including the version as indicated by the date of the VIS publication and the date the VIS was given to the patient should be included in the vaccine documentation and transmitted in the immunization registry interface.   

ONC 2015 CEHRT f(1) immunization registries requires if multiple VISs are present for a vaccine,  the vaccine administrator can specify exactly which VISs were given to the patient.  VIS, if available, have two language options in athenaNet, English and Spanish. The default shown will match the patient's preferred language if English or Spanish. If the preferred is a different language, the language defaults to English. You can select the alternate language options to display. This simplifies the selection process for documentation. 

The VIS returned with a vaccine reflects only those VIS given to the patient, rather than a full set of VIS for the vaccine type. 


Is this a breaking change: Yes 


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

The previous/existing behavior is to return all of the VIS for a vaccine, since the app did not have a field for the user to indicate which one was given. The new behavior fixes this to return only VIS given, based on a new field we will be adding as part of this change. Any API consumers who were relying on the actual old behavior will have to change code.  Any code that assumes that vaccine data includes all available VIS for the vaccine should use the available data from the CDC instead, which is located here. Users that assumed the documented behavior was correct won't have to make any change.


What will happen if you do not update code  

Endpoint users who do not update their code will only have access to a subset of the VIS for a vaccine, depending on which VIS were given to a patient. 


Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

On this Page