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

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

This library defines decision support logic for the IMMZ.D2.DT.TBE.Encepur decision table in the Immunization CPG

Title: IMMZD2DTTBEEncepurLogic
Id: IMMZD2DTTBEEncepurLogic
Version: 0.2.0
Url: IMMZD2DTTBEEncepurLogic
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 decision support logic for the IMMZ.D2.DT.TBE.Encepur decision table in the Immunization CPG

Related Artifacts:

Dependencies

Parameters:
NameTypeMinMaxIn/Out
Todaydate01In
PatientPatient01Out
Client is not due for TBE vaccination Case 1boolean01Out
Client is not due for TBE vaccination Case 2boolean01Out
Client is not due for TBE vaccination Case 3boolean01Out
Client is not due for TBE vaccinationboolean01Out
Client is not due for TBE vaccination Guidancestring01Out
Client is due for TBE vaccination Case 1boolean01Out
Client is due for TBE vaccination Case 2boolean01Out
Client is due for TBE vaccination Case 3boolean01Out
Client is due for TBE vaccinationboolean01Out
Client is due for TBE vaccination Guidancestring01Out
The primary series is complete. Client is not due for TBE booster doseboolean01Out
The primary series is complete. Client is not due for TBE booster dose Guidancestring01Out
The primary series is completeboolean01Out
The primary series is complete Guidancestring01Out
Clinical judgement is required. Create a clinical noteboolean01Out
Clinical judgement is required. Create a clinical note Guidancestring01Out
Guidancestring01Out
Has Guidanceboolean01Out
Test ValidationResource01Out
Content: text/cql

/*
 * Library: IMMZD2DTTBEEncepurLogic (IMMZ.D2.DT.TBE.Encepur)
 * Rule: Determine if the client is due for a tick-borne encephalitis (TBE) vaccination according to the national immunization schedule
 * Decision Table: Encepur schedule
(In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children		)
 * Trigger: IMMZ.D2  Determine required vaccination(s) if any
 */
library IMMZD2DTTBEEncepurLogic

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

include IMMZD2DTTBEEncounterElements called Encounter

parameter Today Date default Today()

context Patient


/*
@dynamicValue: Guidance
*/
define "Guidance":
  case
    when "Client is not due for TBE vaccination" then "Client is not due for TBE vaccination Guidance"
    when "Client is due for TBE vaccination" then "Client is due for TBE vaccination Guidance"
    when "The primary series is complete. Client is not due for TBE booster dose" then "The primary series is complete. Client is not due for TBE booster dose Guidance"
    when "The primary series is complete" then "The primary series is complete Guidance"
    when "Clinical judgement is required. Create a clinical note" then "Clinical judgement is required. Create a clinical note Guidance"
    else ''
  end

define "Has Guidance":
  "Guidance" is not null and "Guidance" != ''

/*
@output: Client is not due for TBE vaccination Case 1
@pseudocode: "Immunization recommendation status" = "Not due"
*/
define "Client is not due for TBE vaccination Case 1":
  Encounter."Client's age is less than 1 year"

/*
@output: Client is not due for TBE vaccination Case 2
@pseudocode: "Immunization recommendation status" = "Not due"
*/
define "Client is not due for TBE vaccination Case 2":
  Encounter."One TBE primary series dose was administered"
    and Encounter."The latest TBE dose was administered less than 1 month ago"

/*
@output: Client is not due for TBE vaccination Case 3
@pseudocode: "Immunization recommendation status" = "Not due"
*/
define "Client is not due for TBE vaccination Case 3":
  Encounter."Two TBE primary series doses were administered"
    and Encounter."The latest TBE dose was administered less than 9 months ago"

/*
@output: Client is not due for TBE vaccination
@pseudocode: "Immunization recommendation status" = "Not due"
*/
define "Client is not due for TBE vaccination":
  "Client is not due for TBE vaccination Case 1"
    or "Client is not due for TBE vaccination Case 2"
    or "Client is not due for TBE vaccination Case 3"

/*
@output: Client is not due for TBE vaccination Guidance
@guidance: Should not vaccinate client with first TBE dose as client's age is less than 1 year. 
Check for any vaccines due and inform the caregiver of when to come back for the first dose.
@guidance: Should not vaccinate client with second TBE dose as the latest dose was administered less than 1 month ago. 
Check for any vaccines due and inform the caregiver of when to come back for the next dose.
@guidance: Should not vaccinate client with third TBE dose as the latest dose was administered less than 9 months ago. 
Check for any vaccines due and inform the caregiver of when to come back for the next dose.
*/
define "Client is not due for TBE vaccination Guidance":
  case
    when "Client is not due for TBE vaccination Case 1" then 'Should not vaccinate client with first TBE dose as client\'s age is less than 1 year. 
Check for any vaccines due and inform the caregiver of when to come back for the first dose.'
    when "Client is not due for TBE vaccination Case 2" then 'Should not vaccinate client with second TBE dose as the latest dose was administered less than 1 month ago. 
Check for any vaccines due and inform the caregiver of when to come back for the next dose.'
    when "Client is not due for TBE vaccination Case 3" then 'Should not vaccinate client with third TBE dose as the latest dose was administered less than 9 months ago. 
Check for any vaccines due and inform the caregiver of when to come back for the next dose.'
    else ''
  end

/*
@output: Client is due for TBE vaccination Case 1
@pseudocode: "Immunization recommendation status" = "Due"
*/
define "Client is due for TBE vaccination Case 1":
  Encounter."No TBE primary series doses were administered"
    and Encounter."Client's age is more than or equal to 1 year"

/*
@output: Client is due for TBE vaccination Case 2
@pseudocode: "Immunization recommendation status" = "Due"
*/
define "Client is due for TBE vaccination Case 2":
  Encounter."One TBE primary series dose was administered"
    and Encounter."The latest TBE dose was administered more than 1 month ago"

/*
@output: Client is due for TBE vaccination Case 3
@pseudocode: "Immunization recommendation status" = "Due"
*/
define "Client is due for TBE vaccination Case 3":
  Encounter."Two TBE primary series doses were administered"
    and Encounter."The latest TBE dose was administered more than 9 months ago"

/*
@output: Client is due for TBE vaccination
@pseudocode: "Immunization recommendation status" = "Due"
*/
define "Client is due for TBE vaccination":
  "Client is due for TBE vaccination Case 1"
    or "Client is due for TBE vaccination Case 2"
    or "Client is due for TBE vaccination Case 3"

/*
@output: Client is due for TBE vaccination Guidance
@guidance: Should vaccinate client with first TBE dose as no TBE doses have been administered and client's age is more than 1 year. 
Check for contraindications.
@guidance: Should vaccinate client with second TBE dose as the latest dose was administered more than 1 month ago. 
Check for contraindications.
@guidance: Should vaccinate client with third TBE dose as the latest dose was administered more than 9 months ago.
Check for contraindications.
*/
define "Client is due for TBE vaccination Guidance":
  case
    when "Client is due for TBE vaccination Case 1" then 'Should vaccinate client with first TBE dose as no TBE doses have been administered and client\'s age is more than 1 year. 
Check for contraindications.'
    when "Client is due for TBE vaccination Case 2" then 'Should vaccinate client with second TBE dose as the latest dose was administered more than 1 month ago. 
Check for contraindications.'
    when "Client is due for TBE vaccination Case 3" then 'Should vaccinate client with third TBE dose as the latest dose was administered more than 9 months ago.
Check for contraindications.'
    else ''
  end

/*
@output: The primary series is complete. Client is not due for TBE booster dose
@pseudocode: "Immunization recommendation status" = "Not due"
*/
define "The primary series is complete. Client is not due for TBE booster dose":
  Encounter."Three TBE primary series doses were administered"
    and Encounter."No TBE booster dose was administered"
    and Encounter."The latest TBE dose was administered less than 3 years ago"

/*
@output: The primary series is complete. Client is not due for TBE booster dose Guidance
@guidance: Should not vaccinate client with TBE booster dose as the latest TBE dose was administered less than 3 years ago. 
Check for any vaccines due and inform the caregiver of when to come back for the booster dose.
*/
define "The primary series is complete. Client is not due for TBE booster dose Guidance":
  'Should not vaccinate client with TBE booster dose as the latest TBE dose was administered less than 3 years ago. 
Check for any vaccines due and inform the caregiver of when to come back for the booster dose.'

/*
@output: The primary series is complete
@pseudocode: Client is due for TBE booster dose
*/
define "The primary series is complete":
  Encounter."Three TBE primary series doses were administered"
    and Encounter."No TBE booster dose was administered"
    and Encounter."The latest TBE dose was administered more than 3 years ago"

/*
@output: The primary series is complete Guidance
@guidance: Should vaccinate client with TBE booster dose as the primary series has been completed and the latest TBE dose was administered more than 3 years ago. 
Check for contraindications.
*/
define "The primary series is complete Guidance":
  'Should vaccinate client with TBE booster dose as the primary series has been completed and the latest TBE dose was administered more than 3 years ago. 
Check for contraindications.'

/*
@output: Clinical judgement is required. Create a clinical note
@pseudocode: "Immunization recommendation status" = "Further evaluation needed"
*/
define "Clinical judgement is required. Create a clinical note":
  Encounter."Three TBE primary series doses were administered"
    and Encounter."At least one booster dose was administered"

/*
@output: Clinical judgement is required. Create a clinical note Guidance
@guidance: Assess if supplementary booster TBE dose(s) are necessary and create a clinical note. 
Check for any vaccines due.
*/
define "Clinical judgement is required. Create a clinical note Guidance":
  'Assess if supplementary booster TBE dose(s) are necessary and create a clinical note. 
Check for any vaccines due.'


/*
@test: Test expected results based on example patients
*/
define "Test Validation":
  case
    when Patient.id = '24.1' then "Client is not due for TBE vaccination Case 1" and "Guidance" = 'Should not vaccinate client with first TBE dose as client\'s age is less than 1 year. 
Check for any vaccines due and inform the caregiver of when to come back for the first dose.'
    when Patient.id = '25.01' then "Client is due for TBE vaccination Case 1" and "Guidance" = 'Should vaccinate client with first TBE dose as no TBE doses have been administered and client\'s age is more than 1 year. 
Check for contraindications.'
    when Patient.id = '26.03' then "Client is not due for TBE vaccination Case 2" and "Guidance" = 'Should not vaccinate client with second TBE dose as the latest dose was administered less than 1 month ago. 
Check for any vaccines due and inform the caregiver of when to come back for the next dose.'
    when Patient.id = '27.03' then "Client is due for TBE vaccination Case 2" and "Guidance" = 'Should vaccinate client with second TBE dose as the latest dose was administered more than 1 month ago. 
Check for contraindications.'
    when Patient.id = '28.03' then "Client is not due for TBE vaccination Case 3" and "Guidance" = 'Should not vaccinate client with third TBE dose as the latest dose was administered less than 9 months ago. 
Check for any vaccines due and inform the caregiver of when to come back for the next dose.'
    when Patient.id = '29.03' then "Client is due for TBE vaccination Case 3" and "Guidance" = 'Should vaccinate client with third TBE dose as the latest dose was administered more than 9 months ago.
Check for contraindications.'
    when Patient.id = '30.023' then "The primary series is complete. Client is not due for TBE booster dose" and "Guidance" = 'Should not vaccinate client with TBE booster dose as the latest TBE dose was administered less than 3 years ago. 
Check for any vaccines due and inform the caregiver of when to come back for the booster dose.'
    when Patient.id = '31.023' then "The primary series is complete" and "Guidance" = 'Should vaccinate client with TBE booster dose as the primary series has been completed and the latest TBE dose was administered more than 3 years ago. 
Check for contraindications.'
    when Patient.id = '32.02' then "Clinical judgement is required. Create a clinical note" and "Guidance" = 'Assess if supplementary booster TBE dose(s) are necessary and create a clinical note. 
Check for any vaccines due.'
    else 'No test case set'
  end
Content: application/elm+xml
Encoded data (112832 characters)