SMART Base
0.3.0 - ci-build
SMART Base, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/litlfred/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 Knowledge graph: publication type 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 Digital Health Interventions for Healthcare Providers 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 Services and Application Types: Surveillance and Response 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 SMART Guidelines Authoring Skills ValueSet 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 Knowledge graph L1: predicates 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 Digital Health Interventions for Persons 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 SMART Guidelines Authoring Persona Types ValueSet ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Classification of Digital Health Interventions v2 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 Services and Application Types: Health System/Provider Administration 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 Classification of Digital Health Interventions v1 ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Knowledge graph: GRADE certainty of evidence 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 Knowledge graph: resolution status 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 Digital Health Interventions: Data Services 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 Knowledge graph L1: classes 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 Knowledge graph: GRADE recommendation strength ValueSet codes. Generated from FHIR expansions using IRI format.
JSON Schema for Knowledge graph: derivation 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 definitions for FHIR Logical Models, defining structured data elements and their relationships:
The atomic normative statement. This is the node nothing in the WHO estate currently makes addressable. statement is a VERBATIM quote, never a paraphrase — a paraphrased recommendation is a new recommendation. strength is GRADE (strong | conditional); certainty is GRADE (high | moderate | low | very-low); conditionality records the 'in settings where…' qualifier that decides whether a DAK can adopt it unchanged. Class IRI: http://smart.who.int/kg/recommendation.
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.
One typed node of a knowledge-graph document. Its instance fields are an instance of the logical model of its class (see definedBy), e.g. KGPublication for a publication.
PICO C. Frequently absent in WHO recommendations; absence is recorded rather than invented. Class IRI: http://smart.who.int/kg/comparator.
The body of evidence behind a recommendation, with its GRADE certainty rating. Class IRI: http://smart.who.int/kg/evidence.
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
PICO O. Class IRI: http://smart.who.int/kg/outcome.
A source a graph document was extracted from, pinned by hash.
A citation string exactly as it appears in an L2 or L3 artefact, together with what it was resolved to. Grounded directly in the BCG table, where every rule's annotationEntry[1] reads "WHO recommendations for routine immunization – summary tables (March 2023) (1)" — a citation that no tool can currently follow. This class is where that string becomes a link, and where the fact that resolving it was a judgement gets recorded. text is verbatim. location is the artefact path plus the element id — e.g. the DMN rule id. numbering preserves the "(1)" back-reference into the source document's own bibliography. resolutionStatus is unresolved | resolved | ambiguous; ambiguous is a legitimate terminal state and must not be collapsed to resolved. Class IRI: http://smart.who.int/kg/citation.
An implementation consideration attached to a recommendation. Grounded: the BCG table's first annotationEntry carries exactly this — "Neonates born to women of unknown HIV status should be vaccinated as the benefits…" — clinical nuance that shapes the decision logic but is not the recommendation itself. Class IRI: http://smart.who.int/kg/remark.
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 non-functional requirement from a 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 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.
A normative delivery schedule. Grounded: the BCG table cites "WHO recommendations for routine immunization – summary tables", which IS a schedule publication — the single most-cited L1 source in the immunization DAK. Class IRI: http://smart.who.int/kg/schedule.
Logical Model for representing a complete Digital Adaptation Kit (DAK) with metadata and all 9 DAK components
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
Where a node or edge came from in its source. Required on anything not mechanically derived.
One L1 knowledge-graph document: typed nodes and reified edges, provenance-pinned to the sources it was extracted from. In JSON the context element is written @context.
What a recommendation is about, and the hinge to L2. Corresponds to the DAK component smart-base defines as HealthInterventions — today `id`, `description[x]` and `reference 1..* DublinCore`, i.e. a bibliographic citation with no recommendation behind it. This class is what that citation should resolve to. Corresponds to HealthInterventions: identifier = HealthInterventions.id and description = HealthInterventions.description[x]; not a Parent because HealthInterventions requires reference 1..* DublinCore, which in the graph is an edge to a publication rather than a field. Class IRI: http://smart.who.int/kg/health-intervention.
One reified statement: a predicate from a source node to a target node, with its derivation and evidence.
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.
Logical Model for representing Test Scenarios from a DAK. A set of test scenarios to validate an implementation of the DAK.
An L2 or L3 artefact addressed by canonical URL — a BPMN process, a DMN decision table, a FHIR PlanDefinition. Deliberately opaque: it carries an IRI and a free-text kind, and this graph asserts nothing about its internal structure. That opacity is the boundary. The L2 and L3 subgraphs model those artefacts properly; L1 only needs to point. Class IRI: http://smart.who.int/kg/external-artifact.
A code in an external terminology — ICD-10, ICD-11, SNOMED CT, ATC, or a WHO classification such as CDHI. CROSS-REFERENCE ONLY. It records system, code and display, and asserts NOTHING about the terminology: no hierarchy, no subsumption, no synonyms, no post-coordination. The terminology has its own authority, its own release cycle and its own tooling, and a partial copy here would be wrong within one release. Resolve meaning against the terminology server, not against this graph. Derives from Coding (FHIR R4 core datatype); system, code, display, version are its elements. Class IRI: http://smart.who.int/kg/terminology-code.
A programme indicator defined normatively at L1. Distinct from the DAK's ProgramIndicator component, which is its L2 expression; that model already carries `references 0..* id` pointing at health intervention ids. Corresponds to ProgramIndicator: same element names and types (markdown), identifier = ProgramIndicator.id; not a Parent because ProgramIndicator makes name, definition, numerator, denominator and disaggregation 1..1 and an L1 indicator is recorded with what its source states. Class IRI: http://smart.who.int/kg/indicator.
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
Logical Model representing Dublin Core metadata elements as defined at https://www.dublincore.org/specifications/dublin-core/dcmi-terms/
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 User Scenarios from a DAK. Narratives that describe how the different personas may interact with each other.
Logical Model for representing functional requirement from a 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.
A chapter, annex or numbered section. Recommendations are located by section and page, which is what makes an extraction checkable. Class IRI: http://smart.who.int/kg/publication-section.
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 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
A WHO normative publication: a guideline, guidance, recommendation summary, or classification. Metadata follows Dublin Core, which HealthInterventions already uses. publicationType distinguishes normative guideline from guidance from summary table — a summary table restates recommendations made elsewhere, and conflating the two makes provenance wrong. identifier holds ISBN/ISSN/DOI, as CDHIv2 already does. sha256 pins the PDF. Derives from DublinCore (smart-base input/fsh/models/DublinCore.fsh); title, creator, publisher, date, identifier, language, rights are its elements. Class IRI: http://smart.who.int/kg/publication.
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 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
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
PICO P. Class IRI: http://smart.who.int/kg/population.
One row of a schedule: which intervention, for whom, when, how many doses. This is the granularity a decision table actually consumes — the BCG rules turn on dose count, age and interval since a live vaccine. Class IRI: http://smart.who.int/kg/schedule-entry.
PICO I. The clinical or public-health action, distinct from health-intervention, which is the DAK-facing component. Class IRI: http://smart.who.int/kg/intervention.
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
Complete API specification documentation for all available endpoints:
API endpoints for Knowledge graph: publication type Schema
API endpoints for Digital Health Interventions for Clients Schema
API endpoints for Digital Health Interventions for Healthcare Providers Schema
API endpoints for Services and Application Types: Registries and Directories Schema
API endpoints for Services and Application Types: Surveillance and Response Schema
API endpoints for Core Data Element Type Value Set Schema
API endpoints for SMART Guidelines Authoring Skills ValueSet Schema
API endpoints for Services and Application Types: Data Management Services Schema
API endpoints for Knowledge graph L1: predicates Schema
API endpoints for Digital Health Interventions for Health Management and Support Personnel Schema
API endpoints for Digital Health Interventions for Persons Schema
API endpoints for Services and Application Types: Point of Service Schema
API endpoints for SMART Guidelines Authoring Persona Types ValueSet Schema
API endpoints for Classification of Digital Health Interventions v2 Schema
API endpoints for Smart Guidelines Persona Types Value Set Schema
API endpoints for Services and Application Types: Health System/Provider Administration Schema
API endpoints for Digital Health Interventions: Data Services Schema
API endpoints for Classification of Digital Health Interventions v1 Schema
API endpoints for Knowledge graph: GRADE certainty of evidence Schema
API endpoints for Smart Guidelines Decision Table Actions Schema
API endpoints for Knowledge graph: resolution status Schema
API endpoints for Digital Health Interventions for Health Workers Schema
API endpoints for Digital Health Interventions: Data Services Schema
API endpoints for Digital Health Interventions for Health System Managers Schema
API endpoints for Knowledge graph L1: classes Schema
API endpoints for Services and Application Types Schema
API endpoints for Knowledge graph: GRADE recommendation strength Schema
API endpoints for Knowledge graph: derivation Schema
API endpoints for Health System Challenges Schema
API endpoints for Knowledge graph L1: Recommendation
API endpoints for Business Process Workflow (DAK)
API endpoints for Knowledge graph: node
API endpoints for Knowledge graph L1: Comparator
API endpoints for Knowledge graph L1: Evidence
API endpoints for Requirements Source
API endpoints for Knowledge graph L1: Outcome
API endpoints for Knowledge graph: provenance source
API endpoints for Knowledge graph L1: Citation
API endpoints for Knowledge graph L1: Remark
API endpoints for Program Indicator Source
API endpoints for Non-Functional Requirement (DAK)
API endpoints for Generic Persona (DAK)
API endpoints for SUSHI Configuration Logical Model
API endpoints for Knowledge graph L1: Schedule
API endpoints for Digital Adaptation Kit (DAK)
API endpoints for Business Process Workflow Source
API endpoints for Knowledge graph: evidence location
API endpoints for Knowledge graph L1: graph document
API endpoints for Knowledge graph L1: Health intervention
API endpoints for Knowledge graph: edge
API endpoints for Health Interventions and Recommendations (DAK)
API endpoints for Decision-Support Logic (DAK)
API endpoints for Test Scenario (DAK)
API endpoints for Knowledge graph L1: External artefact
API endpoints for Knowledge graph L1: Terminology code
API endpoints for Knowledge graph L1: Indicator
API endpoints for User Scenario Source
API endpoints for Dublin Core Metadata Element Set
API endpoints for Functional and Non-Functional Requirements (DAK)
API endpoints for FHIR Schema Base (SMART Guidelines)
API endpoints for User Scenario (DAK)
API endpoints for Functional Requirement (DAK)
API endpoints for Program Indicator (DAK)
API endpoints for Knowledge graph L1: Publication section
API endpoints for Core Data Element (DAK)
API endpoints for Health Interventions Source
API endpoints for Knowledge graph L1: Publication
API endpoints for Core Data Element Source
API endpoints for Decision Support Logic Source
API endpoints for Generic Persona Source
API endpoints for Knowledge graph L1: Population
API endpoints for Knowledge graph L1: Schedule entry
API endpoints for Knowledge graph L1: Intervention
API endpoints for Test Scenario Source
Complete list of all available ValueSet schemas
Complete list of all available Logical Model schemas
OpenAPI specification for StructureDefinition-BusinessProcessWorkflowSource
OpenAPI specification for StructureDefinition-KGRecommendation
OpenAPI specification for StructureDefinition-ProgramIndicator
OpenAPI specification for StructureDefinition-RequirementsSource
OpenAPI specification for ValueSet-KGL1ClassesVS
OpenAPI specification for ValueSet-CoreDataElementTypeVS
OpenAPI specification for StructureDefinition-HealthInterventionsSource
OpenAPI specification for StructureDefinition-CoreDataElement
OpenAPI specification for ValueSet-SGPersonaTypesVS
OpenAPI specification for StructureDefinition-NonFunctionalRequirement
OpenAPI specification for StructureDefinition-DecisionSupportLogicSource
OpenAPI specification for StructureDefinition-GenericPersona
OpenAPI specification for ValueSet-KGL1PredicatesVS
OpenAPI specification for StructureDefinition-FunctionalRequirement
OpenAPI specification for StructureDefinition-DublinCore
OpenAPI specification for StructureDefinition-KGCitation
OpenAPI specification for StructureDefinition-ProgramIndicatorSource
OpenAPI specification for StructureDefinition-Persona
OpenAPI specification for StructureDefinition-KGProvenanceSource
OpenAPI specification for StructureDefinition-KGExternalArtifact
OpenAPI specification for StructureDefinition-TestScenario
OpenAPI specification for StructureDefinition-KGPublicationSection
OpenAPI specification for StructureDefinition-GenericPersonaSource
OpenAPI specification for ValueSet-KGDerivationVS
OpenAPI specification for StructureDefinition-SushiConfigLogicalModel
OpenAPI specification for StructureDefinition-KGNode
OpenAPI specification for StructureDefinition-TestScenarioSource
OpenAPI specification for ValueSet-KGPublicationTypeVS
OpenAPI specification for StructureDefinition-DAK
OpenAPI specification for StructureDefinition-KGEvidenceLocation
OpenAPI specification for StructureDefinition-Requirements
OpenAPI specification for StructureDefinition-KGSchedule
OpenAPI specification for StructureDefinition-CoreDataElementSource
OpenAPI specification for StructureDefinition-KGOutcome
OpenAPI specification for StructureDefinition-KGIntervention
OpenAPI specification for StructureDefinition-FHIRSchemaBase
OpenAPI specification for StructureDefinition-KGTerminologyCode
OpenAPI specification for StructureDefinition-KGIndicator
OpenAPI specification for ValueSet-KGGradeCertaintyVS
OpenAPI specification for StructureDefinition-KGHealthIntervention
OpenAPI specification for StructureDefinition-DecisionSupportLogic
OpenAPI specification for StructureDefinition-KGPublication
OpenAPI specification for StructureDefinition-UserScenarioSource
OpenAPI specification for StructureDefinition-KGPopulation
OpenAPI specification for StructureDefinition-KGRemark
OpenAPI specification for StructureDefinition-KGEvidence
OpenAPI specification for StructureDefinition-KGScheduleEntry
OpenAPI specification for StructureDefinition-HealthInterventions
OpenAPI specification for StructureDefinition-UserScenario
OpenAPI specification for StructureDefinition-KGComparator
OpenAPI specification for ValueSet-SGAuthoringPersonaTypesVS
OpenAPI specification for StructureDefinition-KGGraphDocument
OpenAPI specification for ValueSet-DecisionTableActions
OpenAPI specification for ValueSet-SGAuthoringSkillsVS
OpenAPI specification for StructureDefinition-KGEdge
OpenAPI specification for ValueSet-KGResolutionStatusVS
OpenAPI specification for StructureDefinition-BusinessProcessWorkflow
OpenAPI specification for ValueSet-KGGradeStrengthVS
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.