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: Dose of a Vaccine
| Official URL: http://example.org/fhir/StructureDefinition/vax-dose | Version: 0.1.0 | |||
| Draft as of 2026-02-11 | Computable Name: VaxDose | |||
Detailed information about each vaccination dose.
Usages:
- This Profile 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.
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Evaluation Status Value Set | 📦0.1.0 | This IG |
| Immunization.statusReason | Base | extensible | Evaluation Reason | 📦0.1.0 | This IG |
| Immunization.vaccineCode | Base | required | VaccineCodesCvxMvx | 📦0.1.0 | This IG |
| Immunization.subpotentReason | Base | required | Immunization Subpotent Reason | 📦4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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 Immunization
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Evaluation Status Value Set | 📦0.1.0 | This IG |
| Immunization.statusReason | Base | extensible | Evaluation Reason | 📦0.1.0 | This IG |
| Immunization.vaccineCode | Base | required | VaccineCodesCvxMvx | 📦0.1.0 | This IG |
| Immunization.subpotentReason | Base | required | Immunization Subpotent Reason | 📦4.0.1 | FHIR Std. |
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Immunization.status | Base | required | Evaluation Status Value Set | 📦0.1.0 | This IG |
| Immunization.statusReason | Base | extensible | Evaluation Reason | 📦0.1.0 | This IG |
| Immunization.vaccineCode | Base | required | VaccineCodesCvxMvx | 📦0.1.0 | This IG |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.0.1 | FHIR Std. |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📍4.0.1 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📍4.0.1 | FHIR Std. |
| Immunization.performer.function | Base | extensible | Immunization Function Codes | 📍4.0.1 | FHIR Std. |
| Immunization.reasonCode | Base | example | Immunization Reason Codes | 📍4.0.1 | FHIR Std. |
| Immunization.subpotentReason | Base | required | Immunization Subpotent Reason | 📦4.0.1 | FHIR Std. |
| Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📍4.0.1 | FHIR Std. |
| Immunization.fundingSource | Base | example | Immunization Funding Source | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present |
documentType.exists() or reference.exists()
|
This structure is derived from Immunization
Summary
Mandatory: 1 element
Extensions
This structure refers to these extensions:
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/assessment-date
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/inadvertent-administration-status
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/valid-age-status
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/valid-age-reason
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-interval-status
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-interval-reason
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-interval-status
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-interval-reason
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/vaccination-conflict
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-vaccine-status
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-vaccine-reason
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-vaccine-status
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-vaccine-reason
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Immunization.occurrence[x]
- The element 1 is sliced based on the value of Immunization.protocolApplied
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Immunization |
0..* | Immunization | Immunization event information | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:assessmentDate |
0..1 | dateTime | Extension URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/assessment-date | |
| extension:inadvertentAdministration |
0..1 | boolean | Inadvertent Administration Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/inadvertent-administration-status | |
| extension:validAgeStatus |
0..1 | boolean | Valid Age Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/valid-age-status | |
| extension:validAgeReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Valid Age Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/valid-age-reason Binding: Valid Age Reason (required) | |
| extension:preferredIntervalStatus |
0..1 | boolean | Preferred Interval Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-interval-status | |
| extension:preferredIntervalReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Preferred Interval Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-interval-reason Binding: Interval Reason (required) | |
| extension:allowedIntervalStatus |
0..1 | boolean | Allowed Interval Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-interval-status | |
| extension:allowedIntervalReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Allowed Interval Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-interval-reason Binding: Interval Reason (required) | |
| extension:vaccinationConflict |
0..1 | boolean | Vaccination Conflict URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/vaccination-conflict | |
| extension:preferredVaccineStatus |
0..1 | boolean | Preferred Vaccine Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-vaccine-status | |
| extension:preferredVaccineReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Preferred Vaccine Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-vaccine-reason Binding: Reasons why certain doses are Preferred or Allowed doses (required) | |
| extension:allowedVaccineStatus |
0..1 | boolean | Allowed Vaccine Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-vaccine-status | |
 extension:allowedVaccineReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Allowed Vaccine Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-vaccine-reason Binding: Reasons why certain doses are Preferred or Allowed doses (required) | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: Evaluation Status Value Set (required) |
 statusReason |
0..1 | CodeableConcept | Reason not done Binding: Evaluation Reason (extensible) | |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineCodesCvxMvx (required) |
 patient |
Σ | 1..1 | Reference(Patient) | Who was immunized |
 Slices for occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this |
| occurrence[x]:occurrenceDateTime |
Σ | 1..1 | dateTime | Vaccine administration date |
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency |
| subpotentReason |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (required) | |
 protocolApplied |
0..* | BackboneElement | Protocol followed by the provider Slice: Unordered, Open by pattern:doseNumberPositiveInt | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Evaluation Status Value Set | 📦0.1.0 | This IG |
| Immunization.statusReason | Base | extensible | Evaluation Reason | 📦0.1.0 | This IG |
| Immunization.vaccineCode | Base | required | VaccineCodesCvxMvx | 📦0.1.0 | This IG |
| Immunization.subpotentReason | Base | required | Immunization Subpotent Reason | 📦4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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 Immunization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:assessmentDate |
0..1 | dateTime | Extension URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/assessment-date | |
| extension:inadvertentAdministration |
0..1 | boolean | Inadvertent Administration Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/inadvertent-administration-status | |
| extension:validAgeStatus |
0..1 | boolean | Valid Age Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/valid-age-status | |
| extension:validAgeReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Valid Age Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/valid-age-reason Binding: Valid Age Reason (required) | |
| extension:preferredIntervalStatus |
0..1 | boolean | Preferred Interval Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-interval-status | |
| extension:preferredIntervalReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Preferred Interval Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-interval-reason Binding: Interval Reason (required) | |
| extension:allowedIntervalStatus |
0..1 | boolean | Allowed Interval Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-interval-status | |
| extension:allowedIntervalReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Allowed Interval Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-interval-reason Binding: Interval Reason (required) | |
| extension:vaccinationConflict |
0..1 | boolean | Vaccination Conflict URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/vaccination-conflict | |
| extension:preferredVaccineStatus |
0..1 | boolean | Preferred Vaccine Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-vaccine-status | |
| extension:preferredVaccineReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Preferred Vaccine Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-vaccine-reason Binding: Reasons why certain doses are Preferred or Allowed doses (required) | |
| extension:allowedVaccineStatus |
0..1 | boolean | Allowed Vaccine Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-vaccine-status | |
| extension:allowedVaccineReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Allowed Vaccine Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-vaccine-reason Binding: Reasons why certain doses are Preferred or Allowed doses (required) | |
 status |
1..1 | code | completed | entered-in-error | not-done Binding: Evaluation Status Value Set (required) | |
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: Evaluation Reason (extensible) | |
| vaccineCode |
1..1 | CodeableConcept | Vaccine product administered Binding: VaccineCodesCvxMvx (required) | |
| Slices for occurrence[x] |
1..1 | dateTime | Vaccine administration date Slice: Unordered, Open by type:$this | |
| occurrence[x]:occurrenceDateTime |
1..1 | dateTime | Vaccine administration date | |
| subpotentReason |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (required) | |
| protocolApplied |
0..* | BackboneElement | Protocol followed by the provider Slice: Unordered, Open by pattern:doseNumberPositiveInt | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Evaluation Status Value Set | 📦0.1.0 | This IG |
| Immunization.statusReason | Base | extensible | Evaluation Reason | 📦0.1.0 | This IG |
| Immunization.vaccineCode | Base | required | VaccineCodesCvxMvx | 📦0.1.0 | This IG |
| Immunization.subpotentReason | Base | required | Immunization Subpotent Reason | 📦4.0.1 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:assessmentDate |
0..1 | dateTime | Extension URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/assessment-date | |||||
| extension:inadvertentAdministration |
0..1 | boolean | Inadvertent Administration Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/inadvertent-administration-status | |||||
| extension:validAgeStatus |
0..1 | boolean | Valid Age Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/valid-age-status | |||||
| extension:validAgeReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Valid Age Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/valid-age-reason Binding: Valid Age Reason (required) | |||||
| extension:preferredIntervalStatus |
0..1 | boolean | Preferred Interval Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-interval-status | |||||
| extension:preferredIntervalReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Preferred Interval Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-interval-reason Binding: Interval Reason (required) | |||||
| extension:allowedIntervalStatus |
0..1 | boolean | Allowed Interval Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-interval-status | |||||
| extension:allowedIntervalReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Allowed Interval Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-interval-reason Binding: Interval Reason (required) | |||||
| extension:vaccinationConflict |
0..1 | boolean | Vaccination Conflict URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/vaccination-conflict | |||||
| extension:preferredVaccineStatus |
0..1 | boolean | Preferred Vaccine Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-vaccine-status | |||||
| extension:preferredVaccineReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Preferred Vaccine Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-vaccine-reason Binding: Reasons why certain doses are Preferred or Allowed doses (required) | |||||
| extension:allowedVaccineStatus |
0..1 | boolean | Allowed Vaccine Status URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-vaccine-status | |||||
| extension:allowedVaccineReason |
0..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Allowed Vaccine Reason URL: http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-vaccine-reason Binding: Reasons why certain doses are Preferred or Allowed doses (required) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: Evaluation Status Value Set (required) | ||||
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: Evaluation Reason (extensible) | |||||
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineCodesCvxMvx (required) | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| Slices for occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this | ||||
| occurrence[x]:occurrenceDateTime |
Σ | 1..1 | dateTime | Vaccine administration date | ||||
| recorded |
0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
| primarySource |
Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
| reportOrigin |
0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
| location |
0..1 | Reference(Location) | Where immunization occurred | |||||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
| doseQuantity |
0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered | |||||
| performer |
Σ | 0..* | BackboneElement | Who performed event | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
| note |
Σ | 0..* | Annotation | Additional immunization notes | ||||
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency | ||||
| subpotentReason |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (required) | |||||
| education |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| documentType |
0..1 | string | Educational material document identifier | |||||
| reference |
0..1 | uri | Educational material reference pointer | |||||
| publicationDate |
0..1 | dateTime | Educational material publication date | |||||
| presentationDate |
0..1 | dateTime | Educational material presentation date | |||||
| programEligibility |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
| fundingSource |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
| reaction |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| date |
0..1 | dateTime | When reaction started | |||||
| detail |
0..1 | Reference(Observation) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied |
0..* | BackboneElement | Protocol followed by the provider Slice: Unordered, Open by pattern:doseNumberPositiveInt | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Immunization.status | Base | required | Evaluation Status Value Set | 📦0.1.0 | This IG |
| Immunization.statusReason | Base | extensible | Evaluation Reason | 📦0.1.0 | This IG |
| Immunization.vaccineCode | Base | required | VaccineCodesCvxMvx | 📦0.1.0 | This IG |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.0.1 | FHIR Std. |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📍4.0.1 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📍4.0.1 | FHIR Std. |
| Immunization.performer.function | Base | extensible | Immunization Function Codes | 📍4.0.1 | FHIR Std. |
| Immunization.reasonCode | Base | example | Immunization Reason Codes | 📍4.0.1 | FHIR Std. |
| Immunization.subpotentReason | Base | required | Immunization Subpotent Reason | 📦4.0.1 | FHIR Std. |
| Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📍4.0.1 | FHIR Std. |
| Immunization.fundingSource | Base | example | Immunization Funding Source | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Immunization | A resource should have narrative for robust management |
text.`div`.exists()
|
| 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()
|
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present |
documentType.exists() or reference.exists()
|
This structure is derived from Immunization
Summary
Mandatory: 1 element
Extensions
This structure refers to these extensions:
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/assessment-date
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/inadvertent-administration-status
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/valid-age-status
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/valid-age-reason
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-interval-status
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-interval-reason
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-interval-status
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-interval-reason
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/vaccination-conflict
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-vaccine-status
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/preferred-vaccine-reason
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-vaccine-status
- http://fhirfli.dev/fhir/ig/cicada/StructureDefinition/allowed-vaccine-reason
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Immunization.occurrence[x]
- The element 1 is sliced based on the value of Immunization.protocolApplied
Other representations of profile: CSV, Excel, Schematron