The Cicada Vaccine Forecasting Engine and Guide
0.1.0 - ci-build
The Cicada Vaccine Forecasting Engine and Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2026-09-02 |
{
"resourceType" : "CodeSystem",
"id" : "forecast-reason",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem forecast-reason</b></p><a name=\"forecast-reason\"> </a><a name=\"hcforecast-reason\"> </a><p>This case-sensitive code system <code>http://fhirfli.dev/fhir/ig/cicada/CodeSystem/forecast-reason</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">series-complete<a name=\"forecast-reason-series-complete\"> </a></td><td>Patient series is complete</td><td>Every target dose in the series is satisfied. Maps to ImmDS #complete.</td></tr><tr><td style=\"white-space:nowrap\">not-recommended-history<a name=\"forecast-reason-not-recommended-history\"> </a></td><td>Not recommended at this time due to past immunization history</td><td>Maps to ImmDS #notRecommended.</td></tr><tr><td style=\"white-space:nowrap\">exceeded-maximum-age<a name=\"forecast-reason-exceeded-maximum-age\"> </a></td><td>Patient has exceeded the maximum age</td><td>Maps to ImmDS #maximumAge.</td></tr><tr><td style=\"white-space:nowrap\">past-seasonal-end<a name=\"forecast-reason-past-seasonal-end\"> </a></td><td>Past seasonal recommendation end date</td><td>Maps to ImmDS #seasonalPast.</td></tr><tr><td style=\"white-space:nowrap\">complete-for-the-season<a name=\"forecast-reason-complete-for-the-season\"> </a></td><td>Patient is complete for the season</td><td>The series is complete for the current season and a further dose falls in a later one. Maps to ImmDS #seasonalComplete. A deliberate deviation from CDSi, which has no such reason: ACIP defines influenza and RSV recommendations by season, and without this a patient who has had this year's dose is indistinguishable from one who never needs another.</td></tr><tr><td style=\"white-space:nowrap\">evidence-of-immunity<a name=\"forecast-reason-evidence-of-immunity\"> </a></td><td>Patient has evidence of immunity</td><td>No ImmDS concept.</td></tr><tr><td style=\"white-space:nowrap\">contraindication<a name=\"forecast-reason-contraindication\"> </a></td><td>Patient has a contraindication</td><td>No ImmDS concept.</td></tr><tr><td style=\"white-space:nowrap\">cannot-finish-before-maximum-age<a name=\"forecast-reason-cannot-finish-before-maximum-age\"> </a></td><td>Patient is unable to finish the series prior to the maximum age</td><td>No ImmDS concept.</td></tr><tr><td style=\"white-space:nowrap\">below-minimum-age-to-start<a name=\"forecast-reason-below-minimum-age-to-start\"> </a></td><td>Patient has not reached the minimum age to start</td><td>No ImmDS concept.</td></tr><tr><td style=\"white-space:nowrap\">shared-clinical-decision-making<a name=\"forecast-reason-shared-clinical-decision-making\"> </a></td><td>Recommended by shared clinical decision-making</td><td>ACIP recommends this series by shared clinical decision-making rather than routinely, so it is not a care gap. Read from CDC's own marking in the series name, and for HPV from the 27-45 year band CDC states in its guidance. No CDSi or ImmDS concept; ICE calls it CLINICAL_PATIENT_DISCRETION.</td></tr></table></div>"
},
"url" : "http://fhirfli.dev/fhir/ig/cicada/CodeSystem/forecast-reason",
"version" : "0.1.0",
"name" : "CicadaForecastReasonCS",
"title" : "Cicada Forecast Reason Code System",
"status" : "draft",
"date" : "2026-09-02T22:18:14-04:00",
"publisher" : "FHIR-FLI",
"contact" : [
{
"name" : "FHIR-FLI",
"telecom" : [
{
"system" : "url",
"value" : "http://fhirfli.dev"
}
]
}
],
"description" : "Why the engine forecast what it did. The ImmDS ForecastReason code system covers four of these; the rest have no ImmDS concept, and the ImmDS binding on ImmunizationRecommendation.recommendation.forecastReason is example strength, so they travel as a second coding rather than being dropped.",
"caseSensitive" : true,
"content" : "complete",
"count" : 10,
"concept" : [
{
"code" : "series-complete",
"display" : "Patient series is complete",
"definition" : "Every target dose in the series is satisfied. Maps to ImmDS #complete."
},
{
"code" : "not-recommended-history",
"display" : "Not recommended at this time due to past immunization history",
"definition" : "Maps to ImmDS #notRecommended."
},
{
"code" : "exceeded-maximum-age",
"display" : "Patient has exceeded the maximum age",
"definition" : "Maps to ImmDS #maximumAge."
},
{
"code" : "past-seasonal-end",
"display" : "Past seasonal recommendation end date",
"definition" : "Maps to ImmDS #seasonalPast."
},
{
"code" : "complete-for-the-season",
"display" : "Patient is complete for the season",
"definition" : "The series is complete for the current season and a further dose falls in a later one. Maps to ImmDS #seasonalComplete. A deliberate deviation from CDSi, which has no such reason: ACIP defines influenza and RSV recommendations by season, and without this a patient who has had this year's dose is indistinguishable from one who never needs another."
},
{
"code" : "evidence-of-immunity",
"display" : "Patient has evidence of immunity",
"definition" : "No ImmDS concept."
},
{
"code" : "contraindication",
"display" : "Patient has a contraindication",
"definition" : "No ImmDS concept."
},
{
"code" : "cannot-finish-before-maximum-age",
"display" : "Patient is unable to finish the series prior to the maximum age",
"definition" : "No ImmDS concept."
},
{
"code" : "below-minimum-age-to-start",
"display" : "Patient has not reached the minimum age to start",
"definition" : "No ImmDS concept."
},
{
"code" : "shared-clinical-decision-making",
"display" : "Recommended by shared clinical decision-making",
"definition" : "ACIP recommends this series by shared clinical decision-making rather than routinely, so it is not a care gap. Read from CDC's own marking in the series name, and for HPV from the 27-45 year band CDC states in its guidance. No CDSi or ImmDS concept; ICE calls it CLINICAL_PATIENT_DISCRETION."
}
]
}