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: IMMZD2DTHepatitisBEncounterElements

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

This library defines encounter-based elements for Hepatitis B used throughout the Immunization CPG

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

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

code: logic-library

Date: 2025-08-08 19:12:11+0000
Publisher: WHO
Description:

This library defines encounter-based elements for Hepatitis B used throughout the Immunization CPG

Related Artifacts:

Dependencies

Parameters:
NameTypeMinMaxIn/Out
HepBBirthDoseAgeLimitDaysinteger01In
HepBLowerLimitWeeksinteger01In
Todaydate01In
EncounterIdstring01In
PatientPatient01Out
Hepatitis B Doses Administered to PatientImmunization0*Out
Date of Latest Hepatitis B Dosedate01Out
Date of First Hepatitis B Dosedate01Out
Hepatitis B Dose 0 Doses Administered to PatientImmunization0*Out
Number of Hepatitis B Dose 0 Doses Administeredinteger01Out
Hepatitis B birth dose was not administeredboolean01Out
Hepatitis B birth dose was administeredboolean01Out
Hepatitis B Primary Series Doses Administered to PatientImmunization0*Out
Number of Hepatitis B Primary Series Doses Administeredinteger01Out
No hepatitis B primary series doses were administeredboolean01Out
One hepatitis B primary series dose was administeredboolean01Out
One hepatitis B primary series doses were administeredboolean01Out
Two hepatitis B primary series doses were administeredboolean01Out
Three hepatitis B primary series doses were administeredboolean01Out
Number of Hepatitis B Doses Administeredinteger01Out
No hepatitis B doses were administeredboolean01Out
One hepatitis B dose was administeredboolean01Out
Two hepatitis B doses were administeredboolean01Out
Three hepatitis B doses were administeredboolean01Out
Client's age is less than {Member States defined upper limit}boolean01Out
Client's age is more than {Member States defined upper limit}boolean01Out
Client's age is less than {Member States defined lower limit}boolean01Out
Client's age is more than or equal to {Member States defined lower limit}boolean01Out
Client's age is more than {Member States defined lower limit}boolean01Out
Client's weight at birth was over 2000 gboolean01Out
Client's weight at birth was below 2000 gboolean01Out
Client was not a premature infant at birthboolean01Out
Client was a premature infant at birthboolean01Out
The latest hepatitis B dose was administered less than 4 weeks agoboolean01Out
The latest hepatitis B dose was administered more than 4 weeks agoboolean01Out
The first hepatitis B dose was administered less than 6 months agoboolean01Out
The first hepatitis B dose was administered more than 6 months agoboolean01Out
Content: text/cql

/*
  * Library: IMMZD2DTHepatitisBEncounterElements
  */
library IMMZD2DTHepatitisBEncounterElements

using FHIR version '4.0.1'
include FHIRHelpers version '4.0.1'

include WHOConcepts
include WHOCommon called WC
include WHOElements called WE

include IMMZCommon called Common
include IMMZConcepts called Concepts

include IMMZEncounterElements called Encounter

include IMMZD2DTHepatitisBElements called HepatitisBElements

parameter HepBBirthDoseAgeLimitDays Integer default 1
parameter HepBLowerLimitWeeks Integer default 4
parameter Today Date default Today()
parameter EncounterId String

context Patient

/*
@internal: Hepatitis B containing Doses Administered to Patient
*/
define "Hepatitis B Doses Administered to Patient":
  HepatitisBElements."Hepatitis B Doses Administered to Patient".onOrBefore(Today)

/*
@internal: Date and time of last Hepatitis B dose
*/
define "Date of Latest Hepatitis B Dose":
  date from start of "Hepatitis B Doses Administered to Patient".mostRecent().occurrence.toInterval()

/*
@internal: Date and time of first Hepatitis B dose
*/
define "Date of First Hepatitis B Dose":
  date from start of "Hepatitis B Doses Administered to Patient".earliest().occurrence.toInterval()

/*
@internal: Hepatitis B containing Doses Administered to Patient that are in the Dose 0 series
*/
define "Hepatitis B Dose 0 Doses Administered to Patient":
  HepatitisBElements."Hepatitis B Dose 0 Doses Administered to Patient".onOrBefore(Today)

/*
@internal: Number of Hepatitis B Dose 0 doses
*/
define "Number of Hepatitis B Dose 0 Doses Administered":
  Count("Hepatitis B Dose 0 Doses Administered to Patient")

/*
@input: Hepatitis B birth dose was not administered
@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Birth dose" = TRUE) = 0
*/
define "Hepatitis B birth dose was not administered":
  "Number of Hepatitis B Dose 0 Doses Administered" = 0

/*
@input: Hepatitis B birth dose was administered
@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Birth dose" = TRUE) = 1
*/
define "Hepatitis B birth dose was administered":
  "Number of Hepatitis B Dose 0 Doses Administered" = 1

/*
@internal: Hepatitis B containing Doses Administered to Patient that are in the Primary series
*/
define "Hepatitis B Primary Series Doses Administered to Patient":
  HepatitisBElements."Hepatitis B Primary Series Doses Administered to Patient".onOrBefore(Today)

/*
@internal: Number of Hepatitis B Primary Series doses
*/
define "Number of Hepatitis B Primary Series Doses Administered":
  Count("Hepatitis B Primary Series Doses Administered to Patient")

/*
@input: No hepatitis B primary series doses were administered
@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines"and "Type of dose" = "Primary series") = 0
*/
define "No hepatitis B primary series doses were administered":
  "Number of Hepatitis B Primary Series Doses Administered" = 0

/*
@input: One hepatitis B primary series dose was administered
@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Type of dose" = "Primary series") = 1
*/
define "One hepatitis B primary series dose was administered":
  "Number of Hepatitis B Primary Series Doses Administered" = 1
/*
@input: One hepatitis B primary series doses were administered
@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" 
and "Type of dose" = "Primary series") = 1
*/
define "One hepatitis B primary series doses were administered":
  "One hepatitis B primary series dose was administered"

/*
@input: Two hepatitis B primary series doses were administered
@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Type of dose" = "Primary series") = 2
*/
define "Two hepatitis B primary series doses were administered":
  "Number of Hepatitis B Primary Series Doses Administered" = 2

/*
@input: Three hepatitis B primary series doses were administered
@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Type of dose" = "Primary series") = 3
*/
define "Three hepatitis B primary series doses were administered":
  "Number of Hepatitis B Primary Series Doses Administered" = 3

/*
@internal: Number of Hepatitis B doses
*/
define "Number of Hepatitis B Doses Administered":
  Count("Hepatitis B Doses Administered to Patient")

/*
@input: No hepatitis B doses were administered
@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines")
 = 0
*/
define "No hepatitis B doses were administered":
  "Number of Hepatitis B Doses Administered" = 0

/*
@input: One hepatitis B dose was administered
@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines")
 = 1
*/
define "One hepatitis B dose was administered":
  "Number of Hepatitis B Doses Administered" = 1

/*
@input: Two hepatitis B doses were administered
@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines")
 = 2
*/
define "Two hepatitis B doses were administered":
  "Number of Hepatitis B Doses Administered" = 2

/*
@input: Three hepatitis B doses were administered
@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines")
 = 3
*/
define "Three hepatitis B doses were administered":
  "Number of Hepatitis B Doses Administered" = 3

/*
@input: Client's age is less than {Member States defined upper limit}
@pseudocode: Today's date − "Date of birth" < Member States defined upper limit
*/
define "Client's age is less than {Member States defined upper limit}":
  Encounter."Current Patient Age In Days" < HepBBirthDoseAgeLimitDays

/*
@input: Client's age is more than {Member States defined upper limit}
@pseudocode: Today's date - "Date of birth" > Member States defined upper limit
This will leave a gap if not >=, so using the that.  See https://github.com/WorldHealthOrganization/smart-dak-immz/issues/8
*/
define "Client's age is more than {Member States defined upper limit}":
  Encounter."Current Patient Age In Days" >= HepBBirthDoseAgeLimitDays

/*
@input: Client's age is less than {Member States defined lower limit}
@pseudocode: Today's date − "Date of birth" < Member States defined lower limit
*/
define "Client's age is less than {Member States defined lower limit}":
  Encounter."Current Patient Age In Weeks" < HepBLowerLimitWeeks

/*
@input: Client's age is more than or equal to {Member States defined lower limit}
@pseudocode: Today's date − "Date of birth" ≥ Member States defined lower limit
*/
define "Client's age is more than or equal to {Member States defined lower limit}":
  Encounter."Current Patient Age In Weeks" >= HepBLowerLimitWeeks

/*
@input: Client's age is more than {Member States defined lower limit}
@pseudocode: Today's date − "Date of birth"  > Member States defined lower limit
@note: This seems like it should be based on missing the birth dose and not the same 
       as other categories that are after the birth dose.
*/
define "Client's age is more than {Member States defined lower limit}":
  Encounter."Current Patient Age In Days" >= HepBBirthDoseAgeLimitDays

/*
@input: Client's weight at birth was over 2000 g
@pseudocode: "Birth weight in grams"  ≥ 2000
*/
define "Client's weight at birth was over 2000 g":
  Encounter."Client's weight at birth was over 2000 g"

/*
@input: Client's weight at birth was below 2000 g
@pseudocode: "Birth weight in grams" < 2000
*/
define "Client's weight at birth was below 2000 g":
  Encounter."Client's weight at birth was below 2000 g"

/*
@input: Client was not a premature infant at birth
@pseudocode: "Preterm birth" ≠  TRUE
*/
define "Client was not a premature infant at birth":
  Encounter."Client was not a premature infant at birth"

/*
@input: Client was a premature infant at birth
@pseudocode: "Preterm birth" =  TRUE
*/
define "Client was a premature infant at birth":
  Encounter."Client was a premature infant at birth"

/*
@input: The latest hepatitis B dose was administered less than 4 weeks ago
@pseudocode: Today's date − latest "Date and time of vaccination" (where "Vaccine type" = "Hepatitis B-containing vaccines") 
< 4 weeks
*/
define "The latest hepatitis B dose was administered less than 4 weeks ago":
  "Date of Latest Hepatitis B Dose" is not null 
    and duration in weeks between "Date of Latest Hepatitis B Dose" and Today < 4

/*
@input: The latest hepatitis B dose was administered more than 4 weeks ago
@pseudocode: Today's date − latest "Date and time of vaccination" (where "Vaccine type" = "Hepatitis B-containing vaccines") 
≥ 4 weeks
*/
define "The latest hepatitis B dose was administered more than 4 weeks ago":
  not("The latest hepatitis B dose was administered less than 4 weeks ago")

/*
@input: The first hepatitis B dose was administered less than 6 months ago
@pseudocode: Today's date − "Date and time of vaccination" (where "Vaccine type" = "Hepatitis B-contai
ning vaccines" and "Dose number" = 1) < 6 months
*/
define "The first hepatitis B dose was administered less than 6 months ago":
  "Date of First Hepatitis B Dose" is not null 
    and duration in months between "Date of First Hepatitis B Dose" and Today < 6
    
/*
@input: The first hepatitis B dose was administered more than 6 months ago
@pseudocode: Today's date − "Date and time of vaccination" (where "Vaccine type" = "Hepatitis B-contai
ning vaccines" and "Dose number" = 1) ≥ 6 months
*/
define "The first hepatitis B dose was administered more than 6 months ago":
  not("The first hepatitis B dose was administered less than 6 months ago")
Content: application/elm+xml
Encoded data (82436 characters)