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 
Immunization Decision Support Forecast
OPERATION: ImmunizationDS Forecast
This is an Immunization Decision Support Forecast Request operation. It provides standardized request and response interfaces to Immunization Forecasters.
URL: [base]/$immds-forecast
Parameters
| Use | Name | Cardinality | Type | Binding | Documentation |
| IN | assessmentDate | 1..1 | date |
The date on which to assess the forecast |
|
| IN | patient | 1..1 | Patient |
Patient information |
|
| IN | immunization | 0..* | Immunization |
Patient immunization history |
|
| OUT | evaluation | 0..* | ImmunizationEvaluation |
The evaluation against a schedule |
|
| OUT | recommendation | 1..1 | ImmunizationRecommendation |
The immunization engine produced forecast |
source file: pages/_includes/immds-forecast-operation.md
The operation is invoked using the POST Syntax with the Parameters payload as follows:
POST [base]/$immds-forecast
Example
Request the immunization forecast assessed on 2019-06-27 for a patient
POST [base]/$immds-forecast
Accept: application/fhir+json;charset=utf-8
Content-Type: application/fhir+json;charset=utf-8
[other headers]
Request Body
{
"resourceType": "Parameters",
"id": "parameters-in-example",
"parameter": [
{
"name": "assessmentDate",
"valueDate": "2019-06-27"
},
{
"name": "patient",
"resource": {
"resourceType": "Patient",
"id": "forecast-example",
"meta" : {
"profile" : [
"http://hl7.org/fhir/uv/immds/StructureDefinition/immds-patient"
]
},
"identifier" : [
{
"_system" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "masked"
}
]
},
"_value" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "masked"
}
]
}
}
],
"name" : [
{
"_family" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "masked"
}
]
},
"_given" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "masked"
}
]
}
]
}
],
"gender": "male",
"birthDate": "2019-04-28"
}
},
{
"name": "immunization",
"resource": {
"resourceType": "Immunization",
"id": "c9d3fd2e-cf34-44f8-aa68-4413a01c4153",
"meta": {
"versionId": "1",
"lastUpdated": "2019-06-27T11:55:25.382-04:00"
},
"contained": [
{
"resourceType": "Patient",
"id": "patient-forecast-data",
"meta" : {
"profile" : [
"http://hl7.org/fhir/uv/immds/StructureDefinition/immds-patient"
]
},
"identifier" : [
{
"_system" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "masked"
}
]
},
"_value" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "masked"
}
]
}
}
],
"name" : [
{
"_family" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "masked"
}
]
},
"_given" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "masked"
}
]
}
]
}
],
"gender": "male",
"birthDate": "2019-04-28"
}
],
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "08",
"display": "Hep B, adolescent or pediatric"
}
]
},
"patient": {
"reference": "#patient-forecast-data"
},
"occurrenceDateTime": "2019-04-29",
"recorded": "2019-04-29T00:00:00-04:00",
"primarySource": false
}
}
]
}
Response
HTTP/1.1 200 OK
Content-Type: application/fhir+json;charset=utf-8
[other headers]
Response Body
{
"resourceType": "Parameters",
"id": "parameters-out-example",
"parameter": [
{
"name": "recommendation",
"resource": {
"resourceType": "ImmunizationRecommendation",
"id": "69c6d273-aa68-4cd1-9a61-8b9c6506e7cc",
"meta": {
"versionId": "1",
"lastUpdated": "2019-06-27T11:55:25.772-04:00"
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Immunization Forecast Recommendation</div>"
},
"contained": [
{
"resourceType": "Patient",
"id": "patient-forecast-data",
"meta" : {
"profile" : [
"http://hl7.org/fhir/uv/immds/StructureDefinition/immds-patient"
]
},
"identifier" : [
{
"_system" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "masked"
}
]
},
"_value" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "masked"
}
]
}
}
],
"name" : [
{
"_family" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "masked"
}
]
},
"_given" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "masked"
}
]
}
]
}
],
"gender": "male",
"birthDate": "2019-04-28"
}
],
"patient": {
"reference": "#patient-forecast-data"
},
"date": "2019-06-27",
"recommendation": [
{
"vaccineCode": [
{
"coding": [
{
"system": "http://example.org/cdc/cvx/vaccine-code",
"code": "45",
"display": "HepB"
}
]
}
],
"forecastStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-recommendation-status",
"code": "due",
"display": "Due"
}
]
},
"dateCriterion": [
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "30980-7",
"display": "Date vaccine due"
}
]
},
"value": "2019-05-27T00:00:00-04:00"
},
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "59778-1",
"display": "Date when overdue for immunization"
}
]
},
"value": "2019-07-28T00:00:00-04:00"
},
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "59777-3",
"display": "Latest date to give immunization"
}
]
},
"value": "2219-04-28T00:00:00-04:00"
},
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "30981-5",
"display": "Earliest date to give"
}
]
},
"value": "2019-05-27T00:00:00-04:00"
}
],
"doseNumberPositiveInt": 2
},
{
"vaccineCode": [
{
"coding": [
{
"system": "http://example.org/cdc/cvx/vaccine-code",
"code": "20",
"display": "DTaP"
}
]
}
],
"forecastStatus": {
"coding": [
{
"system": "http://example.org/fhir/immunization-recommendation-status",
"code": "duelater",
"display": "duelater"
}
]
},
"dateCriterion": [
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "30980-7",
"display": "Date vaccine due"
}
]
},
"value": "2019-06-28T00:00:00-04:00"
},
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "59778-1",
"display": "Date when overdue for immunization"
}
]
},
"value": "2019-07-28T00:00:00-04:00"
},
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "59777-3",
"display": "Latest date to give immunization"
}
]
},
"value": "2169-04-28T00:00:00-04:00"
},
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "30981-5",
"display": "Earliest date to give"
}
]
},
"value": "2019-06-09T00:00:00-04:00"
}
],
"doseNumberPositiveInt": 1
},
[Snipped for brevity...]
]
}
}
]
}
