Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4B - 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_R4B | ||
This cross-version profile allows R5 Immunization content to be represented via FHIR R4B 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.
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.3.0 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.3.0 | FHIR Std. |
| 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.exists() and ('#'+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(uri) = '#').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 | Immunization.implicitRules, Immunization.extension, Immunization.extension:basedOn, Immunization.extension:administeredProduct, Immunization.extension:supportingInformation, Immunization.extension:informationSource, Immunization.extension:reason, Immunization.modifierExtension, Immunization.status, Immunization.vaccineCode, Immunization.patient, Immunization.occurrence[x], Immunization.isSubpotent | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Immunization.extension, Immunization.extension:basedOn, Immunization.extension:administeredProduct, Immunization.extension:supportingInformation, Immunization.extension:informationSource, Immunization.extension:reason, Immunization.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  Immunization |
0..* | Immunization(4.3.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): IETF language tag
| |||||
| 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 Constraints: dom-r4b | |||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
   extension:basedOn |
0..* | Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4B(0.1.0) | CarePlan | Cross-version Profile for R5.MedicationRequest for use in FHIR R4B(0.1.0) | MedicationRequest | Cross-version Profile for R5.ServiceRequest for use in FHIR R4B(0.1.0) | ServiceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4B(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 Constraints: ext-1 | |||||
| extension:administeredProduct |
0..1 | CodeableReference(Cross-version Profile for R5.Medication for use in FHIR R4B(0.1.0) | Medication) | R5: Product that was administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct Constraints: ext-1 | |||||
| extension:supportingInformation |
0..* | Reference(Cross-version Profile for R5.Resource for use in FHIR R4B(0.1.0) | Resource) | R5: Additional information in support of the immunization (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.supportingInformation Constraints: ext-1 | |||||
| extension:informationSource |
0..1 | CodeableReference(Cross-version Profile for R5.Patient for use in FHIR R4B(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4B(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4B(0.1.0) | PractitionerRole | Cross-version Profile for R5.RelatedPerson for use in FHIR R4B(0.1.0) | RelatedPerson | Cross-version Profile for R5.Organization for use in FHIR R4B(0.1.0) | Organization) | R5: Indicates the source of a reported record (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource Binding: ImmunizationOriginCodes (example): x Constraints: ext-1 | |||||
 extension:reason |
0..* | CodeableReference(Cross-version Profile for R5.Condition for use in FHIR R4B(0.1.0) | Condition | Cross-version Profile for R5.Observation for use in FHIR R4B(0.1.0) | Observation | Cross-version Profile for R5.DiagnosticReport for use in FHIR R4B(0.1.0) | DiagnosticReport) | R5: Why immunization occurred additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.reason Constraints: ext-1 | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) | ||||
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example) | |||||
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example) | ||||
 patient |
Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
 occurrence[x] |
Σ | 1..1 | Vaccine administration date | |||||
| occurrenceDateTime |
dateTime | |||||||
 occurrenceString |
string | |||||||
| 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) | |||||
| location |
0..1 | Reference(Location) | Where immunization occurred | |||||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:manufacturer |
0..1 | CodeableConcept | R5: manufacturer additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.manufacturer Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| 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: CodesForImmunizationSiteOfAdministration (example) | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example) | |||||
| doseQuantity |
0..1 | SimpleQuantity(4.3.0) | 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible) | ||||
 actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
 id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:actor |
0..1 | Reference(Resource) | R5: actor URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| note |
Σ | 0..* | Annotation | Additional immunization notes | ||||
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example) | |||||
| 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 Constraints: imm-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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) | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:program |
1..1 | CodeableConcept | R5: The program that eligibility is declared for (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.programEligibility.program Constraints: ext-1 | |||||
| extension:programStatus |
1..1 | CodeableConcept | R5: The patient's eligibility status for the program (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.programEligibility.programStatus Binding: ImmunizationProgramEligibility (example): x Constraints: ext-1 | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| fundingSource |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example) | |||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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) | |||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.3.0 | FHIR Std. |
| Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📍4.3.0 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.3.0 | FHIR Std. |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.3.0 | FHIR Std. |
| Immunization.manufacturer.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📍4.3.0 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📍4.3.0 | FHIR Std. |
| Immunization.performer.function | Base | extensible | Immunization Function Codes | 📍4.3.0 | FHIR Std. |
| Immunization.performer.actor.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Immunization.reasonCode | Base | example | Immunization Reason Codes | 📍4.3.0 | FHIR Std. |
| Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📍4.3.0 | FHIR Std. |
| Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📍4.3.0 | FHIR Std. |
| Immunization.fundingSource | Base | example | Immunization Funding Source | 📍4.3.0 | FHIR Std. |
| Immunization.protocolApplied.targetDisease | Base | example | Immunization Target Disease Codes | 📍4.3.0 | FHIR Std. |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | Immunization.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | Immunization.meta, Immunization.implicitRules, Immunization.language, Immunization.text, Immunization.extension, Immunization.extension:basedOn, Immunization.extension:administeredProduct, Immunization.extension:supportingInformation, Immunization.extension:informationSource, Immunization.extension:reason, Immunization.modifierExtension, Immunization.identifier, Immunization.status, Immunization.statusReason, Immunization.vaccineCode, Immunization.patient, Immunization.encounter, Immunization.occurrence[x], Immunization.recorded, Immunization.primarySource, Immunization.reportOrigin, Immunization.location, Immunization.manufacturer, Immunization.manufacturer.extension, Immunization.manufacturer.extension:manufacturer, Immunization.manufacturer.reference, Immunization.manufacturer.type, Immunization.manufacturer.identifier, Immunization.manufacturer.display, Immunization.lotNumber, Immunization.expirationDate, Immunization.site, Immunization.route, Immunization.doseQuantity, Immunization.performer, Immunization.performer.extension, Immunization.performer.modifierExtension, Immunization.performer.function, Immunization.performer.actor, Immunization.performer.actor.extension, Immunization.performer.actor.extension:actor, Immunization.performer.actor.reference, Immunization.performer.actor.type, Immunization.performer.actor.identifier, Immunization.performer.actor.display, Immunization.note, Immunization.reasonCode, Immunization.reasonReference, Immunization.isSubpotent, Immunization.subpotentReason, Immunization.education, Immunization.education.extension, Immunization.education.modifierExtension, Immunization.education.documentType, Immunization.education.reference, Immunization.education.publicationDate, Immunization.education.presentationDate, Immunization.programEligibility, Immunization.programEligibility.extension, Immunization.programEligibility.extension:program, Immunization.programEligibility.extension:programStatus, Immunization.programEligibility.coding, Immunization.programEligibility.text, Immunization.fundingSource, Immunization.reaction, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.reaction.date, Immunization.reaction.detail, Immunization.reaction.reported, Immunization.protocolApplied, Immunization.protocolApplied.extension, Immunization.protocolApplied.modifierExtension, Immunization.protocolApplied.series, Immunization.protocolApplied.authority, Immunization.protocolApplied.targetDisease, Immunization.protocolApplied.doseNumber[x], Immunization.protocolApplied.seriesDoses[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Immunization.extension, Immunization.extension:basedOn, Immunization.extension:administeredProduct, Immunization.extension:supportingInformation, Immunization.extension:informationSource, Immunization.extension:reason, Immunization.modifierExtension, Immunization.manufacturer.extension, Immunization.manufacturer.extension:manufacturer, Immunization.performer.extension, Immunization.performer.modifierExtension, Immunization.performer.actor.extension, Immunization.performer.actor.extension:actor, Immunization.education.extension, Immunization.education.modifierExtension, Immunization.programEligibility.extension, Immunization.programEligibility.extension:program, Immunization.programEligibility.extension:programStatus, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.protocolApplied.extension, Immunization.protocolApplied.modifierExtension | 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: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.3.0 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.3.0 | FHIR Std. |
| 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.exists() and ('#'+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(uri) = '#').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 | Immunization.implicitRules, Immunization.extension, Immunization.extension:basedOn, Immunization.extension:administeredProduct, Immunization.extension:supportingInformation, Immunization.extension:informationSource, Immunization.extension:reason, Immunization.modifierExtension, Immunization.status, Immunization.vaccineCode, Immunization.patient, Immunization.occurrence[x], Immunization.isSubpotent | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Immunization.extension, Immunization.extension:basedOn, Immunization.extension:administeredProduct, Immunization.extension:supportingInformation, Immunization.extension:informationSource, Immunization.extension:reason, Immunization.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Immunization
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | Immunization(4.3.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): IETF language tag
| |||||
| 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 Constraints: dom-r4b | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:basedOn |
0..* | Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4B(0.1.0) | CarePlan | Cross-version Profile for R5.MedicationRequest for use in FHIR R4B(0.1.0) | MedicationRequest | Cross-version Profile for R5.ServiceRequest for use in FHIR R4B(0.1.0) | ServiceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4B(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 Constraints: ext-1 | |||||
| extension:administeredProduct |
0..1 | CodeableReference(Cross-version Profile for R5.Medication for use in FHIR R4B(0.1.0) | Medication) | R5: Product that was administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct Constraints: ext-1 | |||||
| extension:supportingInformation |
0..* | Reference(Cross-version Profile for R5.Resource for use in FHIR R4B(0.1.0) | Resource) | R5: Additional information in support of the immunization (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.supportingInformation Constraints: ext-1 | |||||
| extension:informationSource |
0..1 | CodeableReference(Cross-version Profile for R5.Patient for use in FHIR R4B(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4B(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4B(0.1.0) | PractitionerRole | Cross-version Profile for R5.RelatedPerson for use in FHIR R4B(0.1.0) | RelatedPerson | Cross-version Profile for R5.Organization for use in FHIR R4B(0.1.0) | Organization) | R5: Indicates the source of a reported record (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource Binding: ImmunizationOriginCodes (example): x Constraints: ext-1 | |||||
| extension:reason |
0..* | CodeableReference(Cross-version Profile for R5.Condition for use in FHIR R4B(0.1.0) | Condition | Cross-version Profile for R5.Observation for use in FHIR R4B(0.1.0) | Observation | Cross-version Profile for R5.DiagnosticReport for use in FHIR R4B(0.1.0) | DiagnosticReport) | R5: Why immunization occurred additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.reason Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) | ||||
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example) | |||||
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example) | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| occurrence[x] |
Σ | 1..1 | Vaccine administration date | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrenceString |
string | |||||||
| 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) | |||||
| location |
0..1 | Reference(Location) | Where immunization occurred | |||||
| manufacturer |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:manufacturer |
0..1 | CodeableConcept | R5: manufacturer additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.manufacturer Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| 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: CodesForImmunizationSiteOfAdministration (example) | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example) | |||||
| doseQuantity |
0..1 | SimpleQuantity(4.3.0) | 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible) | ||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:actor |
0..1 | Reference(Resource) | R5: actor URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| note |
Σ | 0..* | Annotation | Additional immunization notes | ||||
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example) | |||||
| 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 Constraints: imm-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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) | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:program |
1..1 | CodeableConcept | R5: The program that eligibility is declared for (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.programEligibility.program Constraints: ext-1 | |||||
| extension:programStatus |
1..1 | CodeableConcept | R5: The patient's eligibility status for the program (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.programEligibility.programStatus Binding: ImmunizationProgramEligibility (example): x Constraints: ext-1 | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| fundingSource |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example) | |||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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) | |||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.3.0 | FHIR Std. |
| Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📍4.3.0 | FHIR Std. |
| Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.3.0 | FHIR Std. |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.3.0 | FHIR Std. |
| Immunization.manufacturer.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Immunization.site | Base | example | Codes for Immunization Site of Administration | 📍4.3.0 | FHIR Std. |
| Immunization.route | Base | example | Immunization Route Codes | 📍4.3.0 | FHIR Std. |
| Immunization.performer.function | Base | extensible | Immunization Function Codes | 📍4.3.0 | FHIR Std. |
| Immunization.performer.actor.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Immunization.reasonCode | Base | example | Immunization Reason Codes | 📍4.3.0 | FHIR Std. |
| Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📍4.3.0 | FHIR Std. |
| Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📍4.3.0 | FHIR Std. |
| Immunization.fundingSource | Base | example | Immunization Funding Source | 📍4.3.0 | FHIR Std. |
| Immunization.protocolApplied.targetDisease | Base | example | Immunization Target Disease Codes | 📍4.3.0 | FHIR Std. |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | Immunization.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | Immunization.meta, Immunization.implicitRules, Immunization.language, Immunization.text, Immunization.extension, Immunization.extension:basedOn, Immunization.extension:administeredProduct, Immunization.extension:supportingInformation, Immunization.extension:informationSource, Immunization.extension:reason, Immunization.modifierExtension, Immunization.identifier, Immunization.status, Immunization.statusReason, Immunization.vaccineCode, Immunization.patient, Immunization.encounter, Immunization.occurrence[x], Immunization.recorded, Immunization.primarySource, Immunization.reportOrigin, Immunization.location, Immunization.manufacturer, Immunization.manufacturer.extension, Immunization.manufacturer.extension:manufacturer, Immunization.manufacturer.reference, Immunization.manufacturer.type, Immunization.manufacturer.identifier, Immunization.manufacturer.display, Immunization.lotNumber, Immunization.expirationDate, Immunization.site, Immunization.route, Immunization.doseQuantity, Immunization.performer, Immunization.performer.extension, Immunization.performer.modifierExtension, Immunization.performer.function, Immunization.performer.actor, Immunization.performer.actor.extension, Immunization.performer.actor.extension:actor, Immunization.performer.actor.reference, Immunization.performer.actor.type, Immunization.performer.actor.identifier, Immunization.performer.actor.display, Immunization.note, Immunization.reasonCode, Immunization.reasonReference, Immunization.isSubpotent, Immunization.subpotentReason, Immunization.education, Immunization.education.extension, Immunization.education.modifierExtension, Immunization.education.documentType, Immunization.education.reference, Immunization.education.publicationDate, Immunization.education.presentationDate, Immunization.programEligibility, Immunization.programEligibility.extension, Immunization.programEligibility.extension:program, Immunization.programEligibility.extension:programStatus, Immunization.programEligibility.coding, Immunization.programEligibility.text, Immunization.fundingSource, Immunization.reaction, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.reaction.date, Immunization.reaction.detail, Immunization.reaction.reported, Immunization.protocolApplied, Immunization.protocolApplied.extension, Immunization.protocolApplied.modifierExtension, Immunization.protocolApplied.series, Immunization.protocolApplied.authority, Immunization.protocolApplied.targetDisease, Immunization.protocolApplied.doseNumber[x], Immunization.protocolApplied.seriesDoses[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Immunization.extension, Immunization.extension:basedOn, Immunization.extension:administeredProduct, Immunization.extension:supportingInformation, Immunization.extension:informationSource, Immunization.extension:reason, Immunization.modifierExtension, Immunization.manufacturer.extension, Immunization.manufacturer.extension:manufacturer, Immunization.performer.extension, Immunization.performer.modifierExtension, Immunization.performer.actor.extension, Immunization.performer.actor.extension:actor, Immunization.education.extension, Immunization.education.modifierExtension, Immunization.programEligibility.extension, Immunization.programEligibility.extension:program, Immunization.programEligibility.extension:programStatus, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.protocolApplied.extension, Immunization.protocolApplied.modifierExtension | 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: 0 element(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.r4b#0.1.0 based on FHIR 4.3.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
