WHO Immunization Implementation Guide
0.1.0 - CI Build International flag

WHO Immunization Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.1.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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Knowledge Artifacts: Activity Definitions

These define activities that can be performed as part of the guidelines in this implementation guide.

IMMZ.D2.DT.CR

Provide measles immunization communication

IMMZ.D2.DT.HepatitisB.MR

Provide immunization

IMMZ.D2.DT.Measles.MR

Provide immunization

IMMZ.D2.DT.Polio.IPV.MR

Provide immunization

IMMZ.D2.DT.Polio.bOPV.MR

Provide immunization

IMMZ.D2.DT.YellowFever.MR

Provide immunization

IMMZ.D5.DT.Measles.MR

Immunization Contraindication

IMMZ.D5.DT.Polio.bOPV.MR

Immunization Contraindication

IMMZ.D5.DT.YellowFever.MR

Immunization Contraindication

Knowledge Artifacts: Plan Definitions

These define workflows, rules, strategies, or protocols as part of content in this implementation guide.

IMMZ.D18.S.Measles.Dose0.HighTx

Provision of the measles MCV0 dose (dose zero). Countries with ongoing transmission in which the risk of measles mortality remains high.

IMMZ.D18.S.Measles.Dose0.LowTx

Provision of the measles MCV0 dose (dose zero). Countries with ongoing transmission in which the risk of measles mortality remains high.

IMMZ.D18.S.Measles.HighTx

Determine if the client is due for a measles vaccination according to the national immunization protocol. Countries with ongoing transmission in which the risk of measles mortality remains high.

IMMZ.D18.S.Measles.LowTx

Determine if the client is due for a measles vaccination according to the national immunization protocol. Countries with low levels of measles transmission.

IMMZ.D18.S.Measles.Supp

Provision of a measles supplementary dose Countries with ongoing transmission in which the risk of measles mortality remains high.

IMMZ.D18.S.YellowFever

Determine if the client is due for a yellow fever vaccination according to the national immunization protocol.

IMMZ.D2.DT.HepatitisB3Delayed

Determine if the client is due for a hepatitis B vaccination according to the national immunization schedule

IMMZ.D2.DT.HepatitisB3OnTime

Determine if the client is due for a hepatitis B vaccination according to the national immunization schedule

IMMZ.D2.DT.HepatitisB4OnTime

Determine if the client is due for a hepatitis B vaccination according to the national immunization schedule

IMMZ.D2.DT.HepatitisBBirth

Determine if the client is due for a hepatitis B vaccination according to the national immunization schedule

IMMZ.D2.DT.Measles.Dose0

Determine if the client is due for a measles vaccination according to the national immunization protocol. Measles dose 0 (MCV0) administration.

IMMZ.D2.DT.Measles.HighTx

Determine if the client is due for a measles vaccination according to the national immunization protocol. Countries with ongoing transmission in which the risk of measles mortality remains high.

IMMZ.D2.DT.Measles.LowTx

Determine if the client is due for a measles vaccination according to the national immunization protocol. Countries with low levels of measles transmission.

IMMZ.D2.DT.Measles.Supp

Determine if the client is due for a measles vaccination according to the national immunization protocol. Measles supplementary dose administration.

IMMZ.D2.DT.Polio.Birth

Determine if the client is due for a polio vaccination according to the national immunization protocol. Birth dose administration as part of “bOPV plus IPV” schedule (In countries that are polio-endemic countries or countries at high risk for importation and subsequent spread of poliovirus, that follow the combined bOPV-IPV schedule)

IMMZ.D2.DT.Polio.IPVOnly

Determine if the client is due for a polio vaccination according to the national immunization protocol. IPV-only (in countries, in polio-free regions, with a very low risk of importation and sustained high routine immunization coverage (DTP3 >90%)

IMMZ.D2.DT.Polio.Sequential

Determine if the client is due for a polio vaccination according to the national immunization protocol. Sequential IPV–bOPV schedule (in countries with high vaccination coverage (e.g. 90–95%) and low importation risk (where neighbouring countries and/or countries that share substantial population movement have a similarly high coverage))

IMMZ.D2.DT.Polio.bOPVIPV

Determine if the client is due for a polio vaccination according to the national immunization protocol. bOPV plus IPV schedule (applicable for all countries)

IMMZ.D2.DT.YellowFever

Determine if the client is due for a yellow fever vaccination according to the national immunization protocol.

IMMZ.D5.DT.HepatitisB

Check contraindications for Hepatitis B vaccine

IMMZ.D5.DT.Measles

Check contraindications for Measles vaccine

IMMZ.D5.DT.Polio

Check contraindications for Polio vaccine

IMMZ.D5.DT.YellowFever

Check contraindications for Yellow Fever vaccine

IMMZ.DT.Umbrella

If the child or patient has not been given MCV1 (at 9 months) and MCV2 (between 15-18 months) vaccination

Knowledge Artifacts: Measure

These define measures as part of content in this implementation guide.

IMMZIND07MeaslesHighTx

IMMZ.IND.07 Measles indicator for first dose in High Transmission area.

IMMZIND07MeaslesLowTx

IMMZ.IND.07 Measles indicator for first dose in Low Transmission area.

IMMZIND08Measles

IMMZ.IND.08 Measles indicator for second dose.

IMMZIND08Measles

IMMZ.IND.40 Dropout rate of MCV1 to MCV2.

IMMZIND26YellowFever

IMMZ.IND.26 Yellow Fever indicator for first dose.

Knowledge Artifacts: Libraries

These define logic, asset collections and other libraries as part of content in this implementation guide.

FHIRCommon
FHIRHelpers
IMMZCommon
IMMZCommonIzDataElements
IMMZConcepts
IMMZConfig
IMMZD18SMeaslesDose0
IMMZD18SMeaslesDose0HighTx
IMMZD18SMeaslesDose0LowTx
IMMZD18SMeaslesHighTx
IMMZD18SMeaslesLowTx
IMMZD18SMeaslesSupp
IMMZD18SYellowFever
IMMZD2DTHepatitisB3Delayed
IMMZD2DTHepatitisB3OnTime
IMMZD2DTHepatitisB4OnTime
IMMZD2DTHepatitisBBirth
IMMZD2DTHepatitisBInput
IMMZD2DTMeasles
IMMZD2DTMeaslesDose0
IMMZD2DTMeaslesHighTx
IMMZD2DTMeaslesInput
IMMZD2DTMeaslesLowTx
IMMZD2DTMeaslesSupp
IMMZD2DTPolioBirth
IMMZD2DTPolioIPVOnly
IMMZD2DTPolioInput
IMMZD2DTPolioSequential
IMMZD2DTPoliobOPVIPV
IMMZD2DTYellowFever
IMMZD2DTYellowFeverInput
IMMZD5DTHepatitisB
IMMZD5DTMeasles
IMMZD5DTMeaslesCI
IMMZD5DTPolio
IMMZD5DTYellowFever
IMMZIND07MeaslesHighTx
IMMZIND07MeaslesLowTx
IMMZIND08Measles
IMMZIND26YellowFever
IMMZIND40Measles
IMMZINDMeasles
IMMZINDYellowFever
IMMZIndicatorCommon
IMMZStratifiers
IMMZVaccineLibrary
WHOCommon
WHOConcepts

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

IMMZ.C Register Client

Data elements for the IMMZ.C Register Client Data Dictionary.

IMMZ.D1 Capture Client History for All Antigens

Data elements for the IMMZ.D1 Capture Client History Data Dictionary for the fields that apply to all antigens.

IMMZ.D1 Capture Client History for Hepatitis B

Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Hepatitis B.

IMMZ.D1 Capture Client History for Measles

Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Measles.

IMMZ.D1 Capture Client History for Polio

Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Polio.

IMMZ.D1 Capture Client History for Yellow Fever

Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Yellow Fever.

IMMZ.D5 Check Contraindications

Data elements for the IMMZ.D5 Check Contraindications Data Dictionary.

Structures: Questionnaires

These define forms used by systems conforming to this implementation guide to capture or expose data to end users.

Capture Client History Questionnaire

Immunization - Capture Client History Questionnaire

Capture Client History Questionnaire - Hepatitis B

Immunization - Capture Client History Questionnaire for Hepatitis B Immunization

Capture Client History Questionnaire - Measles

Immunization - Capture Client History Questionnaire for Measles Immunization

Capture Client History Questionnaire - Polio

Immunization - Capture Client History Questionnaire for Polio Immunization

Capture Client History Questionnaire - Yellow Fever

Immunization - Capture Client History Questionnaire for Yellow Fever Immunization

Check Contraindications Questionnaire

Immunization - Check Contraindications Questionnaire

Client Registration Questionnaire

Immunization - Client Registration Questionnaire

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

ARV Drugs values

Codes representing ARV Drugs values

Birthweight valueset

Codes representing Birthweight values

HIV status values

Codes representing HIV status values

IMMZ.C.DE5 ValueSet for Sex

ValueSet for Sex for IMMZ.C.DE5.

IMMZ.D.DE1 ValueSet for Immunization event status

ValueSet for Immunization event status for IMMZ.D.DE1

IMMZ.D.DE107 ValueSet for Type of reaction

ValueSet for Type of reaction for IMMZ.D.DE107

IMMZ.D.DE115 ValueSet for Reaction outcome

ValueSet for Reaction outcome for IMMZ.D.DE115

IMMZ.D.DE126 ValueSet for Disease targeted

ValueSet for Disease targeted for IMMZ.D.DE126

IMMZ.D.DE156 ValueSet for Immunization recommendation status

ValueSet for Immunization recommendation status for IMMZ.D.DE156

IMMZ.D.DE161 ValueSet for Potential contraindications

ValueSet for Potential contraindications for IMMZ.D.DE161

IMMZ.D.DE18 ValueSet for Vaccine brand

ValueSet for Vaccine brand for IMMZ.D.DE18

IMMZ.D.DE19 ValueSet for Vaccine type

ValueSet for Vaccine type for IMMZ.D.DE19

IMMZ.D.DE21 ValueSet for Country of vaccination

ValueSet for Country of vaccination for IMMZ.D.DE21

IMMZ.D.DE22 ValueSet for Vaccination location

ValueSet for Vaccination location for IMMZ.D.DE22

IMMZ.D.DE23 ValueSet for Vaccine manufacturer

ValueSet for Vaccine manufacturer for IMMZ.D.DE23

IMMZ.D.DE25 ValueSet for Vaccine market authorization holder

ValueSet for Vaccine market authorization holder for IMMZ.D.DE25

IMMZ.D.DE5 ValueSet for Reason vaccine was not administered

ValueSet for Reason vaccine was not administered for IMMZ.D.DE5

IMMZ.D.DE86 ValueSet for Client education and counselling on immunization

ValueSet for Client education and counselling on immunization for IMMZ.D.DE86

IMMZ.D.DE95 ValueSet for Reaction manifestation

ValueSet for Reaction manifestation for IMMZ.D.DE95

IMMZ.D1.DE10 ValueSet for HIV status

ValueSet for HIV status for IMMZ.D1.DE10

IMMZ.D1.DE103 ValueSet for Type of dose

ValueSet for Type of dose for IMMZ.D1.DE103

IMMZ.D1.DE35 ValueSet for Type of polio dose

ValueSet for Type of polio dose for IMMZ.D1.DE35

IMMZ.D1.DE52 ValueSet for Type of JE dose

ValueSet for Type of JE dose for IMMZ.D1.DE52

IMMZ.D1.DE56 ValueSet for Type of TBE dose

ValueSet for Type of TBE dose for IMMZ.D1.DE56

IMMZ.D1.DE61 ValueSet for Type of typhoid dose

ValueSet for Type of typhoid dose for IMMZ.D1.DE61

IMMZ.D1.DE65 ValueSet for Type of cholera dose

ValueSet for Type of cholera dose for IMMZ.D1.DE65

IMMZ.D1.DE68 ValueSet for Type of meningococcal dose

ValueSet for Type of meningococcal dose for IMMZ.D1.DE68

IMMZ.D1.DE73 ValueSet for Type of hepatitis A dose

ValueSet for Type of hepatitis A dose for IMMZ.D1.DE73

IMMZ.D1.DE77 ValueSet for Dengue serostatus

ValueSet for Dengue serostatus for IMMZ.D1.DE77

IMMZ.D1.DE84 ValueSet for Type of TB infection test performed

ValueSet for Type of TB infection test performed for IMMZ.D1.DE84

IMMZ.D1.DE87 ValueSet for TB infection test result

ValueSet for TB infection test result for IMMZ.D1.DE87

IMMZ.D1.DE99 ValueSet for Type of hepatitis B dose

ValueSet for Type of hepatitis B dose for IMMZ.D1.DE87

IMMZ.Z.DE14 Polio containing vaccines

Vaccine terminology codes for polio.

IMMZ.Z.DE14.IPV Inactiviated Polio containing vaccines

Vaccine terminology codes for inactivated polio vaccines.

IMMZ.Z.DE14.bOPV Oral Polio containing vaccines

Vaccine terminology codes for oral polio vaccines.

IMMZ.Z.DE23 Yellow fever containing vaccines

Vaccine terminology codes for yellow fever.

IMMZ.Z.DE6 Hepatitis B containing vaccines

Vaccine terminology codes for hepatitis B.

IMMZ.Z.DE9 ValueSet for Measles Vaccines

Vaccine terminology codes for measles.

Immunocompromised valueset

Codes representing Immunocompromised values

Negative Test Results

Codes representing negative test result values

Positive Test Result valuest

Codes representing Positive Test Result values

Pregnancy status values

Codes representing possible values for the Pregnancy status element

Set of live attenuated vaccines

Codes representing live attenuated vaccines

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

IMMZ.C CodeSystem for Data Elements

CodeSystem for IMMZ.C Data Elements

IMMZ.D CodeSystem for Data Elements

CodeSystem for IMMZ.D Data Elements

IMMZ.D1 CodeSystem for Data Elements

CodeSystem for IMMZ.D1 Data Elements

Terminology: Structure Maps

These define transformations to convert between data structures used by systems conforming to this implementation guide.

StructureMap/IMMZCLMToPatient
StructureMap/IMMZCQRToLM
StructureMap/IMMZCQRToPatient
StructureMap/IMMZD1HepatitisBLMToResources
StructureMap/IMMZD1HepatitisBQRToLM
StructureMap/IMMZD1HepatitisBQRToResources
StructureMap/IMMZD1LMToResources
StructureMap/IMMZD1MeaslesLMToResources
StructureMap/IMMZD1MeaslesQRToLM
StructureMap/IMMZD1MeaslesQRToResources
StructureMap/IMMZD1PolioLMToResources
StructureMap/IMMZD1PolioQRToLM
StructureMap/IMMZD1PolioQRToResources
StructureMap/IMMZD1QRToLM
StructureMap/IMMZD1YellowFeverQRToResources
StructureMap/IMMZD5LMToResources
StructureMap/IMMZD5QRToLM
StructureMap/IMMZD5QRToResources

Terminology: Concept Maps

These define transformations to convert between codes by systems conforming with this implementation guide.

ConceptMap to and From IMMZ.C sex to administrative gender

Mapping to and from IMMZ.C sex coding to FHIR Administrative Gender.

ConceptMap to and from IMMZ.C DataElements

Mapping to and from IMMZ.C Data Dictionary to other codesystems.

ConceptMap to and from IMMZ.D DataElements

Mapping to and from IMMZ.D Data Dictionary to other codesystems.

ConceptMap to and from IMMZ.D1 DataElements

Mapping to and from IMMZ.D1 Data Dictionary to other codesystems.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Example.IMMZ.C.QuestionnaireResponse.1
Example.IMMZ.D1.QuestionnaireResponse.1
Example.IMMZ.D1.QuestionnaireResponse.2
Example.IMMZ.D1.QuestionnaireResponse.3
Example.IMMZ.D1.QuestionnaireResponse.HepatitisB
Example.IMMZ.D1.QuestionnaireResponse.Polio
Example.IMMZ.D1.QuestionnaireResponse.YF
Example.IMMZ.D5.QuestionnaireResponse.1
Example.IMMZ.D5.QuestionnaireResponse.2
Example.IMMZ.D5.QuestionnaireResponse.3
Example.IMMZ.D5.QuestionnaireResponse.4
patient123456
patient654321

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

cqf-tooling