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: Program Indicator (DAK)

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

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.

Usages:

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
.. ProgramIndicator 0..* Base Program Indicator (DAK)
... id 1..1 id Indicator ID
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... name 1..1 string Name
... numerator 1..1 markdown Numerator
... denominator 1..1 markdown Denominator
... disaggregation 1..1 markdown Disaggregation
... references 0..* id References

doco Documentation for this format

API Information

Program Indicator (DAK) API

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.

Version: 1.0.0

Endpoints

GET /StructureDefinition-ProgramIndicator.schema.json

JSON Schema definition for the Logical Model StructureDefinition-ProgramIndicator

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

Schema Definition

StructureDefinition-ProgramIndicator

Description: 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.

Type: object

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

Properties

  • resourceType (string): Resource type identifier for ProgramIndicator logical model
  • id (string): Identifier for the program indicator
  • description[x] (unknown): Description of the program indicator - either Markdown content or a URI to a Markdown file (absolute or relative to repository root)
  • name (string): Name of the indicator
  • definition (string): Definition of what the indicator measures
  • numerator (string): Description of the numerator calculation
  • denominator (string): Description of the denominator calculation
  • disaggregation (string): Description of how the indicator should be disaggregated
  • references (array): References to Health Intervention IDs providing additional context

Required fields: resourceType, id, name, definition, numerator, denominator, disaggregation

Full Schema (JSON) 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-ProgramIndicator.schema.json",
  "title": "Program Indicator (DAK)",
  "description": "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.",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "ProgramIndicator",
      "description": "Resource type identifier for ProgramIndicator logical model"
    },
    "id": {
      "type": "string",
      "description": "Identifier for the program indicator"
    },
    "description[x]": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string",
          "format": "uri"
        }
      ],
      "description": "Description of the program indicator - either Markdown content or a URI to a Markdown file (absolute or relative to repository root)"
    },
    "name": {
      "type": "string",
      "description": "Name of the indicator"
    },
    "definition": {
      "type": "string",
      "description": "Definition of what the indicator measures"
    },
    "numerator": {
      "type": "string",
      "description": "Description of the numerator calculation"
    },
    "denominator": {
      "type": "string",
      "description": "Description of the denominator calculation"
    },
    "disaggregation": {
      "type": "string",
      "description": "Description of how the indicator should be disaggregated"
    },
    "references": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "References to Health Intervention IDs providing additional context"
    }
  },
  "required": [
    "resourceType",
    "id",
    "name",
    "definition",
    "numerator",
    "denominator",
    "disaggregation"
  ],
  "resourceDefinition": "http://smart.who.int/base/StructureDefinition/ProgramIndicator",
  "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
.. ProgramIndicator 0..* Base Program Indicator (DAK)
... id 1..1 id Indicator ID
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... name 1..1 string Name
... numerator 1..1 markdown Numerator
... denominator 1..1 markdown Denominator
... disaggregation 1..1 markdown Disaggregation
... references 0..* id References

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ProgramIndicator 0..* Base Program Indicator (DAK)
... id 1..1 id Indicator ID
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... name 1..1 string Name
... numerator 1..1 markdown Numerator
... denominator 1..1 markdown Denominator
... disaggregation 1..1 markdown Disaggregation
... references 0..* id References

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(6 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ProgramIndicator 0..* Base Program Indicator (DAK)
... id 1..1 id Indicator ID
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... name 1..1 string Name
... numerator 1..1 markdown Numerator
... denominator 1..1 markdown Denominator
... disaggregation 1..1 markdown Disaggregation
... references 0..* id References

doco Documentation for this format

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ProgramIndicator 0..* Base Program Indicator (DAK)
... id 1..1 id Indicator ID
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... name 1..1 string Name
... numerator 1..1 markdown Numerator
... denominator 1..1 markdown Denominator
... disaggregation 1..1 markdown Disaggregation
... references 0..* id References

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ProgramIndicator 0..* Base Program Indicator (DAK)
... id 1..1 id Indicator ID
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... name 1..1 string Name
... numerator 1..1 markdown Numerator
... denominator 1..1 markdown Denominator
... disaggregation 1..1 markdown Disaggregation
... references 0..* id References

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(6 nested mandatory elements)

 

Other representations of profile: CSV, Excel