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

CDS-Immunization Forecast Operation Definition - XML Format

Documentation: Operation Definition  Formats: XML, JSON, Turtle

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="cdsi-forecast-operation"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
			<h2>CDS-Immunization Forecast</h2>
			<p>OPERATION: CDS-Immunization Forecast</p>
			<div>
				<p>This is a Clinicial Decision Support Immunization Forecast Request operation. It provides a standardized request and response interfaces to Immunization Forecasters.</p>
			</div>
			<p>URL: [base]/Parameters/$cds-immunization-forecast</p>
			<p>Parameters</p>
			<table class="grid">
				<tr>
					<td>
						<b>Use</b>
					</td>
					<td>
						<b>Name</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>1..1</td>
					<td><a href="http://build.fhir.org/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>1..1</td>
					<td><a href="cdsi-patient.html">Patient</a></td>
					<td>
					</td>
					<td>
						<div>
							<p>Patient information (only gender and birthDate)</p>
						</div>
					</td>
				</tr>
				<tr>

					<td>IN</td>
					<td>immunization</td>
					<td>0..*</td>
					<td><a href="cdsi-immunization.html">Immunization</a></td>
					<td/>
					<td>
						<div>
							<p>Patient immunization history</p>
						</div>
					</td>
				</tr>
				<tr>
					<td>OUT</td>
					<td>recommendation</td>
					<td>1..1</td>
					<td><a href="cdsi-immunizationrecommendation.html">ImmunizationRecommendation</a></td>
					<td/>
					<td>
						<div>
							<p>The CDS-Immunization engine produced forecast</p>
						</div>
					</td>
				</tr>
			</table>
			<div>

			</div>
		</div>
  </text>
<!--  MDI
	<url value="http://www.nist.gov/OperationDefinition/cdsi-forecast-operation"/>
 -->
  <url
       value="http://hl7.org/fhir/uv/cdsi/OperationDefinition/cdsi-forecast-operation"/>
  <name value="CDSi Forecast"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2015-05-05T00:34:00-05:00"/>
  <publisher value="NIST"/>
  <contact>
    <name value="System Administrator"/>
    <telecom>
      <system value="email"/>
      <value value="michael.indovina@nist.gov"/>
    </telecom>
  </contact>
  <description
               value="This is a Clinicial Decision Support Immunization Forecast Request operation. It provides a standardized request and response interfaces to Immunization Forecasters."/>
  <code value="cdsi-forecast"/>
  <comment
           value="Pilot implemented in AEGIS WildFHIR FHIR test client and server - http://wildfhir.aegis.net/fhir1-8-0-gui"/>
  <resource value="Patient"/>
  <system value="false"/>
  <type value="true"/>
  <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 - gender and birthDate only"/>
    <type value="Patient"/>
    <binding>
      <strength value="required"/>
      <valueSetUri value="http://hl7.org/fhir/ValueSet/administrative-gender"/>
    </binding>
  </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="recommendation"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="immunization recommendation"/>
    <type value="ImmunizationRecommendation"/>
  </parameter>
</OperationDefinition>