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/tree/main and changes regularly. See the Directory of published versions
| Official URL: http://smart.who.int/immunizations/ValueSet/IMMZD2DTBCGVS | Version: 0.2.0 | |||
| Active as of 2025-11-25 | Computable Name: IMMZD2DTBCGVS | |||
ValueSet IMMZD2DTBCG for IMMZ.D2.DT.BCG. Business rule: Determine if the client is due for a bacille Calmette–Guérin (BCG) vaccination according to the national immunization schedule Trigger: IMMZ.D2 Determine required vaccination(s) if any Table: IMMZ.D2.DT.BCG
References
This value set is not used here; it may be used elsewhere (e.g. specifications and/or implementations that use this content)
http://smart.who.int/immunizations/CodeSystem/IMMZDAK version 📦0.2.0| Code | Display | Definition |
| No BCG primary series dose was administered-112 | No BCG primary series dose was administered | Count of vaccines administered (where "Vaccine type" = "BCG vaccines" and "Type of dose" = "Primary series") = 0 |
| Client's age is less than or equal to 28 days-40 | Client's age is less than or equal to 28 days | Today's date − "Date of birth" ≤ 28 days |
| Client's HIV status is negative or unknown-29 | Client's HIV status is negative or unknown | "HIV status" ≠ "HIV-positive" |
| No live vaccine was administered-90 | No live vaccine was administered | Today's date − latest "Date and time of vaccination" (where "Live vaccine" = TRUE) IS NULL |
| Client is due for BCG vaccination-44 | Client is due for BCG vaccination | "Immunization recommendation status" = "Due" |
| Live vaccine was administered in the last four weeks-92 | Live vaccine was administered in the last four weeks | Today's date − latest "Date and time of vaccination" (where "Live vaccine" = TRUE) < 4 weeks |
| Client is not due for BCG vaccination-48 | Client is not due for BCG vaccination | "Immunization recommendation status" = "Not due" |
| Client's HIV status is positive-29 | Client's HIV status is positive | "HIV status" = "HIV-positive" |
| Client is currently receiving antiretroviral therapy-25 | Client is currently receiving antiretroviral therapy | "Currently on ART" = TRUE |
| Client is immunologically stable-31 | Client is immunologically stable | "Immunologically stable" = TRUE |
| Client is not immunologically stable-32 | Client is not immunologically stable | "Immunologically stable" = FALSE |
| Client is currently not receiving antiretroviral therapy-26 | Client is currently not receiving antiretroviral therapy | "Currently on ART" = FALSE |
| Client's age is between 28 days and 5 years-50 | Client's age is between 28 days and 5 years | 28 days < Today's date − "Date of birth" < 5 years |
| Client's TB infection test result is negative-39 | Client's TB infection test result is negative | "TB infection test result" = "Negative" |
| No live vaccine was administered in the last four weeks-92 | No live vaccine was administered in the last four weeks | Today's date − latest "Date and time of vaccination" (where "Live vaccine" = TRUE) ≥ 4 weeks |
| Client's TB infection test result is unknown (test not done or no result yet)-34 | Client's TB infection test result is unknown (test not done or no result yet) | "TB infection test result" IS NULL |
| Clinical judgement is required. Create clinical note.-66 | Clinical judgement is required. Create clinical note. | "Immunization recommendation status" = "Further evaluation needed" |
| Client's TB infection test result is positive-39 | Client's TB infection test result is positive | "TB infection test result" = "Positive" |
| Client is not clinically well-25 | Client is not clinically well | "Clinically well" = FALSE |
| Client is clinically well-24 | Client is clinically well | "Clinically well" = TRUE |
| Client's age is more than 5 years-40 | Client's age is more than 5 years | Today's date − "Date of birth" ≥ 5 years |
| Clinical judgement is required. Create clinical note.-67 | Clinical judgement is required. Create clinical note. | '"Immunization recommendation status" = "Further evaluation needed" |
| One BCG primary series dose was administered-112 | One BCG primary series dose was administered | Count of vaccines administered (where "Vaccine type" = "BCG vaccines" and "Type of dose" = "Primary series") = 1 |
| BCG immunization schedule is complete-140 | BCG immunization schedule is complete | '"Immunization recommendation status" = "Complete" "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "BCG vaccines") |
This value set expansion contains 24 concepts.
| System | Code | Display | JSON | XML |
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | No BCG primary series dose was administered-112 | No BCG primary series dose was administered | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client's age is less than or equal to 28 days-40 | Client's age is less than or equal to 28 days | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client's HIV status is negative or unknown-29 | Client's HIV status is negative or unknown | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | No live vaccine was administered-90 | No live vaccine was administered | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client is due for BCG vaccination-44 | Client is due for BCG vaccination | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Live vaccine was administered in the last four weeks-92 | Live vaccine was administered in the last four weeks | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client is not due for BCG vaccination-48 | Client is not due for BCG vaccination | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client's HIV status is positive-29 | Client's HIV status is positive | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client is currently receiving antiretroviral therapy-25 | Client is currently receiving antiretroviral therapy | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client is immunologically stable-31 | Client is immunologically stable | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client is not immunologically stable-32 | Client is not immunologically stable | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client is currently not receiving antiretroviral therapy-26 | Client is currently not receiving antiretroviral therapy | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client's age is between 28 days and 5 years-50 | Client's age is between 28 days and 5 years | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client's TB infection test result is negative-39 | Client's TB infection test result is negative | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | No live vaccine was administered in the last four weeks-92 | No live vaccine was administered in the last four weeks | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client's TB infection test result is unknown (test not done or no result yet)-34 | Client's TB infection test result is unknown (test not done or no result yet) | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Clinical judgement is required. Create clinical note.-66 | Clinical judgement is required. Create clinical note. | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client's TB infection test result is positive-39 | Client's TB infection test result is positive | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client is not clinically well-25 | Client is not clinically well | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client is clinically well-24 | Client is clinically well | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Client's age is more than 5 years-40 | Client's age is more than 5 years | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | Clinical judgement is required. Create clinical note.-67 | Clinical judgement is required. Create clinical note. | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | One BCG primary series dose was administered-112 | One BCG primary series dose was administered | ||
http://smart.who.int/immunizations/CodeSystem/IMMZDAK | BCG immunization schedule is complete-140 | BCG immunization schedule is complete |
Explanation of the columns that may appear on this page:
| Level | A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies |
| System | The source of the definition of the code (when the value set draws in codes defined elsewhere) |
| Code | The code (used as the code in the resource instance) |
| Display | The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application |
| Definition | An explanation of the meaning of the concept |
| Comments | Additional notes about how to use the code |
JSON Schema for IMMZD2DTBCG ValueSet for Decision Table ValueSet codes. Generated from FHIR expansions using IRI format.
Version: 1.0.0
This endpoint serves the JSON Schema definition for the enumeration ValueSet-IMMZD2DTBCGVS.
Description: JSON Schema for IMMZD2DTBCG ValueSet for Decision Table ValueSet codes. Generated from FHIR expansions using IRI format.
Type: string
Schema ID: http://smart.who.int/immunizations/ValueSet-IMMZD2DTBCGVS.schema.json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "http://smart.who.int/immunizations/ValueSet-IMMZD2DTBCGVS.schema.json",
"title": "IMMZD2DTBCG ValueSet for Decision Table Schema",
"description": "JSON Schema for IMMZD2DTBCG ValueSet for Decision Table ValueSet codes. Generated from FHIR expansions using IRI format.",
"type": "string",
"enum": [
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#No BCG primary series dose was administered-112",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's age is less than or equal to 28 days-40",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's HIV status is negative or unknown-29",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#No live vaccine was administered-90",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is due for BCG vaccination-44",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Live vaccine was administered in the last four weeks-92",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is not due for BCG vaccination-48",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's HIV status is positive-29",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is currently receiving antiretroviral therapy-25",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is immunologically stable-31",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is not immunologically stable-32",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is currently not receiving antiretroviral therapy-26",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's age is between 28 days and 5 years-50",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's TB infection test result is negative-39",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#No live vaccine was administered in the last four weeks-92",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's TB infection test result is unknown (test not done or no result yet)-34",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Clinical judgement is required. Create clinical note.-66",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's TB infection test result is positive-39",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is not clinically well-25",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is clinically well-24",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's age is more than 5 years-40",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Clinical judgement is required. Create clinical note.-67",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#One BCG primary series dose was administered-112",
"http://smart.who.int/immunizations/CodeSystem/IMMZDAK#BCG immunization schedule is complete-140"
],
"narrative": "This schema validates IRI-formatted codes for the IMMZD2DTBCG ValueSet for Decision Table ValueSet. Each enum value includes the system URI in the format {systemuri}#{code} to match JSON-LD enumeration IRIs. Display values are available at http://smart.who.int/immunizations/ValueSet-IMMZD2DTBCGVS.displays.json. For a complete listing of all ValueSets, see artifacts.html#terminology-value-sets.",
"fhir:displays": "http://smart.who.int/immunizations/ValueSet-IMMZD2DTBCGVS.displays.json",
"fhir:valueSet": "http://smart.who.int/immunizations/ValueSet/IMMZD2DTBCGVS",
"fhir:version": "0.2.0",
"fhir:expansionTimestamp": "2025-09-29T20:59:26.458Z"
}This documentation is automatically generated from the OpenAPI specification.