Immunization Decision Support Forecast (ImmDS) Implementation Guide
1.0.0 - STU1

This page is part of the Immunization Decision Support Forecast FHIR IG (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

ImmDSParameterOutExample01 - JSON Representation

(back to description)

Raw json

Source view


{
  "resourceType" : "Parameters",
  "id" : "parameters-out-example",
  "parameter" : [
    {
      "name" : "evaluation",
      "resource" : {
        "resourceType" : "ImmunizationEvaluation",
        "id" : "immunization-evaluation-example",
        "status" : "completed",
        "patient" : {
          "reference" : "Patient/ImmDSPatientExample"
        },
        "date" : "2020-05-26",
        "targetDisease" : {
          "coding" : [
            {
              "system" : "http://snomed.info/sct",
              "code" : "66071002",
              "display" : "Hepatitis B"
            }
          ]
        },
        "immunizationEvent" : {
          "reference" : "Immunization/ImmDSImmunizationExample"
        },
        "doseStatus" : {
          "coding" : [
            {
              "system" : "http://terminology.hl7.org/CodeSystem/immunization-evaluation-dose-status",
              "code" : "valid",
              "display" : "Valid"
            }
          ]
        },
        "series" : "ACIP 3-dose HepB series",
        "doseNumberPositiveInt" : 1,
        "seriesDosesPositiveInt" : 3
      }
    },
    {
      "name" : "recommendation",
      "resource" : {
        "resourceType" : "ImmunizationRecommendation",
        "id" : "immunizationrecommendation-forecast-example",
        "patient" : {
          "reference" : "Patient/ImmDSPatientExample"
        },
        "date" : "2020-05-26",
        "recommendation" : [
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/sid/cvx",
                    "code" : "45",
                    "display" : "Hep B, unspecified formulation"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://hl7.org/fhir/us/immds/CodeSystem/ForecastStatus",
                  "code" : "notComplete",
                  "display" : "Not Complete"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2020-05-28"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2020-09-25"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2020-05-26"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2020-11-25"
              }
            ],
            "doseNumberPositiveInt" : 2
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/sid/cvx",
                    "code" : "20",
                    "display" : "DTaP"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://hl7.org/fhir/us/immds/CodeSystem/ForecastStatus",
                  "code" : "notComplete",
                  "display" : "Not Complete"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2020-06-28"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2020-07-25"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2020-06-09"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2099-06-28"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/sid/cvx",
                    "code" : "17",
                    "display" : "Hib, unspecified formulation"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://hl7.org/fhir/us/immds/CodeSystem/ForecastStatus",
                  "code" : "notComplete",
                  "display" : "Not Complete"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2020-06-28"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2020-07-25"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2020-06-09"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2099-06-28"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/sid/cvx",
                    "code" : "10",
                    "display" : "IPV"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://hl7.org/fhir/us/immds/CodeSystem/ForecastStatus",
                  "code" : "notComplete",
                  "display" : "Not Complete"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2020-06-28"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2020-07-25"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2020-06-09"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2099-06-28"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/sid/cvx",
                    "code" : "33",
                    "display" : "pneumococcal polysaccharide PPV23"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://hl7.org/fhir/us/immds/CodeSystem/ForecastStatus",
                  "code" : "notComplete",
                  "display" : "Not Complete"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2020-06-28"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2020-07-25"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2020-06-09"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2099-06-28"
              }
            ],
            "doseNumberPositiveInt" : 1
          },
          {
            "vaccineCode" : [
              {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/sid/cvx",
                    "code" : "122",
                    "display" : "rotavirus, unspecified formulation"
                  }
                ]
              }
            ],
            "forecastStatus" : {
              "coding" : [
                {
                  "system" : "http://hl7.org/fhir/us/immds/CodeSystem/ForecastStatus",
                  "code" : "notComplete",
                  "display" : "Not Complete"
                }
              ]
            },
            "dateCriterion" : [
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30980-7",
                      "display" : "Date vaccine due"
                    }
                  ]
                },
                "value" : "2020-06-28"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59778-1",
                      "display" : "Date when overdue for immunization"
                    }
                  ]
                },
                "value" : "2020-07-25"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "30981-5",
                      "display" : "Earliest date to give"
                    }
                  ]
                },
                "value" : "2020-06-09"
              },
              {
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://loinc.org",
                      "code" : "59777-3",
                      "display" : "Latest date to give immunization"
                    }
                  ]
                },
                "value" : "2099-06-28"
              }
            ],
            "doseNumberPositiveInt" : 1
          }
        ]
      }
    }
  ]
}