abstractbaseDefinitioncopyrightdate- Values Differ
descriptionexperimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisherpurposestatustitletypeurlversion- Values Differ
| Left: | WHO SMART Guidelines Immunization (http://smart.who.int/base-clinical/StructureDefinition/sg-immunization) |
| Right: | WHO SMART Guidelines Immunization (http://smart.who.int/base-clinical/StructureDefinition/sg-immunization) |
| Error | StructureDefinition.version | Values for version differ: '1.0.0' vs '1.0.1' |
| Information | StructureDefinition.date | Values for date differ: '2026-09-04T05:49:22+00:00' vs '2026-10-02T07:59:36+00:00' |
| Name | Value | Comments | |
|---|---|---|---|
| abstract | false | ||
| baseDefinition | http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-immunization | ||
| copyright | |||
| date | 2026-09-04T05:49:22+00:00 | 2026-10-02T07:59:36+00:00 |
|
| description | The WHO SMART Guidelines Immunization profile defines conformance requirements and exchange expectations for Immunization resources in WHO Smart Guidelines content. | ||
| experimental | false | ||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
| jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 | ||
| kind | resource | ||
| name | SGImmunization | ||
| publisher | WHO | ||
| purpose | |||
| status | draft | ||
| title | WHO SMART Guidelines Immunization | ||
| type | Immunization | ||
| url | http://smart.who.int/base-clinical/StructureDefinition/sg-immunization | ||
| version | 1.0.0 | 1.0.1 |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 Immunization | S | 0..* | CPGImmunization | Immunization event information | S | 0..* | CPGImmunization | Immunization event information | |||||||||
 id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
| language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | 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 | 0..* | Resource | Contained, inline Resources | |||||||||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
 identifier | S | 1..* | Identifier | Business identifier | S | 1..* | Identifier | Business identifier | |||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | |||||||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | Σ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||||||
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | SΣ | 1..1 | string | The value that is unique Example General: 123456 | |||||||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | Σ | 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) | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||||||
| status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required): A set of codes indicating the current status of an Immunization. | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required): A set of codes indicating the current status of an Immunization. | |||||||||
| statusReason | S | 0..1 | CodeableConcept | Reason not done Binding: ?? (example): The reason why a vaccine was not administered. | S | 0..1 | CodeableConcept | Reason not done Binding: ?? (example): The reason why a vaccine was not administered. | |||||||||
| vaccineCode | SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: ?? (example): The code for vaccine product administered. | SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: ?? (example): The code for vaccine product administered. | |||||||||
| patient | SΣ | 1..1 | Reference(WHO SMART Guidelines Patient) | Who was immunized | SΣ | 1..1 | Reference(WHO SMART Guidelines Patient) | Who was immunized | |||||||||
| encounter | S | 0..1 | Reference(WHO SMART Guidelines Encounter) | Encounter immunization was part of | S | 0..1 | Reference(WHO SMART Guidelines Encounter) | Encounter immunization was part of | |||||||||
| occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date | SΣ | 1..1 | dateTime | Vaccine administration date | |||||||||
| recorded | S | 1..1 | dateTime | When the immunization was first captured in the subject's record | S | 1..1 | dateTime | When the immunization was first captured in the subject's record | |||||||||
| primarySource | SΣ | 0..1 | boolean | Indicates context the data was recorded in | SΣ | 0..1 | boolean | Indicates context the data was recorded in | |||||||||
| reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ?? (example): The source of the data for a record which is not from a primary source. | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ?? (example): The source of the data for a record which is not from a primary source. | |||||||||||
| location | S | 0..1 | Reference(WHO SMART Guidelines Location) | Where immunization occurred | S | 0..1 | Reference(WHO SMART Guidelines Location) | Where immunization occurred | |||||||||
| manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||||||||
| lotNumber | 0..1 | string | Vaccine lot number | 0..1 | string | Vaccine lot number | |||||||||||
| expirationDate | 0..1 | date | Vaccine expiration date | 0..1 | date | Vaccine expiration date | |||||||||||
| site | S | 0..1 | CodeableConcept | Body site vaccine was administered Binding: ?? (example): The site at which the vaccine was administered. | S | 0..1 | CodeableConcept | Body site vaccine was administered Binding: ?? (example): The site at which the vaccine was administered. | |||||||||
| route | S | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered. | S | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered. | |||||||||
| doseQuantity | S | 0..1 | ?? | Amount of vaccine administered | S | 0..1 | ?? | Amount of vaccine administered | |||||||||
| performer | Σ | 0..* | BackboneElement | Who performed event | Σ | 0..* | BackboneElement | Who performed event | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event. | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event. | |||||||||
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | |||||||||
| note | Σ | 0..* | Annotation | Additional immunization notes | Σ | 0..* | Annotation | Additional immunization notes | |||||||||
| reasonCode | S | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered. | S | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered. | |||||||||
| reasonReference | S | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | S | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||||||
| isSubpotent | ?!SΣ | 0..1 | boolean | Dose potency | ?!SΣ | 0..1 | boolean | Dose potency | |||||||||
| subpotentReason | S | 0..* | CodeableConcept | Reason for being subpotent Binding: ?? (example): The reason why a dose is considered to be subpotent. | S | 0..* | CodeableConcept | Reason for being subpotent Binding: ?? (example): The reason why a dose is considered to be subpotent. | |||||||||
| education | C | 0..* | BackboneElement | Educational material presented to patient | C | 0..* | BackboneElement | Educational material presented to patient | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| documentType | 0..1 | string | Educational material document identifier | 0..1 | string | Educational material document identifier | |||||||||||
| reference | 0..1 | uri | Educational material reference pointer | 0..1 | uri | Educational material reference pointer | |||||||||||
| publicationDate | 0..1 | dateTime | Educational material publication date | 0..1 | dateTime | Educational material publication date | |||||||||||
| presentationDate | 0..1 | dateTime | Educational material presentation date | 0..1 | dateTime | Educational material presentation date | |||||||||||
| programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ?? (example): The patient's eligibility for a vaccation program. | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ?? (example): The patient's eligibility for a vaccation program. | |||||||||||
| fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ?? (example): The source of funding used to purchase the vaccine administered. | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ?? (example): The source of funding used to purchase the vaccine administered. | |||||||||||
| reaction | S | 0..* | BackboneElement | Details of a reaction that follows immunization | S | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| date | 0..1 | dateTime | When reaction started | 0..1 | dateTime | When reaction started | |||||||||||
| detail | S | 0..1 | Reference(WHO SMART Guidelines Observation) | Additional information on reaction | S | 0..1 | Reference(WHO SMART Guidelines Observation) | Additional information on reaction | |||||||||
| reported | 0..1 | boolean | Indicates self-reported reaction | 0..1 | boolean | Indicates self-reported reaction | |||||||||||
 protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | 0..* | BackboneElement | Protocol followed by the provider | |||||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| series | 0..1 | string | Name of vaccine series | 0..1 | string | Name of vaccine series | |||||||||||
| authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||||||||
| targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ?? (example): The vaccine preventable disease the dose is being administered for. | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ?? (example): The vaccine preventable disease the dose is being administered for. | |||||||||||
| doseNumber[x] | 1..1 | positiveInt, string | Dose number within series | 1..1 | positiveInt, string | Dose number within series | |||||||||||
| seriesDoses[x] | 0..1 | positiveInt, string | Recommended number of doses for immunity | 0..1 | positiveInt, string | Recommended number of doses for immunity | |||||||||||
| Documentation for this format | |||||||||||||||||