Immunization - FHIR v6.0.0-ballot2

FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

11.7.13 Resource Immunization - Search Parameters

Public Health icon

Work Group

Maturity Level: N/A

Trial Use

Security Category: Patient

Compartments: Patient, Practitioner

Search parameters for the Immunization 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

Generated Narrative: SearchParameter clinical-date

11.7.14 date

Parameter date:date

Immunization: Vaccination (non)-Administration Date

Resource Immunization

Expression (Immunization.occurrence.ofType(dateTime))

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

Comparators Allowed: 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

Generated Narrative: SearchParameter clinical-identifier

11.7.15 identifier

Parameter identifier:token

Immunization: Business identifier

Resource Immunization

Expression Immunization.identifier

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/Immunization-location

Generated Narrative: SearchParameter Immunization-location

11.7.16 location

Parameter location:reference

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

Resource Immunization

Expression Immunization.location

Processing Mode Normal

Target Resources Location

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/Immunization-lot-number

Generated Narrative: SearchParameter Immunization-lot-number

11.7.17 lot-number

Parameter lot-number:string

Vaccine Lot Number

Resource Immunization

Expression Immunization.lotNumber

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/Immunization-manufacturer

Generated Narrative: SearchParameter Immunization-manufacturer

11.7.18 manufacturer

Parameter manufacturer:reference

Vaccine Manufacturer

Resource Immunization

Expression Immunization.manufacturer.reference

Processing Mode Normal

Target Resources Organization

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/clinical-patient

This search parameter is part of the common search parameter clinical-patient

Generated Narrative: SearchParameter clinical-patient

11.7.19 patient

Parameter patient:reference

Immunization: The patient for the vaccination record

Resource Immunization

Expression Immunization.patient

Processing Mode Normal

Target Resources Patient

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/Immunization-performer

Generated Narrative: SearchParameter Immunization-performer

11.7.20 performer

Parameter performer:reference

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

Resource Immunization

Expression Immunization.performer.actor

Processing Mode Normal

Target Resources Organization, RelatedPerson, PractitionerRole, Practitioner, Patient

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/Immunization-reaction

Generated Narrative: SearchParameter Immunization-reaction

11.7.21 reaction

Parameter reaction:reference

Additional information on reaction

Resource Immunization

Expression Immunization.reaction.manifestation.reference

Processing Mode Normal

Target Resources Observation

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

Generated Narrative: SearchParameter Immunization-reaction-date

11.7.22 reaction-date

Parameter reaction-date:date

When reaction started

Resource Immunization

Expression Immunization.reaction.date

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/Immunization-reason-code

Generated Narrative: SearchParameter Immunization-reason-code

11.7.23 reason-code

Parameter reason-code:token

Reason why the vaccine was administered

Resource Immunization

Expression Immunization.reason.concept

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/Immunization-reason-reference

Generated Narrative: SearchParameter Immunization-reason-reference

11.7.24 reason-reference

Parameter reason-reference:reference

Reference to a resource (by instance)

Resource Immunization

Expression Immunization.reason.reference

Processing Mode Normal

Target Resources Observation, DiagnosticReport, Condition

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/Immunization-series

Generated Narrative: SearchParameter Immunization-series

11.7.25 series

Parameter series:string

The series being followed by the provider

Resource Immunization

Expression Immunization.protocolApplied.series

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/Immunization-status

Generated Narrative: SearchParameter Immunization-status

11.7.26 status

Parameter status:token

Immunization event status

Resource Immunization

Expression Immunization.status

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/Immunization-status-reason

Generated Narrative: SearchParameter Immunization-status-reason

11.7.27 status-reason

Parameter status-reason:token

Reason why the vaccine was not administered

Resource Immunization

Expression Immunization.statusReason

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/Immunization-target-disease

Generated Narrative: SearchParameter Immunization-target-disease

11.7.28 target-disease

Parameter target-disease:token

The target disease the dose is being administered against

Resource Immunization

Expression Immunization.protocolApplied.targetDisease

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/Immunization-vaccine-code

Generated Narrative: SearchParameter Immunization-vaccine-code

11.7.29 vaccine-code

Parameter vaccine-code:token

Vaccine Product Administered

Resource Immunization

Expression Immunization.vaccineCode

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true