dhis2_metadata
Retrieve DHIS2 metadata for resources like data elements, indicators, and programs. Apply filters and select fields to get only the information needed.
Instructions
Query DHIS2 metadata with a simplified interface.
Convenience wrapper around dhis2_query() for common metadata lookups.
Args:
resource: Metadata resource type — e.g. "dataElements", "indicators",
"organisationUnits", "programs", "dataSets", "trackedEntityTypes".
filters: Filter expressions in DHIS2 format, e.g. ["name:ilike:malaria", "valueType:eq:NUMBER"].
fields: Comma-separated field list (default: "id,name,shortName").
paging: Set True to get only the first page (faster for large resources).
Examples:
dhis2_metadata("dataElements", ["name:ilike:HAT", "valueType:eq:INTEGER"])
dhis2_metadata("programs", fields="id,name,programType,trackedEntityType[id,name]")
dhis2_metadata("organisationUnits", ["level:eq:3"], fields="id,name,level,parent[id,name]")
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| resource | Yes | ||
| filters | No | ||
| fields | No | id,name,shortName | |
| paging | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |