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

Logical Model: Digital Adaptation Kit (DAK)

Official URL: http://smart.who.int/base/StructureDefinition/DAK Version: 0.2.0
Active as of 2025-10-14 Computable Name: DAK

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

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DAK 0..* Base Digital Adaptation Kit (DAK)
... id 1..1 string DAK ID
... name 1..1 string DAK Name
... title 1..1 string DAK Title
.... descriptionString string
.... descriptionUri uri
... version 1..1 string DAK Version
... status 1..1 code DAK Status
... publicationUrl 1..1 url Publication URL
... previewUrl 1..1 url Preview URL
... canonicalUrl 1..1 url Canonical URL
... license 1..1 code License
... copyrightYear 1..1 string Copyright Year
... publisher 1..1 BackboneElement Publisher
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Publisher Name
.... url 0..1 url Publisher URL
... healthInterventions 0..* HealthInterventionsSource Health Interventions and Recommendations
... personas 0..* GenericPersonaSource Generic Personas
... userScenarios 0..* UserScenarioSource User Scenarios
... businessProcesses 0..* BusinessProcessWorkflowSource Generic Business Processes and Workflows
... dataElements 0..* CoreDataElementSource Core Data Elements
... decisionLogic 0..* DecisionSupportLogicSource Decision-Support Logic
... indicators 0..* ProgramIndicatorSource Program Indicators
... requirements 0..* RequirementsSource Functional and Non-Functional Requirements
... testScenarios 0..* TestScenarioSource Test Scenarios

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

API Information

Digital Adaptation Kit (DAK) API

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

Version: 1.0.0

Endpoints

GET /StructureDefinition-DAK.schema.json

JSON Schema definition for the Logical Model StructureDefinition-DAK

This endpoint serves the JSON Schema definition for the Logical Model StructureDefinition-DAK.

Schema Definition

StructureDefinition-DAK

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

Type: object

Schema ID: https://worldhealthorganization.github.io/smart-base/StructureDefinition-DAK.schema.json

Properties

  • resourceType (string): Resource type identifier for DAK logical model
  • id (object): Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
  • name (string): Name of the publishing organization
  • title (string): Full title of the DAK (e.g., SMART Base)
  • description[x] (unknown): Description of the DAK - either Markdown content or a URI to a Markdown file (absolute or relative to repository root)
  • version (string): Version of the DAK
  • status (string): Publication status of the DAK
  • publicationUrl (string): Canonical URL for the published DAK (e.g., https://smart.who.int/base for WHO repositories)
  • previewUrl (string): Preview URL for the current CI build (e.g., https://worldhealthorganization.github.io/smart-base)
  • canonicalUrl (string): The canonical URL to use for this DAK instance - equals publicationUrl for release branches, previewUrl for development branches
  • license (string): License under which the DAK is published
  • copyrightYear (string): Year or year range for copyright
  • publisher (object): Organization responsible for publishing the DAK
  • modifierExtension (array): May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
  • url (string): URL of the publishing organization
  • healthInterventions (array): Overview of the health interventions and WHO, regional or national recommendations included within the DAK
  • personas (array): Depiction of the human and system actors
  • userScenarios (array): Narratives that describe how the different personas may interact with each other
  • businessProcesses (array): Business processes and workflows for achieving health programme objectives
  • dataElements (array): Data elements required throughout the different points of a workflow
  • decisionLogic (array): Decision-support logic and algorithms to support appropriate service delivery
  • indicators (array): Core set of indicators for decision-making, performance metrics and reporting
  • requirements (array): High-level list of core functions and capabilities that the system must have
  • testScenarios (array): Set of test scenarios to validate an implementation of the DAK

Required fields: resourceType, id, name, title, description[x], version, status, publicationUrl, previewUrl, canonicalUrl, license, copyrightYear, publisher, name

Full Schema (JSON)
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-DAK.schema.json",
  "title": "Digital Adaptation Kit (DAK)",
  "description": "Logical Model for representing a complete Digital Adaptation Kit (DAK) with metadata and all 9 DAK components",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "DAK",
      "description": "Resource type identifier for DAK logical model"
    },
    "id": {
      "type": "object",
      "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."
    },
    "name": {
      "type": "string",
      "description": "Name of the publishing organization"
    },
    "title": {
      "type": "string",
      "description": "Full title of the DAK (e.g., SMART Base)"
    },
    "description[x]": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string",
          "format": "uri"
        }
      ],
      "description": "Description of the DAK - either Markdown content or a URI to a Markdown file (absolute or relative to repository root)"
    },
    "version": {
      "type": "string",
      "description": "Version of the DAK"
    },
    "status": {
      "type": "string",
      "description": "Publication status of the DAK"
    },
    "publicationUrl": {
      "type": "string",
      "format": "uri",
      "description": "Canonical URL for the published DAK (e.g., https://smart.who.int/base for WHO repositories)"
    },
    "previewUrl": {
      "type": "string",
      "format": "uri",
      "description": "Preview URL for the current CI build (e.g., https://worldhealthorganization.github.io/smart-base)"
    },
    "canonicalUrl": {
      "type": "string",
      "format": "uri",
      "description": "The canonical URL to use for this DAK instance - equals publicationUrl for release branches, previewUrl for development branches"
    },
    "license": {
      "type": "string",
      "description": "License under which the DAK is published"
    },
    "copyrightYear": {
      "type": "string",
      "description": "Year or year range for copyright"
    },
    "publisher": {
      "type": "object",
      "description": "Organization responsible for publishing the DAK"
    },
    "modifierExtension": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR Extension"
      },
      "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL of the publishing organization"
    },
    "healthInterventions": {
      "type": "array",
      "items": {
        "$ref": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-HealthInterventionsSource.schema.json"
      },
      "description": "Overview of the health interventions and WHO, regional or national recommendations included within the DAK"
    },
    "personas": {
      "type": "array",
      "items": {
        "$ref": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-GenericPersonaSource.schema.json"
      },
      "description": "Depiction of the human and system actors"
    },
    "userScenarios": {
      "type": "array",
      "items": {
        "$ref": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-UserScenarioSource.schema.json"
      },
      "description": "Narratives that describe how the different personas may interact with each other"
    },
    "businessProcesses": {
      "type": "array",
      "items": {
        "$ref": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-BusinessProcessWorkflowSource.schema.json"
      },
      "description": "Business processes and workflows for achieving health programme objectives"
    },
    "dataElements": {
      "type": "array",
      "items": {
        "$ref": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-CoreDataElementSource.schema.json"
      },
      "description": "Data elements required throughout the different points of a workflow"
    },
    "decisionLogic": {
      "type": "array",
      "items": {
        "$ref": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-DecisionSupportLogicSource.schema.json"
      },
      "description": "Decision-support logic and algorithms to support appropriate service delivery"
    },
    "indicators": {
      "type": "array",
      "items": {
        "$ref": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-ProgramIndicatorSource.schema.json"
      },
      "description": "Core set of indicators for decision-making, performance metrics and reporting"
    },
    "requirements": {
      "type": "array",
      "items": {
        "$ref": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-RequirementsSource.schema.json"
      },
      "description": "High-level list of core functions and capabilities that the system must have"
    },
    "testScenarios": {
      "type": "array",
      "items": {
        "$ref": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-TestScenarioSource.schema.json"
      },
      "description": "Set of test scenarios to validate an implementation of the DAK"
    }
  },
  "required": [
    "resourceType",
    "id",
    "name",
    "title",
    "description[x]",
    "version",
    "status",
    "publicationUrl",
    "previewUrl",
    "canonicalUrl",
    "license",
    "copyrightYear",
    "publisher",
    "name"
  ],
  "resourceDefinition": "http://smart.who.int/base/StructureDefinition/DAK",
  "fhir:parent": "http://hl7.org/fhir/StructureDefinition/Base"
}

This documentation is automatically generated from the OpenAPI specification.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DAK 0..* Base Digital Adaptation Kit (DAK)
... id 1..1 string DAK ID
... name 1..1 string DAK Name
... title 1..1 string DAK Title
.... descriptionString string
.... descriptionUri uri
... version 1..1 string DAK Version
... status 1..1 code DAK Status
... publicationUrl 1..1 url Publication URL
... previewUrl 1..1 url Preview URL
... canonicalUrl 1..1 url Canonical URL
... license 1..1 code License
... copyrightYear 1..1 string Copyright Year
... publisher 1..1 BackboneElement Publisher
.... name 1..1 string Publisher Name
.... url 0..1 url Publisher URL
... healthInterventions 0..* HealthInterventionsSource Health Interventions and Recommendations
... personas 0..* GenericPersonaSource Generic Personas
... userScenarios 0..* UserScenarioSource User Scenarios
... businessProcesses 0..* BusinessProcessWorkflowSource Generic Business Processes and Workflows
... dataElements 0..* CoreDataElementSource Core Data Elements
... decisionLogic 0..* DecisionSupportLogicSource Decision-Support Logic
... indicators 0..* ProgramIndicatorSource Program Indicators
... requirements 0..* RequirementsSource Functional and Non-Functional Requirements
... testScenarios 0..* TestScenarioSource Test Scenarios

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DAK 0..* Base Digital Adaptation Kit (DAK)
... id 1..1 string DAK ID
... name 1..1 string DAK Name
... title 1..1 string DAK Title
.... descriptionString string
.... descriptionUri uri
... version 1..1 string DAK Version
... status 1..1 code DAK Status
... publicationUrl 1..1 url Publication URL
... previewUrl 1..1 url Preview URL
... canonicalUrl 1..1 url Canonical URL
... license 1..1 code License
... copyrightYear 1..1 string Copyright Year
... publisher 1..1 BackboneElement Publisher
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Publisher Name
.... url 0..1 url Publisher URL
... healthInterventions 0..* HealthInterventionsSource Health Interventions and Recommendations
... personas 0..* GenericPersonaSource Generic Personas
... userScenarios 0..* UserScenarioSource User Scenarios
... businessProcesses 0..* BusinessProcessWorkflowSource Generic Business Processes and Workflows
... dataElements 0..* CoreDataElementSource Core Data Elements
... decisionLogic 0..* DecisionSupportLogicSource Decision-Support Logic
... indicators 0..* ProgramIndicatorSource Program Indicators
... requirements 0..* RequirementsSource Functional and Non-Functional Requirements
... testScenarios 0..* TestScenarioSource Test Scenarios

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(13 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DAK 0..* Base Digital Adaptation Kit (DAK)
... id 1..1 string DAK ID
... name 1..1 string DAK Name
... title 1..1 string DAK Title
.... descriptionString string
.... descriptionUri uri
... version 1..1 string DAK Version
... status 1..1 code DAK Status
... publicationUrl 1..1 url Publication URL
... previewUrl 1..1 url Preview URL
... canonicalUrl 1..1 url Canonical URL
... license 1..1 code License
... copyrightYear 1..1 string Copyright Year
... publisher 1..1 BackboneElement Publisher
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Publisher Name
.... url 0..1 url Publisher URL
... healthInterventions 0..* HealthInterventionsSource Health Interventions and Recommendations
... personas 0..* GenericPersonaSource Generic Personas
... userScenarios 0..* UserScenarioSource User Scenarios
... businessProcesses 0..* BusinessProcessWorkflowSource Generic Business Processes and Workflows
... dataElements 0..* CoreDataElementSource Core Data Elements
... decisionLogic 0..* DecisionSupportLogicSource Decision-Support Logic
... indicators 0..* ProgramIndicatorSource Program Indicators
... requirements 0..* RequirementsSource Functional and Non-Functional Requirements
... testScenarios 0..* TestScenarioSource Test Scenarios

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DAK 0..* Base Digital Adaptation Kit (DAK)
... id 1..1 string DAK ID
... name 1..1 string DAK Name
... title 1..1 string DAK Title
.... descriptionString string
.... descriptionUri uri
... version 1..1 string DAK Version
... status 1..1 code DAK Status
... publicationUrl 1..1 url Publication URL
... previewUrl 1..1 url Preview URL
... canonicalUrl 1..1 url Canonical URL
... license 1..1 code License
... copyrightYear 1..1 string Copyright Year
... publisher 1..1 BackboneElement Publisher
.... name 1..1 string Publisher Name
.... url 0..1 url Publisher URL
... healthInterventions 0..* HealthInterventionsSource Health Interventions and Recommendations
... personas 0..* GenericPersonaSource Generic Personas
... userScenarios 0..* UserScenarioSource User Scenarios
... businessProcesses 0..* BusinessProcessWorkflowSource Generic Business Processes and Workflows
... dataElements 0..* CoreDataElementSource Core Data Elements
... decisionLogic 0..* DecisionSupportLogicSource Decision-Support Logic
... indicators 0..* ProgramIndicatorSource Program Indicators
... requirements 0..* RequirementsSource Functional and Non-Functional Requirements
... testScenarios 0..* TestScenarioSource Test Scenarios

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DAK 0..* Base Digital Adaptation Kit (DAK)
... id 1..1 string DAK ID
... name 1..1 string DAK Name
... title 1..1 string DAK Title
.... descriptionString string
.... descriptionUri uri
... version 1..1 string DAK Version
... status 1..1 code DAK Status
... publicationUrl 1..1 url Publication URL
... previewUrl 1..1 url Preview URL
... canonicalUrl 1..1 url Canonical URL
... license 1..1 code License
... copyrightYear 1..1 string Copyright Year
... publisher 1..1 BackboneElement Publisher
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Publisher Name
.... url 0..1 url Publisher URL
... healthInterventions 0..* HealthInterventionsSource Health Interventions and Recommendations
... personas 0..* GenericPersonaSource Generic Personas
... userScenarios 0..* UserScenarioSource User Scenarios
... businessProcesses 0..* BusinessProcessWorkflowSource Generic Business Processes and Workflows
... dataElements 0..* CoreDataElementSource Core Data Elements
... decisionLogic 0..* DecisionSupportLogicSource Decision-Support Logic
... indicators 0..* ProgramIndicatorSource Program Indicators
... requirements 0..* RequirementsSource Functional and Non-Functional Requirements
... testScenarios 0..* TestScenarioSource Test Scenarios

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(13 nested mandatory elements)

 

Other representations of profile: CSV, Excel