Immunization

An Immunization resource represents a vaccination administered to a patient.

Overview

See the FHIR documentation for more information about Immunization resources.

Mapped Concepts in HIEBus

  • MedicationAdministration
  • MedicationProfile
  • ClaimService

Supported Interactions

Immunization resources support the following interactions.

Search Parameters

When searching for Immunization resources, the following search parameters are supported.

Name Type Prefixes
Modifiers
Can be Chained? Description
_id Token Logical id of this artifact.
_lastUpdated Date lt  le  gt  ge  When the resource version last changed.
claim Reference :missing  yes Searches for immunizations by their associated claim.
date Date ne  lt  le  gt  ge  sa  eb  ap  Vaccination (non)-Administration Date.
encounter Reference :missing  yes Searches for immunizations by their associated encounter.
explanation-of-benefit Reference :missing  yes Searches for immunizations by their associated explanation of benefit.
lot-number String :contains  :exact  Vaccine Lot Number.
patient Reference yes The patient for the vaccination record.
performer Reference :missing  yes The practitioner or organization who played a role in the vaccination.
provenance-agent Reference yes Search by provenance, specified by its author (aka originator) Organization.
reason-code Token :not  :in  :notin  Reason why the vaccine was administered.
status Token Immunization event status.
vaccine-code Token :not  :in  :notin  Vaccine Product Administered.

Sortable Parameters

When searching Immunization resources, it is possible to sort the returned values by the following search parameters.

  • date
  • _id

Only one sort parameter may be specified.

Supported Includes

When searching Immunization resources, it is possible to include the resources referenced by the following field names.

  • Claim
  • Encounter
  • Explanation Of Benefit
  • Patient
  • Performer
  • Provenance Agent

Back to Resources