ImmunizationRecommendation

ResourceClinical · MedicationsTrial useMaturity 1

A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

8 of 8 parameters tested

Structure

Show inherited elements (14)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Business identifier
patientRequiredΣ	1..1	Reference(Patient)	Who this profile is for
dateRequiredΣ	1..1	dateTime	Date recommendation(s) created
authority	0..1	Reference(Organization)	Who is responsible for protocol
recommendationRequiredΣ	1..*	BackboneElement	Vaccine administration recommendations
vaccineCodeΣ	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies toBinding (example): vaccine-code
targetDiseaseΣ	0..1	CodeableConcept	Disease to be immunized againstBinding (example): immunization-recommendation-target-disease
contraindicatedVaccineCodeΣ	0..*	CodeableConcept	Vaccine which is contraindicated to fulfill the recommendationBinding (example): vaccine-code
forecastStatusRequired?!Σ	1..1	CodeableConcept	Vaccine recommendation statusBinding (example): immunization-recommendation-status
forecastReasonΣ	0..*	CodeableConcept	Vaccine administration status reasonBinding (example): immunization-recommendation-reason
dateCriterion	0..*	BackboneElement	Dates governing proposed immunization
codeRequired	1..1	CodeableConcept	Type of dateBinding (example): immunization-recommendation-date-criterion
valueRequired	1..1	dateTime	Recommended date
description	0..1	string	Protocol details
series	0..1	string	Name of vaccination series
doseNumber[x]Σ	0..1	positiveInt | string	Recommended dose number within series
seriesDoses[x]	0..1	positiveInt | string	Recommended number of doses for immunity
supportingImmunization	0..*	Reference(Immunization | ImmunizationEvaluation)	Past immunizations supporting recommendation
supportingPatientInformation	0..*	Reference(Resource)	Patient observations supporting recommendation

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/ImmunizationRecommendation?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
date	date	Date recommendation(s) created ImmunizationRecommendation.date
identifier	token	Business identifier ImmunizationRecommendation.identifier
information	reference	Patient observations supporting recommendation ImmunizationRecommendation.recommendation.supportingPatientInformation
patient	reference	Who this profile is for ImmunizationRecommendation.patient
status	token	Vaccine recommendation status ImmunizationRecommendation.recommendation.forecastStatus
support	reference	Past immunizations supporting recommendation ImmunizationRecommendation.recommendation.supportingImmunization
target-disease	token	Disease to be immunized against ImmunizationRecommendation.recommendation.targetDisease
vaccine-type	token	Vaccine or vaccine group recommendation applies to ImmunizationRecommendation.recommendation.vaccineCode

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition