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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
constraints and profile structures for SMART Guidelines resources
| SMART Guidelines ActivityDefinition |
The minimum expectations for ActivityDefinition resources used in SMART Guidelines |
| SMART Guidelines Actor |
Structure and constraints for ActorDefinition resources used in SMART Guidelines |
| SMART Guidelines Business Process |
Structure and constraints for Business Processes represented in SMART Guidelines |
| SMART Guidelines CodeSystem |
Defines the minimum expectations for CodeSystem resources used in SMART Guidelines |
| SMART Guidelines ConceptMap |
Defines the minimum expectations for ConceptMap resources used in SMART Guidelines |
| SMART Guidelines GraphDefinition |
The minimum expectations for GraphDefinition resources used in SMART Guidelines |
| SMART Guidelines Group Definition |
Structure and constraints for Group Definitions represented in SMART Guidelines |
| SMART Guidelines ImplementationGuide |
Defines the minimum expectations for ImplementationGuide resources used in SMART Guidelines |
| SMART Guidelines Library |
Defines the minimum expectations for Library resources used in SMART Guidelines |
| SMART Guidelines Logical Model |
Defines the minimum expectations for Logical Models used in SMART Guidelines |
| SMART Guidelines Measure |
Defines the minimum expectations for Measure resources used in SMART Guidelines |
| SMART Guidelines PlanDefinition |
Defines the minimum expectations for PlanDefinition resources used in SMART Guidelines |
| SMART Guidelines Questionnaire |
Defines the minimum expectations for Questionnaire resources used in SMART Guidelines |
| SMART Guidelines StructureDefinition |
Defines the minimum expectations for StructureDefinition resources used in SMART Guidelines |
| SMART Guidelines StructureMap |
Defines the minimum expectations for StructureMap resources used in SMART Guidelines |
| SMART Guidelines Transaction |
Structure and constraints for TransactionDefinition resources used in SMART Guidelines |
| SMART Guidelines ValueSet |
Defines the minimum expectations for ValueSet resources used in SMART Guidelines |
The following artifacts define the types of individuals and/or systems that will interact as part of the use cases covered by this implementation guide.
| Client Registry / Master Patient Index |
A digital system that creates, maintains, and provides authoritative unique identifiers for individuals (persons) accessing health services, enabling cross-facility patient matching and de-duplication. The client registry supports DHIs including:
Services and Application Types:
|
| Community Health Worker |
A frontline member of the health workforce who delivers health interventions at the community level, acting as a link between communities and formal health facilities. Community health workers are a key sub-group of healthcare providers. Community health workers use DHIs to:
ISCO-08: 3255 (Community health workers), 5321 (Health care assistants). Examples: Village health worker, health extension worker, community health volunteer, lay health advisor, peer educator, traditional birth attendant, community case manager. |
| Electronic Medical Record (EMR) System |
A secure, digital system that holds information about people's health and clinical care managed by healthcare providers. Also referred to as an Electronic Health Record (EHR). The EMR system supports DHIs including:
Services and Application Type: A5 — Electronic medical record systems Functional areas: Clinical decision support, record management, person registration, appointment scheduling, referral tracking. |
| Health Data Manager and Analyst |
A professional who manages, analyses, and disseminates health data to support evidence-based decision-making. This corresponds to the 'Data services' user group in CDISAH v2, providing crosscutting functionality across the health system. Data managers use DHIs to:
ISCO-08: 2120 (Mathematicians, actuaries and statisticians), 2521 (Database designers and administrators), 2523 (Computer network professionals), 3120 (Computer network and systems technicians). Examples: Biostatistician, epidemiologist, health informatician, data analyst, DHIS2 administrator, GIS specialist, interoperability engineer, terminology manager. |
| Health Information Exchange / Interoperability Platform |
A middleware system or shared infrastructure that enables health data exchange between disparate health information systems using standard protocols and formats. The interoperability platform supports DHIs including:
Services and Application Type: D2 — Data interchange and interoperability Functional areas: Semantic interoperability, technical interoperability, information exchange, data mediation, enterprise service bus. |
| Health Management Information System (HMIS) |
A digital system used to collect, process, report, and use aggregate health data for programme planning, monitoring, and evaluation at district and national levels. The HMIS supports DHIs including:
Services and Application Type: D6 — Health Management Information Systems (HMIS) Functional areas: Data collection, reporting dashboards, target monitoring, programme performance tracking, data quality management. |
| Health System Manager |
A professional involved in the administration and oversight of health systems. Health system managers use DHIs to:
ISCO-08: 1342 (Health services managers), 2446 (Social work professionals n.e.c.), 3354 (Government social benefits officials), 4311 (Accounting and bookkeeping clerks). Examples: District health officer, programme manager, supply chain officer, HMIS coordinator, hospital administrator, vital registration officer, health insurance administrator. |
| Healthcare Provider |
A member of the health workforce who delivers health interventions. This group has also been described as 'health workers' or 'healthcare workers'. Healthcare providers use DHIs to:
ISCO-08: 2211 (Generalist medical practitioners), 2212 (Specialist medical practitioners), 2221 (Nursing professionals), 2222 (Midwifery professionals), 3211 (Medical imaging and therapeutic equipment technicians), 3212 (Medical and pathology laboratory technicians), 3213 (Pharmaceutical technicians and assistants), 3221 (Nursing associate professionals), 3222 (Midwifery associate professionals), 3255 (Community health workers). Examples: Physician, nurse, midwife, clinical officer, pharmacist, laboratory technician, dentist, allied health professional. |
| Laboratory Information System (LIS) |
A digital system that manages the complete lifecycle of laboratory test orders, specimen tracking, result production, and result reporting to healthcare providers and persons. The LIS supports DHIs including:
Services and Application Type: A6 — Laboratory information systems Functional areas: Lab requests/test ordering, sample tracking, sample processing, results reporting. |
| Logistics Management Information System (LMIS) |
A digital system that manages the health supply chain from quantification and forecasting through distribution, inventory management, and consumption tracking. The LMIS supports DHIs including:
Services and Application Type: B6 — Logistics management information systems (LMIS) |
| Person (Health Service User) |
A member of the public who is a potential or current user of health services, including health prevention and wellness activities. Other terms used for this group include 'patient', 'client', 'individual', and 'health service user'. Caregivers of individuals receiving health services are also included. Persons interact with DHIs to:
ISCO-08: Not applicable (non-occupational role). Examples: Patient, pregnant woman, caregiver, child, community member, health scheme beneficiary, person living with a chronic condition. |
| Public Health and Disease Surveillance System |
A digital system for detecting, monitoring, investigating, and responding to disease outbreaks and public health threats. The surveillance system supports DHIs including:
Services and Application Type: E2 — Public health and disease surveillance systems |
These define activities that can be performed as part of content in this implementation guide.
| SGDecisionTableGuidance |
These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.
| 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. |
| Business Process Workflow Source |
Source reference for Business Process Workflow - exactly one of the following must be provided:
|
| 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. |
| Core Data Element Source |
Source reference for Core Data Element - exactly one of the following must be provided:
|
| Decision Support Logic Source |
Source reference for Decision Support Logic - exactly one of the following must be provided:
|
| 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. |
| Digital Adaptation Kit (DAK) |
Logical Model for representing a complete Digital Adaptation Kit (DAK) with metadata and all 9 DAK components |
| 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 Schema Base (SMART Guidelines) |
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. |
| Functional Requirement (DAK) |
Logical Model for representing functional requirement from a DAK |
| 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. |
| 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. |
| Generic Persona Source |
Source reference for Generic Persona - exactly one of the following must be provided:
|
| Health Interventions Source |
Source reference for Health Interventions - exactly one of the following must be provided:
|
| 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. |
| Non-Functional Requirement (DAK) |
Logical Model for representing non-functional requirement from a DAK |
| Persona (DAK) |
Logical Model for representing Personas from a DAK |
| 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. |
| Program Indicator Source |
Source reference for Program Indicator - exactly one of the following must be provided:
|
| Requirements Source |
Source reference for Requirements - exactly one of the following must be provided:
|
| 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. |
| Test Scenario (DAK) |
Logical Model for representing Test Scenarios from a DAK. A set of test scenarios to validate an implementation of the DAK. |
| Test Scenario Source |
Source reference for Test Scenario - exactly one of the following must be provided:
|
| User Scenario (DAK) |
Logical Model for representing User Scenarios from a DAK. Narratives that describe how the different personas may interact with each other. |
| User Scenario Source |
Source reference for User Scenario - exactly one of the following must be provided:
|
These define forms used by systems conforming to this implementation guide to capture or expose data to end users.
| Questionnaire for IMMZ.D2 Determine required vaccination(s) if any |
Auto-generated questionnaire for decision table DAK.DT.IMMZ.D2.DT.BCG |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| SMART Guidelines Communication Request |
Provide communication |
| SMART Guidelines Decision Table |
Defines the minimum expectations for PlanDefinition resources used in SMART Guidelines which are derived from DAK Decision Tables |
| SMART Guidelines Requirements |
Smart Guidelines Requirements |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| LinkIdExt |
Smart Guidelines link identifier extension |
| Markdown |
Markdown extension |
| SGActorExt |
Smart Guidelines Actor Reference extension |
| SGDocumentation |
Smart Guidelines Documentation extension |
| SGMarkdown |
Smart Guidelines markdown extension |
| SGRequirementExt |
Smart Guidelines Requirements extension |
| SGString |
Smart Guidelines (required) string extension for use in a complex extension |
| SGTask |
Extension to reference SMART Guidelines task type |
| SGUserStory |
Smart Guidelines extension to support structured User Stories (As a |
| SGcode |
Smart Guidelines code extension |
| Satisfies |
Indicates that if the conditions for this requirement are satisified, then that it should be viewed as satisifying the referenced requirement. |
These define sets of codes used by systems conforming to this implementation guide.
| Classification of Digital Health Interventions v1 |
Value Set for Classification of Digital Health Interventions v1. Autogenerated from DAK artifacts |
| Classification of Digital Health Interventions v2 |
Value Set for the Classification of Digital Interventions, Services and Applications in Health (CDISAH), second edition (2023). |
| Core Data Element Type Value Set |
Value set of core data element types |
| Digital Health Interventions for Clients |
Digital Health Interventions whose primary user group is Clients (persons using health services). Group 1 of the Classification of Digital Health Interventions v1 (2018). |
| Digital Health Interventions for Health Management and Support Personnel |
Digital Health Interventions whose primary user group is Health Management and Support Personnel. Group 3 of the Classification of Digital Interventions, Services and Applications in Health v2 (CDISAH, 2023). |
| Digital Health Interventions for Health System Managers |
Digital Health Interventions whose primary user group is Health System Managers. Group 3 of the Classification of Digital Health Interventions v1 (2018). |
| Digital Health Interventions for Health Workers |
Digital Health Interventions whose primary user group is Health Workers. Group 2 of the Classification of Digital Health Interventions v1 (2018). |
| Digital Health Interventions for Healthcare Providers |
Digital Health Interventions whose primary user group is Healthcare Providers. Group 2 of the Classification of Digital Interventions, Services and Applications in Health v2 (CDISAH, 2023). |
| Digital Health Interventions for Persons |
Digital Health Interventions whose primary user group is Persons (health service users). Group 1 of the Classification of Digital Interventions, Services and Applications in Health v2 (CDISAH, 2023). |
| Digital Health Interventions: Data Services |
Crosscutting Data Services DHIs. Group 4 of the Classification of Digital Health Interventions v1 (2018). |
| Digital Health Interventions: Data Services |
Crosscutting Data Services DHIs. Group 4 of the Classification of Digital Interventions, Services and Applications in Health v2 (CDISAH, 2023). |
| Health System Challenges |
Value set for Health System Challenges (Classification of Digital Health System Categories v1, 2018). Includes all 25 system category codes (A–Y). |
| ISCO-08 Value Set |
Extensible value set of ISCO-08 codes for persona classification |
| Services and Application Types |
Value set for Services and Application Types (Classification of Digital Health Services and Application Types v2, CDISAH 2023). Includes all codes across the five architecture groups (A–E). |
| Services and Application Types: Data Management Services |
Services and systems that support the collection, aggregation, storage, analysis, and exchange of health data. Group D of the Classification of Digital Health Services and Application Types v2 (CDISAH, 2023). |
| Services and Application Types: Health System/Provider Administration |
Systems that support the administrative and managerial functions of health systems and healthcare organisations. Group B of the Classification of Digital Health Services and Application Types v2 (CDISAH, 2023). |
| Services and Application Types: Point of Service |
Systems that facilitate the provision and delivery of healthcare services to persons at the point of care. Group A of the Classification of Digital Health Services and Application Types v2 (CDISAH, 2023). |
| Services and Application Types: Registries and Directories |
Systems that create, maintain, and provide authoritative master records for persons, providers, facilities, products and health events. Group C of the Classification of Digital Health Services and Application Types v2 (CDISAH, 2023). |
| Services and Application Types: Surveillance and Response |
Systems that support the detection, monitoring, and response to disease outbreaks and public health threats. Group E of the Classification of Digital Health Services and Application Types v2 (CDISAH, 2023). |
| Smart Guidelines Decision Table Actions |
Value Set for Smart Guidelines Documentation Decision Table Actions |
| Smart Guidelines Documentation Section |
Value Set for Smart Guidelines Documentation Section to autogenerate documentation from artifacts |
| Smart Guidelines Persona Types Value Set |
Value Set for Smart Guidelines Persona Section to autogenerate documentation from artifacts |
These define new code systems used by systems conforming to this implementation guide.
| Classification of Digital Health Interventions v1 |
CodeSystem for Classification of Digital Health Interventions v1. Autogenerated from DAK artifacts |
| Classification of Digital Health Interventions v2 |
CodeSystem for the Classification of Digital Interventions, Services and Applications in Health (CDISAH), second edition (2023). ISBN 978-92-4-008194-9. Organised into four groups based on the primary user:
New categories vs v1: 1.4.4, 1.6.2, 1.8, 2.5.6, 2.11, 3.1.5, 3.5.7, 3.5.8, 3.8, 4.3.5, 4.4.2, 4.4.3, 4.5. See ConceptMap CDHIv1toCDHIv2 for the full mapping from the first edition. |
| Classification of Digital Health Services and Application Types v2 |
CodeSystem for the Classification of Digital Health Services and Application Types v2, as defined in the Classification of Digital Interventions, Services and Applications in Health (CDISAH), second edition (2023). ISBN 978-92-4-008194-9. Services and Application Types represent the types of software, ICT systems and services or communication channels that deliver or execute digital health interventions (DHIs) and health content. The types are organised into five representations within the Digital Health Architecture: A. Point of service B. Health system/Provider administration C. Registries and Directories D. Data Management services E. Surveillance and Response |
| Classification of Digital Health System Categories v1 |
CodeSystem for Classification of Digital Health System Categories v1. Autogenerated from DAK artifacts |
| Core Data Element Type |
CodeSystem for Core Data Element types - defines the type of FHIR resource that a Core Data Element references. |
| International Standard Classification of Occupations 2008 |
ISCO-08 codes from the International Labour Organization official classification |
| SMART Guidelines Persona Types |
CodeSystem for SMART Guidelines Persona Types |
| SMART Guidelines Tasks |
CodeSystem for SMART Guidelines tasks which are specializations of the Business Process Modeling Notatiton (BPMN) tasks, which are included in this codesystem See BPMN Spectification for more info. The descriptions were adapted from the normative human readable documentation. |
| Smart Guidelines Actions (columns) for Decision Tables |
CodeSystem for Smart Guidelines Documentation Actions for Decision Tables" |
| Smart Guidelines Documentation Section |
CodeSystem for Smart Guidelines Documentation Section to autogenerate documentation from artifacts |
These define transformations to convert between codes by systems conforming with this implementation guide.
| Hierarchy of the Classification of Digital Health Interventions v1 |
Mapping to represent hierarchy within the Classification of Digital Health Interventions v1. |
| Hierarchy of the Classification of Digital Health Interventions v2 |
Mapping to represent hierarchy within the Classification of Digital Interventions, Services and Applications in Health (CDISAH) v2. |
| Mapping from CDHI v1 to CDISAH v2 |
Mapping from the Classification of Digital Health Interventions v1 (CDHI v1, 2018) to the Classification of Digital Interventions, Services and Applications in Health v2 (CDISAH v2, 2023). Key structural changes reflected in this map:
|
| Mapping from CDSC v1 to Services and Application Types v2 |
Mapping from the Classification of Digital Health System Categories v1 (CDSCv1, 2018) to the Classification of Digital Health Services and Application Types v2 (CDSCv2, 2023). The v1 used 25 single-letter codes (A–Y). The v2 completely restructured this into 5 representations within the digital health enterprise architecture, each with alphanumeric codes (A1–A9, B1–B8, C1–C11, D1–D8, E1–E2). Several new v2 categories have no v1 equivalent: A3 (Decision support), A4 (Diagnostics), B1 (Blood bank), B3 (Health program monitoring), B7 (Patient administration), C4 (Facility registries), C5 (Health worker registry), C7 (Immunisation information), C8 (Master patient index), C9 (Product catalogues), C10 (Public Key directories), D1 (Analytics), D3 (Data warehouses). |