Immunization Decision Support Forecast (ImmDS) Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ImmunizationFHIRDS/ and changes regularly. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Immunization Decision Support Forecast

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "ImmDSForecastOperation",
  "language" : "en",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition ImmDSForecastOperation</b></p><a name=\"ImmDSForecastOperation\"> </a><a name=\"hcImmDSForecastOperation\"> </a><p>URL: [base]/$immds-forecast</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>assessmentDate</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>The date on which to assess the forecast.</p>\n</div></td></tr><tr><td>IN</td><td>patient</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></td><td/><td><div><p>Patient information.</p>\n</div></td></tr><tr><td>IN</td><td>immunization</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/immunization.html\">Immunization</a></td><td/><td><div><p>Patient immunization history.</p>\n</div></td></tr><tr><td>OUT</td><td>evaluation</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/immunizationevaluation.html\">ImmunizationEvaluation</a></td><td/><td><div><p>The evaluation against a schedule.</p>\n</div></td></tr><tr><td>OUT</td><td>recommendation</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/immunizationrecommendation.html\">ImmunizationRecommendation</a></td><td/><td><div><p>The decision support engine produced forecast.</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "pher"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 3,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/immds/ImplementationGuide/hl7.fhir.us.immds"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/immds/ImplementationGuide/hl7.fhir.us.immds"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/us/immds/OperationDefinition/ImmDSForecastOperation",
  "version" : "2.0.0",
  "name" : "ImmDSForecast",
  "title" : "Immunization Decision Support Forecast",
  "status" : "active",
  "kind" : "operation",
  "date" : "2025-11-20T20:43:18+00:00",
  "publisher" : "HL7 International / Public Health",
  "contact" : [
    {
      "name" : "HL7 International / Public Health",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/pher"
        }
      ]
    },
    {
      "name" : "Nathan Bunker",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:nbunker@immregistry.org"
        }
      ]
    }
  ],
  "description" : "The Immunization Decision Support Forecast Request operation to provide standardized request and response interfaces to Immunization Forecasters.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "code" : "immds-forecast",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "assessmentDate",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The date on which to assess the forecast.",
      "type" : "date"
    },
    {
      "name" : "patient",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Patient information.",
      "type" : "Patient"
    },
    {
      "name" : "immunization",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Patient immunization history.",
      "type" : "Immunization"
    },
    {
      "name" : "evaluation",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "The evaluation against a schedule.",
      "type" : "ImmunizationEvaluation"
    },
    {
      "name" : "recommendation",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The decision support engine produced forecast.",
      "type" : "ImmunizationRecommendation"
    }
  ]
}