"identifier":
"patient":
"recommendation":
{
"resourceType" : "ImmunizationRecommendation",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier
"patient" : { Reference(Patient) }, // R! Who this profile is for
"recommendation" : [{ // R! Vaccine administration recommendations
"date" : "<dateTime>", // R! Date recommendation created
"vaccineCode" : { CodeableConcept }, // R! Vaccine recommendation applies to
"doseNumber" : "<positiveInt>", // Recommended dose number
"forecastStatus" : { CodeableConcept }, // R! Vaccine administration status
"dateCriterion" : [{ // Dates governing proposed immunization
"code" : { CodeableConcept }, // R! Type of date
"value" : "<dateTime>" // R! Recommended date
}],
"protocol" : { // Protocol used by recommendation
"doseSequence" : <integer>, // Dose number within sequence
"description" : "<string>", // Protocol details
"authority" : { Reference(Organization) }, // Who is responsible for protocol
"series" : "<string>" // Name of vaccination series
},
"supportingImmunization" : [{ Reference(Immunization) }], // Past immunizations supporting recommendation
"supportingPatientInformation" : [{ Reference(Observation|
AllergyIntolerance) }] // Patient observations supporting recommendation
}]
}
The following search parameters can be used to query ImmunizationRecommendation resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/ImmunizationRecommendation?query-param=queryvalue
Search Parameter | Field Type | Resource Fields Searched |
---|---|---|
date | date | recommendation.date |
dose-number | number | recommendation.doseNumber |
dose-sequence | number | recommendation.protocol.doseSequence |
identifier | text | identifier |
information | reference | recommendation.supportingPatientInformation |
patient | reference | patient |
status | text | recommendation.forecastStatus |
support | reference | recommendation.supportingImmunization |
vaccine-type | text | recommendation.vaccineCode |