This page is part of the Immunization Decision Support Forecast FHIR IG (v0.2.0: STU 1 Ballot 2) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions 
JSON Format: OperationDefinition-immds-forecast-operation
Raw json
{
"resourceType" : "OperationDefinition",
"id" : "immds-forecast-operation",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<h2>Immunization Decision Support Forecast</h2>\n\t\t\t<p>OPERATION: ImmunizationDS Forecast</p>\n\t\t\t<div>\n\t\t\t\t<p>This is an Immunization Decision Support Forecast Request operation. It provides standardized request and response interfaces to Immunization Forecasters.</p>\n\t\t\t</div>\n\t\t\t<p>URL: [base]/$immds-forecast</p>\n\t\t\t<p>Parameters</p>\n\t\t\t<table class=\"grid\">\n\t\t\t\t<tr>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<b>Use</b>\n\t\t\t\t\t</td>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<b>Name</b>\n\t\t\t\t\t</td>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<b>Cardinality</b>\n\t\t\t\t\t</td>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<b>Type</b>\n\t\t\t\t\t</td>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<b>Binding</b>\n\t\t\t\t\t</td>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<b>Documentation</b>\n\t\t\t\t\t</td>\n\t\t\t\t</tr>\n\t\t\t\t<tr>\n\t\t\t\t\t<td>IN</td>\n\t\t\t\t\t<td>assessmentDate</td>\n\t\t\t\t\t<td>1..1</td>\n\t\t\t\t\t<td><a href=\"http://build.fhir.org/datatypes.html#date\">date</a></td>\n\t\t\t\t\t<td/>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<div>\n\t\t\t\t\t\t\t<p>The date on which to assess the forecast</p>\n\t\t\t\t\t\t</div>\n\t\t\t\t\t</td>\n\t\t\t\t</tr>\n\t\t\t\t<tr>\n\n\n\t\t\t\t\t<td>IN</td>\n\t\t\t\t\t<td>patient</td>\n\t\t\t\t\t<td>1..1</td>\n\t\t\t\t\t<td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></td>\n\t\t\t\t\t<td>\n\t\t\t\t\t</td>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<div>\n\t\t\t\t\t\t\t<p>Patient information</p>\n\t\t\t\t\t\t</div>\n\t\t\t\t\t</td>\n\t\t\t\t</tr>\n\t\t\t\t<tr>\n\n\t\t\t\t\t<td>IN</td>\n\t\t\t\t\t<td>immunization</td>\n\t\t\t\t\t<td>0..*</td>\n\t\t\t\t\t<td><a href=\"http://hl7.org/fhir/us/core/StructureDefinition-us-core-immunization.html\">Immunization</a></td>\n\t\t\t\t\t<td/>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<div>\n\t\t\t\t\t\t\t<p>Patient immunization history</p>\n\t\t\t\t\t\t</div>\n\t\t\t\t\t</td>\n\t\t\t\t</tr>\n\t\t\t\t<tr>\n\t\t\t\t\t<td>OUT</td>\n\t\t\t\t\t<td>evaluation</td>\n\t\t\t\t\t<td>0..*</td>\n\t\t\t\t\t<td><a href=\"http://hl7.org/fhir/R4/immunizationevaluation.html\">ImmunizationEvaluation</a></td>\n\t\t\t\t\t<td/>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<div>\n\t\t\t\t\t\t\t<p>The evaluation against a schedule</p>\n\t\t\t\t\t\t</div>\n\t\t\t\t\t</td>\n\t\t\t\t</tr>\n\t\t\t\t<tr>\n\t\t\t\t\t<td>OUT</td>\n\t\t\t\t\t<td>recommendation</td>\n\t\t\t\t\t<td>1..1</td>\n\t\t\t\t\t<td><a href=\"http://hl7.org/fhir/R4/immunization.html\">ImmunizationRecommendation</a></td>\n\t\t\t\t\t<td/>\n\t\t\t\t\t<td>\n\t\t\t\t\t\t<div>\n\t\t\t\t\t\t\t<p>The immunization engine produced forecast</p>\n\t\t\t\t\t\t</div>\n\t\t\t\t\t</td>\n\t\t\t\t</tr>\n\t\t\t</table>\n\t\t\t<div>\n\n\t\t\t</div>\n\t\t</div>"
},
"url" : "http://hl7.org/fhir/uv/immds/OperationDefinition/immds-forecast-operation",
"version" : "0.2.0",
"name" : "ImmDSForecast",
"status" : "draft",
"kind" : "operation",
"date" : "2019-06-26T14:47:00-04:00",
"publisher" : "HL7 International - Medications / Immunizations",
"description" : "This is an Immunization Decision Support Forecast Request operation. It provides standardized request and response interfaces to Immunization Forecasters.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"affectsState" : false,
"code" : "immds-forecast",
"comment" : "Pilot implemented in AEGIS WildFHIR FHIR test client and server - http://wildfhir.aegis.net/fhir4-0-0-gui",
"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 immunization engine produced forecast",
"type" : "ImmunizationRecommendation"
}
]
}
