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 xml | Download

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="ImmDSForecastOperation"/>
  <language value="en"/>
  <text>
    <status value="generated"/>
    <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>
</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>
</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>
</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>
</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>
</div></td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="pher"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="3">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/us/immds/ImplementationGuide/hl7.fhir.us.immds"/>
      </extension>
    </valueInteger>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/us/immds/ImplementationGuide/hl7.fhir.us.immds"/>
      </extension>
    </valueCode>
  </extension>
  <url
       value="http://hl7.org/fhir/us/immds/OperationDefinition/ImmDSForecastOperation"/>
  <version value="2.0.0"/>
  <name value="ImmDSForecast"/>
  <title value="Immunization Decision Support Forecast"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2025-11-20T20:43:18+00:00"/>
  <publisher value="HL7 International / Public Health"/>
  <contact>
    <name value="HL7 International / Public Health"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/pher"/>
    </telecom>
  </contact>
  <contact>
    <name value="Nathan Bunker"/>
    <telecom>
      <system value="email"/>
      <value value="mailto:nbunker@immregistry.org"/>
    </telecom>
  </contact>
  <description
               value="The Immunization Decision Support Forecast Request operation to provide standardized request and response interfaces to Immunization Forecasters."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <code value="immds-forecast"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="assessmentDate"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The date on which to assess the forecast."/>
    <type value="date"/>
  </parameter>
  <parameter>
    <name value="patient"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Patient information."/>
    <type value="Patient"/>
  </parameter>
  <parameter>
    <name value="immunization"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation value="Patient immunization history."/>
    <type value="Immunization"/>
  </parameter>
  <parameter>
    <name value="evaluation"/>
    <use value="out"/>
    <min value="0"/>
    <max value="*"/>
    <documentation value="The evaluation against a schedule."/>
    <type value="ImmunizationEvaluation"/>
  </parameter>
  <parameter>
    <name value="recommendation"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The decision support engine produced forecast."/>
    <type value="ImmunizationRecommendation"/>
  </parameter>
</OperationDefinition>