Naming Conventions in DHIS2
- Rodolfo Melia
Naming the different objects in DHIS2 in a consistent, organised way facilitates the work that we all do in our shared instance of DHIS2. It helps systems administrator when building data collection tool, or the thousands of users doing analytical work, trying to find the correct Data Element among our long collection. Standardized naming convention also helps to avoid duplication of metadata objects, and re-utilization when appropriate.
General principles
Simplify and shorten names whenever is possible
keep them meaningful
Always provide context.
Pay particular attention to Data Elements and indicators, as they are exposed in analytics and affect the rendering of the chart/ table.
Naming principles for Data Elements and Indicators
It should not be based on how the data is collected
It should not mention the frequency (by month, this year..)
“Number of” is unnecessary / redundant
Name and Short Name should be for data output (analytic)
Form Name is for data capture
General naming structure
CI | HHH | PROJ | Object Name |
Health Area acronym (2 to 4 letters) | Project acronym | Data collection dimension name (brief description) |
Examples:
KH HIV NFP - Self-testing kits distributed (a data element)
KH HIV NFP - Facility Monthly (a data set)
KH HIV NFP - Test type (a category combination)
Component | Meaning | Notes |
|---|---|---|
KH | Cambodia | In DHIS2 we always use the country 2-ISO code. Not required for global projects. |
HIV | Human Immunodeficiency Virus | The health area - see list |
NFP | New Frontiers Project | Optional - if the data must be collected only for that project |
Self-testing kits distributed | The measure in question | be as concise as possible. |
Short Names
For Data Elements and Indicators, short names can be used at the time of analytics. You have a limit of 50 ch, but aim for less - about 25-30 ch if possible. Your analytics will look much nicer !
Full Name: KH HIV NFP - Self-testing kits (STK) distributed
Short Name: KH HIV - STK distributed
Key DHIS2 objects naming conventions
We list below all the DHIS2 for which PSI requires the use of naming conventions.
DHIS2 Object | Naming Convention | Name Example |
|---|---|---|
Category | [2-4 letter program code] AND/OR [CORE/ISO2] - [Category name] | CORE - Age groups (0-4, 5-14, 15-24, 25+) WHP - Reason for IUD removal |
Category combination | [2-4 letter program code] AND/OR [CORE/ISO2] - [Category Combo name] | CORE - Age groups (0-4, 5-14, 15-24, 25+) & gender WHP - Reason for IUD removal |
Category option | NOT APPLICABLE | Use shortest possible name. Reuse them as much as possible. |
Data element | [CORE/ISO2] [2-3 letter intervention area code] - [2-4 letter project/program code] - [DE name] | Aggregated DE: Tracker DE: |
Data element group | [CORE/ISO2] [2-3 letter intervention area code] - [2-4 letter project/program code] - [DE Group name] | UG RH WHP - RH Service Provision |
Data element group set | [CORE/ISO2] [2-3 letter intervention area code] [2-4 letter program code] | UG HIV PLP |
Data Set | [CORE/ISO2] [2-3 letter intervention area code] [2-4 letter program code] - [Dataset name] | UG MCH MUM - Monthly Facility HMIS Form |
Indicator | [CORE/ISO2] [2-3 letter intervention area code] [2-4 letter program code] - [Indicator name] | CORE MAL RDT - % of children under 5 with confirmed malaria receiving ACTs |
Option Set | [CORE/ISO2] [2-3 letter intervention area code] [2-4 letter program code] - [Option set name] | CORE MAL RDT - Results |
Options of an Option Set | NOT APPLICABLE |
|
Organisation unit | [OrgUnit name] ([Code]) | Administrative area: Bushenyi (402) Facility: Kicwamba Maternity Clinic (S-KMC-051) Provider: Musoki Jackline (S-KMC-051-012) |
Organisation Unit Group | [ISO2] [group set name] - [group] | Global: Type - Clinic Local: KE Region - Western |
Organisation Unit Group Set | For global OU groups: [group set name] For local OU groups: [ISO2] [group set name] | Global: Type Local: KE Region |
Program | [ISO2] - [2-3 letter intervention area code] [2-4 letter program code] - [Program name] | GT SRH WHP - Client Tracker |
Program Stage | Stage Name (always shown in context) | Follow-up Visit |
Exemptions for naming conventions
Category Options
Options (in an Option Set)
The values for Category Options and the Options on a Optionset are visible on the data collection forms and analytics - adding acronyms at the beginning will create confusion and waste valuable screen space. Also, Categories (like ages, sex, type of organizations) are universal values, that can be used across projects and countries.
Using Codes in DHIS2 objects
Codes are optional for all objects, but may assist in providing an additional mechanism for sorting objects and importing/exporting metadata and data associated with the object across servers. Specific nomenclature for organisation unit codes is described in the organisation unit standard.
General principles for codes:
Never use spaces
Keep length consistent, if possible
DHIS2 Object | Code Convention | Code Example |
|---|---|---|
Data element | [CORE/ISO2]_[3 letter intervention area code]-[2-4 letter project/program code]_[(TRK)]_[123] | CORE_MAL-RDT_003 CD_MAL-RDT_038 |
Organisation unit | Administrative areas: [ISO2][1234] Facilities: [ISO2][PSI/MOH/(project code)][1234] Providers: [facility code]-[provider code] | Facility: KEPSI1034 Provider: KEPSI1034-023 |
Appendix - Health Areas
Health Area Code | Health Area Name |
|---|---|
HTS | HIV |
TB | Tuberculosis |
SRH | Sexual Reproductive Health (= incl. Family Planning) |
MAL | Malaria |
VMC | Voluntary Male Circumcision |
CC | Cervical Cancer |
HT | Hypertension |
ICM | Integrated Case Management of Childhood Illnesses |
MNH | Maternal, Newborn, and Child Health |
SA | Safe Abortion |
PAC | Post Abortion Care |
STI | Sexually Transmitted Infections |
WASH | Water & Sanitation |