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
Extension: Vaccine Recommendation Category
| Official URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/vaccine-recommendation-category-ext | Version: 0.1.0 | |||
| Draft as of 2026-09-07 | Computable Name: VaccineRecommendationCategory | |||
CDC's vaccine recommendation category for one Best Patient Series in this forecast: Routine, High-Risk, or SCDM (shared clinical decision making), determined per CDC's Vaccine Recommendation Category Determination (CDSi supporting data 4.65) once the forecast is known, for a series whose status is Not Complete. Carries the series name, the category, and CDC's material for it. One extension per contributing series that has a category.
Context of Use
-
Element ID:
ImmunizationRecommendation.recommendation
This extension may be used on the following element(s)
Usage info
Usages:
- Examples for this Extension: ImmunizationRecommendation/cicada-forecast-example
You can also check for usages in the FHIR IG Statistics
Formal Views of Extension Content
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Vaccine Recommendation Category | |
  extension |
2..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:series |
1..1 | Extension | The Best Patient Series the category is for | |
  extension |
0..0 | Extension | ||
| url |
1..1 | uri | "series" | |
  value[x] |
0..1 | string | Value of extension | |
| extension:category |
1..1 | Extension | Routine, High-Risk, or SCDM | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "category" | |
 value[x] |
0..1 | CodeableConcept | Value of extension Binding: Vaccine Recommendation Category Value Set (required) | |
 extension:material |
0..* | Extension | CDC's additional material for this recommendation | |
 extension |
0..0 | Extension | ||
| url |
1..1 | uri | "material" | |
| value[x] |
0..1 | url | Value of extension | |
| url |
1..1 | uri | "http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/vaccine-recommendation-category-ext" | |
 value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Vaccine Recommendation Category | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:series |
1..1 | Extension | The Best Patient Series the category is for | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "series" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:category |
1..1 | Extension | Routine, High-Risk, or SCDM | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "category" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: Vaccine Recommendation Category Value Set (required) | |
| extension:material |
0..* | Extension | CDC's additional material for this recommendation | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "material" | |
| value[x] |
0..1 | url | Value of extension | |
| url |
1..1 | uri | "http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/vaccine-recommendation-category-ext" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: CDC's vaccine recommendation category for one Best Patient Series in this forecast: Routine, High-Risk, or SCDM (shared clinical decision making), determined per CDC's Vaccine Recommendation Category Determination (CDSi supporting data 4.65) once the forecast is known, for a series whose status is Not Complete. Carries the series name, the category, and CDC's material for it. One extension per contributing series that has a category.
- series: string: An Extension
- category: CodeableConcept: An Extension
- material: url: An Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Vaccine Recommendation Category | |
| extension |
2..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:series |
1..1 | Extension | The Best Patient Series the category is for | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "series" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:category |
1..1 | Extension | Routine, High-Risk, or SCDM | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "category" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: Vaccine Recommendation Category Value Set (required) | |
| extension:material |
0..* | Extension | CDC's additional material for this recommendation | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "material" | |
| value[x] |
0..1 | url | Value of extension | |
| url |
1..1 | uri | "http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/vaccine-recommendation-category-ext" | |
| value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Vaccine Recommendation Category | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:series |
1..1 | Extension | The Best Patient Series the category is for | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "series" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:category |
1..1 | Extension | Routine, High-Risk, or SCDM | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "category" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: Vaccine Recommendation Category Value Set (required) | |
| extension:material |
0..* | Extension | CDC's additional material for this recommendation | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "material" | |
| value[x] |
0..1 | url | Value of extension | |
| url |
1..1 | uri | "http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/vaccine-recommendation-category-ext" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: CDC's vaccine recommendation category for one Best Patient Series in this forecast: Routine, High-Risk, or SCDM (shared clinical decision making), determined per CDC's Vaccine Recommendation Category Determination (CDSi supporting data 4.65) once the forecast is known, for a series whose status is Not Complete. Carries the series name, the category, and CDC's material for it. One extension per contributing series that has a category.
- series: string: An Extension
- category: CodeableConcept: An Extension
- material: url: An Extension
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:category.value[x] | Base | required | Vaccine Recommendation Category Value Set | 📦0.1.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|