DAK API Documentation Hub

SMART Base, 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-base/tree/main and changes regularly. See the Directory of published versions

This page provides access to Data Access Kit (DAK) API documentation and schemas.

DAK API Documentation Hub

API Enumeration Endpoints

These endpoints provide lists of all available schemas and vocabularies of each type:

ValueSets.schema.json

Enumeration of all available ValueSet schemas

Available Endpoints:

ValueSet-CDHIv1.schema.json - JSON Schema for Classification of Digital Health Interventions v1 Schema
ValueSet-CoreDataElementTypeVS.schema.json - JSON Schema for Core Data Element Type Value Set Schema
ValueSet-DecisionTableActions.schema.json - JSON Schema for Smart Guidelines Decision Table Actions Schema
ValueSet-SGPersonaTypesVS.schema.json - JSON Schema for Smart Guidelines Persona Types Value Set Schema
ValueSet-CDSCv1.schema.json - JSON Schema for Classification of Digital Health System Categories v1 Schema

LogicalModels.schema.json

Enumeration of all available Logical Model schemas

Available Endpoints:

StructureDefinition-DecisionSupportLogicSource.schema.json - JSON Schema for Decision Support Logic Source
StructureDefinition-DublinCore.schema.json - JSON Schema for Dublin Core Metadata Element Set
StructureDefinition-DAK.schema.json - JSON Schema for Digital Adaptation Kit (DAK)
StructureDefinition-NonFunctionalRequirement.schema.json - JSON Schema for Non-Functional Requirement (DAK)
StructureDefinition-CoreDataElementSource.schema.json - JSON Schema for Core Data Element Source
StructureDefinition-ProgramIndicator.schema.json - JSON Schema for Program Indicator (DAK)
StructureDefinition-HealthInterventions.schema.json - JSON Schema for Health Interventions and Recommendations (DAK)
StructureDefinition-DecisionSupportLogic.schema.json - JSON Schema for Decision-Support Logic (DAK)
StructureDefinition-UserScenarioSource.schema.json - JSON Schema for User Scenario Source
StructureDefinition-HealthInterventionsSource.schema.json - JSON Schema for Health Interventions Source
StructureDefinition-UserScenario.schema.json - JSON Schema for User Scenario (DAK)
StructureDefinition-ProgramIndicatorSource.schema.json - JSON Schema for Program Indicator Source
StructureDefinition-GenericPersona.schema.json - JSON Schema for Generic Persona (DAK)
StructureDefinition-FunctionalRequirement.schema.json - JSON Schema for Functional Requirement (DAK)
StructureDefinition-TestScenarioSource.schema.json - JSON Schema for Test Scenario Source
StructureDefinition-TestScenario.schema.json - JSON Schema for Test Scenario (DAK)
StructureDefinition-Persona.schema.json - JSON Schema for Persona (DAK)
StructureDefinition-BusinessProcessWorkflow.schema.json - JSON Schema for Business Process Workflow (DAK)
StructureDefinition-GenericPersonaSource.schema.json - JSON Schema for Generic Persona Source
StructureDefinition-Requirements.schema.json - JSON Schema for Functional and Non-Functional Requirements (DAK)
StructureDefinition-SushiConfigLogicalModel.schema.json - JSON Schema for SUSHI Configuration Logical Model
StructureDefinition-CoreDataElement.schema.json - JSON Schema for Core Data Element (DAK)
StructureDefinition-RequirementsSource.schema.json - JSON Schema for Requirements Source
StructureDefinition-BusinessProcessWorkflowSource.schema.json - JSON Schema for Business Process Workflow Source

ValueSet Schemas (5 available)

JSON Schema definitions for FHIR ValueSets, providing structured enumeration of allowed code values:

Classification of Digital Health Interventions v1 Schema

JSON Schema for Classification of Digital Health Interventions v1 ValueSet codes. Generated from FHIR expansions using IRI format.

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🔗 OpenAPI

Core Data Element Type Value Set Schema

JSON Schema for Core Data Element Type Value Set ValueSet codes. Generated from FHIR expansions using IRI format.

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🔗 OpenAPI

Smart Guidelines Decision Table Actions Schema

JSON Schema for Smart Guidelines Decision Table Actions ValueSet codes. Generated from FHIR expansions using IRI format.

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🔗 OpenAPI

Smart Guidelines Persona Types Value Set Schema

JSON Schema for Smart Guidelines Persona Types Value Set ValueSet codes. Generated from FHIR expansions using IRI format.

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🔗 OpenAPI

Classification of Digital Health System Categories v1 Schema

JSON Schema for Classification of Digital Health System Categories v1 ValueSet codes. Generated from FHIR expansions using IRI format.

🩺 FHIR 📄 JSON Schema 🏷️ Displays 🔗 OpenAPI

Logical Model Schemas (24 available)

JSON Schema definitions for FHIR Logical Models, defining structured data elements and their relationships:

Decision Support Logic Source

Source reference for Decision Support Logic - exactly one of the following must be provided: - url (url data type): URL to retrieve DecisionSupportLogic definition from input/ or external source - canonical (canonical data type): Canonical URI pointing to the DecisionSupportLogic definition - instance: Inline DecisionSupportLogic instance data

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Dublin Core Metadata Element Set

Logical Model representing Dublin Core metadata elements as defined at https://www.dublincore.org/specifications/dublin-core/dcmi-terms/

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Digital Adaptation Kit (DAK)

Logical Model for representing a complete Digital Adaptation Kit (DAK) with metadata and all 9 DAK components

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Non-Functional Requirement (DAK)

Logical Model for representing non-functional requirement from a DAK

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Core Data Element Source

Source reference for Core Data Element - exactly one of the following must be provided: - url (url data type): URL to retrieve CoreDataElement definition from input/ or external source - canonical (canonical data type): Canonical URI pointing to the CoreDataElement definition - instance: Inline CoreDataElement instance data

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Program Indicator (DAK)

Logical Model for representing Program Indicators from a DAK. Core set of indicators that need to be aggregated for decision-making, performance metrics and subnational and national reporting.

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Health Interventions and Recommendations (DAK)

Logical Model for representing Health Interventions and Recommendations from a DAK. Overview of the health interventions and WHO, regional or national recommendations included within the DAK.

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Decision-Support Logic (DAK)

Logical Model for representing Decision-Support Logic from a DAK. Decision-support logic and algorithms to support appropriate service delivery in accordance with WHO clinical, public health and data use guidelines.

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

User Scenario Source

Source reference for User Scenario - exactly one of the following must be provided: - url (url data type): URL to retrieve UserScenario definition from input/ or external source - canonical (canonical data type): Canonical URI pointing to the UserScenario definition - instance: Inline UserScenario instance data

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Health Interventions Source

Source reference for Health Interventions - exactly one of the following must be provided: - url (url data type): URL to retrieve HealthInterventions definition from input/ or external source - canonical (canonical data type): Canonical URI pointing to the HealthInterventions definition - instance: Inline HealthInterventions instance data

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

User Scenario (DAK)

Logical Model for representing User Scenarios from a DAK. Narratives that describe how the different personas may interact with each other.

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Program Indicator Source

Source reference for Program Indicator - exactly one of the following must be provided: - url (url data type): URL to retrieve ProgramIndicator definition from input/ or external source - canonical (canonical data type): Canonical URI pointing to the ProgramIndicator definition - instance: Inline ProgramIndicator instance data

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Generic Persona (DAK)

Logical Model for representing Generic Personas from a DAK. Depiction of the human and system actors. Human actors are end users, supervisors and related stakeholders who would be interacting with the digital system or involved in the clinical care, public health or health system pathway.

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Functional Requirement (DAK)

Logical Model for representing functional requirement from a DAK

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Test Scenario Source

Source reference for Test Scenario - exactly one of the following must be provided: - url (url data type): URL to retrieve TestScenario definition from input/ or external source - canonical (canonical data type): Canonical URI pointing to the TestScenario definition - instance: Inline TestScenario instance data

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Test Scenario (DAK)

Logical Model for representing Test Scenarios from a DAK. A set of test scenarios to validate an implementation of the DAK.

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Persona (DAK)

Logical Model for representing Personas from a DAK

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Business Process Workflow (DAK)

Logical Model for representing Generic Business Processes and Workflows from a DAK. A business process is a set of related activities or tasks performed together to achieve the objectives of the health programme area.

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Generic Persona Source

Source reference for Generic Persona - exactly one of the following must be provided: - url (url data type): URL to retrieve GenericPersona definition from input/ or external source - canonical (canonical data type): Canonical URI pointing to the GenericPersona definition - instance: Inline GenericPersona instance data

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Functional and Non-Functional Requirements (DAK)

Logical Model for representing Functional and Non-Functional Requirements from a DAK. A high-level list of core functions and capabilities that the system must have to meet the end users' needs.

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

SUSHI Configuration Logical Model

Logical model defining the structure of sushi-config.yaml files used for FHIR Implementation Guide configuration. This model captures the essential metadata and configuration parameters needed for IG publishing.

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Core Data Element (DAK)

Logical Model for representing Core Data Elements from a DAK. A core data element can be one of: a ValueSet, a CodeSystem, a ConceptMap, or a Logical Model adherent to SGLogicalModel. This is the ONE EXCEPTION to allowing FHIR R4 models into the DAK LMs.

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Requirements Source

Source reference for Requirements - exactly one of the following must be provided: - url (url data type): URL to retrieve Requirements definition from input/ or external source - canonical (canonical data type): Canonical URI pointing to the Requirements definition - instance: Inline Requirements instance data

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

Business Process Workflow Source

Source reference for Business Process Workflow - exactly one of the following must be provided: - url (url data type): URL to retrieve BusinessProcessWorkflow definition from input/ or external source - canonical (canonical data type): Canonical URI pointing to the BusinessProcessWorkflow definition - instance: Inline BusinessProcessWorkflow instance data

🩺 FHIR 📄 JSON Schema 🔗 OpenAPI

OpenAPI Documentation

Complete API specification documentation for all available endpoints:

ValueSet-CDHIv1 Endpoints

API endpoints for Classification of Digital Health Interventions v1 Schema