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

Resource Profile: Antigen Supporting Data

Official URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/antigen-supporting-data Version: 0.1.0
Draft as of 2026-02-11 Computable Name: AntigenSupportingData

A resource to store supporting data for antigens including target disease, vaccine groups, immunity criteria, contraindications, and vaccination series.

Usages:

  • This Resource is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. antigen-supporting-data 0..* Element Antigen Supporting Data

Elements defined in Ancestors:@id, extension
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... targetDisease 0..1 CodeableConcept The disease that the vaccine targets.
... vaccineGroup 0..1 CodeableConcept The vaccine group associated with the target disease.
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... clinicalHistory 0..* BackboneElement List of clinical guidelines that describe circumstances of immunity.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... guidelineCode 1..1 string Code of the guideline.
..... guidelineTitle 1..1 string Title of the guideline.
.... dateOfBirth 0..1 BackboneElement Birth date related immunity information.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... immunityBirthDate 1..1 date Date conferring automatic immunity.
..... birthCountry 1..1 string Country of birth relevant to immunity.
..... exclusion 0..* BackboneElement Exclusions based on certain criteria.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... exclusionCode 1..1 string Code for the exclusion criteria.
...... exclusionTitle 1..1 string Title of the exclusion criteria.
... contraindications 0..1 BackboneElement Information about contraindications for the vaccine.
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineGroup 0..1 BackboneElement Contraindications specific to the vaccine group.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... contraindication 0..* BackboneElement List of contraindications.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... observationCode 1..1 string Code identifying the contraindication.
...... observationTitle 1..1 string Title of the contraindication.
...... contraindicationText 1..1 string Description of the contraindication.
... series 0..* BackboneElement Information about the vaccination series.
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... seriesName 1..1 string Name of the vaccination series.
.... targetDisease 1..1 CodeableConcept Disease targeted by the series.
.... vaccineGroup 1..1 CodeableConcept Vaccine group for the series.
.... seriesType 1..1 string Type of series (standard, risk-based, etc.).
.... selectSeries 0..1 BackboneElement Selection criteria for the series.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... defaultSeries 1..1 boolean If this is the default series.
..... productPath 1..1 boolean If the series has a specific product path.
..... seriesGroupName 1..1 string Name of the series group.
..... seriesGroup 1..1 string Group number of the series.
..... seriesPriority 1..1 string Priority of the series.
..... seriesPreference 1..1 string Preference number within the group.
..... maxAgeToStart 1..1 string Maximum age to start the series.
.... seriesDose 0..* BackboneElement Doses within the series.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... doseNumber 1..1 string Number of the dose in the series.
..... age 0..* BackboneElement Age recommendations for the dose.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... absMinAge 1..1 string Absolute minimum age for the dose.
...... minAge 1..1 string Minimum recommended age for the dose.
...... earliestRecAge 1..1 string Earliest recommended age for the dose.
...... latestRecAge 1..1 string Latest recommended age for the dose.
..... preferableVaccine 0..* BackboneElement Preferable vaccines for the dose.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... vaccineType 1..1 string Type of the vaccine.
...... cvx 1..1 string CVX code for the vaccine.
...... beginAge 1..1 string Beginning age for the vaccine.
...... endAge 1..1 string Ending age for the vaccine.
...... volume 1..1 decimal Volume of the vaccine to be administered.
...... forecastVaccineType 1..1 string Forecast type of the vaccine.
...... tradeName 0..1 string Trade name of the vaccine.
...... mvx 0..1 string Manufacturer's vaccine code.
..... allowableVaccine 0..* BackboneElement Allowable vaccines if preferable vaccines are not available.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... vaccineType 1..1 string Type of allowable vaccine.
...... cvx 1..1 string CVX code for allowable vaccine.
...... beginAge 1..1 string Beginning age for allowable vaccine.
...... endAge 1..1 string Ending age for allowable vaccine.
..... seasonalRecommendation 0..1 BackboneElement Seasonal recommendation for the vaccine dose.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... startDate 1..1 string Start date for the seasonal recommendation.
...... endDate 1..1 string End date for the seasonal recommendation.

doco Documentation for this format

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()

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. antigen-supporting-data 0..* Element Antigen Supporting Data

Elements defined in Ancestors:@id, extension
... targetDisease 0..1 CodeableConcept The disease that the vaccine targets.
... vaccineGroup 0..1 CodeableConcept The vaccine group associated with the target disease.
... immunity 0..1 BackboneElement Information about immunity from clinical history or birth data.
.... clinicalHistory 0..* BackboneElement List of clinical guidelines that describe circumstances of immunity.
..... guidelineCode 1..1 string Code of the guideline.
..... guidelineTitle 1..1 string Title of the guideline.
.... dateOfBirth 0..1 BackboneElement Birth date related immunity information.
..... immunityBirthDate 1..1 date Date conferring automatic immunity.
..... birthCountry 1..1 string Country of birth relevant to immunity.
..... exclusion 0..* BackboneElement Exclusions based on certain criteria.
...... exclusionCode 1..1 string Code for the exclusion criteria.
...... exclusionTitle 1..1 string Title of the exclusion criteria.
.... vaccineGroup 0..1 BackboneElement Contraindications specific to the vaccine group.
..... contraindication 0..* BackboneElement List of contraindications.
...... observationCode 1..1 string Code identifying the contraindication.
...... observationTitle 1..1 string Title of the contraindication.
...... contraindicationText 1..1 string Description of the contraindication.
... series 0..* BackboneElement Information about the vaccination series.
.... seriesName 1..1 string Name of the vaccination series.
.... targetDisease 1..1 CodeableConcept Disease targeted by the series.
.... vaccineGroup 1..1 CodeableConcept Vaccine group for the series.
.... seriesType 1..1 string Type of series (standard, risk-based, etc.).
.... selectSeries 0..1 BackboneElement Selection criteria for the series.
..... defaultSeries 1..1 boolean If this is the default series.
..... productPath 1..1 boolean If the series has a specific product path.
..... seriesGroupName 1..1 string Name of the series group.
..... seriesGroup 1..1 string Group number of the series.
..... seriesPriority 1..1 string Priority of the series.
..... seriesPreference 1..1 string Preference number within the group.
..... maxAgeToStart 1..1 string Maximum age to start the series.
.... seriesDose 0..* BackboneElement Doses within the series.
..... doseNumber 1..1 string Number of the dose in the series.
..... age 0..* BackboneElement Age recommendations for the dose.
...... absMinAge 1..1 string Absolute minimum age for the dose.
...... minAge 1..1 string Minimum recommended age for the dose.
...... earliestRecAge 1..1 string Earliest recommended age for the dose.
...... latestRecAge 1..1 string Latest recommended age for the dose.
..... preferableVaccine 0..* BackboneElement Preferable vaccines for the dose.
...... vaccineType 1..1 string Type of the vaccine.
...... cvx 1..1 string CVX code for the vaccine.
...... beginAge 1..1 string Beginning age for the vaccine.
...... endAge 1..1 string Ending age for the vaccine.
...... volume 1..1 decimal Volume of the vaccine to be administered.
...... forecastVaccineType 1..1 string Forecast type of the vaccine.
...... tradeName 0..1 string Trade name of the vaccine.
...... mvx 0..1 string Manufacturer's vaccine code.
..... allowableVaccine 0..* BackboneElement Allowable vaccines if preferable vaccines are not available.
...... vaccineType 1..1 string Type of allowable vaccine.
...... cvx 1..1 string CVX code for allowable vaccine.
...... beginAge 1..1 string Beginning age for allowable vaccine.
...... endAge 1..1 string Ending age for allowable vaccine.
..... seasonalRecommendation 0..1 BackboneElement Seasonal recommendation for the vaccine dose.
...... startDate 1..1 string Start date for the seasonal recommendation.
...... endDate 1..1 string End date for the seasonal recommendation.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. antigen-supporting-data 0..* Element Antigen Supporting Data

Elements defined in Ancestors:@id, extension
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... targetDisease 0..1 CodeableConcept The disease that the vaccine targets.
... vaccineGroup 0..1 CodeableConcept The vaccine group associated with the target disease.
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... clinicalHistory 0..* BackboneElement List of clinical guidelines that describe circumstances of immunity.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... guidelineCode 1..1 string Code of the guideline.
..... guidelineTitle 1..1 string Title of the guideline.
.... dateOfBirth 0..1 BackboneElement Birth date related immunity information.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... immunityBirthDate 1..1 date Date conferring automatic immunity.
..... birthCountry 1..1 string Country of birth relevant to immunity.
..... exclusion 0..* BackboneElement Exclusions based on certain criteria.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... exclusionCode 1..1 string Code for the exclusion criteria.
...... exclusionTitle 1..1 string Title of the exclusion criteria.
... contraindications 0..1 BackboneElement Information about contraindications for the vaccine.
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineGroup 0..1 BackboneElement Contraindications specific to the vaccine group.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... contraindication 0..* BackboneElement List of contraindications.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... observationCode 1..1 string Code identifying the contraindication.
...... observationTitle 1..1 string Title of the contraindication.
...... contraindicationText 1..1 string Description of the contraindication.
... series 0..* BackboneElement Information about the vaccination series.
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... seriesName 1..1 string Name of the vaccination series.
.... targetDisease 1..1 CodeableConcept Disease targeted by the series.
.... vaccineGroup 1..1 CodeableConcept Vaccine group for the series.
.... seriesType 1..1 string Type of series (standard, risk-based, etc.).
.... selectSeries 0..1 BackboneElement Selection criteria for the series.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... defaultSeries 1..1 boolean If this is the default series.
..... productPath 1..1 boolean If the series has a specific product path.
..... seriesGroupName 1..1 string Name of the series group.
..... seriesGroup 1..1 string Group number of the series.
..... seriesPriority 1..1 string Priority of the series.
..... seriesPreference 1..1 string Preference number within the group.
..... maxAgeToStart 1..1 string Maximum age to start the series.
.... seriesDose 0..* BackboneElement Doses within the series.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... doseNumber 1..1 string Number of the dose in the series.
..... age 0..* BackboneElement Age recommendations for the dose.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... absMinAge 1..1 string Absolute minimum age for the dose.
...... minAge 1..1 string Minimum recommended age for the dose.
...... earliestRecAge 1..1 string Earliest recommended age for the dose.
...... latestRecAge 1..1 string Latest recommended age for the dose.
..... preferableVaccine 0..* BackboneElement Preferable vaccines for the dose.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... vaccineType 1..1 string Type of the vaccine.
...... cvx 1..1 string CVX code for the vaccine.
...... beginAge 1..1 string Beginning age for the vaccine.
...... endAge 1..1 string Ending age for the vaccine.
...... volume 1..1 decimal Volume of the vaccine to be administered.
...... forecastVaccineType 1..1 string Forecast type of the vaccine.
...... tradeName 0..1 string Trade name of the vaccine.
...... mvx 0..1 string Manufacturer's vaccine code.
..... allowableVaccine 0..* BackboneElement Allowable vaccines if preferable vaccines are not available.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... vaccineType 1..1 string Type of allowable vaccine.
...... cvx 1..1 string CVX code for allowable vaccine.
...... beginAge 1..1 string Beginning age for allowable vaccine.
...... endAge 1..1 string Ending age for allowable vaccine.
..... seasonalRecommendation 0..1 BackboneElement Seasonal recommendation for the vaccine dose.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... startDate 1..1 string Start date for the seasonal recommendation.
...... endDate 1..1 string End date for the seasonal recommendation.

doco Documentation for this format

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()

This structure is derived from Element

Summary

Mandatory: 0 element(37 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. antigen-supporting-data 0..* Element Antigen Supporting Data

Elements defined in Ancestors:@id, extension
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... targetDisease 0..1 CodeableConcept The disease that the vaccine targets.
... vaccineGroup 0..1 CodeableConcept The vaccine group associated with the target disease.
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... clinicalHistory 0..* BackboneElement List of clinical guidelines that describe circumstances of immunity.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... guidelineCode 1..1 string Code of the guideline.
..... guidelineTitle 1..1 string Title of the guideline.
.... dateOfBirth 0..1 BackboneElement Birth date related immunity information.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... immunityBirthDate 1..1 date Date conferring automatic immunity.
..... birthCountry 1..1 string Country of birth relevant to immunity.
..... exclusion 0..* BackboneElement Exclusions based on certain criteria.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... exclusionCode 1..1 string Code for the exclusion criteria.
...... exclusionTitle 1..1 string Title of the exclusion criteria.
... contraindications 0..1 BackboneElement Information about contraindications for the vaccine.
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineGroup 0..1 BackboneElement Contraindications specific to the vaccine group.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... contraindication 0..* BackboneElement List of contraindications.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... observationCode 1..1 string Code identifying the contraindication.
...... observationTitle 1..1 string Title of the contraindication.
...... contraindicationText 1..1 string Description of the contraindication.
... series 0..* BackboneElement Information about the vaccination series.
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... seriesName 1..1 string Name of the vaccination series.
.... targetDisease 1..1 CodeableConcept Disease targeted by the series.
.... vaccineGroup 1..1 CodeableConcept Vaccine group for the series.
.... seriesType 1..1 string Type of series (standard, risk-based, etc.).
.... selectSeries 0..1 BackboneElement Selection criteria for the series.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... defaultSeries 1..1 boolean If this is the default series.
..... productPath 1..1 boolean If the series has a specific product path.
..... seriesGroupName 1..1 string Name of the series group.
..... seriesGroup 1..1 string Group number of the series.
..... seriesPriority 1..1 string Priority of the series.
..... seriesPreference 1..1 string Preference number within the group.
..... maxAgeToStart 1..1 string Maximum age to start the series.
.... seriesDose 0..* BackboneElement Doses within the series.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... doseNumber 1..1 string Number of the dose in the series.
..... age 0..* BackboneElement Age recommendations for the dose.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... absMinAge 1..1 string Absolute minimum age for the dose.
...... minAge 1..1 string Minimum recommended age for the dose.
...... earliestRecAge 1..1 string Earliest recommended age for the dose.
...... latestRecAge 1..1 string Latest recommended age for the dose.
..... preferableVaccine 0..* BackboneElement Preferable vaccines for the dose.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... vaccineType 1..1 string Type of the vaccine.
...... cvx 1..1 string CVX code for the vaccine.
...... beginAge 1..1 string Beginning age for the vaccine.
...... endAge 1..1 string Ending age for the vaccine.
...... volume 1..1 decimal Volume of the vaccine to be administered.
...... forecastVaccineType 1..1 string Forecast type of the vaccine.
...... tradeName 0..1 string Trade name of the vaccine.
...... mvx 0..1 string Manufacturer's vaccine code.
..... allowableVaccine 0..* BackboneElement Allowable vaccines if preferable vaccines are not available.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... vaccineType 1..1 string Type of allowable vaccine.
...... cvx 1..1 string CVX code for allowable vaccine.
...... beginAge 1..1 string Beginning age for allowable vaccine.
...... endAge 1..1 string Ending age for allowable vaccine.
..... seasonalRecommendation 0..1 BackboneElement Seasonal recommendation for the vaccine dose.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... startDate 1..1 string Start date for the seasonal recommendation.
...... endDate 1..1 string End date for the seasonal recommendation.

doco Documentation for this format

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()

Differential View

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. antigen-supporting-data 0..* Element Antigen Supporting Data

Elements defined in Ancestors:@id, extension
... targetDisease 0..1 CodeableConcept The disease that the vaccine targets.
... vaccineGroup 0..1 CodeableConcept The vaccine group associated with the target disease.
... immunity 0..1 BackboneElement Information about immunity from clinical history or birth data.
.... clinicalHistory 0..* BackboneElement List of clinical guidelines that describe circumstances of immunity.
..... guidelineCode 1..1 string Code of the guideline.
..... guidelineTitle 1..1 string Title of the guideline.
.... dateOfBirth 0..1 BackboneElement Birth date related immunity information.
..... immunityBirthDate 1..1 date Date conferring automatic immunity.
..... birthCountry 1..1 string Country of birth relevant to immunity.
..... exclusion 0..* BackboneElement Exclusions based on certain criteria.
...... exclusionCode 1..1 string Code for the exclusion criteria.
...... exclusionTitle 1..1 string Title of the exclusion criteria.
.... vaccineGroup 0..1 BackboneElement Contraindications specific to the vaccine group.
..... contraindication 0..* BackboneElement List of contraindications.
...... observationCode 1..1 string Code identifying the contraindication.
...... observationTitle 1..1 string Title of the contraindication.
...... contraindicationText 1..1 string Description of the contraindication.
... series 0..* BackboneElement Information about the vaccination series.
.... seriesName 1..1 string Name of the vaccination series.
.... targetDisease 1..1 CodeableConcept Disease targeted by the series.
.... vaccineGroup 1..1 CodeableConcept Vaccine group for the series.
.... seriesType 1..1 string Type of series (standard, risk-based, etc.).
.... selectSeries 0..1 BackboneElement Selection criteria for the series.
..... defaultSeries 1..1 boolean If this is the default series.
..... productPath 1..1 boolean If the series has a specific product path.
..... seriesGroupName 1..1 string Name of the series group.
..... seriesGroup 1..1 string Group number of the series.
..... seriesPriority 1..1 string Priority of the series.
..... seriesPreference 1..1 string Preference number within the group.
..... maxAgeToStart 1..1 string Maximum age to start the series.
.... seriesDose 0..* BackboneElement Doses within the series.
..... doseNumber 1..1 string Number of the dose in the series.
..... age 0..* BackboneElement Age recommendations for the dose.
...... absMinAge 1..1 string Absolute minimum age for the dose.
...... minAge 1..1 string Minimum recommended age for the dose.
...... earliestRecAge 1..1 string Earliest recommended age for the dose.
...... latestRecAge 1..1 string Latest recommended age for the dose.
..... preferableVaccine 0..* BackboneElement Preferable vaccines for the dose.
...... vaccineType 1..1 string Type of the vaccine.
...... cvx 1..1 string CVX code for the vaccine.
...... beginAge 1..1 string Beginning age for the vaccine.
...... endAge 1..1 string Ending age for the vaccine.
...... volume 1..1 decimal Volume of the vaccine to be administered.
...... forecastVaccineType 1..1 string Forecast type of the vaccine.
...... tradeName 0..1 string Trade name of the vaccine.
...... mvx 0..1 string Manufacturer's vaccine code.
..... allowableVaccine 0..* BackboneElement Allowable vaccines if preferable vaccines are not available.
...... vaccineType 1..1 string Type of allowable vaccine.
...... cvx 1..1 string CVX code for allowable vaccine.
...... beginAge 1..1 string Beginning age for allowable vaccine.
...... endAge 1..1 string Ending age for allowable vaccine.
..... seasonalRecommendation 0..1 BackboneElement Seasonal recommendation for the vaccine dose.
...... startDate 1..1 string Start date for the seasonal recommendation.
...... endDate 1..1 string End date for the seasonal recommendation.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. antigen-supporting-data 0..* Element Antigen Supporting Data

Elements defined in Ancestors:@id, extension
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... targetDisease 0..1 CodeableConcept The disease that the vaccine targets.
... vaccineGroup 0..1 CodeableConcept The vaccine group associated with the target disease.
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... clinicalHistory 0..* BackboneElement List of clinical guidelines that describe circumstances of immunity.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... guidelineCode 1..1 string Code of the guideline.
..... guidelineTitle 1..1 string Title of the guideline.
.... dateOfBirth 0..1 BackboneElement Birth date related immunity information.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... immunityBirthDate 1..1 date Date conferring automatic immunity.
..... birthCountry 1..1 string Country of birth relevant to immunity.
..... exclusion 0..* BackboneElement Exclusions based on certain criteria.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... exclusionCode 1..1 string Code for the exclusion criteria.
...... exclusionTitle 1..1 string Title of the exclusion criteria.
... contraindications 0..1 BackboneElement Information about contraindications for the vaccine.
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineGroup 0..1 BackboneElement Contraindications specific to the vaccine group.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... contraindication 0..* BackboneElement List of contraindications.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... observationCode 1..1 string Code identifying the contraindication.
...... observationTitle 1..1 string Title of the contraindication.
...... contraindicationText 1..1 string Description of the contraindication.
... series 0..* BackboneElement Information about the vaccination series.
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... seriesName 1..1 string Name of the vaccination series.
.... targetDisease 1..1 CodeableConcept Disease targeted by the series.
.... vaccineGroup 1..1 CodeableConcept Vaccine group for the series.
.... seriesType 1..1 string Type of series (standard, risk-based, etc.).
.... selectSeries 0..1 BackboneElement Selection criteria for the series.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... defaultSeries 1..1 boolean If this is the default series.
..... productPath 1..1 boolean If the series has a specific product path.
..... seriesGroupName 1..1 string Name of the series group.
..... seriesGroup 1..1 string Group number of the series.
..... seriesPriority 1..1 string Priority of the series.
..... seriesPreference 1..1 string Preference number within the group.
..... maxAgeToStart 1..1 string Maximum age to start the series.
.... seriesDose 0..* BackboneElement Doses within the series.
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... doseNumber 1..1 string Number of the dose in the series.
..... age 0..* BackboneElement Age recommendations for the dose.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... absMinAge 1..1 string Absolute minimum age for the dose.
...... minAge 1..1 string Minimum recommended age for the dose.
...... earliestRecAge 1..1 string Earliest recommended age for the dose.
...... latestRecAge 1..1 string Latest recommended age for the dose.
..... preferableVaccine 0..* BackboneElement Preferable vaccines for the dose.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... vaccineType 1..1 string Type of the vaccine.
...... cvx 1..1 string CVX code for the vaccine.
...... beginAge 1..1 string Beginning age for the vaccine.
...... endAge 1..1 string Ending age for the vaccine.
...... volume 1..1 decimal Volume of the vaccine to be administered.
...... forecastVaccineType 1..1 string Forecast type of the vaccine.
...... tradeName 0..1 string Trade name of the vaccine.
...... mvx 0..1 string Manufacturer's vaccine code.
..... allowableVaccine 0..* BackboneElement Allowable vaccines if preferable vaccines are not available.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... vaccineType 1..1 string Type of allowable vaccine.
...... cvx 1..1 string CVX code for allowable vaccine.
...... beginAge 1..1 string Beginning age for allowable vaccine.
...... endAge 1..1 string Ending age for allowable vaccine.
..... seasonalRecommendation 0..1 BackboneElement Seasonal recommendation for the vaccine dose.
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... startDate 1..1 string Start date for the seasonal recommendation.
...... endDate 1..1 string End date for the seasonal recommendation.

doco Documentation for this format

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()

This structure is derived from Element

Summary

Mandatory: 0 element(37 nested mandatory elements)

 

​Other representations of profile: CSV, Excel, Schematron