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

CDSi Forecast Operation Definition - JSON Format

Documentation: Operation Definition  Formats: XML, JSON, Turtle

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