Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

11.7.13 Resource Immunization - Search Parameters

Public Health and Emergency Response icon Work GroupMaturity Level: N/AStandards Status: InformativeSecurity Category: Patient Compartments: Patient, Practitioner

Search Parameter Registry for the immunization resource

11.7.14 Search Parameters

Search parameter list for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/build/SearchParameter/Immunization-date

11.7.15 date

Parameter date:date

Vaccination (non)-Administration Date

Resources
Expression(Immunization.occurrence as dateTime)
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Immunization-identifier

11.7.16 identifier

Parameter identifier:token

Business identifier

Resources
ExpressionImmunization.identifier
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Immunization-location

11.7.17 location

Parameter location:reference

The service delivery location or facility in which the vaccine was / was to be administered

ResourceImmunization
ExpressionImmunization.location
Target ResourcesLocation
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Immunization-lot-number

11.7.18 lot-number

Parameter lot-number:string

Vaccine Lot Number

ResourceImmunization
ExpressionImmunization.lotNumber
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Immunization-manufacturer

11.7.19 manufacturer

Parameter manufacturer:reference

Vaccine Manufacturer

ResourceImmunization
ExpressionImmunization.manufacturer.reference
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Immunization-patient

11.7.20 patient

Parameter patient:reference

The patient for the vaccination record

Resources
ExpressionImmunization.patient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Immunization-performer

11.7.21 performer

Parameter performer:reference

The practitioner, individual or organization who played a role in the vaccination

ResourceImmunization
ExpressionImmunization.performer.actor
Target ResourcesPractitioner, Organization, Patient, PractitionerRole, RelatedPerson
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Immunization-reaction

11.7.22 reaction

Parameter reaction:reference

Additional information on reaction

ResourceImmunization
ExpressionImmunization.reaction.manifestation.reference
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Immunization-reaction-date

11.7.23 reaction-date

Parameter reaction-date:date

When reaction started

ResourceImmunization
ExpressionImmunization.reaction.date
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Immunization-reason-code

11.7.24 reason-code

Parameter reason-code:token

Reason why the vaccine was administered

ResourceImmunization
ExpressionImmunization.reason.concept
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Immunization-reason-reference

11.7.25 reason-reference

Parameter reason-reference:reference

Reference to a resource (by instance)

ResourceImmunization
ExpressionImmunization.reason.reference
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Immunization-series

11.7.26 series

Parameter series:string

The series being followed by the provider

ResourceImmunization
ExpressionImmunization.protocolApplied.series
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Immunization-status

11.7.27 status

Parameter status:token

Immunization event status

ResourceImmunization
ExpressionImmunization.status
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Immunization-status-reason

11.7.28 status-reason

Parameter status-reason:token

Reason why the vaccine was not administered

ResourceImmunization
ExpressionImmunization.statusReason
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Immunization-target-disease

11.7.29 target-disease

Parameter target-disease:token

The target disease the dose is being administered against

ResourceImmunization
ExpressionImmunization.protocolApplied.targetDisease
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Immunization-vaccine-code

11.7.30 vaccine-code

Parameter vaccine-code:token

Vaccine Product Administered

ResourceImmunization
ExpressionImmunization.vaccineCode
MultiplesThe parameter cannot repeat or have multiple values