Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

11.7.14 Resource Immunization - Search Parameters

Public Health and Emergency Response icon Work GroupMaturity Level: N/A  Trial UseSecurity Category: Patient Compartments: Patient, Practitioner

Search parameters for the Resource Immunization - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to this resource.

The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/clinical-date
This search parameter is part of the common search parameter clinical-date

11.7.15 date

Parameter date:date

Immunization: Vaccination (non)-Administration Date

ResourceImmunization
Expression(Immunization.occurrence.ofType(dateTime))
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/clinical-identifier
This search parameter is part of the common search parameter clinical-identifier

11.7.16 identifier

Parameter identifier:token

Immunization: Business identifier

ResourceImmunization
ExpressionImmunization.identifier
Processing ModeNormal
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
Processing ModeNormal
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
Processing ModeNormal
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
Processing ModeNormal
Target ResourcesOrganization
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/clinical-patient
This search parameter is part of the common search parameter clinical-patient

11.7.20 patient

Parameter patient:reference

Immunization: The patient for the vaccination record

ResourceImmunization
ExpressionImmunization.patient
Processing ModeNormal
Target ResourcesPatient
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
Processing ModeNormal
Target ResourcesOrganization, RelatedPerson, PractitionerRole, Practitioner, Patient
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
Processing ModeNormal
Target ResourcesObservation
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
Processing ModeNormal
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
Processing ModeNormal
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
Processing ModeNormal
Target ResourcesObservation, DiagnosticReport, Condition
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
Processing ModeNormal
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
Processing ModeNormal
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
Processing ModeNormal
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
Processing ModeNormal
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
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values