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: IMMZ.D.DE1 ValueSet for Immunization event status

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

ValueSet for Immunization event status for IMMZ.D.DE1

References

Logical Definition (CLD)

  • Include these codes as defined in http://smart.who.int/immunizations/CodeSystem/IMMZ.D version 📦0.2.0
    CodeDisplayDefinition
    DE2CompletedThe immunization event was successfully carried out as intended
    DE3Entered in errorImmunization event record has been mistakenly created or entered into the system. Recorded information is incorrect or should not have been documented, though it is possible that real-world decisions were based on it
    DE4Not donePlanned immunization event was not carried out for some reason

 

Expansion

This value set expansion contains 3 concepts.

SystemCodeDisplayJSONXML
http://smart.who.int/immunizations/CodeSystem/IMMZ.D  DE2Completed
http://smart.who.int/immunizations/CodeSystem/IMMZ.D  DE3Entered in error
http://smart.who.int/immunizations/CodeSystem/IMMZ.D  DE4Not done

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

IMMZ.D.DE1 ValueSet for Immunization event status Schema API

JSON Schema for IMMZ.D.DE1 ValueSet for Immunization event status ValueSet codes. Generated from FHIR expansions using IRI format.

Version: 1.0.0

Endpoints

GET /ValueSet-IMMZ.D.DE1.schema.json

JSON Schema definition for the enumeration ValueSet-IMMZ.D.DE1

This endpoint serves the JSON Schema definition for the enumeration ValueSet-IMMZ.D.DE1.

Schema Definition

ValueSet-IMMZ.D.DE1

Description: JSON Schema for IMMZ.D.DE1 ValueSet for Immunization event status ValueSet codes. Generated from FHIR expansions using IRI format.

Type: string

Schema ID: http://smart.who.int/immunizations/ValueSet-IMMZ.D.DE1.schema.json

Available Values

http://smart.who.int/immunizations/CodeSystem/IMMZ.D#DE2http://smart.who.int/immunizations/CodeSystem/IMMZ.D#DE3http://smart.who.int/immunizations/CodeSystem/IMMZ.D#DE4
Full Schema (JSON)
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://smart.who.int/immunizations/ValueSet-IMMZ.D.DE1.schema.json",
  "title": "IMMZ.D.DE1 ValueSet for Immunization event status Schema",
  "description": "JSON Schema for IMMZ.D.DE1 ValueSet for Immunization event status ValueSet codes. Generated from FHIR expansions using IRI format.",
  "type": "string",
  "enum": [
    "http://smart.who.int/immunizations/CodeSystem/IMMZ.D#DE2",
    "http://smart.who.int/immunizations/CodeSystem/IMMZ.D#DE3",
    "http://smart.who.int/immunizations/CodeSystem/IMMZ.D#DE4"
  ],
  "narrative": "This schema validates IRI-formatted codes for the IMMZ.D.DE1 ValueSet for Immunization event status 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-IMMZ.D.DE1.displays.json. For a complete listing of all ValueSets, see artifacts.html#terminology-value-sets.",
  "fhir:displays": "http://smart.who.int/immunizations/ValueSet-IMMZ.D.DE1.displays.json",
  "fhir:valueSet": "http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE1",
  "fhir:version": "0.2.0",
  "fhir:expansionTimestamp": "2025-06-25T16:39:07.092Z"
}

This documentation is automatically generated from the OpenAPI specification.