Immunization
An Immunization resource represents a vaccination administered to a patient.
Sample Query
Find vaccines from a particular lot:
https://fhir.careevolution.com/Master.Adapter1.WebClient/api/fhir-stu3/Immunization?lot-number=1
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 |
|
|
Resource id.
|
_lastUpdated |
Date |
lt
le
gt
ge
|
|
When the resource last changed.
|
_source |
Uri |
:missing
|
|
Where the resource comes from.
|
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.
|
lot-number |
String |
:contains
:exact
:missing
|
|
Vaccine Lot Number.
|
patient |
Reference |
:missing
|
yes |
The patient the Immunization is about.
|
practitioner |
Reference |
:missing
|
yes |
The practitioner who played a role in the vaccination.
|
provenance-agent |
Reference |
:missing
|
yes |
Search by provenance, specified by its author (aka originator) Organization.
|
reason |
Token |
:not
:in
:notin
:missing
|
|
Why immunization occurred.
|
reason-not-given |
Token |
:not
:in
:notin
:missing
|
|
Explanation of reason vaccination was not 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
- Patient
- Practitioner
- Provenance Agent
Back to Resources