WHO SMART Guidelines - HIV
0.4.4 - ci-build
WHO SMART Guidelines - HIV, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.4.4 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-hiv/tree/main 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:
This tab describes data about a facility or region that are used in workflows and decision logic (i.e. WHO recommendations depend upon these data elements), but are not specific to an individual (e.g. a high HIV burden setting)
This tab describes the data that are collected during the referral workflow (HIV.I)
This tab describes the data that are collected during the workflow for diagnostics for HIV (HIV.G)
This tab describes the data that are collected during the HIV Testing services visit workflow (HIV.B)
This tab describes the data that are collected during the registration workflow (HIV.A)
This tab describes the data that may be collected during care and treatment clinical visit for HIV workflow (HIV.D)
This tab describes the data that are collected during the follow-up and contacting clients workflow (HIV.H)
This tab describes the data that may be collected during care and treatment clinical visit for HIV/TB care (HIV.D)
This tab describes the data that are collected relevant to HIV care and treatment of pregnant and postpartum women and their newborns during the delivery and postpartum care and the infant diagnosis and final HIV status workflows (HIV.E and HIV.F)
This tab describes the data that may be collected during the pre-exposure prophylaxis (PrEP) or post-exposure prophylaxis (PEP) workflow (HIV.C)
JSON Schema defining the structure of the Logical Model enumeration endpoint response
This tab describes the data that are collected during case surveillance (these data elements are drawn from other tabs and do not include data element IDs).
This tab describes the data that are collected during HIV prevention activities (not covered in the previous business processes)
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.