DHIS2 User Manual

2.24

Warranty:  THIS DOCUMENT IS PROVIDED BY THE AUTHORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS MANUAL AND PRODUCTS MENTIONED HEREIN, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License:  Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the source of this documentation, and is available here online: http://www.gnu.org/licenses/fdl.html.

Revision History
Revision 25942016-11-23 11:04:16
Version 2.24

Table of Contents

About this guide
1. What is DHIS2?
1.1. DHIS2 Background
1.2. Key features and purpose of DHIS2
1.3. Use of DHIS2 in HIS: data collection, processing, interpretation, and analysis.
1.4. Technical background
1.4.1. DHIS2 as a platform
1.4.2. Understanding platform independence
1.4.3. Deployment strategies - online vs offline
1.5. Difference between Aggregated and Patient data in a HIS
1.6. Free and Open Source Software (FOSS): benefits and challenges
2. Getting started with DHIS2
2.1. Using the DHIS2 demo server
2.2. Using the DHIS2 live package
2.2.1. Starting the DHIS2 Live package
2.2.2. Downloading and installing the server version
2.3. Logging on to DHIS2
2.4. Logging out of DHIS2
2.5. Quick intro to designing a DHIS2 database
2.5.1. The organisational hierarchy
2.5.2. Data Elements
2.5.3. Datasets and data entry forms
2.5.4. Validation rules
2.5.5. Indicators
2.5.6. Report tables and reports
2.5.7. GIS
2.5.8. Charts and dashboard
3. Data dimensions in DHIS2
3.1. Data dimensions: Core building blocks in DHIS2
3.2. Data elements: The What dimension
3.2.1. Data element categories
3.2.2. Data element group sets
3.3. The organisation unit dimension
3.3.1. Organisation unit group sets and groups
3.3.2. Best practice on the use of group sets and groups
3.4. The period dimension in DHIS2
3.4.1. Period Types
3.4.2. Relative periods
3.4.3. Aggregation of periods
3.5. Data collection vs. data analysis
3.5.1. Data collection and storage
3.5.2. Input does not equal Output
3.6. Extended examples of data elements and forms
3.7. How this works in pivot tables
3.8. Case study: From paper forms to multidimensional datasets - lessons learned
3.8.1. From tables to category combinations - designing multi-dimensional data sets
3.8.2. Step-by-step approach to designing datasets
4. User management
4.1. Creating new users and roles
4.1.1. User maintenance
4.1.2. User role management
4.1.3. User management
4.1.4. User by organisation unit
4.1.5. Managed users
4.1.6. OpenID Support
5. Sharing
5.1. Sharing of objects
5.2. Sharing and access control
5.3. Sharing applied
6. Dashboards
6.1. Setting up the dashboard
6.2. Managing the Dashboard
6.3. Dashboard Sharing
6.4. Manage messages and feedback messages
6.4.1. About messages and feedback messages
6.4.2. Create a message
6.4.3. Read a message
6.4.4. Create a feedback message
6.4.5. Configure feedback message function
6.4.6. Manage feedback messages
7. Data entry
7.1. Data entry with DHIS2
7.1.1. Selecting the data entry form
7.1.2. Entering data
7.1.3. Editing and deleting data
7.1.4. Validating data in the form
7.1.5. Off-line data entry
7.1.6. Multi-organisation unit data entry
8. Using Data Quality functionality
8.1. Overview of data quality checks
8.2. Data quality checks
8.3. Running Validation Rule Analysis
8.4. Std Dev Outlier Analysis
8.5. Min-Max Outlier Analysis
8.6. Follow-Up Analysis
9. Setting up Data Quality functionality
9.1. Overview of data quality check
9.2. Data quality checks
9.3. Data quality check at the point of data entry
9.3.1. Setting the minimum and maximum value range manually
9.3.2. Generated min-max values
9.4. Validation Rule
9.5. Surveillance Rules
9.6. Validation Rule Group
9.7. Scheduled Validation Runs
10. Using the Maintenance app
10.1. Manage data elements and categories
10.1.1. About data elements and categories
10.1.2. Workflow
10.1.3. Create a category option
10.1.4. Create a category
10.1.5. Create a category combination
10.1.6. Create a data element
10.1.7. Create a data element group
10.1.8. Create a data element group set
10.1.9. Create a category option group
10.1.10. Create a category option group set
10.1.11. Edit data elements and other objects
10.1.12. Clone data elements and other objects
10.1.13. Change sharing settings for data elements and other objects
10.1.14. Delete data elements and other objects
10.1.15. Display details of data elements and other objects
10.1.16. Translate data elements and other objects
10.1.17. Assign a code to a category option combination
10.1.18. Use category combinations for data sets
10.2. Manage data sets and data entry forms
10.2.1. About data sets and data entry forms
10.2.2. Workflow
10.2.3. Create a data set
10.2.4. Edit data sets
10.2.5. Clone data sets
10.2.6. Change sharing settings for data sets
10.2.7. Delete data sets and forms
10.2.8. Display details of data sets
10.2.9. Translate data sets
10.2.10. Edit compulsory data elements in a data set
10.2.11. Download default data forms in PDF format
10.2.12. Manage section forms
10.2.13. Manage custom forms
10.3. Manage indicators
10.3.1. About indicators
10.3.2. Workflow
10.3.3. Create an indicator type
10.3.4. Create an indicator
10.3.5. Create an indicator group
10.3.6. Create an indicator group set
10.3.7. Edit indicators and other objects
10.3.8. Clone indicators and other objects
10.3.9. Change sharing settings for indicators and other objects
10.3.10. Delete indicators and other objects
10.4. Manage organisation units
10.4.1. About organisation units
10.4.2. Workflow
10.4.3. Create an organisation unit
10.4.4. Create an organisation unit group
10.4.5. Create an organisation unit group set
10.4.6. Edit organisation units and other objects
10.4.7. Clone organisation units and other objects
10.4.8. Change sharing settings for organisation unit groups and group sets
10.4.9. Delete organisation units and other objects
10.4.10. Display details of organisation units and other objects
10.4.11. Translate organisation units and other objects
10.4.12. Assign names to organisation unit levels
10.4.13. Move organisation units within a hierarchy
10.5. Manage attributes
10.6. Manage constants
10.7. Manage option sets
10.8. Edit multiple object groups at once
10.8.1. Edit multiple objects in an object group
10.8.2. Edit an object in multiple object groups
11. Using reporting functionality
11.1. Reporting functionality in DHIS2
11.2. Using standard reports
11.3. Using dataset reports
11.4. Using resources
11.5. Using reporting rate summary
11.6. Using organisation unit distribution reports
12. Using the Pivot Table app
12.1. About the Pivot table app
12.2. Create a pivot table
12.2.1. Select dimension items
12.2.2. Modify pivot table layout
12.3. Change the display of your table
12.4. Manage pivot table favorites
12.4.1. Save a pivot table as a favorite
12.4.2. Open a favorite
12.4.3. Rename a favorite
12.4.4. Share an interpretation of a favorite
12.4.5. Modify sharing settings for a favorite
12.4.6. Create a link to a favorite
12.4.7. Delete a favorite
12.5. Download data from a pivot table
12.5.1. Download table layout data format
12.5.2. Download plain data source format
12.5.3. Download a CSV format without rendering data in the web browser
12.6. Embed a pivot table in an external web page
12.7. Visualize a pivot table data as a chart or a map
12.7.1. Open a pivot table as a chart
12.7.2. Open a pivot table selection as a chart
12.7.3. Open a pivot table as a map
12.7.4. Open a pivot table selection as a map
12.8. Constraints and tips
13. Using the Data Visualizer app
13.1. Data Visualizer overview
13.2. Create a chart
13.3. Select a chart type
13.4. Select dimension items
13.4.1. Select indicators
13.4.2. Select data elements
13.4.3. Select reporting rates
13.4.4. Select fixed and relative periods
13.4.5. Select organisation units
13.4.6. Select additional dimension items
13.5. Select series, category and filter
13.6. Change the display of your chart
13.7. Download a chart as an image or a PDF
13.8. Download chart data source
13.9. Manage chart favorites
13.9.1. Save a chart as a favorite
13.9.2. Open a favorite
13.9.3. Rename a favorite
13.9.4. Overwrite a favorite
13.9.5. Share a chart interpretation
13.9.6. Modify sharing settings for a favorite
13.9.7. Delete a favorite
13.10. Embed charts in any web page
13.11. Visualize a chart as a pivot table or a map
13.11.1. Open a chart as a pivot table
13.11.2. Open a chart as a map
14. Using the GIS app
14.1. About the GIS app
14.2. Create a new thematic map
14.3. Manage event layer
14.3.1. Create or modify event layer
14.3.2. Turn off cluster
14.3.3. Modify cluster style
14.3.4. Modify information in event pop-up windows
14.3.5. Clear event layer
14.4. Manage facility layer
14.4.1. Create or modify facility layer
14.4.2. Search for an organisation unit
14.4.3. Clear facility layer
14.5. Manage boundary layer
14.5.1. Create or modify boundary layer
14.5.2. Search for an organisation unit
14.5.3. Navigate between organisation hierarchies
14.5.4. Clear boundary layer
14.6. Manage thematic layer 1- 4
14.6.1. Create or modify a thematic layer
14.6.2. Filter values in a thematic layer
14.6.3. Search for an organisation unit
14.6.4. Navigate between organisation hierarchies
14.6.5. Clear thematic layer
14.7. Manage facilities in a layer
14.7.1. Relocate a facility
14.7.2. Swap longitude and latitude of a facility
14.7.3. Display facility information
14.8. Manage Earth Engine layer
14.8.1. Create or modify an Earth Engine layer
14.9. Manage map favorites
14.9.1. Save a map as a favorite
14.9.2. Open a favorite
14.9.3. Rename a favorite
14.9.4. Overwrite a favorite
14.9.5. Share a map interpretation
14.9.6. Modify sharing settings for a favorite
14.9.7. Delete a favorite
14.10. Manage map legend sets
14.10.1. Create a new legend set
14.10.2. Change a legend set
14.10.3. Delete a legend set
14.10.4. Assign a legend set to indicator or data element
14.11. Download a map as image
14.12. Embed a map in an external web page
14.13. Search for a location
14.14. Measure distance and area in a map
14.15. Visualize a map as a pivot table or a chart
14.15.1. Open a map as a chart
14.15.2. Open a map as a pivot table
15. Setting up GIS
15.1. Context
15.2. Importing coordinates
16. Setting up report functionality
16.1. Data sources for reporting
16.1.1. Types of data and aggregation
16.1.2. Resource tables
16.1.3. Report tables
16.2. How to create report tables
16.2.1. General options
16.2.2. Selecting data
16.2.3. Selecting report parameters
16.2.4. Data element dimension tables
16.2.5. Report table - best practices
16.3. Report table outcome
16.4. Standard reports
16.4.1. What is a standard report?
16.4.2. Designing Standard reports in iReport
16.4.3. Designing SQL based standard reports
16.4.4. Designing HTML based standard reports
17. Using the Usage Analytics app
17.1. Create an usage analytics graph
18. Data approval
18.1. Approving and accepting
18.2. Authorities for approving data
18.3. Configuring data approval
18.4. Data visibility
18.5. Approving data
18.6. Approving by category option group set
18.6.1. Approving by one category option group set
18.6.2. Approving by multiple category option group sets
19. Import and export
19.1. Meta-data import
19.1.1. Meta-data import
19.1.2. Importing CSV meta-data
19.1.3. GML data import
19.2. Importing data
19.2.1. XML data import
19.2.2. Importing CSV data
19.2.3. Event data import
19.2.4. Importing PDF data
19.2.5. Importing data from DHIS2 1.4
19.3. Exporting data and meta-data
19.3.1. Metadata export
19.3.2. Meta-data detailed export
19.3.3. Data export
19.3.4. Event data export
19.3.5. Exporting data to other systems
20. Data Administration
20.1. Data browser
20.2. Data integrity
20.2.1. Data elements without data set
20.2.2. Data elements without groups
20.2.3. Data elements violating exclusive group sets
20.2.4. Data elements in data set but not in form or sections
20.2.5. Data elements assigned to data sets with different period types
20.2.6. Data sets not assigned to organisation units
20.2.7. Sections with invalid category combinations
20.2.8. Indicators with identical formulas
20.2.9. Indicators without groups
20.2.10. Invalid indicator numerators
20.2.11. Invalid indicator denominators
20.2.12. Indicators violating exclusive group sets
20.2.13. Duplicate periods
20.2.14. Organisation units with cyclic references
20.2.15. Orphaned organisation units
20.2.16. Organisation units without groups
20.2.17. Organisation units violating compulsory group sets
20.2.18. Organisation units violating exclusive group sets
20.2.19. Organisation unit groups without group sets
20.2.20. Validation rules without groups
20.2.21. Invalid validation rule left side expressions
20.2.22. Invalid validation rule right side expressions
20.3. Maintenance
20.4. Resource tables
20.5. Locale Management
20.6. SQL View
20.6.1. Creating a new SQL view
20.6.2. SQL View management
20.7. Duplicate data elimination
20.8. Data statistics
20.9. Lock exceptions
20.10. Min-Max Value Generation
20.11. Cache Statistics
20.12. Scheduling
20.13. Data synchronization
20.14. Metadata Synchronization Scheduling
21. Settings
21.1. System settings
21.1.1. General settings
21.1.2. Server settings
21.1.3. Appearance settings
21.1.4. Email settings
21.1.5. Access settings
21.1.6. Approval
21.1.7. Calendar settings
21.1.8. Data import
21.1.9. Synchronization settings
22. Mobile
22.1. DHIS2 Mobile Introduction
22.2. Mobile browser based data entry
22.2.1. Getting started with mobile browser data entry
22.3. J2ME GPRS/3G Client
22.3.1. Data connection availability
22.3.2. J2ME GPRS 3G facility reporting client
22.3.3. Detailed configuration of data sets and reporting forms
22.3.4. Mobile application setup
22.4. SMS Command
22.4.1. Set up SMS command
22.4.2. SMS Command Type
22.5. SMS Service
22.5.1. Setting up SMS service
22.5.2. Gateway Configurations
23. Using Event Capture
23.1. Overview
23.2. Capturing events
24. Using the Event Reports app
24.1. Event reports overview
24.2. Create an event report
24.3. Select dimension items
24.4. Select series, category and filter
24.5. Change the display of your chart
24.6. Download chart data source
24.7. Manage event report favorites
24.7.1. Save a chart as a favorite
24.7.2. Open a favorite
24.7.3. Rename a favorite
24.7.4. Overwrite a favorite
24.7.5. Modify sharing settings for a favorite
24.7.6. Delete a favorite
24.8. Create a link to a favorite
24.9. Visualize an event report as a chart
25. Using the Event Visualizer app
25.1. Event Visualizer overview
25.2. Create a chart
25.3. Select a chart type
25.4. Select dimension items
25.5. Select series, category and filter
25.6. Change the display of your chart
25.7. Download a chart as an image or a PDF
25.8. Download chart data source
25.9. Manage chart favorites
25.9.1. Save a chart as a favorite
25.9.2. Open a favorite
25.9.3. Rename a favorite
25.9.4. Overwrite a favorite
25.9.5. Modify sharing settings for a favorite
25.9.6. Delete a favorite
25.10. Create a link to a favorite
25.11. Visualize a chart as a pivot table
26. Using Tracker Capture
26.1. Overview
26.2. TEI search and registration
26.3. Tracker dashboard
26.3.1. Share tracker dashboard
26.4. Tracker reports
27. Tracker
27.1. Introduction
27.1.1. Background
27.1.2. Getting started with tracker
27.2. User guide
27.2.1. Programs / Attributes
27.2.2. Individual records
28. Program Indicators
28.1. Overview
28.2. Setup
28.3. Indicator evaluation
28.3.1. Aggregation type
28.3.2. Expression
28.3.3. Filter
28.3.4. Functions
28.3.5. Variables
29. Program rules
29.1. Overview
29.2. Setup
29.3. Program rule anatomy
29.4. Adding source fields
29.5. Defining expressions
29.6. Defining actions
29.6.1. Hide field action
29.6.2. Hide section action
29.6.3. Show warning action
29.6.4. Show warning on completion action
29.6.5. Show error action
29.6.6. Show error preventing completion action
30. User profiles
30.1. User settings
30.2. User profile
31. Synchronizing metadata
31.1. About metadata synchronization
31.2. Metadata Sync Task
31.3. Authorities to sync and create versioned metadata
31.4. Configure Central Instance
31.5. Configure Local Instance
31.6. Steps to sync metadata
31.7. Best Practices at Central Instance
31.8. Best Practices at Local Instance
32. DHIS2 Frequently Asked Questions
A. User authorities
DHIS2 Glossary
Bibliography
33. Release and upgrade notes
Index

List of Figures

1.1. The health information cycle
18.1. Approving at organisation units
18.2. Approving and accepting
18.3. Hiding of unapproved data
18.4. Example category option groups

List of Tables

3.1.
3.2. Example of detailed storage of data values when using data element categories "Place of Service" and "Age" (simplified for readability compared to the actual database table)
3.3.
3.4.
3.5.
6.1. Feedback handling tools
10.1. Data element objects in the Maintenance app
10.2. Value
10.3. Aggregation operators
10.4. Data entry form types
10.5. Data set objects in the Maintenance app
10.6. Data entry events
10.7. Indicator formula
10.8. Indicator objects in the Maintenance app
10.9. Organisation unit objects in the Maintenance app
10.10. Object types in the Metadata group editor
12.1. Data dimension types
12.2. Table options
12.3. Available formats
13.1. Chart types
13.2. Selection modes
13.3. Chart options
13.4. Available formats
14.1. View organisation unit information
14.2. Example of vaccination coverage legends
15.1. Organisation unit identifiers supported for GML import
18.1. Example Category Option Groups
18.2. Example Category Option Group Set approval levels
18.3. Example Multiple Category Option Group Sets
18.4. Example Multiple Category Option Group Set approval levels
22.1.
22.2. Gateway Configuration Parameters
24.1. Selection modes
24.2. Event reports options
24.3. Available formats
25.1. Chart types
25.2. Selection modes
25.3. Chart options
25.4. Available formats
28.1. Operators
28.2. Functions
28.3. Variables
29.1. Functions
A.1.
33.1. DHIS2 releases

List of Examples

10.1. Three age categories
10.2. Category combination
10.3. Category options groups and group sets
10.4. Use category combination for a data set
10.5. Categories for data sets
10.6. Open future periods for data entry
10.7. Section form example
10.8.
10.9. Classify facilities based on ownership
12.1. Pivot table based on the demo database.
13.1. Chart illustrating the concepts of series, categories and filter
14.1. Vaccination coverage legends