WHO Immunization Implementation Guide
0.2.0 - ci-build

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

Library: IMMZIND16Logic

Official URL: http://smart.who.int/immunizations/Library/IMMZIND16Logic Version: 0.2.0
Draft as of 2025-09-17 Computable Name: IMMZIND16Logic

This library defines population criteria logic for the IMMZ.IND.16 indicator in the Immunization CPG

Title: IMMZIND16Logic
Id: IMMZIND16Logic
Version: 0.2.0
Url: IMMZIND16Logic
Status: draft
Type:

system: http://terminology.hl7.org/CodeSystem/library-type

code: logic-library

Date: 2025-09-17 23:03:28+0000
Publisher: WHO
Description:

This library defines population criteria logic for the IMMZ.IND.16 indicator in the Immunization CPG

Related Artifacts:

Dependencies

Parameters:
NameTypeMinMaxIn/Out
Measurement PeriodPeriod01In
PatientPatient01Out
Initial Populationboolean01Out
Denominatorboolean01Out
Numeratorboolean01Out
Stratification 1string01Out
Stratification 2Coding01Out
Stratification 3Coding01Out
Stratification 4Coding01Out
Content: text/cql
/*
 * Library: IMMZ.IND.16 Logic
 * Immunization coverage for meningococcal vaccine
 * The percentage in the target population who have received a meningococcal vaccine during the reporting period
 * 
 * Numerator: Number of meningococcal vaccine doses administered through routine services during the reporting period
 * Numerator Computation: COUNT of immunization events WHERE "Vaccine type" = "Meningococcal vaccines" AND "Date and time of vaccination" is during the reporting period
 * Denominator: Number in target group
 * Denominator Computation: As defined by the Member States
 * 
 * Disaggregation
 *  - Administrative area
 *  - Sex
 *  - Age in years
 *  - Age group (depending on schedule)
 *
 * References: WHO/UNICEF joint reporting form (1)
 *   WHO Immunization data portal (2)
 *   WHO Immunization facility analysis guide (5)
 *   WHO Handbook on immunization data (6)
 * 
 * Annotations: The calculation for this indicator is in line with the administrative calculation provided on the WHO Immunization data portal.
 *   As per WHO Immunization data portal, recommended denominator used in the administrative coverage calculation for meningococcal A conjugate vaccine is surviving infants. For other meningococcal vaccines, recommended denominator should be specified by Member States as recommended schedules may vary.
 */
library IMMZIND16Logic

using FHIR version '4.0.1'

include FHIRHelpers version '4.0.1'

include WHOCommon called WC

include IMMZCommon called Common
include IMMZConcepts called Concepts
include IMMZIndicatorElements called Elements

include IMMZD2DTMeningococcalElements called Meningococcal

parameter "Measurement Period" Interval<Date> default Interval[@2025-01-01, @2025-12-31]

context Patient

/*
 * As defined by Member State
 */
define "Initial Population":
  true

/*
@denominator: Number in target group
@pseudocode: As defined by the Member States
*/
define "Denominator":
  true

/*
@numerator: Number of meningococcal vaccine doses administered through routine services during the reporting period
@pseudocode: COUNT of immunization events WHERE "Vaccine type" = "Meningococcal vaccines" AND "Date and time of vaccination" is during the reporting period
*/
define "Numerator":
  exists( Meningococcal."Meningococcal Doses Administered to Patient" I 
    where I.occurrence.toInterval() starts during "Measurement Period" )

/*
@disaggregation: Administrative area
                 Sex
                 Age in years
                 Age group (depending on schedule)
*/
define "Stratification 1":
	Elements."By Geographic Region Stratifier"

define "Stratification 2":
	Elements."By Administrative Gender Stratifier"

define "Stratification 3":
	Elements."Age Stratifier"

define "Stratification 4":
	Elements."Infant By Age Stratifier"
Content: application/elm+xml
Encoded data (23644 characters)