DHIS2 User guide



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 2.25@874b2562016-11-23 10:45:57
Version 2.25

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. About dashboards
6.2. Setting up the dashboard
6.3. Change dashboards name
6.4. Add message widget to dashboards
6.5. Delete dashboards
6.6. Translate dashboard names
6.7. Dashboard Sharing
6.8. Manage messages and feedback messages
6.8.1. About messages and feedback messages
6.8.2. Create a message
6.8.3. Read a message
6.8.4. Create a feedback message
6.8.5. Configure feedback message function
6.8.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. Validation Rule Group
9.6. Scheduled Validation Runs
10. Using the Maintenance app
10.1. Manage categories
10.1.1. About 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 category option group
10.1.7. Create a category option group set
10.1.8. Use category combinations for data sets
10.1.9. Assign a code to a category option combination
10.1.10. Edit metadata objects
10.1.11. Clone metadata objects
10.1.12. Change sharing settings for metadata objects
10.1.13. Delete metadata objects
10.1.14. Display details of metadata objects
10.1.15. Translate metadata objects
10.2. Manage data elements
10.2.1. About data elements
10.2.2. Workflow
10.2.3. Create a data element
10.2.4. Create a data element group
10.2.5. Create a data element group set
10.2.6. Edit data elements and other objects
10.2.7. Clone data elements and other objects
10.2.8. Change sharing settings for data elements and other objects
10.2.9. Delete data elements and other objects
10.2.10. Display details of data elements and other objects
10.2.11. Translate data elements and other objects
10.3. Manage data sets and data entry forms
10.3.1. About data sets and data entry forms
10.3.2. Workflow
10.3.3. Create a data set
10.3.4. Edit data sets
10.3.5. Clone data sets
10.3.6. Change sharing settings for data sets
10.3.7. Delete data sets and forms
10.3.8. Display details of data sets
10.3.9. Translate data sets
10.3.10. Override data elements' category combinations in a data set
10.3.11. Edit compulsory data elements in a data set
10.3.12. Download default data forms in PDF format
10.3.13. Manage section forms
10.3.14. Manage custom forms
10.4. Manage indicators
10.4.1. About indicators
10.4.2. Workflow
10.4.3. Create an indicator type
10.4.4. Create an indicator
10.4.5. Create an indicator group
10.4.6. Create an indicator group set
10.4.7. Edit indicators and other objects
10.4.8. Clone indicators and other objects
10.4.9. Change sharing settings for indicators and other objects
10.4.10. Delete indicators and other objects
10.5. Manage organisation units
10.5.1. About organisation units
10.5.2. Workflow
10.5.3. Create an organisation unit
10.5.4. Create an organisation unit group
10.5.5. Create an organisation unit group set
10.5.6. Edit organisation units and other objects
10.5.7. Clone organisation units and other objects
10.5.8. Change sharing settings for organisation unit groups and group sets
10.5.9. Delete organisation units and other objects
10.5.10. Display details of organisation units and other objects
10.5.11. Translate organisation units and other objects
10.5.12. Assign names to organisation unit levels
10.5.13. Move organisation units within a hierarchy
10.6. Manage program metadata
10.6.1. About program metadata
10.6.2. Create a tracked entity attribute
10.6.3. Create a tracked entity attribute group
10.6.4. Create a relationship type
10.6.5. Create a tracked entity
10.6.6. Edit metadata objects
10.6.7. Clone metadata objects
10.6.8. Delete metadata objects
10.6.9. Change sharing settings for metadata objects
10.6.10. Display details of metadata objects
10.6.11. Translate metadata objects
10.7. Manage attributes
10.7.1. About attributes
10.7.2. Create an attribute
10.7.3. Edit metadata objects
10.7.4. Clone metadata objects
10.7.5. Delete metadata objects
10.7.6. Display details of metadata objects
10.7.7. Translate metadata objects
10.8. Manage constants
10.8.1. About constants
10.8.2. Create a constant
10.8.3. Edit metadata objects
10.8.4. Clone metadata objects
10.8.5. Change sharing settings for metadata objects
10.8.6. Delete metadata objects
10.8.7. Display details of metadata objects
10.8.8. Translate metadata objects
10.9. Manage option sets
10.9.1. About option sets
10.9.2. Create an option set
10.9.3. Edit metadata objects
10.9.4. Clone metadata objects
10.9.5. Change sharing settings for metadata objects
10.9.6. Delete metadata objects
10.9.7. Display details of metadata objects
10.9.8. Translate metadata objects
10.10. Manage legends
10.10.1. About legends
10.10.2. Create a legend
10.10.3. Edit metadata objects
10.10.4. Clone metadata objects
10.10.5. Change sharing settings for metadata objects
10.10.6. Delete metadata objects
10.10.7. Display details of metadata objects
10.10.8. Translate metadata objects
10.10.9. Assign a legend to indicator or data element
10.11. Manage predictors
10.11.1. About predictors
10.11.2. Create a predictor
10.11.3. Edit metadata objects
10.11.4. Clone metadata objects
10.11.5. Delete metadata objects
10.11.6. Display details of metadata objects
10.11.7. Translate metadata objects
10.12. Manage push reports
10.12.1. About push reports
10.12.2. Create a push report
10.12.3. Preview push reports
10.12.4. Run push report jobs
10.12.5. Edit metadata objects
10.12.6. Clone metadata objects
10.12.7. Delete metadata objects
10.12.8. Display details of metadata objects
10.12.9. Translate metadata objects
10.13. Manage external map layers
10.13.1. About external map layers
10.13.2. Create an external map layer
10.13.3. Edit metadata objects
10.13.4. Clone metadata objects
10.13.5. Delete metadata objects
10.13.6. Display details of metadata objects
10.13.7. Translate metadata objects
10.14. Edit multiple object groups at once
10.14.1. Edit multiple objects in an object group
10.14.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 pivot table
12.4. Manage favorites
12.4.1. Open a favorite
12.4.2. Save a favorite
12.4.3. Rename a favorite
12.4.4. Write an interpretation for a favorite
12.4.5. Create a link to a favorite
12.4.6. Delete a favorite
12.4.7. View and comment interpretations
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. Manage favorites
13.7.1. Open a favorite
13.7.2. Save a favorite
13.7.3. Rename a favorite
13.7.4. Write an interpretation for a favorite
13.7.5. Create a link to a favorite
13.7.6. Delete a favorite
13.7.7. View and comment interpretations
13.8. Download a chart as an image or a PDF
13.9. Download chart data source
13.10. Embed charts in any web page
13.11. Open a chart as a pivot table or 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 layers
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 layers
14.4.1. Create or modify a facility layer
14.4.2. Search for an organisation unit
14.4.3. Clear facility layer
14.5. Manage facilities in a layer
14.5.1. Relocate a facility
14.5.2. Swap longitude and latitude of a facility
14.5.3. Display facility information
14.6. Manage thematic layers 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 boundary layers
14.7.1. Create or modify boundary layers
14.7.2. Search for organisation units
14.7.3. Navigate between organisation hierarchies
14.7.4. Clear boundary layer
14.8. Manage Earth Engine layer
14.8.1. Create or modify an Earth Engine layer
14.9. Add external map layers
14.10. Manage map favorites
14.10.1. Save a map as a favorite
14.10.2. Open a favorite
14.10.3. Rename a favorite
14.10.4. Overwrite a favorite
14.10.5. Share a map interpretation
14.10.6. Modify sharing settings for a favorite
14.10.7. Delete a favorite
14.11. Save a map as an image
14.12. Embed a map in an external web page
14.13. Search for a location
14.14. Measure distances and areas in a map
14.15. Get the latitude and longitude at any location
14.16. View a map as a pivot table or chart
14.16.1. Open a map as a chart
14.16.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 integrity
20.1.1. Data elements without data set
20.1.2. Data elements without groups
20.1.3. Data elements violating exclusive group sets
20.1.4. Data elements in data set but not in form or sections
20.1.5. Data elements assigned to data sets with different period types
20.1.6. Data sets not assigned to organisation units
20.1.7. Sections with invalid category combinations
20.1.8. Indicators with identical formulas
20.1.9. Indicators without groups
20.1.10. Invalid indicator numerators
20.1.11. Invalid indicator denominators
20.1.12. Indicators violating exclusive group sets
20.1.13. Duplicate periods
20.1.14. Organisation units with cyclic references
20.1.15. Orphaned organisation units
20.1.16. Organisation units without groups
20.1.17. Organisation units violating compulsory group sets
20.1.18. Organisation units violating exclusive group sets
20.1.19. Organisation unit groups without group sets
20.1.20. Validation rules without groups
20.1.21. Invalid validation rule left side expressions
20.1.22. Invalid validation rule right side expressions
20.2. Maintenance
20.3. Resource tables
20.4. Locale Management
20.5. SQL View
20.5.1. Creating a new SQL view
20.5.2. SQL View management
20.6. Duplicate data elimination
20.7. Data statistics
20.8. Lock exceptions
20.9. Min-Max Value Generation
20.10. Cache Statistics
20.11. Scheduling
20.12. Data synchronization
20.13. 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 the Event Capture app
23.1. About the Event Capture app
23.2. Register an event
23.3. Edit an event
23.4. Edit events in grid
23.5. Share events in edit mode
23.6. View an event audit history
23.7. Delete an event
23.8. Modify an event list's layout
23.9. Print an event list
23.10. Download an event list
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 the Tracker Capture app
26.1. About the Tracker Capture app
26.2. About tracked entity instance (TEI) dashboards
26.3. Workflow
26.4. Create a TEI
26.5. Create a TEI and enroll it in a program
26.6. Open an existing TEI dashboard
26.6.1. Simple TEI search
26.6.2. Advanced TEI search
26.6.3. Find a TEI outside your organisation unit
26.6.4. Download TEI search results list
26.6.5. Modify TEI search results list's layout
26.7. Enroll an existing TEI in a program
26.8. Enter event data for a TEI
26.9. Manage a TEI's enrollments
26.9.1. Deactivate a TEI's enrollment
26.9.2. Activate a TEI's enrollment
26.9.3. Mark TEI's enrollment as complete
26.9.4. Reopen completed enrollment
26.9.5. Display TEI's enrollment history
26.9.6. Create a TEI enrollment note
26.10. Send a message to a TEI
26.11. Mark a TEI for follow-up
26.12. Edit a TEI's profile
26.13. Add a relationship to a TEI
26.14. Share a TEI dashboard
26.15. Configure the TEI dashboard
26.15.1. Show or hide widgets
26.15.2. Save the dashboard's layout as default
26.16. Create reports
27. Configuring programs
27.1. About programs
27.2. Manage programs
27.2.1. Create a program
27.2.2. Assign a program to organisation units
27.2.3. Edit programs
27.2.4. Change sharing settings for programs
27.2.5. Delete programs
27.2.6. Display programs
27.2.7. Translate program names
27.3. Manage program stages
27.3.1. About program stages
27.3.2. Create a program stage
27.3.3. Create a program stage section
27.3.4. Change program stage sort order
27.3.5. Change program stage section sort order
27.3.6. Edit program stages
27.3.7. Display program stages
27.3.8. Translate program stages
27.4. Manage program indicators
27.4.1. About program indicators
27.4.2. Create a program indicator
27.4.3. Create a program indicator group
27.4.4. Edit program indicators
27.4.5. Change sharing settings for program indicators
27.4.6. Delete program indicators
27.4.7. Display program indicators
27.4.8. Translate program indicators
27.4.9. Edit program indicator groups
27.4.10. Delete program indicator groups
27.4.11. Display program indicator groups
27.4.12. Translate program indicator groups
27.5. Manage program rules
27.5.1. About program rules
27.5.2. Create a program rule
27.5.3. Edit program rules
27.5.4. Delete program rules
27.5.5. Display program rules
27.5.6. Translate program rules
27.6. Manage program validation rules
27.6.1. About program validation rules
27.6.2. Create a program validation rule
27.6.3. Edit program validation rules
27.6.4. Delete program validation rules
27.7. Manage program notifications
27.7.1. About program notifications
27.7.2. Create a program notification
27.7.3. Create a program stage notification
27.8. [Review ongoing] Manage custom registration forms
27.8.1. About program custom registration forms
27.8.2. About program stage data entry forms
27.8.3. Create a custom program registration form
27.8.4. Create a program stage data entry form
28. User account preferences
29. Synchronizing metadata
29.1. About metadata synchronization
29.2. Metadata Sync Task
29.3. Authorities to sync and create versioned metadata
29.4. Configure Central Instance
29.5. Configure Local Instance
29.6. Steps to sync metadata
29.7. Best Practices at Central Instance
29.8. Best Practices at Local Instance
30. DHIS2 Frequently Asked Questions
A. User authorities
DHIS2 Glossary
31. Release and upgrade notes

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.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)
6.1. Feedback handling tools
10.1. Category objects in the Maintenance app
10.2. Data element objects in the Maintenance app
10.3. Value types
10.4. Aggregation operators
10.5. Data entry form types
10.6. Data set objects in the Maintenance app
10.7. Data entry events
10.8. Indicator formula
10.9. Indicator objects in the Maintenance app
10.10. Organisation unit objects in the Maintenance app
10.11. Program metadata objects in the Maintenance app
10.12. Value types
10.13. Aggregation operators
10.14. Attribute objects in the Maintenance app
10.15. Constant objects in the Maintenance app
10.16. Option set objects in the Maintenance app
10.18. Predictor objects in the Maintenance app
10.19. Push reports objects in the Maintenance app
10.20. External map layer objects in the Maintenance app
10.21. 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
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
20.1. Data maintenance functions in the Data Administration app
22.2. Common Parameters
22.3. 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
26.1. Data entry widgets in the Tracker Capture app
26.2. Report types in Tracker Capture
27.1. Program metadata objects in the Program / Attributes app
27.2. Program metadata objects in the Maintenance app
27.5. Program indicator objects in the Programs / Attributes app
27.6. Operators
27.7. Functions
27.8. Variables
27.9. Program rule objects in the Programs / Attributes app
27.10. Operators
27.11. Functions
31.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.8. Section form example
10.10. Classify facilities based on ownership
10.12. Vaccination coverage legends
10.17. Push report
12.1. Pivot table based on the demo database.
13.1. Chart illustrating the concepts of series, categories and filter
26.3. Mother-Child relationship
26.4. Program summary report