Enums
Enums, or enumerations, are a data type used to define a set of named values that represent fixed options for a field in the API.
Aggregation Period
Used in: Rainfall
The aggregation period refers to the different time periods used to aggregate the rainfall data.
| Aggregation Period | Name | Description | Assessment Type |
|---|---|---|---|
| DEKAD | Dekad | Rainfall indicators are aggregated to the dekad (a period of 10 days within a month) | nan |
| nan | One month | Rainfall indicators are aggregated to a one-month rolling aggregation period | ONE_MONTH |
| nan | Three month | Rainfall indicators are aggregated to a three-month rolling aggregation period | THREE_MONTH |
Assessment Type
Used in: IDPs
The assessment types refer to two different methodologies for obtaining the IDP data coming from the IOM DTM. For more detail, see the IOM DTM methodological framework.
| Assessment Type | Name | Description |
|---|---|---|
| BA | Baseline assessment | A high-level survey to identify population presence and displacement figures in large administrative areas, guiding further detailed assessments |
| SA | Site assessment | Also known as a multi-sectoral location assessment (MSLA), it entails a detailed data collection on living conditions and needs of displaced populations at specific locations identified by Baseline Assessments |
Commodity Category
Used in:
Food Prices & Market Monitor,
WFP Commodity
The commodity categories are used in the WFP food prices data to organize foods into food groups.
| Commodity Category |
|---|
| cereals and tubers |
| meat, fish and eggs |
| milk and dairy |
| miscellaneous food |
| non-food |
| oil and fats |
| pulses and nuts |
| vegetables and fruits |
Disabled Marker
Used in: Humanitarian Needs
This marker is used to indicate any HNO PIN calculations that are disaggregated by disability. For more information on disability classification, see the WHO International Classification of Functioning, Disability and Health (ICF).
| Disabled Marker | Description |
|---|---|
| y | Yes |
| n | No |
| all | No disaggregation |
Event Type
Used in: Conflict Events
ACLED compiles information on political violence, demonstrations, and other non-violent but politically important events. For their public dataset, these events are aggregated into three, non-mutually exclusive categories, outlined in the table below. Please see the ACLED Codebook for their methodology and more detailed descriptions of the sub-event types.
| Event Type | Description |
|---|---|
| civilian_targeting | Civilian targeting events include violence against civilians events and explosions/remote violence events in which civilians were directly targeted. |
| demonstration | Demonstration events include ACLED’s protests and riots event types, with the exception of the mob violence sub-event type of the riots event type. |
| political_violence | Political violence events include ACLED’s battles, violence against civilians, and explosions/remote violence event types, as well as the mob violence sub-event type of the riots event type. |
Gender
Used in:
Baseline Population,
Humanitarian Needs,
Refugees & Persons of Concern
Several sub-categories in HDX-HAPI are disaggregated by gender.
| Gender | Description |
|---|---|
| f | Female |
| m | Male |
| x | Non-binary |
| u | Unspecified |
| o | Other |
| all | No disaggregation |
IPC Code
Used in: Food Security
The IPC/CH classification includes 5 different phases of increasing severity, described in detail on page 53 of the IPC technical manual version 3.1, and summarised in the table below. This enum also includes Phase 3+, to highlight the population in need of action, and total population, used to compute fractions.
| IPC Phase | Name | Description |
|---|---|---|
| 1 | None/Minimal | Households are able to meet essential food and non-food needs without engaging in atypical and unsustainable strategies to access food and income. |
| 2 | Stressed | Households have minimally adequate food consumption but are unable to afford some essential non-food expenditures without engaging in stress-coping strategies. |
| 3 | Crisis | Households either have food consumption gaps that are reflected by high or above-usual acute malnutrition, or are marginally able to meet minimum food needs but only by depleting essential livelihood assets or through crisis-coping strategies. |
| 4 | Emergency | Households either have large food consumption gaps which are reflected in very high acute malnutrition and excess mortality, or are able to mitigate large food consumption gaps but only by employing emergency livelihood strategies and asset liquidation. |
| 5 | Catastrophe/Famine | Households have an extreme lack of food and/or other basic needs even after full employment of coping strategies. Starvation, death, destitution and extremely critical acute malnutrition levels are evident. (For Famine Classification, an area needs to have extreme critical levels of acute malnutrition and mortality.) |
| 3+ | In Need of Action | Sum of population in phases 3, 4, and 5. The population in Phase 3+ does not necessarily reflect the full population in need of urgent action. This is because some households may be in Phase 2 or even 1 but only because of receipt of assistance, and thus, they may be in need of continued action. |
| all | Population | Total population |
IPC Type
Used in: Food Security
The IPC and Cadre Harmonisé provide different projections to aid in planning and response efforts.
| IPC type | Definition |
|---|---|
| current | Food insecurity that is occurring in the current analysis period. |
| first projection | Projected food insecurity occurring in the period immediately following the current analysis period. |
| second projection | Projected food insecurity occurring in the period immediately following the first projection period. |
Population Group
Used in:
Humanitarian Needs,
Refugees & Persons of Concern
Almost all population group terms come from UNHCR's glossary, except for "RRI", and "all". "all" represents no-disaggregation", while RRI" was added as an umbrella term for returnees because the humanitarian needs data does not distinguish between returned refugees and returned IDPs.
| Population Group | Description |
|---|---|
| REF | Refugees |
| ROC | People in a refugee-like situation |
| ASY | Asylum seekers |
| OIP | Other people in need of international protection |
| IDP | Internally displaced persons |
| IOC | People in IDP-like situation |
| STA | Stateless people |
| OOC | Others of concern |
| HST | Host community |
| RET | Returned refugees |
| RST | Resettled refugees |
| NAT | Naturalized refugees |
| RDP | Returned IDPs |
| RRI | An umbrella term for returnees, used in the humanitarian needs data which do not distinguish between returned refugees and returned IDPs |
| all | No disaggregation |
Population Status
Used in:
Humanitarian Needs
The population status disaggregation provides a framework for the HNO to determine how effectively people in need are being reached. Note that "all" does not represent a sum over the different status types, but rather a disaggregation, as the same people may be present in multiple groups.
| Population Status | Description |
|---|---|
| AFF | Affected |
| INN | In-need |
| TGT | Targeted |
| REA | Reached |
| all | No disaggregation, "population" in the source data |
Price Flag
Used in: Food Prices & Market Monitor
Pre-processing characteristics of food prices.
| Price Flag | Description |
|---|---|
| actual | Collected with monthly frequency |
| aggregate | Collected with greater than monthly frequency (daily or weekly), and averaged through a weighted mean to monthly |
| actual,aggregate |
Price Type
Used in: Food Prices & Market Monitor
The point in the supply chain at which the price is determined. See FAO's concepts on price data for more information.
| Price Type |
|---|
| Farm Gate |
| Retail |
| Wholesale |
Risk Class
Used in: National Risk
In national risk, the final INFORM risk score is grouped into one of five risk classes, with the objective of systemically identifying risk in a consistent manner. Note that other categories and dimensions are also grouped into classes but with different thresholds, and these are not included in HDX HAPI. Please see the methodology for more details.
| Risk Class | Description | Risk Score Min | Risk Score Max |
|---|---|---|---|
| 1 | Very low | 0 | 1.9 |
| 2 | Low | 2 | 3.4 |
| 3 | Medium | 3.5 | 4.9 |
| 4 | High | 5 | 6.4 |
| 5 | Very high | 6.5 | 10 |
Version
Used in: Rainfall
What version the rainfall data refers to.
| Version | Name | Description |
|---|---|---|
| FINAL | Final | Rainfall indicators are final |
| FORECAST | Forecast | Rainfall indicators are forecasted into the future |
| PRELIMINARY | Preliminary | Rainfall indicators are preliminary and will be replaced by final figures when they are available |