Immunization Decision Support Forecast Implementation Guide STU1 (Release 0.2.0 Ballot 2)

This page is part of the Immunization Decision Support Forecast FHIR IG (v0.2.0: STU 1 Ballot 2) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

JSON Format: Parameters-parameters-out-example

Raw json

{
  "resourceType" : "Parameters",
  "id" : "parameters-out-example",
  "parameter" : [
    {
      "name" : "recommendation",
      "resource" : {
        "resourceType" : "ImmunizationRecommendation",
        "id" : "69c6d273-aa68-4cd1-9a61-8b9c6506e7cc",
        "meta" : {
          "versionId" : "1",
          "lastUpdated" : "2019-06-27T11:55:25.772-04:00",
          "profile" : [
            "http://hl7.org/fhir/uv/immds/StructureDefinition/immds-immunizationrecommendation"
          ]
        },
        "text" : {
          "status" : "generated",
          "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">Immunization Forecast Recommendation</div>"
        },
        "contained" : [
          {
            "resourceType" : "Patient",
            "id" : "patient-forecast-data",
            "meta" : {
              "profile" : [
                "http://hl7.org/fhir/uv/immds/StructureDefinition/immds-patient"
              ]
            },
            "identifier" : [
              {
                "_system" : {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                      "valueCode" : "masked"
                    }
                  ]
                },
                "_value" : {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                      "valueCode" : "masked"
                    }
                  ]
                }
              }
            ],
            "name" : [
              {
                "_family" : {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                      "valueCode" : "masked"
                    }
                  ]
                },
                "_given" : [
                  {
                    "extension" : [
                      {
                        "url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                        "valueCode" : "masked"
                      }
                    ]
                  }
                ]
              }
            ],
            "gender" : "male",
            "birthDate" : "2019-04-28"
          }
        ],
        "patient" : {
          "reference" : "#patient-forecast-data"
        },
        "date" : "2019-06-27",
        "recommendation" : [
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://example.org/cdc/cvx/vaccine-code",
                    "code" : "45",
                    "display" : "HepB"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://terminology.hl7.org/CodeSystem/immunization-recommendation-status",
                  "code" : "due",
                  "display" : "Due"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2019-05-27T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2019-07-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2099-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2019-05-27T00:00:00-04:00"
              }
            ],
            "doseNumberPositiveInt" : 2
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://example.org/cdc/cvx/vaccine-code",
                    "code" : "20",
                    "display" : "DTaP"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://example.org/fhir/immunization-recommendation-status",
                  "code" : "duelater",
                  "display" : "Due Later"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2019-06-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2019-07-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2099-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2019-06-09T00:00:00-04:00"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://example.org/cdc/cvx/vaccine-code",
                    "code" : "20",
                    "display" : "DTaP, Tdap or Td"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://example.org/fhir/immunization-recommendation-status",
                  "code" : "duelater",
                  "display" : "Due Later"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2019-06-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2019-07-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2099-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2019-06-09T00:00:00-04:00"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://example.org/cdc/cvx/vaccine-code",
                    "code" : "17",
                    "display" : "Hib"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://example.org/fhir/immunization-recommendation-status",
                  "code" : "duelater",
                  "display" : "Due Later"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2019-06-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2019-07-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2024-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2019-06-09T00:00:00-04:00"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://example.org/cdc/cvx/vaccine-code",
                    "code" : "152",
                    "display" : "Pneumococcal"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://example.org/fhir/immunization-recommendation-status",
                  "code" : "duelater",
                  "display" : "Due Later"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2019-06-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2019-07-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2024-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2019-06-09T00:00:00-04:00"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://example.org/cdc/cvx/vaccine-code",
                    "code" : "152",
                    "display" : "PCV"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://example.org/fhir/immunization-recommendation-status",
                  "code" : "duelater",
                  "display" : "Due Later"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2019-06-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2019-07-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2024-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2019-06-09T00:00:00-04:00"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://example.org/cdc/cvx/vaccine-code",
                    "code" : "89",
                    "display" : "Polio"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://example.org/fhir/immunization-recommendation-status",
                  "code" : "duelater",
                  "display" : "Due Later"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2019-06-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2019-07-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2037-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2019-06-09T00:00:00-04:00"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://example.org/cdc/cvx/vaccine-code",
                    "code" : "122",
                    "display" : "Rotavirus"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://example.org/fhir/immunization-recommendation-status",
                  "code" : "duelater",
                  "display" : "Due Later"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2019-06-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2019-07-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2019-08-11T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2019-06-09T00:00:00-04:00"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://example.org/cdc/cvx/vaccine-code",
                    "code" : "03",
                    "display" : "MMR"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://example.org/fhir/immunization-recommendation-status",
                  "code" : "duelater",
                  "display" : "Due Later"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2020-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2020-08-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2069-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2020-04-28T00:00:00-04:00"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://example.org/cdc/cvx/vaccine-code",
                    "code" : "21",
                    "display" : "Varicella"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://example.org/fhir/immunization-recommendation-status",
                  "code" : "duelater",
                  "display" : "Due Later"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2020-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2020-08-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2038-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2020-04-28T00:00:00-04:00"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://example.org/cdc/cvx/vaccine-code",
                    "code" : "108",
                    "display" : "Meningococcal"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://example.org/fhir/immunization-recommendation-status",
                  "code" : "duelater",
                  "display" : "Due Later"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2030-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2032-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2041-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2019-06-23T00:00:00-04:00"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://example.org/cdc/cvx/vaccine-code",
                    "code" : "85",
                    "display" : "HepA"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://example.org/fhir/immunization-recommendation-status",
                  "code" : "duelater",
                  "display" : "Due Later"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2020-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2021-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2099-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2020-04-28T00:00:00-04:00"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://example.org/cdc/cvx/vaccine-code",
                    "code" : "88",
                    "display" : "Influenza"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://example.org/fhir/immunization-recommendation-status",
                  "code" : "duelater",
                  "display" : "Due Later"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2019-10-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2019-10-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2099-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2019-10-28T00:00:00-04:00"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://example.org/cdc/cvx/vaccine-code",
                    "code" : "137",
                    "display" : "HPV"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://example.org/fhir/immunization-recommendation-status",
                  "code" : "duelater",
                  "display" : "Due Later"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2030-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2032-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2041-04-28T00:00:00-04:00"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2028-04-28T00:00:00-04:00"
              }
            ],
            "doseNumberPositiveInt" : 1
          }
        ]
      }
    }
  ]
}