| Title: |
IMMZD2DTHepatitisBElements |
| Id: |
IMMZD2DTHepatitisBElements |
| Version: |
0.2.0 |
| Url: |
IMMZD2DTHepatitisBElements |
| Status: |
draft |
| Experimental: |
true |
| Type: |
system: http://terminology.hl7.org/CodeSystem/library-type
code: logic-library
|
| Date: |
2025-07-02 07:24:46+0000 |
| Publisher: |
WHO |
| Description: |
This library defines context-independent elements for Hepatitis B used throughout the Immunization CPG
|
| Related Artifacts: |
Dependencies
|
| Parameters: |
| Name | Type | Min | Max | In/Out |
|---|
| HepBBirthDoseAgeLimitDays | integer | 0 | 1 | In |
|---|
| HepBLowerLimitWeeks | integer | 0 | 1 | In |
|---|
| Patient | Patient | 0 | 1 | Out |
|---|
| Hepatitis B Doses Administered to Patient | Immunization | 0 | * | Out |
|---|
| Date of Latest Hepatitis B Dose | date | 0 | 1 | Out |
|---|
| Date of First Hepatitis B Dose | date | 0 | 1 | Out |
|---|
| Hepatitis B Dose 0 Doses Administered to Patient | Immunization | 0 | * | Out |
|---|
| Number of Hepatitis B Dose 0 Doses Administered | integer | 0 | 1 | Out |
|---|
| Hepatitis B birth dose was not administered | boolean | 0 | 1 | Out |
|---|
| Hepatitis B birth dose was administered | boolean | 0 | 1 | Out |
|---|
| Hepatitis B Primary Series Doses Administered to Patient | Immunization | 0 | * | Out |
|---|
| Number of Hepatitis B Primary Series Doses Administered | integer | 0 | 1 | Out |
|---|
| No hepatitis B primary series doses were administered | boolean | 0 | 1 | Out |
|---|
| One hepatitis B primary series dose was administered | boolean | 0 | 1 | Out |
|---|
| One hepatitis B primary series doses were administered | boolean | 0 | 1 | Out |
|---|
| Two hepatitis B primary series doses were administered | boolean | 0 | 1 | Out |
|---|
| Three hepatitis B primary series doses were administered | boolean | 0 | 1 | Out |
|---|
| Number of Hepatitis B Doses Administered | integer | 0 | 1 | Out |
|---|
| No hepatitis B doses were administered | boolean | 0 | 1 | Out |
|---|
| One hepatitis B dose was administered | boolean | 0 | 1 | Out |
|---|
| Two hepatitis B doses were administered | boolean | 0 | 1 | Out |
|---|
| Three hepatitis B doses were administered | boolean | 0 | 1 | Out |
|---|
| Client's age is less than {Member States defined upper limit} | boolean | 0 | 1 | Out |
|---|
| Client's age is more than {Member States defined upper limit} | boolean | 0 | 1 | Out |
|---|
| Client's age is less than {Member States defined lower limit} | boolean | 0 | 1 | Out |
|---|
| Client's age is more than or equal to {Member States defined lower limit} | boolean | 0 | 1 | Out |
|---|
| Client's age is more than {Member States defined lower limit} | boolean | 0 | 1 | Out |
|---|
| Client's weight at birth was over 2000 g | boolean | 0 | 1 | Out |
|---|
| Client's weight at birth was below 2000 g | boolean | 0 | 1 | Out |
|---|
| Client was not a premature infant at birth | boolean | 0 | 1 | Out |
|---|
| Client was a premature infant at birth | boolean | 0 | 1 | Out |
|---|
| The latest hepatitis B dose was administered less than 4 weeks ago | boolean | 0 | 1 | Out |
|---|
| The latest hepatitis B dose was administered more than 4 weeks ago | boolean | 0 | 1 | Out |
|---|
| The first hepatitis B dose was administered less than 6 months ago | boolean | 0 | 1 | Out |
|---|
| The first hepatitis B dose was administered more than 6 months ago | boolean | 0 | 1 | Out |
|---|
|
| Content: text/cql |
|---|
/*
* Library: IMMZD2DTHepatitisBElements
*/
library IMMZD2DTHepatitisBElements
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 IMMZElements called Elements
parameter HepBBirthDoseAgeLimitDays Integer default 1
parameter HepBLowerLimitWeeks Integer default 4
context Patient
/*
@internal: Hepatitis B containing Doses Administered to Patient
*/
define "Hepatitis B Doses Administered to Patient":
Elements."Doses Administered to Patient" I
where
I.vaccineCode in Concepts."Hepatitis B-containing vaccines"
/*
@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 (Birth) series
*/
define "Hepatitis B Dose 0 Doses Administered to Patient":
"Hepatitis B Doses Administered to Patient".seriesDose0()
/*
@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":
"Hepatitis B Doses Administered to Patient".seriesPrimary()
/*
@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}":
Elements."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 that. See https://github.com/WorldHealthOrganization/smart-dak-immz/issues/8
*/
define "Client's age is more than {Member States defined upper limit}":
Elements."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}":
Elements."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}":
Elements."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}":
Elements."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":
Elements."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":
Elements."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":
Elements."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":
Elements."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 Now() < 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 Now() < 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 (81032 characters)
|
|