Release 5 R6 Ballot (1st Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . 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 Group Maturity Level : N/A   Trial Use Security 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

Resource Immunization
Expression (Immunization.occurrence.ofType(dateTime))
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.16 identifier

Parameter identifier : token

Immunization : Business identifier

Resource Immunization
Expression Immunization.identifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.17 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.18 lot-number

Parameter lot-number : string

Vaccine Lot Number

Resource Immunization
Expression Immunization.lotNumber
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.19 manufacturer

Parameter manufacturer : reference

Vaccine Manufacturer

Resource Immunization
Expression Immunization.manufacturer.reference
Processing Mode Normal
Target Resources Organization
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.20 patient

Parameter patient : reference

Immunization : The patient for the vaccination record

Resource Immunization
Expression Immunization.patient
Processing Mode Normal
Target Resources Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.21 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.22 reaction

Parameter reaction : reference

Additional information on reaction

Resource Immunization
Expression Immunization.reaction.manifestation.reference
Processing Mode Normal
Target Resources Observation
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.23 reaction-date

Parameter reaction-date : date

When reaction started

Resource Immunization
Expression Immunization.reaction.date
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.24 reason-code

Parameter reason-code : token

Reason why the vaccine was administered

Resource Immunization
Expression Immunization.reason.concept
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.25 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.26 series

Parameter series : string

The series being followed by the provider

Resource Immunization
Expression Immunization.protocolApplied.series
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.27 status

Parameter status : token

Immunization event status

Resource Immunization
Expression Immunization.status
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.28 status-reason

Parameter status-reason : token

Reason why the vaccine was not administered

Resource Immunization
Expression Immunization.statusReason
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.29 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

11.7.30 vaccine-code

Parameter vaccine-code : token

Vaccine Product Administered

Resource Immunization
Expression Immunization.vaccineCode
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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