Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/1.0/StructureDefinition/profile-Immunization | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R2_Immunization_R4B | ||
This cross-version profile allows DSTU2 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.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Immunization |
0..* | Immunization(4.3.0) | Immunization event information | |
  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 Constraints: ext-1 | |
   extension:reported |
1..1 | boolean | DSTU2: Indicates a self-reported record (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.reported Constraints: ext-1 | |
 Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 |
| modifierExtension:wasNotGiven |
?! | 0..1 | boolean | DSTU2: Flag for whether immunization was given additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.wasNotGiven Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
 extension:status |
0..1 | code | DSTU2: in-progress | on-hold | completed | entered-in-error | stopped additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.status Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization Constraints: ext-1 | |
 vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example) |
 patient |
Σ | 1..1 | Reference(Patient) | Who was immunized |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:patient |
0..1 | Reference(Resource) | DSTU2: patient additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |
 occurrence[x] |
Σ | 1..1 | Vaccine administration date | |
| occurrenceDateTime |
dateTime | |||
 occurrenceString |
string | |||
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency |
| Documentation for this format | ||||
| 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:reported, Immunization.modifierExtension, Immunization.modifierExtension:wasNotGiven, Immunization.status, Immunization.status.extension, Immunization.status.extension:status, Immunization.vaccineCode, Immunization.patient, Immunization.patient.extension, Immunization.patient.extension: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:reported, Immunization.modifierExtension, Immunization.modifierExtension:wasNotGiven, Immunization.status.extension, Immunization.status.extension:status, Immunization.patient.extension, Immunization.patient.extension:patient | 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 | ||||
| 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:meta |
0..1 | (Complex) | DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| 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 | |||||
| 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:text |
0..1 | (Complex) | DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:reported |
1..1 | boolean | DSTU2: Indicates a self-reported record (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.reported Constraints: ext-1 | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| modifierExtension:wasNotGiven |
?! | 0..1 | boolean | DSTU2: Flag for whether immunization was given additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.wasNotGiven Constraints: ext-1 | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| 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:identifier |
0..* | Identifier | DSTU2: identifier additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:status |
0..1 | code | DSTU2: in-progress | on-hold | completed | entered-in-error | stopped additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.status Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| 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 | ||||
| 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:patient |
0..1 | Reference(Resource) | DSTU2: patient additional types 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 | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| 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:encounter |
0..1 | Reference(Resource) | DSTU2: Encounter administered as part of additional types 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 | ||||
| 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 | |||||
| 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:location |
0..1 | Reference(Resource) | DSTU2: Where vaccination occurred additional types 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 | ||||
| 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 | Reference(Resource) | DSTU2: manufacturer additional types 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 | ||||
| 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:performer |
0..1 | Reference(Resource) | DSTU2: Who administered vaccine additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| extension:requester |
0..1 | Reference(Resource) | DSTU2: Who ordered vaccination additional types 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 | ||||
| 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:note |
0..* | Annotation | DSTU2: Vaccination notes additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.note Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| 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) | |||||
| 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 | |||||
| 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:detail |
0..1 | Reference(Resource) | DSTU2: detail additional types 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 | ||||
| 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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:description |
0..1 | string | DSTU2: Details of vaccine protocol (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.vaccinationProtocol.description Constraints: ext-1 | |||||
| extension:doseStatus |
1..1 | CodeableConcept | DSTU2: Indicates if dose counts towards immunity (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.vaccinationProtocol.doseStatus Binding: R2VaccinationProtocolDoseStatusForR4B (0.1.0) (example): The status of the vaccination protocol (i.e. should this count) Constraints: ext-1 | |||||
| extension:doseStatusReason |
0..1 | CodeableConcept | DSTU2: Why dose does (not) count (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.vaccinationProtocol.doseStatusReason Binding: R2VaccinationProtocolDoseStatusReasonForR4B (0.1.0) (example): The reason for the determining if a vaccination should count or why vaccination should not count. 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 | |||||
| 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:authority |
0..1 | Reference(Resource) | DSTU2: Who is responsible for protocol additional types 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 | ||||
| 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.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Immunization.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| Immunization.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Immunization.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Immunization.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| Immunization.identifier.type | Base | extensible | IdentifierType | 📍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.patient.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Immunization.encounter.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.3.0 | FHIR Std. |
| Immunization.location.type | Base | extensible | ResourceType | 📍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.reaction.detail.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Immunization.protocolApplied.authority.type | Base | extensible | ResourceType | 📍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.meta.extension, Immunization.meta.extension:meta, Immunization.meta.versionId, Immunization.meta.lastUpdated, Immunization.meta.source, Immunization.meta.profile, Immunization.meta.security, Immunization.meta.tag, Immunization.implicitRules, Immunization.language, Immunization.text, Immunization.text.extension, Immunization.text.extension:text, Immunization.text.status, Immunization.text.div, Immunization.extension, Immunization.extension:reported, Immunization.modifierExtension, Immunization.modifierExtension:wasNotGiven, Immunization.identifier, Immunization.identifier.extension, Immunization.identifier.extension:identifier, Immunization.identifier.use, Immunization.identifier.type, Immunization.identifier.system, Immunization.identifier.value, Immunization.identifier.period, Immunization.identifier.assigner, Immunization.status, Immunization.status.extension, Immunization.status.extension:status, Immunization.statusReason, Immunization.vaccineCode, Immunization.patient, Immunization.patient.extension, Immunization.patient.extension:patient, Immunization.patient.reference, Immunization.patient.type, Immunization.patient.identifier, Immunization.patient.display, Immunization.encounter, Immunization.encounter.extension, Immunization.encounter.extension:encounter, Immunization.encounter.reference, Immunization.encounter.type, Immunization.encounter.identifier, Immunization.encounter.display, Immunization.occurrence[x], Immunization.recorded, Immunization.primarySource, Immunization.reportOrigin, Immunization.location, Immunization.location.extension, Immunization.location.extension:location, Immunization.location.reference, Immunization.location.type, Immunization.location.identifier, Immunization.location.display, 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:performer, Immunization.performer.actor.extension:requester, Immunization.performer.actor.reference, Immunization.performer.actor.type, Immunization.performer.actor.identifier, Immunization.performer.actor.display, Immunization.note, Immunization.note.extension, Immunization.note.extension:note, Immunization.note.author[x], Immunization.note.time, Immunization.note.text, 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.fundingSource, Immunization.reaction, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.reaction.date, Immunization.reaction.detail, Immunization.reaction.detail.extension, Immunization.reaction.detail.extension:detail, Immunization.reaction.detail.reference, Immunization.reaction.detail.type, Immunization.reaction.detail.identifier, Immunization.reaction.detail.display, Immunization.reaction.reported, Immunization.protocolApplied, Immunization.protocolApplied.extension, Immunization.protocolApplied.extension:description, Immunization.protocolApplied.extension:doseStatus, Immunization.protocolApplied.extension:doseStatusReason, Immunization.protocolApplied.modifierExtension, Immunization.protocolApplied.series, Immunization.protocolApplied.authority, Immunization.protocolApplied.authority.extension, Immunization.protocolApplied.authority.extension:authority, Immunization.protocolApplied.authority.reference, Immunization.protocolApplied.authority.type, Immunization.protocolApplied.authority.identifier, Immunization.protocolApplied.authority.display, 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.meta.extension, Immunization.meta.extension:meta, Immunization.text.extension, Immunization.text.extension:text, Immunization.extension, Immunization.extension:reported, Immunization.modifierExtension, Immunization.modifierExtension:wasNotGiven, Immunization.identifier.extension, Immunization.identifier.extension:identifier, Immunization.status.extension, Immunization.status.extension:status, Immunization.patient.extension, Immunization.patient.extension:patient, Immunization.encounter.extension, Immunization.encounter.extension:encounter, Immunization.location.extension, Immunization.location.extension:location, Immunization.manufacturer.extension, Immunization.manufacturer.extension:manufacturer, Immunization.performer.extension, Immunization.performer.modifierExtension, Immunization.performer.actor.extension, Immunization.performer.actor.extension:performer, Immunization.performer.actor.extension:requester, Immunization.note.extension, Immunization.note.extension:note, Immunization.education.extension, Immunization.education.modifierExtension, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.reaction.detail.extension, Immunization.reaction.detail.extension:detail, Immunization.protocolApplied.extension, Immunization.protocolApplied.extension:description, Immunization.protocolApplied.extension:doseStatus, Immunization.protocolApplied.extension:doseStatusReason, Immunization.protocolApplied.modifierExtension, Immunization.protocolApplied.authority.extension, Immunization.protocolApplied.authority.extension:authority | 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()
|
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 |
0..* | Immunization(4.3.0) | Immunization event information | |
| 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 Constraints: ext-1 | |
| extension:reported |
1..1 | boolean | DSTU2: Indicates a self-reported record (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.reported Constraints: ext-1 | |
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 |
| modifierExtension:wasNotGiven |
?! | 0..1 | boolean | DSTU2: Flag for whether immunization was given additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.wasNotGiven Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:status |
0..1 | code | DSTU2: in-progress | on-hold | completed | entered-in-error | stopped additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.status Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization Constraints: ext-1 | |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example) |
| patient |
Σ | 1..1 | Reference(Patient) | Who was immunized |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:patient |
0..1 | Reference(Resource) | DSTU2: patient additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |
| occurrence[x] |
Σ | 1..1 | Vaccine administration date | |
| occurrenceDateTime |
dateTime | |||
| occurrenceString |
string | |||
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency |
| Documentation for this format | ||||
| 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:reported, Immunization.modifierExtension, Immunization.modifierExtension:wasNotGiven, Immunization.status, Immunization.status.extension, Immunization.status.extension:status, Immunization.vaccineCode, Immunization.patient, Immunization.patient.extension, Immunization.patient.extension: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:reported, Immunization.modifierExtension, Immunization.modifierExtension:wasNotGiven, Immunization.status.extension, Immunization.status.extension:status, Immunization.patient.extension, Immunization.patient.extension:patient | 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 | ||||
| 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:meta |
0..1 | (Complex) | DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| 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 | |||||
| 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:text |
0..1 | (Complex) | DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:reported |
1..1 | boolean | DSTU2: Indicates a self-reported record (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.reported Constraints: ext-1 | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| modifierExtension:wasNotGiven |
?! | 0..1 | boolean | DSTU2: Flag for whether immunization was given additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.wasNotGiven Constraints: ext-1 | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| 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:identifier |
0..* | Identifier | DSTU2: identifier additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:status |
0..1 | code | DSTU2: in-progress | on-hold | completed | entered-in-error | stopped additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.status Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| 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 | ||||
| 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:patient |
0..1 | Reference(Resource) | DSTU2: patient additional types 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 | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| 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:encounter |
0..1 | Reference(Resource) | DSTU2: Encounter administered as part of additional types 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 | ||||
| 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 | |||||
| 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:location |
0..1 | Reference(Resource) | DSTU2: Where vaccination occurred additional types 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 | ||||
| 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 | Reference(Resource) | DSTU2: manufacturer additional types 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 | ||||
| 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:performer |
0..1 | Reference(Resource) | DSTU2: Who administered vaccine additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| extension:requester |
0..1 | Reference(Resource) | DSTU2: Who ordered vaccination additional types 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 | ||||
| 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:note |
0..* | Annotation | DSTU2: Vaccination notes additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.note Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| 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) | |||||
| 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 | |||||
| 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:detail |
0..1 | Reference(Resource) | DSTU2: detail additional types 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 | ||||
| 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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:description |
0..1 | string | DSTU2: Details of vaccine protocol (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.vaccinationProtocol.description Constraints: ext-1 | |||||
| extension:doseStatus |
1..1 | CodeableConcept | DSTU2: Indicates if dose counts towards immunity (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.vaccinationProtocol.doseStatus Binding: R2VaccinationProtocolDoseStatusForR4B (0.1.0) (example): The status of the vaccination protocol (i.e. should this count) Constraints: ext-1 | |||||
| extension:doseStatusReason |
0..1 | CodeableConcept | DSTU2: Why dose does (not) count (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Immunization.vaccinationProtocol.doseStatusReason Binding: R2VaccinationProtocolDoseStatusReasonForR4B (0.1.0) (example): The reason for the determining if a vaccination should count or why vaccination should not count. 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 | |||||
| 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:authority |
0..1 | Reference(Resource) | DSTU2: Who is responsible for protocol additional types 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 | ||||
| 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.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Immunization.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| Immunization.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Immunization.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Immunization.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| Immunization.identifier.type | Base | extensible | IdentifierType | 📍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.patient.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Immunization.encounter.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.3.0 | FHIR Std. |
| Immunization.location.type | Base | extensible | ResourceType | 📍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.reaction.detail.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Immunization.protocolApplied.authority.type | Base | extensible | ResourceType | 📍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.meta.extension, Immunization.meta.extension:meta, Immunization.meta.versionId, Immunization.meta.lastUpdated, Immunization.meta.source, Immunization.meta.profile, Immunization.meta.security, Immunization.meta.tag, Immunization.implicitRules, Immunization.language, Immunization.text, Immunization.text.extension, Immunization.text.extension:text, Immunization.text.status, Immunization.text.div, Immunization.extension, Immunization.extension:reported, Immunization.modifierExtension, Immunization.modifierExtension:wasNotGiven, Immunization.identifier, Immunization.identifier.extension, Immunization.identifier.extension:identifier, Immunization.identifier.use, Immunization.identifier.type, Immunization.identifier.system, Immunization.identifier.value, Immunization.identifier.period, Immunization.identifier.assigner, Immunization.status, Immunization.status.extension, Immunization.status.extension:status, Immunization.statusReason, Immunization.vaccineCode, Immunization.patient, Immunization.patient.extension, Immunization.patient.extension:patient, Immunization.patient.reference, Immunization.patient.type, Immunization.patient.identifier, Immunization.patient.display, Immunization.encounter, Immunization.encounter.extension, Immunization.encounter.extension:encounter, Immunization.encounter.reference, Immunization.encounter.type, Immunization.encounter.identifier, Immunization.encounter.display, Immunization.occurrence[x], Immunization.recorded, Immunization.primarySource, Immunization.reportOrigin, Immunization.location, Immunization.location.extension, Immunization.location.extension:location, Immunization.location.reference, Immunization.location.type, Immunization.location.identifier, Immunization.location.display, 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:performer, Immunization.performer.actor.extension:requester, Immunization.performer.actor.reference, Immunization.performer.actor.type, Immunization.performer.actor.identifier, Immunization.performer.actor.display, Immunization.note, Immunization.note.extension, Immunization.note.extension:note, Immunization.note.author[x], Immunization.note.time, Immunization.note.text, 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.fundingSource, Immunization.reaction, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.reaction.date, Immunization.reaction.detail, Immunization.reaction.detail.extension, Immunization.reaction.detail.extension:detail, Immunization.reaction.detail.reference, Immunization.reaction.detail.type, Immunization.reaction.detail.identifier, Immunization.reaction.detail.display, Immunization.reaction.reported, Immunization.protocolApplied, Immunization.protocolApplied.extension, Immunization.protocolApplied.extension:description, Immunization.protocolApplied.extension:doseStatus, Immunization.protocolApplied.extension:doseStatusReason, Immunization.protocolApplied.modifierExtension, Immunization.protocolApplied.series, Immunization.protocolApplied.authority, Immunization.protocolApplied.authority.extension, Immunization.protocolApplied.authority.extension:authority, Immunization.protocolApplied.authority.reference, Immunization.protocolApplied.authority.type, Immunization.protocolApplied.authority.identifier, Immunization.protocolApplied.authority.display, 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.meta.extension, Immunization.meta.extension:meta, Immunization.text.extension, Immunization.text.extension:text, Immunization.extension, Immunization.extension:reported, Immunization.modifierExtension, Immunization.modifierExtension:wasNotGiven, Immunization.identifier.extension, Immunization.identifier.extension:identifier, Immunization.status.extension, Immunization.status.extension:status, Immunization.patient.extension, Immunization.patient.extension:patient, Immunization.encounter.extension, Immunization.encounter.extension:encounter, Immunization.location.extension, Immunization.location.extension:location, Immunization.manufacturer.extension, Immunization.manufacturer.extension:manufacturer, Immunization.performer.extension, Immunization.performer.modifierExtension, Immunization.performer.actor.extension, Immunization.performer.actor.extension:performer, Immunization.performer.actor.extension:requester, Immunization.note.extension, Immunization.note.extension:note, Immunization.education.extension, Immunization.education.modifierExtension, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.reaction.detail.extension, Immunization.reaction.detail.extension:detail, Immunization.protocolApplied.extension, Immunization.protocolApplied.extension:description, Immunization.protocolApplied.extension:doseStatus, Immunization.protocolApplied.extension:doseStatusReason, Immunization.protocolApplied.modifierExtension, Immunization.protocolApplied.authority.extension, Immunization.protocolApplied.authority.extension:authority | 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()
|
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-r2.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
