WHO Immunization Implementation Guide, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-immunizations/ and changes regularly. See the Directory of published versions
Resource Profile: SMART Guidelines Immunizations Immunization
| Official URL: http://smart.who.int/immunizations/StructureDefinition/IMMZ.Immunization | Version: 0.2.0 | |||
| Draft as of 2025-01-16 | Computable Name: IMMZImmunization | |||
Immunization Profile for the Immunizations SMART Guidelines. From IMMZ.D Administer Vaccine
Usages:
- Refer to this Profile: SMART Guidelines Immunizations Observation
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Immunization.extension:typeOfPolio.value[x] | required | IMMZ_D_DE212http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212From this IG | |
| Immunization.extension:typeOfJe.value[x] | required | IMMZ_D_DE216http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216From this IG | |
| Immunization.extension:typeOfTbe.value[x] | required | IMMZ_D_DE220http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220From this IG | |
| Immunization.extension:typeOfTyphoid.value[x] | required | IMMZ_D_DE225http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225From this IG | |
| Immunization.extension:typeOfCholera.value[x] | required | IMMZ_D_DE229http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229From this IG | |
| Immunization.extension:typeOfMeningococcal.value[x] | required | IMMZ_D_DE229http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229From this IG | |
| Immunization.extension:typeOfHepatitisA.value[x] | required | IMMZ_D_DE237http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237From this IG | |
| Immunization.extension:typeOfHepatitisB.value[x] | required | IMMZ_D_DE254http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254From this IG | |
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1From the FHIR Standard | |
| Immunization.statusReason | required | IMMZ_D_DE5http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5From this IG | |
| Immunization.vaccineCode | required | IMMZ_Z_VShttp://smart.who.int/immunizations/ValueSet/IMMZ.Z.VSFrom this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Immunization
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| Immunization.extension:typeOfPolio.value[x] | required | IMMZ_D_DE212http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212From this IG | |
| Immunization.extension:typeOfJe.value[x] | required | IMMZ_D_DE216http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216From this IG | |
| Immunization.extension:typeOfTbe.value[x] | required | IMMZ_D_DE220http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220From this IG | |
| Immunization.extension:typeOfTyphoid.value[x] | required | IMMZ_D_DE225http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225From this IG | |
| Immunization.extension:typeOfCholera.value[x] | required | IMMZ_D_DE229http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229From this IG | |
| Immunization.extension:typeOfMeningococcal.value[x] | required | IMMZ_D_DE229http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229From this IG | |
| Immunization.extension:typeOfHepatitisA.value[x] | required | IMMZ_D_DE237http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237From this IG | |
| Immunization.extension:typeOfHepatitisB.value[x] | required | IMMZ_D_DE254http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254From this IG | |
| Immunization.statusReason | required | IMMZ_D_DE5http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5From this IG | |
| Immunization.vaccineCode | required | IMMZ_Z_VShttp://smart.who.int/immunizations/ValueSet/IMMZ.Z.VSFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  Immunization |
0..* | Immunization | Immunization event information | |||||
  id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
  Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
   extension:typeOfPolio |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
  id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
 value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required) | |||||
| extension:typeOfJe |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE216 ValueSet for Type of JE dose (required) | |||||
| extension:typeOfTbe |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE220 ValueSet for Type of TBE dose (required) | |||||
| extension:typeOfTyphoid |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE225 ValueSet for Type of typhoid dose (required) | |||||
| extension:typeOfCholera |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required) | |||||
| extension:typeOfMeningococcal |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required) | |||||
| extension:typeOfHepatitisA |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required) | |||||
| extension:typeOfHepatitisB |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required) | |||||
 extension:vaccineBrand |
1..1 | CodeableConcept | Immunization Vaccine Brand URL: http://smart.who.int/immunizations/StructureDefinition/IMMZVaccineBrand Binding: IMMZ.D.DE18 ValueSet for Vaccine brand (example) | |||||
| extension:liveVaccine |
0..1 | boolean | Immunization Live Vaccine URL: http://smart.who.int/immunizations/StructureDefinition/IMMZLiveVaccine | |||||
 extension:marketAuthorizationHolder |
1..1 | CodeableConcept | Immunization Market Authorization Holder URL: http://smart.who.int/immunizations/StructureDefinition/IMMZMarketAuthorization Binding: IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example) | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: IMMZ.D.DE5 ValueSet for Reason vaccine was not administered (required) | |||||
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: IMMZ.Z.VS ValueSet for vaccine types (required) | ||||
 patient |
Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date | ||||
| 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): The source of the data for a record which is not from a primary source. | |||||
| location |
0..1 | Reference(Location) | Where immunization occurred | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:countryOfVaccination |
1..1 | CodeableConcept | Immunization Country of Vaccination URL: http://smart.who.int/immunizations/StructureDefinition/IMMZCountryOfVaccination Binding: Iso3166-1-3 (required) | |||||
| extension:administrativeArea |
0..1 | CodeableConcept | Immunization Administrative Area URL: http://smart.who.int/immunizations/StructureDefinition/IMMZAdministrativeArea | |||||
| 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): Aa resource (or, for logical models, the URI of the logical model). | ||||
| 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 | |||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
| doseQuantity |
0..1 | SimpleQuantity | Amount of vaccine administered | |||||
| performer |
Σ | 0..* | BackboneElement | Who performed event | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (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 | ||||
| note |
Σ | 0..* | Annotation | Additional immunization notes | ||||
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency | ||||
| subpotentReason |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
| education |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| documentType |
0..1 | string | Educational material document identifier | |||||
| reference |
0..1 | uri | Educational material reference pointer | |||||
| publicationDate |
0..1 | dateTime | Educational material publication date | |||||
| presentationDate |
0..1 | dateTime | Educational material presentation date | |||||
| programEligibility |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
| fundingSource |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
| reaction |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| date |
0..1 | dateTime | When reaction started | |||||
| detail |
0..1 | Reference(Observation) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
  Slices for protocolApplied |
1..* | BackboneElement | Protocol followed by the provider Slice: Unordered, Open by exists:series, exists:doseNumber | |||||
  protocolApplied:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| series |
0..1 | string | Name of vaccine series | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
 doseNumber[x] |
1..1 | Dose number within series | ||||||
| doseNumberPositiveInt |
positiveInt | |||||||
| doseNumberString |
string | |||||||
 seriesDoses[x] |
0..1 | Recommended number of doses for immunity | ||||||
| seriesDosesPositiveInt |
positiveInt | |||||||
| seriesDosesString |
string | |||||||
| protocolApplied:immzProtocol |
1..* | BackboneElement | Protocol followed by the provider | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
 extension:dueDateOfNextDose |
0..1 | date | Immunization Due Date of Next Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZDueDateOfNextDose | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| series |
1..1 | string | Name of vaccine series | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
| doseNumber[x] |
1..1 | string | Dose number within series | |||||
 seriesDoses[x] |
0..1 | Recommended number of doses for immunity | ||||||
| seriesDosesPositiveInt |
positiveInt | |||||||
| seriesDosesString |
string | |||||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| Immunization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Immunization.extension:typeOfPolio.value[x] | required | IMMZ_D_DE212http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212From this IG | ||||
| Immunization.extension:typeOfJe.value[x] | required | IMMZ_D_DE216http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216From this IG | ||||
| Immunization.extension:typeOfTbe.value[x] | required | IMMZ_D_DE220http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220From this IG | ||||
| Immunization.extension:typeOfTyphoid.value[x] | required | IMMZ_D_DE225http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225From this IG | ||||
| Immunization.extension:typeOfCholera.value[x] | required | IMMZ_D_DE229http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229From this IG | ||||
| Immunization.extension:typeOfMeningococcal.value[x] | required | IMMZ_D_DE229http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229From this IG | ||||
| Immunization.extension:typeOfHepatitisA.value[x] | required | IMMZ_D_DE237http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237From this IG | ||||
| Immunization.extension:typeOfHepatitisB.value[x] | required | IMMZ_D_DE254http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254From this IG | ||||
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1From the FHIR Standard | ||||
| Immunization.statusReason | required | IMMZ_D_DE5http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5From this IG | ||||
| Immunization.vaccineCode | required | IMMZ_Z_VShttp://smart.who.int/immunizations/ValueSet/IMMZ.Z.VSFrom this IG | ||||
| Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-originFrom the FHIR Standard | ||||
| Immunization.location.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-siteFrom the FHIR Standard | ||||
| Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-routeFrom the FHIR Standard | ||||
| Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-functionFrom the FHIR Standard | ||||
| Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reasonFrom the FHIR Standard | ||||
| Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reasonFrom the FHIR Standard | ||||
| Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibilityFrom the FHIR Standard | ||||
| Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-sourceFrom the FHIR Standard | ||||
| Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-diseaseFrom the FHIR Standard | ||||
| Immunization.protocolApplied:immzProtocol.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-diseaseFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() |
This structure is derived from Immunization
Summary
Mandatory: 5 elements(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
- http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
- http://smart.who.int/immunizations/StructureDefinition/IMMZVaccineBrand
- http://smart.who.int/immunizations/StructureDefinition/IMMZLiveVaccine
- http://smart.who.int/immunizations/StructureDefinition/IMMZMarketAuthorization
- http://smart.who.int/immunizations/StructureDefinition/IMMZCountryOfVaccination
- http://smart.who.int/immunizations/StructureDefinition/IMMZAdministrativeArea
- http://smart.who.int/immunizations/StructureDefinition/IMMZDueDateOfNextDose
Slices
This structure defines the following Slices:
- The element 2 is sliced based on the values of Immunization.protocolApplied
Key Elements View
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Immunization.extension:typeOfPolio.value[x] | required | IMMZ_D_DE212http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212From this IG | |
| Immunization.extension:typeOfJe.value[x] | required | IMMZ_D_DE216http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216From this IG | |
| Immunization.extension:typeOfTbe.value[x] | required | IMMZ_D_DE220http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220From this IG | |
| Immunization.extension:typeOfTyphoid.value[x] | required | IMMZ_D_DE225http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225From this IG | |
| Immunization.extension:typeOfCholera.value[x] | required | IMMZ_D_DE229http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229From this IG | |
| Immunization.extension:typeOfMeningococcal.value[x] | required | IMMZ_D_DE229http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229From this IG | |
| Immunization.extension:typeOfHepatitisA.value[x] | required | IMMZ_D_DE237http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237From this IG | |
| Immunization.extension:typeOfHepatitisB.value[x] | required | IMMZ_D_DE254http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254From this IG | |
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1From the FHIR Standard | |
| Immunization.statusReason | required | IMMZ_D_DE5http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5From this IG | |
| Immunization.vaccineCode | required | IMMZ_Z_VShttp://smart.who.int/immunizations/ValueSet/IMMZ.Z.VSFrom this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Immunization
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| Immunization.extension:typeOfPolio.value[x] | required | IMMZ_D_DE212http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212From this IG | |
| Immunization.extension:typeOfJe.value[x] | required | IMMZ_D_DE216http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216From this IG | |
| Immunization.extension:typeOfTbe.value[x] | required | IMMZ_D_DE220http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220From this IG | |
| Immunization.extension:typeOfTyphoid.value[x] | required | IMMZ_D_DE225http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225From this IG | |
| Immunization.extension:typeOfCholera.value[x] | required | IMMZ_D_DE229http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229From this IG | |
| Immunization.extension:typeOfMeningococcal.value[x] | required | IMMZ_D_DE229http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229From this IG | |
| Immunization.extension:typeOfHepatitisA.value[x] | required | IMMZ_D_DE237http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237From this IG | |
| Immunization.extension:typeOfHepatitisB.value[x] | required | IMMZ_D_DE254http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254From this IG | |
| Immunization.statusReason | required | IMMZ_D_DE5http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5From this IG | |
| Immunization.vaccineCode | required | IMMZ_Z_VShttp://smart.who.int/immunizations/ValueSet/IMMZ.Z.VSFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:typeOfPolio |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required) | |||||
| extension:typeOfJe |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE216 ValueSet for Type of JE dose (required) | |||||
| extension:typeOfTbe |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE220 ValueSet for Type of TBE dose (required) | |||||
| extension:typeOfTyphoid |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE225 ValueSet for Type of typhoid dose (required) | |||||
| extension:typeOfCholera |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required) | |||||
| extension:typeOfMeningococcal |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required) | |||||
| extension:typeOfHepatitisA |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required) | |||||
| extension:typeOfHepatitisB |
0..1 | (Complex) | Immunization Type of Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required) | |||||
| extension:vaccineBrand |
1..1 | CodeableConcept | Immunization Vaccine Brand URL: http://smart.who.int/immunizations/StructureDefinition/IMMZVaccineBrand Binding: IMMZ.D.DE18 ValueSet for Vaccine brand (example) | |||||
| extension:liveVaccine |
0..1 | boolean | Immunization Live Vaccine URL: http://smart.who.int/immunizations/StructureDefinition/IMMZLiveVaccine | |||||
| extension:marketAuthorizationHolder |
1..1 | CodeableConcept | Immunization Market Authorization Holder URL: http://smart.who.int/immunizations/StructureDefinition/IMMZMarketAuthorization Binding: IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
| statusReason |
0..1 | CodeableConcept | Reason not done Binding: IMMZ.D.DE5 ValueSet for Reason vaccine was not administered (required) | |||||
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: IMMZ.Z.VS ValueSet for vaccine types (required) | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date | ||||
| 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): The source of the data for a record which is not from a primary source. | |||||
| location |
0..1 | Reference(Location) | Where immunization occurred | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:countryOfVaccination |
1..1 | CodeableConcept | Immunization Country of Vaccination URL: http://smart.who.int/immunizations/StructureDefinition/IMMZCountryOfVaccination Binding: Iso3166-1-3 (required) | |||||
| extension:administrativeArea |
0..1 | CodeableConcept | Immunization Administrative Area URL: http://smart.who.int/immunizations/StructureDefinition/IMMZAdministrativeArea | |||||
| 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): Aa resource (or, for logical models, the URI of the logical model). | ||||
| 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 | |||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
| doseQuantity |
0..1 | SimpleQuantity | Amount of vaccine administered | |||||
| performer |
Σ | 0..* | BackboneElement | Who performed event | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (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 | ||||
| note |
Σ | 0..* | Annotation | Additional immunization notes | ||||
| reasonCode |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency | ||||
| subpotentReason |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
| education |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| documentType |
0..1 | string | Educational material document identifier | |||||
| reference |
0..1 | uri | Educational material reference pointer | |||||
| publicationDate |
0..1 | dateTime | Educational material publication date | |||||
| presentationDate |
0..1 | dateTime | Educational material presentation date | |||||
| programEligibility |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
| fundingSource |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
| reaction |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| date |
0..1 | dateTime | When reaction started | |||||
| detail |
0..1 | Reference(Observation) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| Slices for protocolApplied |
1..* | BackboneElement | Protocol followed by the provider Slice: Unordered, Open by exists:series, exists:doseNumber | |||||
| protocolApplied:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| series |
0..1 | string | Name of vaccine series | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
| doseNumber[x] |
1..1 | Dose number within series | ||||||
| doseNumberPositiveInt |
positiveInt | |||||||
| doseNumberString |
string | |||||||
| seriesDoses[x] |
0..1 | Recommended number of doses for immunity | ||||||
| seriesDosesPositiveInt |
positiveInt | |||||||
| seriesDosesString |
string | |||||||
| protocolApplied:immzProtocol |
1..* | BackboneElement | Protocol followed by the provider | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:dueDateOfNextDose |
0..1 | date | Immunization Due Date of Next Dose URL: http://smart.who.int/immunizations/StructureDefinition/IMMZDueDateOfNextDose | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| series |
1..1 | string | Name of vaccine series | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
| doseNumber[x] |
1..1 | string | Dose number within series | |||||
| seriesDoses[x] |
0..1 | Recommended number of doses for immunity | ||||||
| seriesDosesPositiveInt |
positiveInt | |||||||
| seriesDosesString |
string | |||||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| Immunization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Immunization.extension:typeOfPolio.value[x] | required | IMMZ_D_DE212http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212From this IG | ||||
| Immunization.extension:typeOfJe.value[x] | required | IMMZ_D_DE216http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216From this IG | ||||
| Immunization.extension:typeOfTbe.value[x] | required | IMMZ_D_DE220http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220From this IG | ||||
| Immunization.extension:typeOfTyphoid.value[x] | required | IMMZ_D_DE225http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225From this IG | ||||
| Immunization.extension:typeOfCholera.value[x] | required | IMMZ_D_DE229http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229From this IG | ||||
| Immunization.extension:typeOfMeningococcal.value[x] | required | IMMZ_D_DE229http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229From this IG | ||||
| Immunization.extension:typeOfHepatitisA.value[x] | required | IMMZ_D_DE237http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237From this IG | ||||
| Immunization.extension:typeOfHepatitisB.value[x] | required | IMMZ_D_DE254http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254From this IG | ||||
| Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1From the FHIR Standard | ||||
| Immunization.statusReason | required | IMMZ_D_DE5http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5From this IG | ||||
| Immunization.vaccineCode | required | IMMZ_Z_VShttp://smart.who.int/immunizations/ValueSet/IMMZ.Z.VSFrom this IG | ||||
| Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-originFrom the FHIR Standard | ||||
| Immunization.location.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-siteFrom the FHIR Standard | ||||
| Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-routeFrom the FHIR Standard | ||||
| Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-functionFrom the FHIR Standard | ||||
| Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reasonFrom the FHIR Standard | ||||
| Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reasonFrom the FHIR Standard | ||||
| Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibilityFrom the FHIR Standard | ||||
| Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-sourceFrom the FHIR Standard | ||||
| Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-diseaseFrom the FHIR Standard | ||||
| Immunization.protocolApplied:immzProtocol.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-diseaseFrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() |
This structure is derived from Immunization
Summary
Mandatory: 5 elements(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
- http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
- http://smart.who.int/immunizations/StructureDefinition/IMMZVaccineBrand
- http://smart.who.int/immunizations/StructureDefinition/IMMZLiveVaccine
- http://smart.who.int/immunizations/StructureDefinition/IMMZMarketAuthorization
- http://smart.who.int/immunizations/StructureDefinition/IMMZCountryOfVaccination
- http://smart.who.int/immunizations/StructureDefinition/IMMZAdministrativeArea
- http://smart.who.int/immunizations/StructureDefinition/IMMZDueDateOfNextDose
Slices
This structure defines the following Slices:
- The element 2 is sliced based on the values of Immunization.protocolApplied
Other representations of profile: CSV, Excel, Schematron