Retrieve Immunization

Retrieve a patient's immunization records from the EHR. Access details on vaccinations, including vaccine types, dates administered, and dosage information. Essential for tracking a patient's immunization history and ensuring they receive appropriate vaccinations.

To access this clinical data you'll need the patient identifier, obtainable through the Retrieve Patient interaction.

Retrieving the list of immunizations can be done by sending a GET request. The request is sent to the Immunization endpoint:

https://api.<region>.founda.com/1/organizations/<org-x>/fhir/4/Immunization?<parameters>

Where <region> should be defined according to the different Founda regions and <org-x> should be replaced with the Healthcare Provider's organization ID that you are integrated with.

The response contains a Bundle with 0, 1 or N matching Immunizations. The full Immunization resource can be retrieved with the identifier of the selected Immunization from the result set.

Founda adheres to recognized standards (IHE, HL7 FHIR) to ensure compatibility and harmonization among diverse systems. If there is a profile available for an interaction, it is recommended and preferred to follow the prescribed transactions.

The Retrieve Immunization interaction with the Founda Platform is based on the IHE QEDm profile. To indicate that the request and response should comply with PCC-44, the _profile parameter should be included to the search set: .../Immunization?_profile=https://profiles.ihe.net/ITI/QEDm.

In order to comply with the PCC-44 transaction, the interaction should at least support the parameter in the table below. Additional search parameters, as defined in the FHIR Immunization resource, can be used as well.