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/123/merge and changes regularly. See the Directory of published versions
This page provides access to Data Access Kit (DAK) API documentation and schemas.
This page provides access to all available DAK (Data Access Kit) API endpoints and schemas. The DAK API provides structured access to ValueSet enumerations and Logical Model definitions used throughout this implementation guide.
Interactive Swagger UI documentation for all generated schemas and external API specifications is available in the OpenAPI documentation hub: View OpenAPI Documentation
Each JSON Schema can be used to validate data structures in your applications. The schemas follow the JSON Schema Draft 2020-12 specification and include:
The JSON-LD vocabularies provide semantic web integration for ValueSet enumerations. Each vocabulary includes:
All schemas are derived from the FHIR definitions in this implementation guide. Each schema page includes links to the corresponding FHIR resource definitions for complete context.
The enumeration endpoints provide machine-readable lists of all available schemas, making it easy to discover and integrate with the available data structures programmatically.
The following logical models define the structure for computable representations of WHO DAK content:
Data elements for the IMMZ.D1.Capture or update client history Data Dictionary Activity.
Data elements for the IMMZ.D17.Report AEFI Data Dictionary Activity.
Data elements for the IMMZ.D21.Generate verifiable digital certificate Data Dictionary Activity.
Data elements for the IMMZ.D20.Does client require a verifiable digital certificate Data Dictionary Activity.
Data elements for the IMMZ.D13.Update client record Data Dictionary Activity.
Data elements for the IMMZ.C4.Create client record Data Dictionary Activity. Identical to IMMZ.C5.3.Update client details.
Data elements for the IMMZ.D7.Counsel client Data Dictionary Activity.
Data elements for the IMMZ.D2.Determine required vaccination(s) Data Dictionary Activity.
JSON Schema defining the structure of the Logical Model enumeration endpoint response
Data elements for the IMMZ.D5.Determine vaccine(s) to be administered based on contraindications Data Dictionary Activity.
Data elements for the IMMZ.D18.Determine time for next visit Data Dictionary Activity.
These endpoints provide lists of all available schemas and vocabularies of each type:
Enumeration of all available ValueSet schemas
Enumeration of all available Logical Model schemas
This documentation hub is automatically generated from the available schema and API definitions.