ImmunizationRecommendation - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
identifiertrueIdentifier Business identifier
patientfalseReference Who this profile is for
recommendationtrueData Type Vaccine administration recommendations

ImmunizationRecommendation Example

{
  "patient": {
    "reference": "Patient/example"
  },
  "resourceType": "ImmunizationRecommendation",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Authored by Joginder Madra</div>"
  },
  "recommendation": [
    {
      "protocol": {
        "doseSequence": 1,
        "series": "Vaccination Series 1",
        "description": "First sequence in protocol",
        "authority": {
          "reference": "Organization/hl7"
        }
      },
      "forecastStatus": {
        "text": "Not Complete"
      },
      "dateCriterion": [
        {
          "code": {
            "coding": [
              {
                "code": "earliest",
                "system": "http://hl7.org/fhir/immunization-recommendation-date-criterion",
                "display": "Earliest Date"
              }
            ]
          },
          "value": "2015-12-01T00:00:00-05:00"
        },
        {
          "code": {
            "coding": [
              {
                "code": "recommended",
                "system": "http://hl7.org/fhir/immunization-recommendation-date-criterion",
                "display": "Recommended"
              }
            ]
          },
          "value": "2015-12-01T00:00:00-05:00"
        },
        {
          "code": {
            "coding": [
              {
                "code": "overdue",
                "system": "http://hl7.org/fhir/immunization-recommendation-date-criterion",
                "display": "Past Due Date"
              }
            ]
          },
          "value": "2016-12-28T00:00:00-05:00"
        }
      ],
      "vaccineCode": {
        "coding": [
          {
            "code": "14745005",
            "system": "http://snomed.info/sct",
            "display": "Hepatitis A vaccine"
          }
        ]
      },
      "supportingPatientInformation": [
        {
          "reference": "Observation/example"
        }
      ],
      "date": "2015-02-09T11:04:15.817-05:00",
      "doseNumber": 1,
      "supportingImmunization": [
        {
          "reference": "Immunization/example"
        }
      ]
    }
  ],
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1235"
    }
  ],
  "id": "example"
}

ImmunizationRecommendation Structure


  
{
  "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 }, // Vaccine recommendation applies to
    "targetDisease" : { CodeableConcept }, // Disease to be immunized against
    "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" : "<positiveInt>", // 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
  }]
}


 

ImmunizationRecommendation Search Parameters

The following search parameters can be used to query ImmunizationRecommendation resources. Just submit the like so:

https://api.1up.health/fhir/stu3/ImmunizationRecommendation?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
datedaterecommendation.date
dose-numbernumberrecommendation.doseNumber
dose-sequencenumberrecommendation.protocol.doseSequence
identifiertextidentifier
informationreferencerecommendation.supportingPatientInformation
patientreferencepatient
statustextrecommendation.forecastStatus
supportreferencerecommendation.supportingImmunization
target-diseasetextrecommendation.targetDisease
vaccine-typetextrecommendation.vaccineCode