SMART Base
0.2.0 - ci-build
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.
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:
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
Logical Model representing Dublin Core metadata elements as defined at https://www.dublincore.org/specifications/dublin-core/dcmi-terms/
Logical Model for representing a complete Digital Adaptation Kit (DAK) with metadata and all 9 DAK components
Logical Model for representing non-functional requirement from a DAK
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
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.
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.
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.
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
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
Logical Model for representing User Scenarios from a DAK. Narratives that describe how the different personas may interact with each other.
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
Base logical model providing the common schema metadata interface inherited by all SMART Guidelines logical models. Every SMART Guidelines logical model schema derives from this base, which documents the shared FHIR and JSON-LD metadata properties used by the JSON Schema generation pipeline.
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.
Logical Model for representing functional requirement from a DAK
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
Logical Model for representing Test Scenarios from a DAK. A set of test scenarios to validate an implementation of the DAK.
JSON Schema defining the structure of the Logical Model enumeration endpoint response
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.
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
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.
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.
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.
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
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
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.