Release Note¶
3.0.0¶
A new major release of the TB metadata and system design for integrating routine tuberculosis data into national HMIS for analysis. This version is aligned with the updates made in definitions and data entry forms as presented in the TB surveillance guidance (2024).
The major update is the Notification and Outcomes datasets and dashboards, which transition from custom datasets to flat datasets. There are further critical changes in definitions and terminology. See Notifications and Outcomes system design guide for details.
Other component confligurations are re-released as compatibility versions for DHIS2 v2.41.
2.0.0¶
This is a major new release of the TB metadata and system design for integrating routine tuberculosis data into national HMIS for analysis. This version is aligned with the latest WHO strategic information guidelines for tuberculosis programmes (2023).
The changes affect the notification and outcomes for first and second-line treatment and the household contacts of the confirmed TB cases.
New Content¶
Metadata changes primarily affect the notification and outcomes for first and second-line treatment, as well as household contacts of confirmed TB cases.
- Notification and Outcomes
The main changes to the datasets TB - Case notification, TB - Case notification (additional), TB - Treatment outcomes, and TB - Treatment outcomes (second line) datasets include: Updated dataset name dataset name for additional yearly notifications. This dataset is considered an annual extension of the routine core quarterly reported information and is therefore called “additional”.
- TB - Case notification (additional) (previously called ‘TB - RR/MDR case detection and treatment’
Updated metadata (new, older and legacy) names to conform with updated WHO nomenclature for: - Recurrent cases (previously referred to as ‘relapsed’) - Re-registered cases (previously referred to as ‘retreated’) - New episode cases (previously referred to as ‘new or relapse’)
Updated data elements to reflect the new guidelines on disaggregation, such as - Data Elements for Extrapulmonary, bacteriologically confirmed or clinically diagnosed no longer require a disaggregation by treatment history - Additional age disaggregations for TB cases - Resistance monitoring classifications (e.g. Isoniazid, fluoroquinolones and bedaquiline susceptibility testing) - Treatment history: Lab confirmed RR/MDR-TB now disaggregated by previous treatment history - Treatment regimen: DR-TB cohorts are now defined in terms of their regimen length and content
- TB Prevention - Household (HH) contacts
Split previous dataset into two new datasets to ensure precise calculations derived from specific cohorts and analysis periods; and allows for streamlined aggregation of data sourced from the Household Contacts Investigation tracker: - Notifications of HH contacts - Tuberculosis Preventive Treatment (TPT) outcomes
- Data Elements Revised disaggregation no longer includes the HIV status of the contacts, but maintains age disaggregation (under or over 5 years old).
All the changes to the metadata are also reflected in the indicators employed for the analysis of the TB - Data Quality dashboard.
1.5.0¶
The Data Quality (DQ) dashboard and guide are added to the TB HMIS toolkit.
1.4.1¶
French translations were added to all package components.
1.4.0¶
Revised package including a new component: Laboratory data set and dashboard.
1.1.1¶
- Included user group
UKWx4jJcrKt"TB data capture", which has data capture rights on all data shareable objects (only in the complete package) - Changed public access sharing to metadata view and data view.
- Removed dashboard
o2Wg6pXAN6X"TB2.Notifications (rates)", and associated chartgTcOAYjw4CQ, pivot tableHCmjOlNONzQand mapz4FMNqKG4gl. - Updated dashboard layout for use with the new dashboard app (from DHIS 2.29 and above)
- Updated periods in favourites, including data up to and including Q2 2019 (where relevant)
- Minor layout changes to pivot tables
hQ1ksBSIpQrandn6ZXdAl1sfD - Updated map favourite names
- Using the built-in translation support for French names rather than having both English and French names.
- Renamed maps
Eq9lKUQOykMandHFi8Oy2fFdJfrom TBm_3.8_... to TBm_3.7_... - Renamed maps
b6VznqkP4HcandoA74TkHOKnXto "TBc_3.5_Ratio of TB cases aged 0-4:5-14 year olds in new and relapse" and "TBc_3.5_Ratio of TB cases aged 0-4:5-14 year olds in new and relapse (annual)"
- Fixed chart
TfeoSE7Ha8F, changing data dimension from category option group set "Sex" to "Sex (with unknown)" - Fixed denominator of indicator
whkj4kr4ghD, should be#{hKTgk1mG2qn} + #{PdhQ1JCS2ij} + #{M6JHtLJJ34t} + #{KZ7rMA7BqcQ} + #{l4TyT04yP8f} + #{NYxehRdsQx3} +#{QNFhsj0fOxK} + #{Nv1RGi4eI7F} + #{NJaeD9Xia7x} + #{KhCB35MHs9A} - Changed description of indicator
p18w24U0caC - Changed name, shortName, code and description of indicator
VLtzufVWnHc - Fixed 3 validation rules with incorrect formulas:
bDjCyRMtkHO- New pulmonary smear-positiveVhVCSKuqraP- New pulmonary smear-negative/smear-unknown/smear not donehZveAwRhLRh- New extrapulmonary cases
- Renamed chart
Fw0CsA5Dpvf(from "TBc_4.3c_Treatment outcomes for DR-TB (%) (annual)" to "TBc_5.5_Treatment outcomes for DR-TB (%) (annual)), and added it to dashboardxJXvUOEhnE9("TB5. DR-TB (annual)").
Version 1.1.0¶
- Added three validation rules for the TB/HIV section of the "TB treatment outcomes" data set:
hXd2GANq20y- "TB/HIV testing (by time of outcome)"zANh0v8Sbr1- "HIV-positive TB patients on co-trimoxazole preventive therapy (CPT) (by time of outcome)"EG3H3WrJnKe- "HIV-positive TB patients on antiretroviral therapy (ART) (by time of outcome)"
- Fixed three validation rules:
puOMC36U2ad- "HIV-positive TB patients on antiretroviral therapy (ART)"MWDQUNd4sZE- "HIV-positive TB patients on co-trimoxazole preventive therapy (CPT)"TV3eW5zYLep- "TB/HIV testing"
- Added two pivot table favourites to complete package only (these are not included in any dashboards):
StXxQoaz26k- "TBt_0.1_Notifications_all data elements_annual"dQxhOVtwwK8- "TBt_0.2_Treatment outcomes_all data elements_annual"
- Fixed two charts where the indicator selection was empty. Both charts should have indicator
VLtzufVWnHc"TB - New and relapse TB cases by age and sex" selected as data, and the data dimension should be set to "filter":TfeoSE7Ha8F- "TBc_1.2_New and relapse cases by age group and sex"VBUUGBP8RFn- "TBc_1.2_New and relapse cases by age group and sex (annual)"
- Fixed several indicators, including names, descriptions and formulas:
| ID | Name | Modified property | Old value | New value |
|---|---|---|---|---|
| lRAKLRVIMgp | TB - Notified TB cases (all cases, all forms) | code | TB_C_NEWINC_ALL | TB_C_NOTIFIED |
| YWTs6xdTRFF | TB - Notified TB cases (new and relapse, all forms) | code | TB_C_NEWINC_NEWREL | TB_C_NEWINC |
| fBwmklJ0VNp | TB - Notified TB cases (new and relapse, all forms) aged 0-4 (%) | numeratorDescription | Number of children aged under 0-4 (new and relapse only) | Number of TB cases aged 0-4 (new and relapse only) |
| ExXsF5qlzdc | TB - Notified TB cases (new and relapse, all forms) aged 15-24 (%) | numeratorDescription | Number of children aged 15-24 (new and relapse only) | Number of TB cases aged 15-24 (new and relapse only) |
| zyyolGvDOLQ | TB - Notified TB cases (new and relapse, all forms) aged 25-34 (%) | numeratorDescription | Number of children aged 25-34 (new and relapse only) | Number of TB cases aged 25-34 (new and relapse only) |
| v7cZx5SUBXP | TB - Notified TB cases (new and relapse, all forms) aged 35-44 (%) | numeratorDescription | Number of children aged 35-44 (new and relapse only) | Number of TB cases aged 35-44 (new and relapse only) |
| rv14EhkmZof | TB - Notified TB cases (new and relapse, all forms) aged 45-54 (%) | numeratorDescription | Number of children aged 45-54 (new and relapse only) | Number of TB cases aged 45-54 (new and relapse only) |
| zw1DhQYN9mb | TB - Notified TB cases (new and relapse, all forms) aged 5-14 (%) | numeratorDescription | Number of children aged 5-14 (new and relapse only) | Number of TB cases aged 5-14 (new and relapse only) |
| TV1Qm6X0ILb | TB - Notified TB cases (new and relapse, all forms) aged 55-64 (%) | numeratorDescription | Number of children aged 55-64 (new and relapse only) | Number of TB cases aged 55-64 (new and relapse only) |
| vwRyMhcuZDh | TB - Notified TB cases (new and relapse, all forms) aged 65+ (%) | numeratorDescription | Number of children aged 65+ (new and relapse only) | Number of TB cases aged 65+ (new and relapse only) |
| aPT4OksC5z7 | TB - Notified TB cases (new and relapse, all forms) children aged 0-14 (%) | numeratorDescription | Number of children aged under 15 | Number of TB cases aged 0-15 (new and relapse only) |
| JCs9GgdcC7d | TB - Notified TB cases (new and relapse, pulmonary clinically diagnosed) | code | TB_C_NEWINC_CLINCONF | TB_C_NEWINC_CLINDX |
| JCs9GgdcC7d | TB - Notified TB cases (new and relapse, pulmonary clinically diagnosed) | numeratorDescription | Pulm bact confirmed new and relapse and history unknown | Pulmonary clinically diagnosed new and relapse and history unknown |
| JCs9GgdcC7d | TB - Notified TB cases (new and relapse, pulmonary clinically diagnosed) | numerator | #{voLCYElGAjX} + #{qlkxnlC6dzU} + #{NYxehRdsQx3} + #{EGlb6CP7czB}" | #{voLCYElGAjX} + #{qlkxnlC6dzU} + #{NYxehRdsQx3} + #{EGlb6CP7czB}+ #{v2qRhkUmjlV} + #{XLV3S8QL8jV} + #{PRB6dolaxC4} |
| VcwgKNqXO9n | TB - Ratio of TB cases aged 0-4:5-14 (new and relapse, all forms) | numeratorDescription | Cases aged 0-4 | Number of TB cases aged 0-4 (new and relapse, all forms) |
| VcwgKNqXO9n | TB - Ratio of TB cases aged 0-4:5-14 (new and relapse, all forms) | denominatorDescription | Cases in children aged 5-14 | Number of TB cases aged 5-14 (new and relapse, all forms) |
| cX7gRvEV6kK | TB - TB cases tested for susceptibility to rifampicin (%) | description | All TB cases tested for susceptibility to rifampicin - RR-TB(%) | All TB cases tested for susceptibility to rifampicin (RR-TB) as a percentage of all TB cases notified |
| Fyx8nuRcxja | TB - TB cases tested for susceptibility to rifampicin (new) (%) | description | New TB cases tested for susceptibility to rifampicin - RR-TB(%) | New TB cases tested for susceptibility to rifampicin (RR-TB) as a percentage of all new TB cases notified |
| Fyx8nuRcxja | TB - TB cases tested for susceptibility to rifampicin (new) (%) | denominatorDescription | Total notified | All new TB cases notified (excluding the cases with unknown treatment history) |
| Fyx8nuRcxja | TB - TB cases tested for susceptibility to rifampicin (new) (%) | denominator | #{wadYJEcT9yh} + #{voLCYElGAjX} + #{v2qRhkUmjlV} + #{ZiF0ngznP1Z} + #{XLV3S8QL8jV} + #{hKTgk1mG2qn} + #{PdhQ1JCS2ij} + #{M6JHtLJJ34t} + #{KZ7rMA7BqcQ} + #{PRB6dolaxC4} + #{Orjo9ewlU9Z} + #{qlkxnlC6dzU} + #{l4TyT04yP8f} + #{NYxehRdsQx3} +#{QNFhsj0fOxK} + #{Nv1RGi4eI7F} + #{NJaeD9Xia7x} + #{KhCB35MHs9A} + #{lgKh8oeoKVj} + #{EGlb6CP7czB} + #{Q5KSbP9ZzHQ} | #{wadYJEcT9yh} + #{voLCYElGAjX} + #{v2qRhkUmjlV} + #{ZiF0ngznP1Z} + #{XLV3S8QL8jV} + #{Orjo9ewlU9Z} + #{qlkxnlC6dzU} |
| whkj4kr4ghD | TB - TB cases tested for susceptibility to rifampicin (previously treated) (%) | description | Previously treated TB cases (including relapses) tested for susceptibility to rifampicin - RR-TB (%) | Previously treated TB cases (including relapses) tested for susceptibility to rifampicin (RR-TB) as a percentage of all previously treated (including relapses) TB cases notified |
| whkj4kr4ghD | TB - TB cases tested for susceptibility to rifampicin (previously treated) (%) | denominatorDescription | Total notified | All previously treated (including relapses) TB cases notified |
| whkj4kr4ghD | TB - TB cases tested for susceptibility to rifampicin (previously treated) (%) | denominator | #{wadYJEcT9yh} + #{voLCYElGAjX} + #{v2qRhkUmjlV} + #{ZiF0ngznP1Z} + #{XLV3S8QL8jV} + #{hKTgk1mG2qn} + #{PdhQ1JCS2ij} + #{M6JHtLJJ34t} + #{KZ7rMA7BqcQ} + #{PRB6dolaxC4} + #{Orjo9ewlU9Z} + #{qlkxnlC6dzU} + #{l4TyT04yP8f} + #{NYxehRdsQx3} +#{QNFhsj0fOxK} + #{Nv1RGi4eI7F} + #{NJaeD9Xia7x} + #{KhCB35MHs9A} + #{lgKh8oeoKVj} + #{EGlb6CP7czB} + #{Q5KSbP9ZzHQ} | #{hKTgk1mG2qn} + #{PdhQ1JCS2ij} + #{M6JHtLJJ34t} + #{KZ7rMA7BqcQ} + #{PRB6dolaxC4} + #{Orjo9ewlU9Z} + #{qlkxnlC6dzU} + #{l4TyT04yP8f} + #{NYxehRdsQx3} +#{QNFhsj0fOxK} + #{Nv1RGi4eI7F} + #{NJaeD9Xia7x} + #{KhCB35MHs9A} |
| WWephINt8ga | TB - TB notification rate (all cases, all forms) per 100 000 population | code | TB_C_ALLINC_100K | TB_C_NOTIFIED_100K |
| o7QoPpjWR9h | TB - TB notification rate (new and relapse, pulmonary clinically diagnosed) per 100 000 population | code | TB_C_NEWINC_CLINDIAG_100K | TB_C_NEWINC_CLINDX_100K |
| o7QoPpjWR9h | TB - TB notification rate (new and relapse, pulmonary clinically diagnosed) per 100 000 population | numerator | #{voLCYElGAjX}+ #{v2qRhkUmjlV}+#{XLV3S8QL8jV}+#{PRB6dolaxC4}+#{qlkxnlC6dzU}+#{NYxehRdsQx3}+#{NJaeD9Xia7x}+ #{EGlb6CP7czB} | #{voLCYElGAjX} + #{v2qRhkUmjlV} + #{XLV3S8QL8jV} + #{PRB6dolaxC4} + #{qlkxnlC6dzU} + #{NYxehRdsQx3} + #{EGlb6CP7czB} |
| SPJLukKxHaj | TB - TB treatment success rate (all DS and DR-TB) (%) | description | Number of all DS+DR TB cases who were successfully treated (cured or who completed their treatment) as a percentage of the total cohort of all DS+DR TB cases registered, excluding cases moved to second-line treatment | Number of all DS+DR TB cases who were successfully treated (cured or who completed their treatment) as a percentage of the total cohort of all DS+DR TB cases registered. |
- Added indicators, charts and maps (specified below), which should be considered "additional", and provide alternative outputs that can be useful for analysing historical data in some circumstances. In particular, they provide visualisations for alternative age disaggregations used by some countries previously:
| Type | ID | Name |
|---|---|---|
| Indicator | PgU1N0PfAwN | TB - Notified TB cases (new, pulmonary smear positive) by age group and sex |
| Indicator | SrgAuZUkqHh | TB - TB cases tested for HIV or with known HIV status - all cases (%) |
| Indicator | HBkfpoEMWna | TB - Notified TB cases (new, all forms) aged 55-64 (%) |
| Indicator | eIG3AwbOY4k | TB - Notified TB cases (new, all forms) aged 65+ (%) |
| Indicator | trwSfpxsWcb | TB - Notified TB cases (new, all forms) aged 45-54 (%) |
| Indicator | GjDECoLvM1z | TB - Notified TB cases (new, all forms) aged 5-14 (%) |
| Indicator | cT1tyz6k18X | TB - Notified TB cases (new, all forms) aged 35-44 (%) |
| Indicator | B1HKzq73wJr | TB - Notified TB cases (new, all forms) aged 15-24 (%) |
| Indicator | KlETO0IOKtI | TB - Notified TB cases (new, all forms) aged 25-34 (%) |
| Indicator | aPfDXoI0tPS | TB - Notified TB cases (new, all forms) aged 0-14 (%) |
| Indicator | jU1JpPt2T62 | TB - Notified TB cases (new, all forms) aged 0-4 (%) |
| Indicator | aArkaKMHNhw | TB - Not evaluated (new and relapse pulmonary bacteriologically confirmed DS-TB cases) (%) |
| Indicator | N7OZj7DONas | TB - Not evaluated (previously treated DS-TB cases) (%) |
| Indicator | xlmDFjsyuiS | TB - Not evaluated (all DR-TB cases) (%) |
| Indicator | HSLNfDLCbUc | TB - Not evaluated (all DS-TB/HIV cases) (%) |
| Indicator | c5yG2hQbSWF | TB - Lost to follow-up (previously treated DS-TB cases) (%) |
| Indicator | w3CiHTdwV4j | TB - Lost to follow-up (all DS-TB/HIV cases) (%) |
| Indicator | NNwvy3Ym6vj | TB - Lost to follow-up (new and relapse pulmonary bacteriologically confirmed DS-TB cases) (%) |
| Indicator | nhoEcbYl2hU | TB - Failed (previously treated DS-TB cases) (%) |
| Indicator | Tm4N8CLJM9I | TB - Lost to follow-up (all DR-TB cases) (%) |
| Indicator | m0VAZ280hFd | TB - Failed (all DS-TB/HIV cases) (%) |
| Indicator | XjyUl0Jmjbj | TB - Failed (new and relapse pulmonary bacteriologically confirmed DS-TB cases) |
| Indicator | wTmoLwBYFa8 | TB - Died (previously treated DS-TB cases) (%) |
| Indicator | P6wlyWUyJHp | TB - Failed (all DR-TB cases) (%) |
| Indicator | gHZcDFFvq5x | TB - Died (new and relapse pulmonary bacteriologically confirmed DS-TB cases) (%) |
| Indicator | RlFZHghqtq7 | TB - Died (all DS-TB/HIV cases) (%) |
| Indicator | c6ju86FLKzU | TB - Died (all DR-TB cases) (%) |
| Indicator | WCE27g52nBt | TB - Cured (new and relapse pulmonary bacteriologically confirmed DS-TB cases) (%) |
| Indicator | OuSWXCijKks | TB - Cured (previously treated DS-TB cases) (%) |
| Indicator | VTNrh2DfO91 | TB - Cured (all DS-TB/HIV cases) (%) |
| Indicator | JfrM1j1pYhc | TB - Cured (all DR-TB cases) (%) |
| Indicator | HBB4o9xQScX | TB - Completed (previously treated DS-TB cases) (%) |
| Indicator | AAiHWXynwMP | TB - Completed (new and relapse pulmonary bacteriologically confirmed DS-TB cases) (%) |
| Indicator | RgcWLiawMTQ | TB - Completed (all DS-TB/HIV cases) (%) |
| Indicator | L6TXyCTI2mW | TB - Completed (all DR-TB cases) (%) |
| Chart | b8BvZ2yyAGI | TBc_1.2a_New smear positive by age group and sex (annual) |
| Chart | NpBI7jrzA0z | TBc_1.3a_New cases (all forms) by age group (%) (annual) |
| Chart | zvXhppFsdjd | TBc_1.3b_New smear positive cases by age group (0-14 group) (%) (annual) |
| Chart | cT3HLHVOOwF | TBc_4.3a_Treatment outcomes for DS-TB/HIV (%) |
| Chart | q9Tag5rbuDJ | TBc_4.3a_Treatment outcomes for DS-TB/HIV (%) (annual) |
| Chart | A3sd6M0Ar3A | TBc_4.3b_Treatment outcomes for previously treated DS-TB (%) |
| Chart | UHn8QRtiKGH | TBc_4.3b_Treatment outcomes for previously treated DS-TB (%) (annual) |
| Chart | Fw0CsA5Dpvf | TBc_4.3c_Treatment outcomes for DR-TB (%) (annual) |
| Chart | qjAxCdXK4it | TBc_4.3d_Treatment outcomes for bacteriologically confirmed DS-TB (%) (annual) |
| Chart | ORUu9PBi84b | TBc_4.3e_Treatment outcomes for smear positive DS-TB (%) (annual) |
| Chart | ztsp2Ew6kdN | TBc_6.2a_TB/HIV cascade of care (all cases) |
| Chart | gOYlLJb51tn | TBc_6.2a_TB/HIV cascade of care (all cases) (annual) |
| Chart | BSKSZRKbSUU | TBc_6.2b_TB/HIV cascade of care (%) |
| Chart | dXIKcGcRfC4 | TBc_6.2b_TB/HIV cascade of care (%) (annual) |
| Chart | cS2kUPAkWri | TBc_6.2c_TB/HIV cascade of care (all cases) (%) |
| Chart | qmmhMtrCtby | TBc_6.2c_TB/HIV cascade of care (all cases) (%) (annual) |
| Chart | obyjcDqxXls | TBc_6.3a_TB/HIV – all TB cases (%) |
| Chart | xpiCsSSLVXp | TBc_6.3a_TB/HIV – all TB cases (%) (annual) |
| Map | R2kLLio5dEv | TBm_6.1a_All TB cases with known HIV status in 2017 (%) (annual) |
| Map | ICV9ugEX8hT | TBm_6.1a_All TB cases with known HIV status in 2017Q4 (%) |