Skip to main content

ImmunizationRecommendation

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

InteractionMethodPath
ReadGET/fhir/R4/ImmunizationRecommendation/[id]
VreadGET/fhir/R4/ImmunizationRecommendation/[id]/_history/[vid]
UpdatePUT/fhir/R4/ImmunizationRecommendation/[id]
PatchPATCH/fhir/R4/ImmunizationRecommendation/[id]
DeleteDELETE/fhir/R4/ImmunizationRecommendation/[id]
CreatePOST/fhir/R4/ImmunizationRecommendation
SearchGET/fhir/R4/ImmunizationRecommendation
HistoryGET/fhir/R4/ImmunizationRecommendation/[id]/_history

Top-level elements​

ElementTypeCardinalityDescription
idstring0..1Logical id of this artifact
metaMeta0..1Metadata about the resource
implicitRulesuri0..1A set of rules under which this content was created
languagecode0..1Language of the resource content
textNarrative0..1Text summary of the resource, for human interpretation
containedResource0..*Contained, inline Resources
extensionExtension0..*Additional content defined by implementations
modifierExtensionExtension0..*Extensions that cannot be ignored
identifierIdentifier0..*Business identifier
patientReference1..1Who this profile is for
datedateTime1..1Date recommendation(s) created
authorityReference0..1Who is responsible for protocol
recommendationBackboneElement1..*Vaccine administration recommendations

Resource-specific search parameters​

ParameterTypeDescription
datedateDate recommendation(s) created
identifiertokenBusiness identifier
informationreferencePatient observations supporting recommendation
patientreferenceWho this profile is for
statustokenVaccine recommendation status
supportreferencePast immunizations supporting recommendation
target-diseasetokenDisease to be immunized against
vaccine-typetokenVaccine or vaccine group recommendation applies to

Reference​

Official FHIR R4 spec: ImmunizationRecommendation.
Maturity: Trial Use 1 (FMM 1).