Skip to content
For the complete DHIS2 documentation index, see llms.txt.
User guides
Analysing data

Using the Maps app

About the Maps app

The Maps App was introduced in release 2.29 and serves as a replacement of the GIS App offering a more intuitive and user-friendly interface. The mapping engine from version 2.34 is based on WebGL technology, capable of showing thousands of features on a map simultaneously.

With the Maps app you can overlay multiple layers and choose among different basemaps. You can create thematic maps of areas and points, view facilities based on classifications, and visualize catchment areas for each facility. You can add labels to areas and points, and search and filter using various criteria. You can move points and set locations on the fly. Maps can be saved and shared with other users and groups, or downloaded as an image.

Note

To use predefined legends in the Maps app, you need to create them first in the Maintenance app.

  • The layer panel on the left side of the workspace shows an overview of the layers for the current map:

    • As layers are added, using the (+) Add layer button, they are arranged and managed in this panel.

    • The basemap card is always shown in the panel. The default available basemaps are OpenStreetMap Light (OSM Light), OpenStreetMap Detailed (OSM Detailed) and Sentinel-2 Cloudless by EOX (Sentinel-2 EOX). The default selected basemap is OSM Light, unless a different basemap has been configured in the system settings. OSM Detailed contains more map features and place names. Sentinel-2 Cloudless is a cloud-free satellite imagery showing natural-color views of the Earth's surface with a 10m resolution.

      If the Azure or Bing Maps API key has been added by a system administrator, then there will be an additional 4 basemaps from Azure/Bing Maps. Road and Dark show roads, borders and places. Use the dark version if the colors on your map layers are bright. Aerial and Aerial Labels show satellite and detailed aerial imagery. Switch between them by selecting the desired image.

      Note: Bing maps is being retired, see the announcement on the Bing Maps Blog. For migration to Azure Maps, you can consult the Bing Maps Migration Overview.

    • The small arrow button to the right of the layer panel, at the top, allows the panel to be hidden or shown.

  • The File button near the top left allows you to open and save maps. See using the maps file menu for more detailed information.
  • The Download button next to the File button allows you to download the current map as a PNG image.
  • The Interpretations button at top right opens an interpretations panel on the right side of the workspace. See viewing interpretations for more information.

  • The + and - buttons on the map allow you to zoom in and out of the map respectively. The mouse scroll wheel zoom is continuous, allowing us to fit the map perfectly to your content.

  • The rotate map button (triangle arrows) allows you to rotate and tilt the map to enhance the view of your data. Press and hold the button (or hold the Control key on your keyboard) while moving your mouse to change the map view. Click to button again to reset the view.

  • Fullscreen (four arrows) allows you to view the map in fullscreen. To exit fullscreen click the button again or the escape key on your keyboard.

  • Zoom to content (bounded magnifying glass symbol) automatically adjusts the zoom level and map center position to put the data on your map in focus.

  • Search (magnifying glass symbol) allows searching for and jumping to a location on the map.

  • The ruler button allows you to measure distances and areas on the map.

  • Right-click on the map to display the longitude and latitude of that location.

Basemaps

Basemap layers are represented by layer cards in the layer panel such as:

Along the top of the basemap card from left to right are:

  • The title of the selected basemap

  • An arrow symbol to collapse and expand the basemap card

In the middle of the basemap card is the list of available basemaps. The current basemap is highlighted.

Along the bottom of the basemap card is:

  • An eye symbol for toggling the visibility of the layer

  • A slider for modifying the layer transparency

Create a new map

  1. In the Apps menu of DHIS2, click Maps. The DHIS2 Maps app opens.

  2. Click the (+) Add layer button in the top left. You are presented with the layer selection dialog:

  3. Select a layer to add to the current map. Possible options are:

    In addition, several layers may be provided by Google Earth Engine and other external services. Various Google Earth Engine layer sources are available if the Google Earth Engine API key has been set up (see documentation).

    Note

    The Maps app administrator can:

    • Select the sources for Google Earth Engine layers available to other users via the Manage available layer sources button.
    • Add external layer sources in the Maintenance app.

    Here is the list of default sources for a Google Earth Engine layer (see complete list):

    • Population and Population age groups

    • Building footprints

    • Elevation

    • Precipitation (monthly)

    • Temperature (monthly)

    • Landcover

    The single default source for an external layer is:

    • Labels overlay

Manage thematic layers

Thematic maps represent spatial variation of geographic distributions. Select your desired combination of indicator/data element, period and organisation unit level. If your database has coordinates and aggregated data values for these organisation units, they will appear on the map.

Note

You must generate the DHIS2 analytics tables to have aggregated data values available.

Thematic layers are represented by layer cards in the layer panel such as:

Along the top of the thematic card from left to right are:

  • A grab field to allow dragging and re-ordering layers with the mouse

  • The title and period associated with the layer

  • An arrow symbol to collapse and expand the thematic card

In the middle of the thematic card is a legend indicating the value ranges displayed on the layer.

Along the bottom of the thematic card from left to right are:

  • An edit (pencil) button to open the layer configuration dialog

  • An eye symbol for toggling the visibility of the layer

  • A slider for modifying the layer transparency

  • A more actions (three dots) button with additional options:

    • A Show/hide data table toggle button to show or hide the data table associated with the layer

    • Open as chart will open this thematic data as a chart in the Data Visualizer app

    • Download data allows you to download the data for this layer in GeoJSON format for use in other mapping software

    • Edit layer is the same as edit button above

    • Remove layer will remove this layer from the current map.

Create a thematic layer

To create a thematic layer, choose Thematic on the Add layer selection. This opens the Thematic layer configuration dialog.

  1. In the Data tab:

    • Select a data item.

    • Select a value from the Aggregation type field for the data values to be shown on the map. By default, "By data element" is selected. Alternative values are: Count; Average; Sum; Standard deviation; Variance; Min; Max. See also Aggregation operators.

    • Only show completed events: Includes only completed events in the aggregation process. This is useful when you want to exclude partial events in indicator calculations. Available for indicators, program indictors and event data items.

  2. In the Period tab

    Select the time span over which the thematic data is mapped.

    • Period display mode - Select how the selected periods will be visualized on the map:

      • Single (default)

        Displays all selected periods as a single combined layer with aggregated data. (Required when only one period is selected or when using start–end dates.)

      • Timeline

        Displays multiple periods as an interactive timeline ordered chronologically. Multiple timeline layers can be added to a map (they will all share the same periods).

      • Split

        Displays multiple periods side by side for comparison. Supports up to 12 periods (including multi-period presets) and can only be combined with other split layers (they will all share the same periods).

    • After selecting a display mode, choose how to define the period(s):

      • Choose from presets - Available for all display modes. If you selected Single, you will also see Define start–end dates as an alternative. You can combine one or more relative and fixed periods.

        • Relative period

          Select Relative periods, then the Period type (Years, Months, etc.) and choose one or more relative periods, such as This year and Last year or Last 12 months.

          A default relative period for analysis can be set in the Systems Settings app.

        • Fixed period

          Select Fixed periods, then choose the Period type (Yearly, Monthly, etc.) and choose one or more fixed periods, such as 2024 or January 2025 and Febuary 2025.

      • Define start - end dates - Available only when the Single display mode is selected. Specify exact start and end dates. Both dates are inclusive and will be reflected in the outputs.

  3. In the Org Units tab:

    • Select the organisation units you want to include in the layer. It is possible to select either

      • One or more specific organisation units, organisation unit levels in the hierarchy, organisation unit groups, or

      • A relative level in the organisation unit hierarchy, with respect to the user. By selecting a User organisation unit the map data will appear differently for users at different levels in the organisation unit hierarchy.

    • Use associated geometry: This dropdown will only show if there are any additional geometry available for your organisation units. This is typically used to show facility catchment areas.

  4. In the Filter tab:

    • Click Add Filter and select an available data item to add a new filter to the data set.

      • Select a data dimension from the dropdown box. You can reduce the number of dimensions shown by using the search field. Click on the name to select a dimension.

      • When a dimension is selected you get a second dropdown with dimension items. Check the items you want to include in the filter.

      Multiple filters may be added. Click the trash button on the right of the filter to remove it.

  5. In the Style tab:

    • Select either Choropleth or Bubble map.

      • Choropleth will assign a color to each org unit shape according to the data value. This is the recommended technique if the data is normalised (per capita).

      • Bubble map will show data values as proportional circles. Use this technique if the data is not normalised (absolute numbers). The circles are placed in the center of each org unit.

    • Set the Low radius and High radius for the proportional circles or the point facilities. The circles will be scaled between low and high radius according to the data value. The radius needs to be between 0 and 50 px.

    • Show labels: Allows org unit names and values to be shown on the layer. Select between "Name", "Name and value" and "Value" only. Font size, weight, style and color can also be modified.

    • Show no data: By default org units with missing data values will not show on the map. Check this box if you want to show them with a color. Click the color to change it.

    • Select the legend type:

      • Automatic color legend: the application will create a legend for you based on what classification method, number of classes and the color scale you select. Set Classification to either:

        • Equal intervals

          the range of each interval will be (highest data value - lowest data value / number of classes)

        • Equal counts

          the legend creator will try to distribute the organisation units evenly.

      • Predefined color legend: Select between the predefined legends.

      • Single color legend: Select the color of the bubbles or circles. Only available for bubble maps.

  6. Click Add layer.

Modify a thematic layer

  1. In the layer panel, click the edit (pencil) icon on the thematic layer card.

  2. Modify the setting on any of the tabs as desired.

  3. Click Update layer.

Filter values in a thematic layer

Thematic layers have a Show/hide data table option that can be toggled on or off from the thematic layer card.

The data table displays the data forming the thematic layer.

  • clicking on a up/down arrow button will sort the table based on that column; toggling between ascending and descending.

  • entering text or expressions into the filter fields below the titles will apply those filters to the data, and the display will adjust according to the filter. The filters are applied as follows:

    • NAME

      filter by name containing the given text

    • VALUE

      filter values by given numbers and/or ranges, for example: 2,>3&\<8

    • LEGEND

      filter by legend containing the given text

    • RANGE

      filter by ranges containing the given text

    • LEVEL

      filter level by numbers and/or ranges, for example: 2,>3&\<8

    • PARENT

      filter by parent names containing the given text

    • ID

      filter by IDs containing the given text

    • TYPE

      filter by GIS display types containing the given text

    • COLOR

      filter by color names containing the given text

Note

Data table filters are temporary and are not saved with the map layers as part of the saved map.

Search for an organisation unit

The NAME filter field in the data table provides an effective way of searching for individual organisation units.

Open organisation unit profile

You can open the organisation unit profile in three ways:

  1. Click on any of the organisasjon units shown on the map, and click the View profile button in the popup.

  2. Right-click one of the organisation units on the map, and select View profile from the menu.

  3. Click on an organisation unit row in the data table.

When there are visible organisation units on the map, you can easily navigate up and down in the hierarchy without using the level/parent user interface.

  1. Right-click one of the organisation units.

  2. Select Drill up one level or Drill down one level.

    The drill down option is disabled if you are on the lowest level or if there are no coordinates available on the level below. Likewise the drill up option is disabled from the highest level.

Remove thematic layer

To clear all data in a thematic layer:

  1. In the layer card to the left, click the more actions (three dots) icon and then on Remove layer.

    The layer is removed from the current map.

Manage event layers

The event layer displays the geographical location of events registered in the DHIS2 tracker. Provided that events have associated point or polygon coordinates, you can use this layer to drill down from the aggregated data displayed in the thematic layers to the underlying individual events or cases.

You can also display aggregated events for facilities or organisation units. You do this through a thematic layer using event data items. This is useful when you only have the coordinates for the Org Unit under which the events are recorded.

Event layers are represented by layer cards in the layer panel such as:

Along the top of the event card from left to right are:

  • A grab field to allow dragging and re-ordering layers with the mouse

  • The title and period associated with the layer

  • An arrow symbol to collapse and expand the event card

In the middle of the event card is a legend indicating the styling of the layer.

Along the bottom of the event card from left to right are:

  • An edit (pencil) button to open the layer configuration dialog

  • An eye symbol for toggling the visibility of the layer

  • A slider for modifying the layer transparency

  • A more actions (three dots) button with additional options:

    • A Show/hide data table toggle button to show or hide the data table associated with the layer

    • Download data allows you to download the data for this layer in GeoJSON format for use in other mapping software

    • Edit layer is the same as edit button above

    • Remove layer will remove this layer from the current map.

Create an event layer

To create an event layer, choose Events on the Add layer selection. This opens the Events layer configuration dialog.

  1. In the Data tab:

    • Select a program and then select a program stage. The Stage field is only shown once a program is selected.

      If there is only one stage available for the selected program, the stage is automatically selected.

    • Select a value from the Coordinate field to determine which positions are displayed on the map. By default, "Event location" is selected. You can also choose "Organisation unit location". Depending on the selected program, additional options may include "Tracked entity location", "Enrollment location", and coordinate-type/organisation-unit-type data elements or attributes such as "Household location"/"Referral facility". The number of events represented on the map may vary depending on the selected option and the availability of coordinates. Organisation units are represented by their centroids.

    • By default all events with coordinates are shown on the map. Use the Event status field to only show events having one status: Active, Completed, Schedule, Overdue or Skipped.

  2. In the Period tab

    • Select the time span for when the events took place. You can select either a fixed period or a relative period.

      • Relative period

        In the Period field, select one of the relative periods, for example This month or Last year.

        A default relative period for analysis can be set in the Systems Settings app.

      • Fixed period

        In the Period field, select Start/end dates and fill in a start date and an end date.

  3. In the Org Units tab:

    • Select the organisation units you want to include in the layer. It is possible to select either

      • One or more specific organisation units, or

      • A relative level in the organisation unit hierarchy, with respect to the user. By selecting a User organisation unit the map data will appear differently for users at different levels in the organisation unit hierarchy.

  4. In the Filter tab:

    • Click ADD FILTER and select an available data item to add a new filter to the data set.

      • For data item of type option set, you can select any of the options from the dropdown box by using the down-wards arrow or by start typing directly in the box to filter for options.

      • For data item of type number, you can select operators like equal, not equal, greater than or less than.

      • For data item of type boolean (yes/no), you can check the box if the condition should be valid or true.

      • For data item of type text you will get two choices: Contains implies that the query will match all values which contains your search value, and Is exact implies that only values which is completely identical to your search query will be returned.

      Multiple filters may be added. Click the trash button on the right of the filter to remove it.

  5. In the Style tab:

    • Select Group events to group nearby events (cluster), or View all events to display events individually.

    • Select a color for the event or cluster points.

    • Select the radius (between 1 and 20) for the events.

    • Select Show buffer to display visual buffer around each event. The radius of the buffer can be modified here. This option is only available if you select View all events above.

    • Select a Style by data item (data element or attribute) to colorise the events according to a data value. If you also select to group events, the culsters will be displayed as small donut charts showing the distribution of the data values. The available options vary for different data types:

      • Option sets: Select a color for each option in an option set. You can set default colors for an option in the Maintenance app.

      • Numbers: You can style a numeric data item in the same way as thematic layers using automatic or predefined legends.

      • Booleans: Select a color for true/yes and another for false/no.

  6. Click Add layer.

Modify an event layer

  1. In the layer panel, click the edit (pencil) icon on the event layer card.

  2. Modify the setting on the DATA, PERIOD, FILTER, ORG UNIT and STYLE tabs as desired.

  3. Click Update layer.

Listing and filtering events

Event layers have a Show/hide data table option that can be toggled on or off from the event layer card.

The data table displays the data forming the event layer.

  • clicking on the up/down arrow will sort the table based on that column; toggling between ascending and descending.

  • entering text or expressions into the filter fields below the titles will apply those filters to the data, and the display will adjust according to the filter. The filters are applied as follows:

    • ID

      filter by event IDs containing the given text

    • ORG UNIT

      filter by org unit name containing the given text

    • EVENT TIME

      filter by event time containing the given text

    • TYPE

      filter by GIS display types containing the given text

    • Style by data item: If events are styled by a data element or attribute (e.g. gender) both the data value and the color can be filtered.

    • Display in reports: Data elements checked to display in reports will be shown in separate columns (see below how to add them).

    • Numeric data values can be filtered by given numbers, and/or ranges, for example: 2,>3&\<8

Note

Data table filters are temporary and are not saved with the map layers as part of the saved map.

Modify information in event data table and popups

If you have access to the selected program in the Maintenance app, you can modify the information displayed in the event pop-up window.

  1. Open the Maintenance app.

  2. Select Program.

  3. Click the program you want to modify and select (2) Assign data elements.

  4. For every data element you want to display in the pop-up window, select corresponding Display in reports.

  5. Click Save.

Download raw event layer data

The raw data for event layers can be downloaded in GeoJSON format for more advanced geo-analytics and processing in desktop GIS software such as QGIS. The downloaded data includes all individual events as GeoJSON features, including attributes for each data element selected for Display in reports.

  • In the layer card to the left, click the more actions (three dots) icon and then on Download data

  • Select the ID format to use as the key for Data Element values in the downloaded GeoJSON file. There are three options available:

    • ID - Use the unique ID of the data element
    • Name - Use the human-friendly name of the data element (translated)
    • Code - Use the code of the data element

  • Select whether or not to Use human-readable keys for other Event attributes, such as Program Stage, Latitude, Longitude, Event Data, and Organization Unit ID, Name, and Code. When this option is not selected these values will be the computer-friendly ID instead of the human-readable (and translated) name.

  • Click the Download button to generate and download a GeoJSON file. The data will be requested from the DHIS2 server and processed by the maps application. This operation may take several minutes to complete.

  • Once the GeoJSON file has been downloaded it can be imported into most standard GIS software applications.

Note that the downloaded data does not include style information as it is not natively supported by the GeoJSON format. Styles can optionally be recreated in external GIS applications using the attributes of each feature.

Clear event layer

To clear all event layer data in a map:

  1. In the layer card to the left, click the more actions (three dots) icon and then on Remove layer.

    The layer is removed from the current map.

Manage tracked entity layers

The tracked entity layer displays the geographical location of tracked entities registered in the DHIS2. Provided that tracked entities have associated point or polygon coordinates, you can explore these on a map.

Tracked entity layers are represented by layer cards in the layer panel such as:

Along the top of the tracked entity card from left to right are:

  • A grab field to allow dragging and re-ordering layers with the mouse.

  • The title and period associated with the layer.

  • An arrow symbol to collapse and expand the tracked entity card.

In the middle of the tracked entity card is a legend indicating the styling of the layer.

Along the bottom of the tracked entity card from left to right are:

  • An edit (pencil) button to open the layer configuration dialog

  • An eye symbol for toggling the visibility of the layer

  • A slider for modifying the layer transparency

  • A more actions (three dots) button with additional options:

    • Edit layer is the same as edit button above

    • Remove layer will remove this layer from the current map.

Create a tracked entity layer

To create an tracked entity layer, choose Tracked entities on the Add layer selection. This opens the Tracked entity layer configuration dialog.

  1. In the Data tab:

    • Select the Tracked Entity Type you want to show on the map.

    • Select a Program where the tracked entities belong.

    • Use the Program status field to select the enrollment status of tracked entities to include: All, Active, Completed or Cancelled.

    • Set the Follow up status of the tracked entity for the given program.

  2. In the Relationships tab

    Caution

    Displaying tracked entity relationships in Maps is an experimental feature

    • If a Tracked Entity Type with relationships has been selected, you can select the Display Tracked Entity relationships checkbox

    • Once checked, you can select the type of relationship to display on the map from the dropdown list. Only relationships from the selected Tracked Entity type are available.

  3. In the Period tab

    • If no program is selected, you can set start and end dates when the tracked entities were last updated.

    • If a program is selected, you can set the period when tracked entities were last updated or when they were registered or enrolled in the program.

  4. In the Org Units tab:

    • Select the organisation units you want to include in the layer. You have 3 selection modes:

      • Selected only: Include tracked entities belonging to selected org units only.

      • Selected and below: Included tracked entities in and right below selected org units.

      • Selected and all below: Included tracked entities in and all below selected org units.

  5. In the Style tab:

    • Select a color for the tracked entities points and polygons.

    • Select the point size (radius between 1 and 20) for the points.

    • Select Show buffer to display visual buffer around each tracked entity. The buffer distance in meters can be modified here.

    • If a relationship type has been selected on the relationships tab you can select color, point size, and line color for relationships and related tracked entities instances

  6. Click Add/Update layer.

Modify a tracked entity layer

  1. In the layer panel, click the edit (pencil) icon on the tracked entity layer card.

  2. Modify the setting on the DATA, PERIOD, ORG UNIT and STYLE tabs as desired.

  3. Click Update layer.

Modify information in tracked entity popups

If you have access to the selected program in the Maintenance app, you can modify the information displayed in the tracked entity pop-up window.

  1. Open the Maintenance app.

  2. Select Program.

  3. Click the program you want to modify and select (3) Attributes.

  4. For every attribute you want to display in the pop-up window, select corresponding Display in list.

  5. Click Save.

Clear a tracked entity layer

To clear a tracked entity layer from a map:

  1. In the layer card to the left, click the more actions (three dots) icon and then on Remove layer.

    The layer is removed from the current map.

Manage facility layers

The facility layer displays icons that represent types of facilities. Polygons do not show up on the map, so make sure that you select an organisation unit level that has facilities.

A polygon is an enclosed area on a map representing a country, a district or a park.

Facility layers are represented by layer cards in the layer panel such as:

Along the top of the facilities card from left to right are:

  • A grab field to allow dragging and re-ordering layers with the mouse

  • The Facilities title

  • An eye symbol for toggling the visibility of the layer

  • An arrow symbol to collapse and expand the facilities card

In the middle of the facilities card is a legend indicating the group set representation.

Along the bottom of the facilities card from left to right are:

  • An edit (pencil) button to open the layer configuration dialog

  • A slider for modifying the layer transparency

  • A more actions (three dots) button with additional options:

    • A Show/hide data table toggle button to show or hide the data table associated with the layer

    • Download data allows you to download the data for this layer in GeoJSON format for use in other mapping software

    • Edit layer is the same as edit button above

    • Remove layer will remove this layer from the current map.

Create a facility layer

To create facility layer, choose Facilities on the **Add layer**selection. This opens the Facility layer configuration dialog.

  1. In the Organisation Units tab

    • Select the organisation unit level(s) and/or group(s) from the selection fields on the right hand side.

    • Select the organisation units you want to include in the layer. It is possible to select either

      • One or more specific organisation units, or

      • A relative level in the organisation unit hierarchy, with respect to the user. By selecting a User organisation unit the map data will appear differently for users at different levels in the organisation unit hierarchy.

    • The system administrator can set the default organsation unit level containing facilities in the System Settings app.

    • Use associated geometry: This dropdown will only show if there are any additional geometry available for your organisation units. This is typically used to show facility catchment areas.

  2. In the Style tab:

    • Select any styling you wish to apply to the facilities.

      • Show labels

        Allows labels to be shown on the layer. Font size, weight and color can be modified here.

      • Show buffer

        Allows a visual buffer to be displayed on the layer around each facility. The radius of the buffer can be modified here. Buffer option is not available if asscoiated geometry is used.

    • Facilities can be styled an organisation unit group set using different icons. Select a group set from the list of organisation unit group sets defined for your DHIS2 instance. The system administrator can set the default organsation unit group set in the System Settings app.

    • If no group set is selected, the facilities will be shown as filled circles. The color and the circle radius can be changed.

  3. Click Add layer.

Create or modify a facility layer

  1. In the layer panel, click the edit (pencil) icon on the facility layer card.

  2. Modify the setting on the GROUP SET, ORGANISATION UNITS and STYLE tabs as desired.

  3. Click Update layer.

Filter values in a facility layer

Facility layers have a Show/hide data table option that can be toggled on or off from the facility layer card.

The data table displays the data forming the facility layer.

  • clicking on the up/down arrow will sort the table based on that column; toggling between ascending and descending.

  • entering text or expressions into the filter fields below the titles will apply those filters to the data, and the display will adjust according to the filter. The filters are applied as follows:

    • NAME

      filter by name containing the given text

    • ID

      filter by IDs containing the given text

    • TYPE

      filter by GIS display types containing the given text

Note

Data table filters are temporary and are not saved with the map layers as part of the saved map.

Search for a facility

The NAME filter field in the data table provides an effective way of searching for individual facilities.

Open organisation unit profile

You can open the organisation unit profile in three ways:

  1. Click on any of the organisasjon units shown on the map, and click the View profile button in the popup.

  2. Right-click one of the organisation units on the map, and select View profile from the menu.

  3. Click on an organisation unit row in the data table.

Remove facility layer

To clear all data in a facility layer:

  1. In the layer card to the left, click the more actions (three dots) icon and then on Remove layer.

    The layer is removed from the current map.

Manage org unit layers

The org unit layer displays the borders and locations of your organisation units. This layer is particularly useful if you are offline and don't have access to background maps.

Org unit layers are represented by layer cards in the layer panel such as:

Along the top of the org unit card from left to right are:

  • A grab field to allow dragging and re-ordering layers with the mouse

  • The Organisation unit title

  • An arrow symbol to collapse and expand the org unit card

Along the bottom of the org unit card from left to right are:

  • An edit (pencil) button to open the layer configuration dialog

  • An eye symbol for toggling the visibility of the layer

  • A slider for modifying the layer transparency

  • A more actions (three dots) button with additional options:

    • A Show/hide data table toggle button to show or hide the data table associated with the layer

    • Download data allows you to download the data for this layer in GeoJSON format for use in other mapping software

    • Edit layer is the same as edit button above

    • Remove layer will remove this layer from the current map.

Create an org unit layer

To create an org unit layer, choose Org units on the Add layer selection. This opens the org unit layer configuration dialog.

  1. In the ORGANISATION UNITS tab

    • select the organisation unit level(s) and/or group(s) from the selection fields on the right hand side.

    • Select the organisation units you want to include in the layer. It is possible to select either

      • One or more specific organisation units, or

      • A relative level in the organisation unit hierarchy, with respect to the user. By selecting a User organisation unit the map data will appear differently for users at different levels in the organisation unit hierarchy.

    • Use associated geometry: This dropdown will only show if there are any additional geometry available for your organisation units. This is typically used to show facility catchment areas.

  2. In the Style tab:

    • select any styling you wish to apply to the org unitss.

      • Labels

        Allows labels to be shown on the layer. Font style can be modified here.

      • Boundary color

        Allows the boundary or outline color of the organisation units to be changed.

      • Point radius

        Sets the base radius when point type elements, such as facilities, are presented on the org unit layer.

    • Organisation units can be styled an organisation unit group set using different colors. Select a group set from the list of organisation unit group sets defined for your DHIS2 instance.

  3. Click Add layer.

Modify an org unit layer

  1. In the layer panel, click the edit (pencil) icon on the org unit layer card.

  2. Modify the setting on the ORGANISATION UNITS and STYLE tabs as desired.

  3. Click Update layer.

Filter values in an org unit layer

Org unit layers have a Show/hide data table option that can be toggled on or off from the org unit layer card.

The data table displays the data forming the org unit layer.

  • clicking on a title will sort the table based on that column; toggling between ascending and descending.

  • entering text or expressions into the filter fields below the titles will apply those filters to the data, and the display will adjust according to the filter. The filters are applied as follows:

    • NAME

      filter by name containing the given text

    • LEVEL

      filter level by numbers and/or ranges, for example: 2,>3&\<8

    • PARENT

      filter by parent names containing the given text

    • ID

      filter by IDs containing the given text

    • TYPE

      filter by GIS display types containing the given text

Note

Data table filters are temporary and are not saved with the map layers as part of the saved map.

Search for an organisational unit

The NAME filter field in the data table provides an effective way of searching for individual organisational units displayed in the org unit layer.

Open organisation unit profile

You can open the organisation unit profile in three ways:

  1. Click on any of the organisasjon units shown on the map, and click the View profile button in the popup.

  2. Right-click one of the organisation units on the map, and select View profile from the menu.

  3. Click on an organisation unit row in the data table.

You can modify the target of the org unit layer in the hierarchy without using the level/parent user interface.

  1. Right-click one of the organisation units.

  2. Select Drill up one level or Drill down one level.

    The drill down option is disabled if you are on the lowest level. Likewise the drill up option is disabled from the highest level.

Remove org unit layer

To clear all data in an org unit layer:

  1. In the layer card to the left, click the more actions (three dots) icon and then on Remove layer.

    The layer is removed from the current map.

Manage Earth Engine layer

Google Earth Engine layers are enabled if a Google Earth Engine API key has been configured for your system. Contact your system administrator if you need access to these layers.

The layers from Google Earth Engine let you display and aggregate external data to your organisation units. Aggregated values can be viewed either in popups or in the data table.

Note

The Maps app administrator can configure available layer sources.

The following layer sources are supported (sources marked with an asterisk "*" are available by default):

  • Population (group): Detailed population data from WorldPop. Estimates are provided annually and include current, historical, and projected population values. Available between 2015 and 2030.

    • Population *: Total population count.
    • Population age groups *: Population broken down by age and gender.

  • Building footprints *: The outlines of buildings derived from high-resolution satellite imagery. Only for sub-Saharan Africa, South and Southeast Asia, Latin America and the Caribbean.

  • Elevation *: Elevation above sea level.

  • Heat stress (group): Universal Thermal Climate Index (UTCI), a measure of the thermal stress experienced by a person in a given environment. Available from 1950.

    • Heat stress daily.
    • Heat stress weekly (derived from daily dataset).
    • Heat stress monthly (derived from daily dataset).

  • Humidity (group): Relative humidity is the the amount of water vapour present in air. Available from 1950.

    • Humidity daily.
    • Humidity weekly (derived from daily dataset).
    • Humidity monthly.

  • Precipitation (group): Accumulated water that falls to the surface. Combines model data with observations from across the world. Two sources are available:

    • ERA5-Land. Available from 1950.
      • Precipitation daily.
      • Precipitation weekly (derived from daily dataset).
      • Precipitation monthly *.
    • CHIRPS. Available from 1981.
      • Precipitation daily.
      • Precipitation weekly (derived from daily dataset).
      • Precipitation monthly (derived from daily dataset).

  • Temperature (group): Temperature at 2m above the surface. Combines model data with observations from across the world. Available from 1950.

    • Temperature daily.
    • Temperature weekly (derived from daily dataset).
    • Temperature monthly *.

  • Land cover *: 17 distinct landcover types collected from satellites by NASA. Available yearly, between 2001 and 2022.

  • Vegetation: Normalized difference vegetation index (NDVI) and Enhanced Vegetation Index (EVI), used to quantify vegetation greenness. Collected from satellites by NASA. Available at 16-day intervals, from 2000.

    • Vegetation 16-day
    • Vegetation weekly (derived from 16-day dataset).
    • Vegetation monthly (derived from 16-day dataset).

Create an Earth Engine layer

To create an Earth Engine layer, choose the desired layer from the Add layer selection. This opens the layer configuration dialog.

  1. In the Data tab:

    • Select dataset (if within a data group):

      • For Population you can select either the Population or the Population age group dataset.

    • Select data subset:

      • For Population age groups you can select the age/gender groups you would like to include when aggregating the data.
      • For Temperature or Heat stress you can select the temporal aggregation method you want to use (Mean, Min, Max).
      • For Vegetation you can select the index you want to use (NDVI or EVI).

    • Select the spatial aggregation methods you would like to use when calculating values for the selected organisation units, this will only affect results in popups and data table (some options might not be available depending on the layer source).

      • Sum: Calculates the total number within each organisation unit. Recommended to use for the population layers.

      • Min: Returns the minimum value in the layer unit displayed below the selection. For population layers it will be the minimum people per hectare. For elevation layer it will return the lowest elevation (meters above sea level).

      • Max: Returns the maximum value in the layer unit. For population layers it will be the minimum people per hectare. For elevation layer it will return the highest elevation for each organisation unit.

      • Mean: Returns the mean value in the layer unit. For population
        layers it will be the mean people per hectare. For precipitation layer it will be the mean rainfall in millimeters across the organisation unit.

      • Median: Returns the median value in the layer unit. For population layers it will be the median people per hectare. For temperature layer it will be the median °C across the organisation unit.

      • Standard deviation: Returns the standard deviation value in the layer unit.

      • Variance: Returns the variance value in the layer unit.

      • Special cases:

        • For "building footprints": Count: Returns the number of buildings within each organisation unit. Note that building counts are only available for smaller organisation unit areas.
        • For "landcover": Percentage, Hectare, Acres: Return the area covered by each landcover category within each organisation in different units.

  2. In the Period tab

    • Select dataset (if within a period group): Select the period type if you have multiple sources enabled for Heat stress, Precipitation, Temperature or Vegetation.

    • Select the period for the data source. The available periods are set by layer source. Some sources are only available at a single point in time.

  3. In the Organisation Units tab:

    • Select the organisation units you where you want to see aggregated data values. It is possible to select either

      • One or more specific organisation units, organisation unit levels in the hierarchy, organisation unit groups, or

      • A relative level in the organisation unit hierarchy, with respect to the user. By selecting a User organisation unit the map data will appear differently for users at different levels in the organisation unit hierarchy.

    • Use associated geometry: This dropdown will only show if there are any additional geometry available for your organisation units. This is typically used to calculate values for facility catchment areas.

  4. In the Style tab

    • Modify the parameters specific to the layer type.

    • Adjust the legend range, steps and colors, as desired.

    • If you select organisation units having a single point coordinate (facilities) you can set a radius buffer to calculate the data value within. A radius of 5000 meters will aggregate all values available within a 5 km distance from a facility. Buffer option is not available if associated geometry is used.

  5. Click Add layer.

Click on the map regions or facilities to see the aggregation result for that organisation unit.

Listing of data values

Earth Engine layers have a Show/hide data table option that can be toggled on or off from the layer card.

The data table displays all the aggregated values for the organisation units selected.

  • Clicking on the up/down button will sort the table based on that column; toggling between ascending and descending.

  • Entering text or expressions into the filter fields below the titles will apply those filters to the data, and the display will adjust according to the filter. The filters are applied as follows:

    • NAME

      filter by name containing the given text

    • ID

      filter by IDs containing the given text

    • TYPE

      filter by GIS display types containing the given text

    • AGGREGATION VALUES ("Sum" and "Mean" in the example above)

      there is one column for each of the aggregation types selected numeric data values can be filtered by given numbers, and/or ranges, for example: 2,>3&\<8

Note

Data table filters are temporary and are not saved with the map layers.

Add external map layers

External map layers are represented as either basemaps or overlays.

Note

The Maps app administrator can add external map layers.

  • Basemaps

    These are available in the basemap card in the layers panel and are selected as any other basemap.

  • Overlays

    These are available in the Add layer selection. Unlike basemaps, overlays can be placed above or below any other overlay layers.

Overlay layers are represented by additional layer cards in the layer panel such as:

Along the top of the overlay card from left to right are:

  • A grab field to allow dragging and re-ordering layers with the mouse

  • The title of the external map layer

  • An arrow symbol to collapse and expand the overlay card

In the middle of the card is a legend if the layer has one.

Along the bottom of the overlay card from left to right are:

  • A slider for modifying the layer transparency

  • A delete (trash can) icon to remove the layer from the current thematic map.

GeoJSON external layers

If you add a GeoJSON external layer to your map, you will have a few style choices:

Once the GeoJSON layer has been displayed, you can view the data table

As with other layers, you can sort and filter the data. If you want to view the data for one row, click on the row to open the Feature Profile:

Organisation unit profile

The organisation unit profile shows detailed information about each organisation unit. You can open the profile from org unit, facility and thematic layers.

You can open the organisation unit profile in three ways:

  1. Click on any of the organisasjon units shown on the map, and click the View profile button in the popup.

  2. Right-click one of the organisation units on the map, and select View profile from the menu.

  3. Click on an organisation unit row in the data table.

The profile will show on the right side of the map. The profile contents is set by the system administrator.

File menu

Use the File menu to manage your maps. Several menu items will be disabled until you open or save a map.

Saving your maps makes it easy to restore them later. It also gives you the opportunity to share them with other users as an interpretation or put it on the dashboard. You can save all types of layer configurations as a saved map.

Create a new map

Click File > New.

NB! This will clear the current map layers you have without saving.

Open a new map

  1. Click File > Open. A dialog box opens with a list of maps.

  2. Find the saved map you want to open. You can either use \< and > or the search field to find a saved map. The list is filtered on every character that you enter. You can filter the list by selecting Show all, Created by me or Created by others.

  3. Click the name of the map you want to open.

Save a map

When you have created a map it is convenient to save it for later use:

  1. Click File > Save.

  2. Enter a Name (required) and a Description (optional) the first time you save a map.

  3. Click Save.

Save a copy of a map

  1. Click File > Save as...

  2. Enter a Name (required) and a Description (optional) for the map.

  3. Click Save.

Rename a map

  1. Click File > Rename.

  2. Enter a new Name and/or Description for your map.

  3. Click Rename. The map is updated.

Translate a map

  1. Click File > Translate.

  2. Select the Locale (language) your translation.

  3. Enter a translated Name and Description. The original text will show below the field.

  4. Click Save.

Modify sharing settings for a map

After you have created a map and saved it, you can share the map with everyone or a user group. To modify the sharing settings:

  1. Click File > Share. The sharing settings dialog opens.

  2. Give access to a user or group: In the text box, search for the name of the user or group you want to share your saved map with and select it.

    Select the access level and click on Give access.

    Repeat the step to add more users or groups.

  3. Users and groups that currently have access: For each user or group, choose the access level. The options are:

    • No access: The public won't have access to the map. This setting is only applicable to All users.

    • View only

    • View and edit

    • Remove access: Remove the access for groups or individuals.

  4. Click Close to close the dialog.

  1. Click File > Get link. A link dialog opens.

  2. Copy the link.

Delete a map

  1. Click File > Delete. A confirmation dialog is displayed.

  2. Click DELETE to confirm that you want to delete the saved map. Your map is deleted and the layers are cleared from the view.

Map interpretations and details

An interpretation is a description of a map at a given period. This information is also visible in the Dashboard app. Click Interpretations and details in the top right of the workspace to open the interpretations panel. The button is only clickable if the map is saved.

View interpretations based on relative periods

To view interpretations for relative periods, such as a year ago:

  1. Open a saved map with interpretations.

  2. Click Interpretations and details in the top right of the workspace to open the interpretations panel.

  3. Click on See interpretation. Your map displays the data and the date based on when the interpretation was created. To view other interpretations, click them.

Write interpretation for a map

To create an interpretation, you first need to create a map and save it. If you've shared your map with other people, the interpretation you write is visible to those people.

  1. Open a saved map.

  2. Click Interpretations and details in the top right of the workspace to open the interpretations panel.

  3. A text field will appear with a placeholder "Write an interpretation" for users that have read access to the saved map.

  4. In the text field, type a comment, question or interpretation. You can also mention other users with '@username'. Start by typing '@' plus the first letters of the username or real name and a mentioning bar will display the available users. Mentioned users will receive an internal DHIS2 message with the interpretation or comment. You can see the interpretation in the Dashboard app.

  5. Click Post interpretation to save the interpretation.

Change sharing settings for an interpretation

  1. Click an interpretation (see how to view an interpretation above).

  2. Click the share icon below the interpretation. The sharing settings dialog opens.

  3. Search for and add a users and user groups that you want to share your map with, and set the access level. Click on Give access.

  4. Change the access level for the users you want to modify:

    • View and edit: Everyone can view and edit the object.

    • View only: Everyone can view the object.

    • No access: The public won't have access to the object. This setting is only applicable to All users.

    • Remove access: Remove the access for groups or individuals.

  5. Click Close when sharing settings are updated.

Save a map as an image

You can download your map as an image by clicking on the Download button in the top menu

You will enter a "download mode" where you can adjust the map layout before you download the image. The left column gives you the following options:

  • Show map name: Select if you want to include the map name or not. This option is only available if the map is saved. To change the name, exit download mode and select File > Rename.
  • Show map description: Select if you want to include the map description or not. This option is only available if a map description was added when the map was saved. To change the map description, exit download mode and select File > Rename.
  • Show legend: Select if you want to include the map legend. If the map includes more than one layer, you can select the visibility for each legend.
  • Show overview map: Select if you want to include an overview map (often named inset map). This option will be disabled if there is not enough room for it in the right column.
  • Show north arrow: Select to include a north arrow on the map. The default position is the lower right corner of the map, but you can change it to another corner.
  • Click Download to download your map.

Resize your browser window to change the map dimensions. You can also reposition both the main map and the overview map.

Map download is not supported in Internet Explorer or Safari. We recommend using Google Chrome or Firefox.

The place search function allows you to search for almost any location or address. This function is useful in order to locate for example sites, facilities, villages or towns on the map.

  1. On the right side of the Maps window, click the magnifier icon.

  2. Type the location you're looking.

    A list of matching locations appear as you type.

  3. From the list, select a location. A pin indicates the location on the map.

Measure distances and areas in a map

  1. In the upper left part of the map, put the cursor on the Measure distances and areas (ruler) icon and click Create new measurement.

  2. Add points to the map.

  3. Click Finish measurement.

Get the latitude and longitude at any location

Right-click a point on the map and select Show longitude/latitude. The values display in a pop-up window.

Maps app administrator

A Maps app administrator can be defined by the system administrator assigning the F_EXTERNAL_MAP_LAYER_PUBLIC_ADD authority.

The Maps app administrator is able to:

  • Select the sources for Google Earth Engine layers available to other users via the Manage available layer sources button.

  • Add new external layer sources via the Maintenance app.

See also