Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Immunization | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_Immunization_R3 | ||
This cross-version profile allows R5 Immunization content to be represented via FHIR STU3 Immunization resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Immunization |
C | 0..* | Immunization | Immunization event information Constraints: imm-2, imm-1 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:occurrence |
1..1 | string | R5: Vaccine administration date additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.occurrence | |
 Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| modifierExtension:status |
?! | 0..1 | code | R5: completed | entered-in-error | not-done additional codes URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.status Binding: Immunization Status Codes (required): x |
| status |
?!Σ | 1..1 | code | completed | entered-in-error Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization |
| notGiven |
?!Σ | 1..1 | boolean | Flag for whether immunization was given |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:statusReason |
0..1 | CodeableConcept | R5: Reason for current status additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.statusReason Binding: R5ImmunizationStatusReasonForR3 (0.1.0) (example): x | |
 vaccineCode |
1..1 | CodeableConcept | Vaccine product administered Binding: Vaccine Administered Value Set (example): The code for vaccine product administered | |
 patient |
1..1 | Reference(Patient) | Who was immunized | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:patient |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: patient additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
 primarySource |
1..1 | boolean | Indicates context the data was recorded in | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📍3.0.2 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (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 | If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present |
(notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
|
| imm-2 | error | Immunization | If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent. |
(notGiven = true) or explanation.reasonNotGiven.empty()
|
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
C | 0..* | Immunization | Immunization event information Constraints: imm-2, imm-1 | ||||
| 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: Common Languages  (extensible): 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:occurrence |
1..1 | string | R5: Vaccine administration date additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.occurrence | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modifierExtension:status |
?! | 0..1 | code | R5: completed | entered-in-error | not-done additional codes URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.status Binding: Immunization Status Codes (required): x | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization | ||||
| notGiven |
?!Σ | 1..1 | boolean | Flag for whether immunization was given | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:statusReason |
0..1 | CodeableConcept | R5: Reason for current status additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.statusReason Binding: R5ImmunizationStatusReasonForR3 (0.1.0) (example): x | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| vaccineCode |
1..1 | CodeableConcept | Vaccine product administered Binding: Vaccine Administered Value Set (example): The code for vaccine product administered | |||||
| patient |
1..1 | Reference(Patient) | Who was immunized | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:patient |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: patient additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter administered as part of | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:encounter |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Encounter immunization was part of additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| date |
0..1 | dateTime | Vaccination administration date | |||||
| primarySource |
1..1 | boolean | Indicates context the data was recorded in | |||||
| reportOrigin |
0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: Immunization Origin Codes (example): The source of the data for a record which is not from a primary source. | |||||
| location |
0..1 | Reference(Location) | Where vaccination occurred | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:location |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Where immunization occurred additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:manufacturer |
0..1 | CodeableConcept | R5: manufacturer additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.manufacturer | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (example): The site at which the vaccine was administered | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunization Route Codes (example): The route by which the vaccine was administered | |||||
| doseQuantity |
0..1 | SimpleQuantity | Amount of vaccine administered | |||||
| practitioner |
Σ | 0..* | BackboneElement | Who performed event | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| role |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: Immunization Role Codes (extensible): The role a practitioner plays in the immunization event | ||||
| actor |
Σ | 1..1 | Reference(Practitioner) | Individual who was performing | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:actor |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Individual or organization who was performing URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| note |
Σ | 0..* | Annotation | Vaccination notes | ||||
| explanation |
0..1 | BackboneElement | Administration/non-administration reasons | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
 extension:basedOn |
0..* | Reference(Cross-version Profile for R5.CarePlan for use in FHIR STU3(0.1.0) | CarePlan | Cross-version Profile for R5.MedicationRequest for use in FHIR STU3(0.1.0) | MedicationRequest | Cross-version Profile for R5.ServiceRequest for use in FHIR STU3(0.1.0) | ReferralRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation) | R5: Authority that the immunization event is based on (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn | |||||
| extension:administeredProduct |
0..1 | (Complex) | R5: Product that was administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct | |||||
| extension:supportingInformation |
0..* | Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) | R5: Additional information in support of the immunization (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.supportingInformation | |||||
| extension:informationSource |
0..1 | (Complex) | R5: Indicates the source of a reported record (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource | |||||
| extension:reason |
0..* | (Complex) | R5: Why immunization occurred additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.reason | |||||
| extension:subpotentReason |
0..* | CodeableConcept | R5: Reason for being subpotent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.subpotentReason Binding: R5ImmunizationSubpotentReasonForR3 (0.1.0) (example): The reason why a dose is considered to be subpotent. | |||||
| extension:programEligibility |
0..* | (Complex) | R5: Patient eligibility for a specific vaccination program (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.programEligibility | |||||
| extension:fundingSource |
0..1 | CodeableConcept | R5: Funding source for the vaccine (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.fundingSource Binding: R5ImmunizationFundingSourceForR3 (0.1.0) (example): x | |||||
| Slices for modifierExtension |
?!Σ | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modifierExtension:isSubpotent |
?!Σ | 0..1 | boolean | R5: Dose potency (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.isSubpotent | ||||
| reason |
0..* | CodeableConcept | Why immunization occurred Binding: Immunization Reason Codes (example): The reason why a vaccine was administered | |||||
| reasonNotGiven |
0..* | CodeableConcept | Why immunization did not occur Binding: Immunization Reasons for Not Immunizing Codes (example): The reason why a vaccine was not administered | |||||
| reaction |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| date |
0..1 | dateTime | When reaction started | |||||
| detail |
0..1 | Reference(Observation) | Additional information on reaction | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:manifestation |
0..1 | CodeableConcept | R5: manifestation additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.reaction.manifestation | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| vaccinationProtocol |
0..* | BackboneElement | What protocol was followed | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| doseSequence |
0..1 | positiveInt | Dose number within series | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:doseNumber |
1..1 | string | R5: doseNumber additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.protocolApplied.doseNumber | |||||
| value |
0..1 | positiveInt | Primitive value for positiveInt | |||||
| description |
0..1 | string | Details of vaccine protocol | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for protocol | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:authority |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Who is responsible for publishing the recommendations additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| series |
0..1 | string | Name of vaccine series | |||||
| seriesDoses |
0..1 | positiveInt | Recommended number of doses for immunity | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:seriesDoses |
0..1 | string | R5: seriesDoses additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.protocolApplied.seriesDoses | |||||
| value |
0..1 | positiveInt | Primitive value for positiveInt | |||||
| targetDisease |
1..* | CodeableConcept | Disease immunized against Binding: Vaccination Protocol Dose Target Codes (example): The disease target of the vaccination protocol | |||||
| doseStatus |
1..1 | CodeableConcept | Indicates if dose counts towards immunity Binding: Vaccination Protocol Dose Status codes (example): The status of the vaccination protocol (i.e. should this count) | |||||
| doseStatusReason |
0..1 | CodeableConcept | Why dose does (not) count Binding: Vaccination Protocol Dose Status Reason codes (example): The reason for the determining if a vaccination should count or why vaccination should not count. | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| Immunization.status | Base | required | Immunization Status Codes | 📍3.0.2 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍3.0.2 | FHIR Std. |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍3.0.2 | FHIR Std. |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📍3.0.2 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📍3.0.2 | FHIR Std. |
| Immunization.practitioner.role | Base | extensible | Immunization Role Codes | 📍3.0.2 | FHIR Std. |
| Immunization.explanation.reason | Base | example | Immunization Reason Codes | 📍3.0.2 | FHIR Std. |
| Immunization.explanation.reasonNotGiven | Base | example | Immunization Reasons for Not Immunizing Codes | 📍3.0.2 | FHIR Std. |
| Immunization.vaccinationProtocol.targetDisease | Base | example | Vaccination Protocol Dose Target Codes | 📍3.0.2 | FHIR Std. |
| Immunization.vaccinationProtocol.doseStatus | Base | example | Vaccination Protocol Dose Status codes | 📍3.0.2 | FHIR Std. |
| Immunization.vaccinationProtocol.doseStatusReason | Base | example | Vaccination Protocol Dose Status Reason codes | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (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 | If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present |
(notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
|
| imm-2 | error | Immunization | If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent. |
(notGiven = true) or explanation.reasonNotGiven.empty()
|
This structure is derived from Immunization
Summary
Mandatory: 2 elements(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
C | 0..* | Immunization | Immunization event information Constraints: imm-2, imm-1 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:occurrence |
1..1 | string | R5: Vaccine administration date additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.occurrence | |
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| modifierExtension:status |
?! | 0..1 | code | R5: completed | entered-in-error | not-done additional codes URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.status Binding: Immunization Status Codes (required): x |
| status |
?!Σ | 1..1 | code | completed | entered-in-error Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization |
| notGiven |
?!Σ | 1..1 | boolean | Flag for whether immunization was given |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:statusReason |
0..1 | CodeableConcept | R5: Reason for current status additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.statusReason Binding: R5ImmunizationStatusReasonForR3 (0.1.0) (example): x | |
| vaccineCode |
1..1 | CodeableConcept | Vaccine product administered Binding: Vaccine Administered Value Set (example): The code for vaccine product administered | |
| patient |
1..1 | Reference(Patient) | Who was immunized | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:patient |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: patient additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| primarySource |
1..1 | boolean | Indicates context the data was recorded in | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📍3.0.2 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (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 | If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present |
(notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
|
| imm-2 | error | Immunization | If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent. |
(notGiven = true) or explanation.reasonNotGiven.empty()
|
Differential View
This structure is derived from Immunization
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
C | 0..* | Immunization | Immunization event information Constraints: imm-2, imm-1 | ||||
| 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: Common Languages (extensible): 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:occurrence |
1..1 | string | R5: Vaccine administration date additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.occurrence | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modifierExtension:status |
?! | 0..1 | code | R5: completed | entered-in-error | not-done additional codes URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.status Binding: Immunization Status Codes (required): x | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization | ||||
| notGiven |
?!Σ | 1..1 | boolean | Flag for whether immunization was given | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:statusReason |
0..1 | CodeableConcept | R5: Reason for current status additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.statusReason Binding: R5ImmunizationStatusReasonForR3 (0.1.0) (example): x | |||||
| value |
0..1 | boolean | Primitive value for boolean | |||||
| vaccineCode |
1..1 | CodeableConcept | Vaccine product administered Binding: Vaccine Administered Value Set (example): The code for vaccine product administered | |||||
| patient |
1..1 | Reference(Patient) | Who was immunized | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:patient |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: patient additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter administered as part of | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:encounter |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Encounter immunization was part of additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| date |
0..1 | dateTime | Vaccination administration date | |||||
| primarySource |
1..1 | boolean | Indicates context the data was recorded in | |||||
| reportOrigin |
0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: Immunization Origin Codes (example): The source of the data for a record which is not from a primary source. | |||||
| location |
0..1 | Reference(Location) | Where vaccination occurred | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:location |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Where immunization occurred additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:manufacturer |
0..1 | CodeableConcept | R5: manufacturer additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.manufacturer | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (example): The site at which the vaccine was administered | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: Immunization Route Codes (example): The route by which the vaccine was administered | |||||
| doseQuantity |
0..1 | SimpleQuantity | Amount of vaccine administered | |||||
| practitioner |
Σ | 0..* | BackboneElement | Who performed event | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| role |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: Immunization Role Codes (extensible): The role a practitioner plays in the immunization event | ||||
| actor |
Σ | 1..1 | Reference(Practitioner) | Individual who was performing | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:actor |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Individual or organization who was performing URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| note |
Σ | 0..* | Annotation | Vaccination notes | ||||
| explanation |
0..1 | BackboneElement | Administration/non-administration reasons | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:basedOn |
0..* | Reference(Cross-version Profile for R5.CarePlan for use in FHIR STU3(0.1.0) | CarePlan | Cross-version Profile for R5.MedicationRequest for use in FHIR STU3(0.1.0) | MedicationRequest | Cross-version Profile for R5.ServiceRequest for use in FHIR STU3(0.1.0) | ReferralRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation) | R5: Authority that the immunization event is based on (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn | |||||
| extension:administeredProduct |
0..1 | (Complex) | R5: Product that was administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct | |||||
| extension:supportingInformation |
0..* | Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) | R5: Additional information in support of the immunization (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.supportingInformation | |||||
| extension:informationSource |
0..1 | (Complex) | R5: Indicates the source of a reported record (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource | |||||
| extension:reason |
0..* | (Complex) | R5: Why immunization occurred additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.reason | |||||
| extension:subpotentReason |
0..* | CodeableConcept | R5: Reason for being subpotent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.subpotentReason Binding: R5ImmunizationSubpotentReasonForR3 (0.1.0) (example): The reason why a dose is considered to be subpotent. | |||||
| extension:programEligibility |
0..* | (Complex) | R5: Patient eligibility for a specific vaccination program (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.programEligibility | |||||
| extension:fundingSource |
0..1 | CodeableConcept | R5: Funding source for the vaccine (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.fundingSource Binding: R5ImmunizationFundingSourceForR3 (0.1.0) (example): x | |||||
| Slices for modifierExtension |
?!Σ | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modifierExtension:isSubpotent |
?!Σ | 0..1 | boolean | R5: Dose potency (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.isSubpotent | ||||
| reason |
0..* | CodeableConcept | Why immunization occurred Binding: Immunization Reason Codes (example): The reason why a vaccine was administered | |||||
| reasonNotGiven |
0..* | CodeableConcept | Why immunization did not occur Binding: Immunization Reasons for Not Immunizing Codes (example): The reason why a vaccine was not administered | |||||
| reaction |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| date |
0..1 | dateTime | When reaction started | |||||
| detail |
0..1 | Reference(Observation) | Additional information on reaction | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:manifestation |
0..1 | CodeableConcept | R5: manifestation additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.reaction.manifestation | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| vaccinationProtocol |
0..* | BackboneElement | What protocol was followed | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| doseSequence |
0..1 | positiveInt | Dose number within series | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:doseNumber |
1..1 | string | R5: doseNumber additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.protocolApplied.doseNumber | |||||
| value |
0..1 | positiveInt | Primitive value for positiveInt | |||||
| description |
0..1 | string | Details of vaccine protocol | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for protocol | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:authority |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Who is responsible for publishing the recommendations additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| series |
0..1 | string | Name of vaccine series | |||||
| seriesDoses |
0..1 | positiveInt | Recommended number of doses for immunity | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:seriesDoses |
0..1 | string | R5: seriesDoses additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.protocolApplied.seriesDoses | |||||
| value |
0..1 | positiveInt | Primitive value for positiveInt | |||||
| targetDisease |
1..* | CodeableConcept | Disease immunized against Binding: Vaccination Protocol Dose Target Codes (example): The disease target of the vaccination protocol | |||||
| doseStatus |
1..1 | CodeableConcept | Indicates if dose counts towards immunity Binding: Vaccination Protocol Dose Status codes (example): The status of the vaccination protocol (i.e. should this count) | |||||
| doseStatusReason |
0..1 | CodeableConcept | Why dose does (not) count Binding: Vaccination Protocol Dose Status Reason codes (example): The reason for the determining if a vaccination should count or why vaccination should not count. | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| Immunization.status | Base | required | Immunization Status Codes | 📍3.0.2 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍3.0.2 | FHIR Std. |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍3.0.2 | FHIR Std. |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📍3.0.2 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📍3.0.2 | FHIR Std. |
| Immunization.practitioner.role | Base | extensible | Immunization Role Codes | 📍3.0.2 | FHIR Std. |
| Immunization.explanation.reason | Base | example | Immunization Reason Codes | 📍3.0.2 | FHIR Std. |
| Immunization.explanation.reasonNotGiven | Base | example | Immunization Reasons for Not Immunizing Codes | 📍3.0.2 | FHIR Std. |
| Immunization.vaccinationProtocol.targetDisease | Base | example | Vaccination Protocol Dose Target Codes | 📍3.0.2 | FHIR Std. |
| Immunization.vaccinationProtocol.doseStatus | Base | example | Vaccination Protocol Dose Status codes | 📍3.0.2 | FHIR Std. |
| Immunization.vaccinationProtocol.doseStatusReason | Base | example | Vaccination Protocol Dose Status Reason codes | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (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 | If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present |
(notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
|
| imm-2 | error | Immunization | If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent. |
(notGiven = true) or explanation.reasonNotGiven.empty()
|
This structure is derived from Immunization
Summary
Mandatory: 2 elements(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
