CDC FHIR® IG: Anonymized Electronic Initial Case Reporting (eICR)
1.0.1 - release

CDC FHIR® IG: Anonymized Electronic Initial Case Reporting (eICR) - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: eICR Anonymized Immunization

Official URL: http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-immunization | Version: 1.0.1
Active as of 2025-04-14 | Computable Name: EICRAnonymizedImmunization

This Immunization profile represents an anonymized eICR Immunization.

It is based on the US Core Immunization profile with further constraints to require making of patient and removal of performer.

Usage:

- Refer to this Resource Profile: eICR Anonymized Composition
- Examples for this Resource Profile: Immunization/immunization-pneumo-anon

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | USCoreImmunizationProfile(4.0.0) | Immunization event information dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children Fixed Value: masked
status |  | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. ele-1: All FHIR elements must have a @value or children
div | C | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' ele-1: All FHIR elements must have a @value or children txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) ele-1: All FHIR elements must have a @value or children
statusReason | S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example) ele-1: All FHIR elements must have a @value or children
vaccineCode | S Σ C | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set (extensible) ele-1: All FHIR elements must have a @value or children us-core-1: SHOULD have a translation to the NDC value set
patient | S Σ | 1..1 | Reference(eICR Anonymized Patient) | The patient of this anonymized Immunization is the anonymized Patient ele-1: All FHIR elements must have a @value or children
occurrence[x] | S Σ | 1..1 |  | Vaccine administration date ele-1: All FHIR elements must have a @value or children
occurrenceDateTime |  |  | dateTime |
primarySource | S Σ | 1..1 | boolean | Indicates context the data was recorded in ele-1: All FHIR elements must have a @value or children
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Immunization.text.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
Immunization.text.status | required | NarrativeStatus `http://hl7.org/fhir/ValueSet/narrative-status|4.0.1` from the FHIR Standard
Immunization.status | required | ImmunizationStatusCodes `http://hl7.org/fhir/ValueSet/immunization-status` from the FHIR Standard
Immunization.statusReason | example | ImmunizationStatusReasonCodes `http://hl7.org/fhir/ValueSet/immunization-status-reason` from the FHIR Standard
Immunization.vaccineCode | extensible | CVXVaccinesAdministeredVaccineSet `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6` from https://vsac.nlm.nih.gov

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
eicr-anon-text | error | Immunization.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |
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() |
txt-1 | error | Immunization.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks() |
txt-2 | error | Immunization.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
us-core-1 | best practice | Immunization.vaccineCode | SHOULD have a translation to the NDC value set : coding.where(system='http://hl7.org/fhir/sid/ndc').empty() |

This structure is derived from USCoreImmunizationProfile

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  |  | USCoreImmunizationProfile(4.0.0) |
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x] |  | 1..1 | code | Value of extension Fixed Value: masked
div |  | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
patient |  | 1..1 | Reference(eICR Anonymized Patient) | The patient of this anonymized Immunization is the anonymized Patient
performer |  | 0..0 |  |
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
eicr-anon-text | error | Immunization.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | USCoreImmunizationProfile(4.0.0) | 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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
status |  | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative.
div | C | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier | Business identifier
status | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required)
statusReason | S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example)
vaccineCode | S Σ C | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set (extensible) us-core-1: SHOULD have a translation to the NDC value set
patient | S Σ | 1..1 | Reference(eICR Anonymized Patient) | The patient of this anonymized Immunization is the anonymized Patient
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
occurrence[x] | S Σ | 1..1 |  | Vaccine administration date
occurrenceDateTime |  |  | dateTime S |
occurrenceString |  |  | string |
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | S Σ | 1..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 | Amount of vaccine administered
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 (example): The reason why a dose is considered to be subpotent.
education | C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present
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
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
series |  | 0..1 | string | Name of vaccine series
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
doseNumber[x] |  | 1..1 |  | Dose number within series
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Immunization.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Immunization.text.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
Immunization.text.status | required | NarrativeStatus `http://hl7.org/fhir/ValueSet/narrative-status|4.0.1` from the FHIR Standard
Immunization.status | required | ImmunizationStatusCodes `http://hl7.org/fhir/ValueSet/immunization-status` from the FHIR Standard
Immunization.statusReason | example | ImmunizationStatusReasonCodes `http://hl7.org/fhir/ValueSet/immunization-status-reason` from the FHIR Standard
Immunization.vaccineCode | extensible | CVXVaccinesAdministeredVaccineSet `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6` from https://vsac.nlm.nih.gov
Immunization.reportOrigin | example | ImmunizationOriginCodes `http://hl7.org/fhir/ValueSet/immunization-origin` from the FHIR Standard
Immunization.site | example | CodesForImmunizationSiteOfAdministration `http://hl7.org/fhir/ValueSet/immunization-site` from the FHIR Standard
Immunization.route | example | ImmunizationRouteCodes `http://hl7.org/fhir/ValueSet/immunization-route` from the FHIR Standard
Immunization.performer.function | extensible | ImmunizationFunctionCodes `http://hl7.org/fhir/ValueSet/immunization-function` from the FHIR Standard
Immunization.reasonCode | example | ImmunizationReasonCodes `http://hl7.org/fhir/ValueSet/immunization-reason` from the FHIR Standard
Immunization.subpotentReason | example | ImmunizationSubpotentReason `http://hl7.org/fhir/ValueSet/immunization-subpotent-reason` from the FHIR Standard
Immunization.programEligibility | example | ImmunizationProgramEligibility `http://hl7.org/fhir/ValueSet/immunization-program-eligibility` from the FHIR Standard
Immunization.fundingSource | example | ImmunizationFundingSource `http://hl7.org/fhir/ValueSet/immunization-funding-source` from the FHIR Standard
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes `http://hl7.org/fhir/ValueSet/immunization-target-disease` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
eicr-anon-text | error | Immunization.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |
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() |
txt-1 | error | Immunization.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks() |
txt-2 | error | Immunization.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
us-core-1 | best practice | Immunization.vaccineCode | SHOULD have a translation to the NDC value set : coding.where(system='http://hl7.org/fhir/sid/ndc').empty() |

This structure is derived from USCoreImmunizationProfile

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 1 element
Fixed: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

- eICR Anonymized Patient (http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-patient)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/data-absent-reason

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | USCoreImmunizationProfile(4.0.0) | Immunization event information dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children Fixed Value: masked
status |  | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. ele-1: All FHIR elements must have a @value or children
div | C | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' ele-1: All FHIR elements must have a @value or children txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) ele-1: All FHIR elements must have a @value or children
statusReason | S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example) ele-1: All FHIR elements must have a @value or children
vaccineCode | S Σ C | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set (extensible) ele-1: All FHIR elements must have a @value or children us-core-1: SHOULD have a translation to the NDC value set
patient | S Σ | 1..1 | Reference(eICR Anonymized Patient) | The patient of this anonymized Immunization is the anonymized Patient ele-1: All FHIR elements must have a @value or children
occurrence[x] | S Σ | 1..1 |  | Vaccine administration date ele-1: All FHIR elements must have a @value or children
occurrenceDateTime |  |  | dateTime |
primarySource | S Σ | 1..1 | boolean | Indicates context the data was recorded in ele-1: All FHIR elements must have a @value or children
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Immunization.text.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
Immunization.text.status | required | NarrativeStatus `http://hl7.org/fhir/ValueSet/narrative-status|4.0.1` from the FHIR Standard
Immunization.status | required | ImmunizationStatusCodes `http://hl7.org/fhir/ValueSet/immunization-status` from the FHIR Standard
Immunization.statusReason | example | ImmunizationStatusReasonCodes `http://hl7.org/fhir/ValueSet/immunization-status-reason` from the FHIR Standard
Immunization.vaccineCode | extensible | CVXVaccinesAdministeredVaccineSet `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6` from https://vsac.nlm.nih.gov

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
eicr-anon-text | error | Immunization.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |
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() |
txt-1 | error | Immunization.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks() |
txt-2 | error | Immunization.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
us-core-1 | best practice | Immunization.vaccineCode | SHOULD have a translation to the NDC value set : coding.where(system='http://hl7.org/fhir/sid/ndc').empty() |

Differential View

This structure is derived from USCoreImmunizationProfile

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  |  | USCoreImmunizationProfile(4.0.0) |
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x] |  | 1..1 | code | Value of extension Fixed Value: masked
div |  | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
patient |  | 1..1 | Reference(eICR Anonymized Patient) | The patient of this anonymized Immunization is the anonymized Patient
performer |  | 0..0 |  |
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
eicr-anon-text | error | Immunization.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Immunization |  | 0..* | USCoreImmunizationProfile(4.0.0) | 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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
status |  | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative.
div | C | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier | Business identifier
status | ?!S Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required)
statusReason | S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example)
vaccineCode | S Σ C | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set (extensible) us-core-1: SHOULD have a translation to the NDC value set
patient | S Σ | 1..1 | Reference(eICR Anonymized Patient) | The patient of this anonymized Immunization is the anonymized Patient
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
occurrence[x] | S Σ | 1..1 |  | Vaccine administration date
occurrenceDateTime |  |  | dateTime S |
occurrenceString |  |  | string |
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | S Σ | 1..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 | Amount of vaccine administered
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 (example): The reason why a dose is considered to be subpotent.
education | C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present
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
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
series |  | 0..1 | string | Name of vaccine series
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
doseNumber[x] |  | 1..1 |  | Dose number within series
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Immunization.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Immunization.text.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
Immunization.text.status | required | NarrativeStatus `http://hl7.org/fhir/ValueSet/narrative-status|4.0.1` from the FHIR Standard
Immunization.status | required | ImmunizationStatusCodes `http://hl7.org/fhir/ValueSet/immunization-status` from the FHIR Standard
Immunization.statusReason | example | ImmunizationStatusReasonCodes `http://hl7.org/fhir/ValueSet/immunization-status-reason` from the FHIR Standard
Immunization.vaccineCode | extensible | CVXVaccinesAdministeredVaccineSet `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6` from https://vsac.nlm.nih.gov
Immunization.reportOrigin | example | ImmunizationOriginCodes `http://hl7.org/fhir/ValueSet/immunization-origin` from the FHIR Standard
Immunization.site | example | CodesForImmunizationSiteOfAdministration `http://hl7.org/fhir/ValueSet/immunization-site` from the FHIR Standard
Immunization.route | example | ImmunizationRouteCodes `http://hl7.org/fhir/ValueSet/immunization-route` from the FHIR Standard
Immunization.performer.function | extensible | ImmunizationFunctionCodes `http://hl7.org/fhir/ValueSet/immunization-function` from the FHIR Standard
Immunization.reasonCode | example | ImmunizationReasonCodes `http://hl7.org/fhir/ValueSet/immunization-reason` from the FHIR Standard
Immunization.subpotentReason | example | ImmunizationSubpotentReason `http://hl7.org/fhir/ValueSet/immunization-subpotent-reason` from the FHIR Standard
Immunization.programEligibility | example | ImmunizationProgramEligibility `http://hl7.org/fhir/ValueSet/immunization-program-eligibility` from the FHIR Standard
Immunization.fundingSource | example | ImmunizationFundingSource `http://hl7.org/fhir/ValueSet/immunization-funding-source` from the FHIR Standard
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes `http://hl7.org/fhir/ValueSet/immunization-target-disease` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |
eicr-anon-text | error | Immunization.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |
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() |
txt-1 | error | Immunization.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks() |
txt-2 | error | Immunization.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
us-core-1 | best practice | Immunization.vaccineCode | SHOULD have a translation to the NDC value set : coding.where(system='http://hl7.org/fhir/sid/ndc').empty() |

This structure is derived from USCoreImmunizationProfile

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 1 element
Fixed: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

- eICR Anonymized Patient (http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-patient)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/data-absent-reason

Other representations of profile: CSV, Excel, Schematron