Who Gho Tools#

Configuration File: who_gho_tools.json Tool Type: Local Tools Count: 3

This page contains all tools defined in the who_gho_tools.json configuration file.

Available Tools#

WHOGHO_get_indicator_data (Type: BaseRESTTool)#

Get actual health data values for a specific WHO Global Health Observatory indicator by its code….

WHOGHO_get_indicator_data tool specification

Tool Information:

  • Name: WHOGHO_get_indicator_data

  • Type: BaseRESTTool

  • Description: Get actual health data values for a specific WHO Global Health Observatory indicator by its code. Returns country-level data with values, confidence intervals, year, and sex/age breakdowns. No authentication required. Common indicator codes: WHOSIS_000001 (life expectancy at birth), MALARIA002 (malaria cases), MDG_0000000026 (HIV prevalence), NCD_BMI_30C (obesity prevalence), SDGPM25 (PM2.5 air pollution), WHS4_100 (hospital beds per 10000). Rows are ordered by country then year and capped at top: the response reports ‘count’ (rows returned), ‘total_available’ (rows matching upstream) and a ‘truncated’ flag, and when truncated a ‘truncation_note’ explaining how to retrieve the rest. Pages are exact OData $skip/$top windows: continue with skip = metadata.next_skip while metadata.has_more is true.

Parameters:

  • indicator_code (string) (required) WHO GHO indicator code. Examples: ‘WHOSIS_000001’ (life expectancy), ‘MALARIA002’ (malaria cases), ‘MDG_0000000026’ (HIV prevalence), ‘NCD_BMI_30C’ (obesity), ‘SDGPM25’ (air pollution PM2.5), ‘WHS4_100’ (hospital beds)

  • filter ([‘string’, ‘null’]) (optional) OData filter for data rows. Examples: “SpatialDim eq ‘USA’”, “TimeDim eq 2022”, “Dim1 eq ‘SEX_FMLE’ and TimeDim ge 2015”

  • top ([‘integer’, ‘null’]) (optional) Maximum number of data rows to return per page (default 100, max 1000). One row is one country-year-dimension observation, so a full time series for one country needs top >= the number of years (and x3 if the indicator is broken down by sex). Raise this, or page with skip, when the response reports truncated=true.

  • orderby ([‘string’, ‘null’]) (optional) OData $orderby clause controlling row order, which also determines which rows survive the top cut-off. Default: “SpatialDim asc,TimeDim asc,Dim1 asc,Dim2 asc,Dim3 asc” (grouped by country, then chronological, with the dimension columns as tie-breakers so skip pages neither repeat nor drop rows), so a truncated result is a contiguous prefix rather than an arbitrary sample. Use “TimeDim asc” for a purely chronological cross-section, or “TimeDim desc” for the most recent years first.

  • skip (integer) (optional) Zero-based OData offset. Continue with metadata.next_skip.

Example Usage:

query = {
    "name": "WHOGHO_get_indicator_data",
    "arguments": {
        "indicator_code": "example_value"
    }
}
result = tu.run(query)

WHOGHO_list_dimension_values (Type: BaseRESTTool)#

Decode WHO GHO dimension codes into human-readable labels and the country->region hierarchy. WHOG…

WHOGHO_list_dimension_values tool specification

Tool Information:

  • Name: WHOGHO_list_dimension_values

  • Type: BaseRESTTool

  • Description: Decode WHO GHO dimension codes into human-readable labels and the country->region hierarchy. WHOGHO_get_indicator_data returns cryptic codes (SpatialDim=’ABW’, Dim1=’SEX_FMLE’/’AGEGROUP_AGE0-4’, region ‘AFR’); this tool resolves every code in a dimension to a Title and gives the country->region rollup via ParentCode (e.g. ABW -> Aruba -> AMR/Americas). Use it to interpret results, build correct $filter clauses for WHOGHO_get_indicator_data, and aggregate countries into WHO regions. Common dimension_code values: ‘COUNTRY’ (234 ISO-3 country codes + region rollup), ‘REGION’ (6 WHO regions: AFR/AMR/EMR/EUR/SEAR/WPR), ‘SEX’ (SEX_BTSX/SEX_MLE/SEX_FMLE), ‘AGEGROUP’ (e.g. AGEGROUP_AGE0-4), ‘GHO’ (indicator codes), ‘YEAR’. Pass ‘Dimension’ (capital D, no DimensionValues) to enumerate all 195 dimensions. No authentication required.

Parameters:

  • dimension_code (string) (required) WHO GHO dimension code whose values to list. Examples: ‘COUNTRY’ (countries + region parent), ‘REGION’ (WHO regions), ‘SEX’, ‘AGEGROUP’, ‘GHO’, ‘YEAR’, ‘WORLDBANKINCOMEGROUP’. Special value ‘Dimension’ (case-sensitive) lists all 195 available dimension codes instead of the values of one dimension.

Example Usage:

query = {
    "name": "WHOGHO_list_dimension_values",
    "arguments": {
        "dimension_code": "example_value"
    }
}
result = tu.run(query)

WHOGHO_search_indicators (Type: BaseRESTTool)#

Search WHO GHO indicators with exact OData $count and $skip/$top pagination. Continue with metada…

WHOGHO_search_indicators tool specification

Tool Information:

  • Name: WHOGHO_search_indicators

  • Type: BaseRESTTool

  • Description: Search WHO GHO indicators with exact OData $count and $skip/$top pagination. Continue with metadata.next_skip while metadata.has_more is true. Results use stable IndicatorCode ordering.

Parameters:

  • filter ([‘string’, ‘null’]) (optional) OData filter string for indicator names. Examples: “contains(IndicatorName,’malaria’)”, “contains(IndicatorName,’HIV’)”, “contains(IndicatorName,’mortality’)”, “contains(IndicatorName,’obesity’)”

  • top ([‘integer’, ‘null’]) (optional) Indicators per page (default 10, max 100)

  • skip (integer) (optional) Zero-based OData offset. Continue with metadata.next_skip.

Example Usage:

query = {
    "name": "WHOGHO_search_indicators",
    "arguments": {
    }
}
result = tu.run(query)