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: Contributing Series Detail
| Official URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/series-detail-ext | Version: 0.1.0 | |||
| Draft as of 2026-09-02 | Computable Name: SeriesDetail | |||
One contributing series: its own status, its own four dates, and the component dates that produced them. A vaccine group forecast reports the aggregate over several series, so without this a group covered by more than one reports a single answer for all of them, and a due date arrives with no way to see whether age or interval produced it. Repeats, one per series.
Context of Use
-
Element ID:
ImmunizationRecommendation.recommendation
This extension may be used on the following element(s)
Usage info
Usages:
- This Extension is not used by any profiles in this Implementation Guide
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 | Contributing Series Detail | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:seriesName |
0..1 | Extension | Extension | |
   extension |
0..0 | Extension | ||
| url |
1..1 | uri | "seriesName" | |
  value[x] |
0..1 | string | Value of extension | |
| extension:seriesGroupName |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "seriesGroupName" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:seriesType |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "seriesType" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:status |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "status" | |
 value[x] |
0..1 | CodeableConcept | Value of extension | |
| extension:targetDoseNumber |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "targetDoseNumber" | |
| value[x] |
0..1 | positiveInt | Value of extension | |
| extension:earliestDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "earliestDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:recommendedDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "recommendedDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:pastDueDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "pastDueDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:latestDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "latestDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:minimumAgeDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "minimumAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:maximumAgeDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "maximumAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:earliestRecommendedAgeDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "earliestRecommendedAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:latestRecommendedAgeDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "latestRecommendedAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:earliestRecommendedIntervalDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "earliestRecommendedIntervalDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:latestRecommendedIntervalDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "latestRecommendedIntervalDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
 extension:seasonalRecommendationStartDate |
0..1 | Extension | Extension | |
 extension |
0..0 | Extension | ||
| url |
1..1 | uri | "seasonalRecommendationStartDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
 url |
1..1 | uri | "http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/series-detail-ext" | |
 value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Contributing Series Detail | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:seriesName |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "seriesName" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:seriesGroupName |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "seriesGroupName" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:seriesType |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "seriesType" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:status |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "status" | |
| value[x] |
0..1 | CodeableConcept | Value of extension | |
| extension:targetDoseNumber |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "targetDoseNumber" | |
| value[x] |
0..1 | positiveInt | Value of extension | |
| extension:earliestDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "earliestDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:recommendedDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "recommendedDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:pastDueDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "pastDueDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:latestDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "latestDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:minimumAgeDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "minimumAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:maximumAgeDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "maximumAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:earliestRecommendedAgeDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "earliestRecommendedAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:latestRecommendedAgeDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "latestRecommendedAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:earliestRecommendedIntervalDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "earliestRecommendedIntervalDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:latestRecommendedIntervalDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "latestRecommendedIntervalDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:seasonalRecommendationStartDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "seasonalRecommendationStartDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| url |
1..1 | uri | "http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/series-detail-ext" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: One contributing series: its own status, its own four dates, and the component dates that produced them. A vaccine group forecast reports the aggregate over several series, so without this a group covered by more than one reports a single answer for all of them, and a due date arrives with no way to see whether age or interval produced it. Repeats, one per series.
- seriesName: string: An Extension
- seriesGroupName: string: An Extension
- seriesType: string: An Extension
- status: CodeableConcept: An Extension
- targetDoseNumber: positiveInt: An Extension
- earliestDate: dateTime: An Extension
- recommendedDate: dateTime: An Extension
- pastDueDate: dateTime: An Extension
- latestDate: dateTime: An Extension
- minimumAgeDate: dateTime: An Extension
- maximumAgeDate: dateTime: An Extension
- earliestRecommendedAgeDate: dateTime: An Extension
- latestRecommendedAgeDate: dateTime: An Extension
- earliestRecommendedIntervalDate: dateTime: An Extension
- latestRecommendedIntervalDate: dateTime: An Extension
- seasonalRecommendationStartDate: dateTime: An Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Contributing Series Detail | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:seriesName |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "seriesName" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:seriesGroupName |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "seriesGroupName" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:seriesType |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "seriesType" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:status |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "status" | |
| value[x] |
0..1 | CodeableConcept | Value of extension | |
| extension:targetDoseNumber |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "targetDoseNumber" | |
| value[x] |
0..1 | positiveInt | Value of extension | |
| extension:earliestDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "earliestDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:recommendedDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "recommendedDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:pastDueDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "pastDueDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:latestDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "latestDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:minimumAgeDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "minimumAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:maximumAgeDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "maximumAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:earliestRecommendedAgeDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "earliestRecommendedAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:latestRecommendedAgeDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "latestRecommendedAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:earliestRecommendedIntervalDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "earliestRecommendedIntervalDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:latestRecommendedIntervalDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "latestRecommendedIntervalDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:seasonalRecommendationStartDate |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "seasonalRecommendationStartDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| url |
1..1 | uri | "http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/series-detail-ext" | |
| value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Contributing Series Detail | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:seriesName |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "seriesName" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:seriesGroupName |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "seriesGroupName" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:seriesType |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "seriesType" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:status |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "status" | |
| value[x] |
0..1 | CodeableConcept | Value of extension | |
| extension:targetDoseNumber |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "targetDoseNumber" | |
| value[x] |
0..1 | positiveInt | Value of extension | |
| extension:earliestDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "earliestDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:recommendedDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "recommendedDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:pastDueDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "pastDueDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:latestDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "latestDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:minimumAgeDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "minimumAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:maximumAgeDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "maximumAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:earliestRecommendedAgeDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "earliestRecommendedAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:latestRecommendedAgeDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "latestRecommendedAgeDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:earliestRecommendedIntervalDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "earliestRecommendedIntervalDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:latestRecommendedIntervalDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "latestRecommendedIntervalDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:seasonalRecommendationStartDate |
0..1 | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "seasonalRecommendationStartDate" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| url |
1..1 | uri | "http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/series-detail-ext" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: One contributing series: its own status, its own four dates, and the component dates that produced them. A vaccine group forecast reports the aggregate over several series, so without this a group covered by more than one reports a single answer for all of them, and a due date arrives with no way to see whether age or interval produced it. Repeats, one per series.
- seriesName: string: An Extension
- seriesGroupName: string: An Extension
- seriesType: string: An Extension
- status: CodeableConcept: An Extension
- targetDoseNumber: positiveInt: An Extension
- earliestDate: dateTime: An Extension
- recommendedDate: dateTime: An Extension
- pastDueDate: dateTime: An Extension
- latestDate: dateTime: An Extension
- minimumAgeDate: dateTime: An Extension
- maximumAgeDate: dateTime: An Extension
- earliestRecommendedAgeDate: dateTime: An Extension
- latestRecommendedAgeDate: dateTime: An Extension
- earliestRecommendedIntervalDate: dateTime: An Extension
- latestRecommendedIntervalDate: dateTime: An Extension
- seasonalRecommendationStartDate: dateTime: An Extension
Other representations of profile: CSV, Excel, Schematron
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()
|