IMMZD2DTHPVSingleDose ValueSet for Decision Table - WHO Immunization Implementation Guide v0.2.0

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

ValueSet: IMMZD2DTHPVSingleDose ValueSet for Decision Table

Official URL: http://smart.who.int/immunizations/ValueSet/IMMZD2DTHPVSingleDoseVS				Version: 0.2.0
Active as of 2025-11-25				Computable Name: IMMZD2DTHPVSingleDoseVS

ValueSet IMMZD2DTHPVSingleDose for IMMZ.D2.DT.HPV.Single dose. Business rule: Determine if the client is due for a human papillomavirus (HPV) vaccination according to the national immunization schedule Trigger: IMMZ.D2 Determine required vaccination(s) if any Table: Alternative single-dose schedule

References

This value set is not used here; it may be used elsewhere (e.g. specifications and/or implementations that use this content)

Logical Definition (CLD)

Include these codes as defined in http://smart.who.int/immunizations/CodeSystem/IMMZDAK version 📦0.2.0

Expansion

This value set expansion contains 17 concepts.

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

API Information

IMMZD2DTHPVSingleDose ValueSet for Decision Table Schema API

JSON Schema for IMMZD2DTHPVSingleDose ValueSet for Decision Table ValueSet codes. Generated from FHIR expansions using IRI format.

Version: 1.0.0

Endpoints

GET /ValueSet-IMMZD2DTHPVSingleDoseVS.schema.json

JSON Schema definition for the enumeration ValueSet-IMMZD2DTHPVSingleDoseVS

This endpoint serves the JSON Schema definition for the enumeration ValueSet-IMMZD2DTHPVSingleDoseVS.

Schema Definition

ValueSet-IMMZD2DTHPVSingleDoseVS

Description: JSON Schema for IMMZD2DTHPVSingleDose ValueSet for Decision Table ValueSet codes. Generated from FHIR expansions using IRI format.

Type: string

Schema ID: http://smart.who.int/immunizations/ValueSet-IMMZD2DTHPVSingleDoseVS.schema.json

Available Values

http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's age is less than 9 years-40http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is not due for HPV vaccination-48http://smart.who.int/immunizations/CodeSystem/IMMZDAK#No HPV primary series doses were administered-112http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's age is between 9 and 20 years-51http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is due for HPV vaccination-44http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's age is more than 20 years-41http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Clinical judgement is required. Create a clinical note.-66http://smart.who.int/immunizations/CodeSystem/IMMZDAK#One HPV primary series dose was administered-112http://smart.who.int/immunizations/CodeSystem/IMMZDAK#The latest HPV dose was administered less than 6 months ago-103http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's HIV status is positive-29http://smart.who.int/immunizations/CodeSystem/IMMZDAK#The latest HPV dose was administered more than 6 months ago-103http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is immunocompromised-26http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is not immunocompromised-26http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's HIV status is negative or unknown-29http://smart.who.int/immunizations/CodeSystem/IMMZDAK#HPV immunization schedule is complete-49http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Two HPV primary series doses were administered-112http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Three HPV primary series doses were administered-112

Full Schema (JSON)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://smart.who.int/immunizations/ValueSet-IMMZD2DTHPVSingleDoseVS.schema.json",
  "title": "IMMZD2DTHPVSingleDose ValueSet for Decision Table Schema",
  "description": "JSON Schema for IMMZD2DTHPVSingleDose ValueSet for Decision Table ValueSet codes. Generated from FHIR expansions using IRI format.",
  "type": "string",
  "enum": [
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's age is less than 9 years-40",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is not due for HPV vaccination-48",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#No HPV primary series doses were administered-112",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's age is between 9 and 20 years-51",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is due for HPV vaccination-44",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's age is more than 20 years-41",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Clinical judgement is required. Create a clinical note.-66",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#One HPV primary series dose was administered-112",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#The latest HPV dose was administered less than 6 months ago-103",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's HIV status is positive-29",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#The latest HPV dose was administered more than 6 months ago-103",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is immunocompromised-26",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client is not immunocompromised-26",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Client's HIV status is negative or unknown-29",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#HPV immunization schedule is complete-49",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Two HPV primary series doses were administered-112",
    "http://smart.who.int/immunizations/CodeSystem/IMMZDAK#Three HPV primary series doses were administered-112"
  ],
  "narrative": "This schema validates IRI-formatted codes for the IMMZD2DTHPVSingleDose 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-IMMZD2DTHPVSingleDoseVS.displays.json. For a complete listing of all ValueSets, see artifacts.html#terminology-value-sets.",
  "fhir:displays": "http://smart.who.int/immunizations/ValueSet-IMMZD2DTHPVSingleDoseVS.displays.json",
  "fhir:valueSet": "http://smart.who.int/immunizations/ValueSet/IMMZD2DTHPVSingleDoseVS",
  "fhir:version": "0.2.0",
  "fhir:expansionTimestamp": "2025-09-29T20:59:26.458Z"
}

This documentation is automatically generated from the OpenAPI specification.

IG © 2023+ WHO. Package smart.who.int.immunizations#0.2.0 based on FHIR 4.0.1. Generated 2025-11-25
Links: Table of Contents | QA Report | Version History | License

Code	Display	Definition
Client's age is less than 9 years-40	Client's age is less than 9 years	Today's date − "Date of birth" < 9 years
Client is not due for HPV vaccination-48	Client is not due for HPV vaccination	"Immunization recommendation status" = "Not due"
No HPV primary series doses were administered-112	No HPV primary series doses were administered	Count of vaccines administered (where "Vaccine type" = "HPV vaccines" and "Type of dose" = "Primary series") = 0
Client's age is between 9 and 20 years-51	Client's age is between 9 and 20 years	9 years ≤ Today's date − "Date of birth" ≤ 20 years
Client is due for HPV vaccination-44	Client is due for HPV vaccination	"Immunization recommendation status" = "Due"
Client's age is more than 20 years-41	Client's age is more than 20 years	Today's date − "Date of birth" > 20 years
Clinical judgement is required. Create a clinical note.-66	Clinical judgement is required. Create a clinical note.	"Immunization recommendation status" = "Further evaluation needed"
One HPV primary series dose was administered-112	One HPV primary series dose was administered	Count of vaccines administered (where "Vaccine type" = "HPV vaccines" and "Type of dose" = "Primary series") = 1
The latest HPV dose was administered less than 6 months ago-103	The latest HPV dose was administered less than 6 months ago	Today's date − latest "Date and time of vaccination" (where "Vaccine type" = "HPV vaccines") < 6 months
Client's HIV status is positive-29	Client's HIV status is positive	"HIV status" = "HIV-positive"
The latest HPV dose was administered more than 6 months ago-103	The latest HPV dose was administered more than 6 months ago	Today's date − latest "Date and time of vaccination" (where "Vaccine type" = "HPV vaccines") ≥ 6 months
Client is immunocompromised-26	Client is immunocompromised	"Immunocompromised" = TRUE
Client is not immunocompromised-26	Client is not immunocompromised	"Immunocompromised" ≠ TRUE
Client's HIV status is negative or unknown-29	Client's HIV status is negative or unknown	"HIV status" ≠ "HIV-positive"
HPV immunization schedule is complete-49	HPV immunization schedule is complete	"Immunization recommendation status" = "Complete"
Two HPV primary series doses were administered-112	Two HPV primary series doses were administered	Count of vaccines administered (where "Vaccine type" = "HPV vaccines" and "Type of dose" = "Primary series") = 2
Three HPV primary series doses were administered-112	Three HPV primary series doses were administered	Count of vaccines administered (where "Vaccine type" = "HPV vaccines" and "Type of dose" = "Primary series") = 3

System	Code	Display	JSON	XML
`http://smart.who.int/immunizations/CodeSystem/IMMZDAK`	Client's age is less than 9 years-40	Client's age is less than 9 years
`http://smart.who.int/immunizations/CodeSystem/IMMZDAK`	Client is not due for HPV vaccination-48	Client is not due for HPV vaccination
`http://smart.who.int/immunizations/CodeSystem/IMMZDAK`	No HPV primary series doses were administered-112	No HPV primary series doses were administered
`http://smart.who.int/immunizations/CodeSystem/IMMZDAK`	Client's age is between 9 and 20 years-51	Client's age is between 9 and 20 years
`http://smart.who.int/immunizations/CodeSystem/IMMZDAK`	Client is due for HPV vaccination-44	Client is due for HPV vaccination
`http://smart.who.int/immunizations/CodeSystem/IMMZDAK`	Client's age is more than 20 years-41	Client's age is more than 20 years
`http://smart.who.int/immunizations/CodeSystem/IMMZDAK`	Clinical judgement is required. Create a clinical note.-66	Clinical judgement is required. Create a clinical note.
`http://smart.who.int/immunizations/CodeSystem/IMMZDAK`	One HPV primary series dose was administered-112	One HPV primary series dose was administered
`http://smart.who.int/immunizations/CodeSystem/IMMZDAK`	The latest HPV dose was administered less than 6 months ago-103	The latest HPV dose was administered less than 6 months ago
`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`	The latest HPV dose was administered more than 6 months ago-103	The latest HPV dose was administered more than 6 months ago
`http://smart.who.int/immunizations/CodeSystem/IMMZDAK`	Client is immunocompromised-26	Client is immunocompromised
`http://smart.who.int/immunizations/CodeSystem/IMMZDAK`	Client is not immunocompromised-26	Client is not immunocompromised
`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`	HPV immunization schedule is complete-49	HPV immunization schedule is complete
`http://smart.who.int/immunizations/CodeSystem/IMMZDAK`	Two HPV primary series doses were administered-112	Two HPV primary series doses were administered
`http://smart.who.int/immunizations/CodeSystem/IMMZDAK`	Three HPV primary series doses were administered-112	Three HPV primary series doses were administered