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 |
| _count |
Special |
|
|
The maximum number of resources to return in a result page.
|
| _elements |
Special |
|
|
Used to request a specific set of elements be returned as part of a resource.
|
| _id |
Token |
|
|
Resource id.
|
| _lastUpdated |
Date |
lt
le
gt
ge
|
|
When the resource last changed.
|
| _source |
Uri |
:missing
|
|
Where the resource comes from.
|
| _summary |
Special |
|
|
Used to return only a portion of the resouces. Defaults to 'false', which returns the whole resource.
|
| _total |
Special |
|
|
Use the value 'estimate' to populate the result bundle's 'total' element with an estimate of the matching number of resources.
|
| claim |
Reference |
:missing
|
yes |
Searches for immunizations by their associated claim.
|
| date |
Date |
ne
lt
le
gt
ge
sa
eb
ap
:missing
|
|
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
:missing
|
|
Vaccine Lot Number.
|
| patient |
Reference |
:missing
|
yes |
The patient the Immunization is about.
|
| performer |
Reference |
:missing
|
yes |
The practitioner or organization who played a role in the vaccination.
|
| provenance-agent |
Reference |
:missing
|
yes |
Search by provenance, specified by its author (aka originator) Organization.
|
| reason-code |
Token |
:not
:in
:notin
:missing
|
|
Reason why the vaccine was administered.
|
| status |
Token |
:missing
|
|
Immunization event status.
|
| vaccine-code |
Token |
:not
:in
:notin
:missing
|
|
Vaccine Product Administered.
|
Sortable Parameters
When searching Immunization resources, it is possible to sort the returned values by the following search parameters.
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
