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/ and changes regularly. See the Directory of published versions
This page provides access to Data Access Kit (DAK) API documentation and schemas.
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
JSON Schema definitions for FHIR ValueSets, providing structured enumeration of allowed code values:
JSON Schema for Classification of Digital Health Interventions v2 ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Services and Application Types: Point of Service ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Digital Health Interventions for Health Management and Support Personnel ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Services and Application Types: Surveillance and Response ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Digital Health Interventions for Health System Managers ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Digital Health Interventions for Clients ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Health System Challenges ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Services and Application Types: Data Management Services ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Smart Guidelines Decision Table Actions ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Core Data Element Type Value Set ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Digital Health Interventions: Data Services ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Services and Application Types: Health System/Provider Administration ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Smart Guidelines Persona Types Value Set ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Digital Health Interventions for Persons ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Digital Health Interventions: Data Services ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for SMART Guidelines Authoring Skills ValueSet ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for SMART Guidelines Authoring Persona Types ValueSet ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Digital Health Interventions for Health Workers ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Services and Application Types: Registries and Directories ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Digital Health Interventions for Healthcare Providers ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Services and Application Types ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Classification of Digital Health Interventions v1 ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema definitions for FHIR Logical Models, defining structured data elements and their relationships:
Logical Model representing Dublin Core metadata elements as defined at https://www.dublincore.org/specifications/dublin-core/dcmi-terms/
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 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.
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
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 User Scenarios from a DAK. Narratives that describe how the different personas may interact with each other.
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
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.
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 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.
Logical Model for representing Test Scenarios from a DAK. A set of test scenarios to validate an implementation of the 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.
Logical Model for representing a complete Digital Adaptation Kit (DAK) with metadata and all 9 DAK components
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.
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 functional requirement from a 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 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
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
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 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
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 non-functional requirement from a DAK
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
Complete API specification documentation for all available endpoints:
API endpoints for Classification of Digital Health Interventions v2 Schema
API endpoints for Services and Application Types: Point of Service Schema
API endpoints for Digital Health Interventions for Health Management and Support Personnel Schema
API endpoints for Services and Application Types: Surveillance and Response Schema
API endpoints for Digital Health Interventions for Health System Managers Schema
API endpoints for Digital Health Interventions for Clients Schema
API endpoints for Services and Application Types: Data Management Services Schema
API endpoints for Smart Guidelines Decision Table Actions Schema
API endpoints for Core Data Element Type Value Set Schema
API endpoints for Digital Health Interventions: Data Services Schema
API endpoints for Services and Application Types: Health System/Provider Administration Schema
API endpoints for Smart Guidelines Persona Types Value Set Schema
API endpoints for Digital Health Interventions for Persons Schema
API endpoints for Digital Health Interventions: Data Services Schema
API endpoints for SMART Guidelines Authoring Skills ValueSet Schema
API endpoints for SMART Guidelines Authoring Persona Types ValueSet Schema
API endpoints for Digital Health Interventions for Health Workers Schema
API endpoints for Services and Application Types: Registries and Directories Schema
API endpoints for Digital Health Interventions for Healthcare Providers Schema
API endpoints for Services and Application Types Schema
API endpoints for Classification of Digital Health Interventions v1 Schema
API endpoints for Dublin Core Metadata Element Set
API endpoints for Decision Support Logic Source
API endpoints for SUSHI Configuration Logical Model
API endpoints for Generic Persona Source
API endpoints for Test Scenario Source
API endpoints for User Scenario (DAK)
API endpoints for Requirements Source
API endpoints for Health Interventions and Recommendations (DAK)
API endpoints for Health Interventions Source
API endpoints for Business Process Workflow (DAK)
API endpoints for Test Scenario (DAK)
API endpoints for Generic Persona (DAK)
API endpoints for Digital Adaptation Kit (DAK)
API endpoints for Functional and Non-Functional Requirements (DAK)
API endpoints for FHIR Schema Base (SMART Guidelines)
API endpoints for Functional Requirement (DAK)
API endpoints for Decision-Support Logic (DAK)
API endpoints for Core Data Element Source
API endpoints for Program Indicator Source
API endpoints for Core Data Element (DAK)
API endpoints for Business Process Workflow Source
API endpoints for Program Indicator (DAK)
API endpoints for Non-Functional Requirement (DAK)
API endpoints for User Scenario Source
Complete list of all available ValueSet schemas
Complete list of all available Logical Model schemas
OpenAPI specification for ValueSet-SGAuthoringSkillsVS
OpenAPI specification for StructureDefinition-Requirements
OpenAPI specification for StructureDefinition-FHIRSchemaBase
OpenAPI specification for StructureDefinition-TestScenarioSource
OpenAPI specification for ValueSet-SGAuthoringPersonaTypesVS
OpenAPI specification for StructureDefinition-BusinessProcessWorkflow
OpenAPI specification for StructureDefinition-ProgramIndicator
OpenAPI specification for StructureDefinition-GenericPersona
OpenAPI specification for StructureDefinition-CoreDataElementSource
OpenAPI specification for StructureDefinition-CoreDataElement
OpenAPI specification for StructureDefinition-NonFunctionalRequirement
OpenAPI specification for StructureDefinition-DAK
OpenAPI specification for StructureDefinition-HealthInterventions
OpenAPI specification for StructureDefinition-BusinessProcessWorkflowSource
OpenAPI specification for StructureDefinition-SushiConfigLogicalModel
OpenAPI specification for StructureDefinition-TestScenario
OpenAPI specification for StructureDefinition-FunctionalRequirement
OpenAPI specification for ValueSet-SGPersonaTypesVS
OpenAPI specification for StructureDefinition-UserScenarioSource
OpenAPI specification for ValueSet-CoreDataElementTypeVS
OpenAPI specification for StructureDefinition-DecisionSupportLogicSource
OpenAPI specification for StructureDefinition-HealthInterventionsSource
OpenAPI specification for StructureDefinition-DecisionSupportLogic
OpenAPI specification for StructureDefinition-UserScenario
OpenAPI specification for StructureDefinition-ProgramIndicatorSource
OpenAPI specification for StructureDefinition-DublinCore
OpenAPI specification for StructureDefinition-Persona
OpenAPI specification for StructureDefinition-GenericPersonaSource
OpenAPI specification for StructureDefinition-RequirementsSource
OpenAPI specification for ValueSet-DecisionTableActions
Each JSON Schema can be used to validate data structures in your applications.
The JSON-LD vocabularies provide semantic web integration for ValueSet enumerations.
All schemas are derived from the FHIR definitions in this implementation guide.
The enumeration endpoints provide machine-readable lists of all available schemas.
This documentation hub is automatically generated from the available schema and API definitions.