dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #22183
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 727: Update data element section.
------------------------------------------------------------
revno: 727
committer: Jason P. Pickering <jason.p.pickering@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Sat 2013-04-20 11:33:11 +0545
message:
Update data element section.
modified:
src/docbkx/en/dhis2_user_man_data_elements.xml
src/docbkx/en/resources/images/maintainence/data_element_categories_add_new.png
src/docbkx/en/resources/images/maintainence/data_element_categories_start.png
src/docbkx/en/resources/images/maintainence/data_element_edit.png
--
lp:~dhis2-documenters/dhis2/dhis2-docbook-docs
https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs
Your team DHIS 2 developers is subscribed to branch lp:~dhis2-documenters/dhis2/dhis2-docbook-docs.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs/+edit-subscription
=== modified file 'src/docbkx/en/dhis2_user_man_data_elements.xml'
--- src/docbkx/en/dhis2_user_man_data_elements.xml 2012-02-27 19:26:53 +0000
+++ src/docbkx/en/dhis2_user_man_data_elements.xml 2013-04-20 05:48:11 +0000
@@ -1,284 +1,299 @@
-<?xml version='1.0' encoding='UTF-8'?>
-<!-- This document was created with Syntext Serna Free. --><!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>
-<chapter>
- <title>Data elements</title>
- <para>When the ‘Data Elements and Indicators’ options is chosen from the main Maintenance menu, the following screen appears:</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/maintainence/data_element_main.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>From the left side menu or by clicking on the sections listed in the central area you can access the various sections on data elements;</para>
- <para>Data Element, Data Element Group, Data Element Group Editor, Data Element Group Set, Data Element Category, Data Element Category Combination. </para>
- <section>
- <title>Data element maintenance</title>
- <para>Each of the options for maintenance of data elements will be described in the following section.</para>
- <itemizedlist>
- <listitem>
- <para>Data element</para>
- <para>Create, modify, view and delete data elements. </para>
- </listitem>
- <listitem>
- <para>Data element group</para>
- <para>Create, modify, view and delete data element groups. </para>
- </listitem>
- <listitem>
- <para>Data element group editor</para>
- <para>Easily add or remove data elements to and from data element groups. </para>
- </listitem>
- <listitem>
- <para>Data element group set editor</para>
- <para>Create, modify, view and delete data elements group sets. </para>
- </listitem>
- <listitem>
- <para>Data element categories</para>
- <para>Create, modify, view and delete data element categories. </para>
- </listitem>
- </itemizedlist>
- <section id="dataElement">
- <title>Data elements</title>
- <para><?inline true?>Data elements form the basis of DHIS2. Data elements define what is actually recorded in system, e.g. number of immunisations or number of cases of malaria. The actual creation and definition of the data elements themselves are far beyond the scope of this manual to describe, but it is assumed that an administrator will be provided with a list of standardised data elements for inclusion into the DHIS2 system. </para>
- <para>To access the data element maintenance module, choose Maintenance -> Data elements and Indicators -> Data element. </para>
- <para>The ‘Filter by name’ will allow you to filter a range of data elements if you know either the full name of the data element, or just a part of it. Type the name
- into the search field and any matching data elements are displayed below.
- You can also choose ‘Filter by group/view all’ to narrow down a data
- element search within a particular data element group. In default mode, this
- field will display all the data elements in the application.
- The ‘Get PDF’ button can be clicked to generate a .pdf file of all the data
- elements. The 'Sort' button can be used to sort the data elements into alphabetical order. </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/maintainence/data_element_main2.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>To add a new data element, click the 'Add new' button. There are various options available from this page that allow the user to modify data elements already present in the database. Each of the options are described below in the "Editing data elements". </para>
- <section>
- <title>Editing data elements</title>
- <para>Click the "Edit"<inlinegraphic fileref="resources/images/dhis2_images/edit.png" align="center"/> button to modify the properties of a data element that has been previously defined. </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/maintainence/data_element_edit.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <itemizedlist>
- <listitem>
- <para>Name: Define the precise name of the data element in this field. Each data element must have a unique name. </para>
- </listitem>
- <listitem>
- <para>Short name: Typically, an abbreviation of the full data element name. This attribute is often used in reports to display the name of the data element, where there is limited space available. </para>
- </listitem>
- <listitem>
- <para>Alternative name: Allows the definition of an alternative name of the data element. </para>
- </listitem>
- <listitem>
- <para>Code: In many countries, data elements are assigned a code. This code can be entered in this field. </para>
- </listitem>
- <listitem>
- <para>Description: Allows a full textual description of the data element to be entered. The user should be as precise as possible, and include full information on how the data element is measured and what its meaning is. </para>
- </listitem>
- <listitem>
- <para>Active: Defines whether a given data element is active or not. Data elements marked as inactive, will not be displayed in the data entry screens. </para>
- </listitem>
- <listitem>
- <para>Domain type: Defines whether a data element is an aggregate or patient type of data element. </para>
- </listitem>
- <listitem>
- <para>Value type: Defines the type of data this data element will be used to record. Currently there are four options: number, text, yes/no (boolean), and date. </para>
- </listitem>
- <listitem>
- <para>Number type: In order to increase the robustness of data entry, DHIS2 supports several different number types. During data entry, users will be restricted to enter the defined number types only. Each of the available options are described below. </para>
- <orderedlist>
- <listitem>
- <para>Number: This number type supports any real value with a single decimal point, an optional negative sign, and no thousands separators. </para>
- </listitem>
- <listitem>
- <para>Integer: Any whole number (positive and negative), including zero.</para>
- </listitem>
- <listitem>
- <para>Positive integer: Any whole number greater than (but not including) zero.</para>
- </listitem>
- <listitem>
- <para>Negative integer: Any whole number less than (but not including) zero.</para>
- </listitem>
- </orderedlist>
- </listitem>
- <listitem>
- <para>Aggregation operator: Defines the default aggregation operation that will be used on this data element. Most data elements should have the "SUM" option set. This includes all data elements which should be added together. Other data elements, such as staffing levels, should be set to use the "AVERAGE" operator, when values along the time dimension should not be added together, but rather averaged.</para>
- </listitem>
- <listitem>
- <para>URL: A URL having an in-depth description of the data element can be entered in the ‘URL’ field. This could be for instance, a link to a metadata repository or registry that contains detailed technical information about the definition and measurement of the data element. </para>
- </listitem>
- <listitem>
- <para>Combination of categories: Defines which category combination the data element should have. </para>
- </listitem>
- <listitem>
- <para>Data element group sets: Click the check box to activate this option hen choose which data element group sets this data element should belong to. Available data element group sets are displayed din the upper window. Click the desired data element group set, then the <guibutton>"Add selected"</guibutton> button to add the data element to the group set. To remove a data element from a group set, click the data element group set in the lower list, and then click<guibutton> "Remove selected"</guibutton>. </para>
- </listitem>
- <listitem>
- <para>Calculated: This option is available only when a data element is created.</para>
- <note>
- <para>As of version 2.3, calculated data elements have been deprecated. Calculated data elements should therefore be implemented as indicators instead.</para>
- </note>
- <para>Select the data elements that will be used to define the calculated data element, and then click "Add selected" to add them calculated data element composition list. Fill in the correct factor for the data element calculation component (defaults to 1). Component elements of the calculated data element can be removed from the definition by pressing the "Remove" button.</para>
- </listitem>
- <listitem>
- <para>Aggregation levels: The Aggregation Levels option allows the data element to be aggregated at one or more levels. When the user clicks on the Aggregation levels option, a drop down menu appears which displays available aggregation levels. The desired aggregation level is then selected by clicking the ‘Add Selected’ button. By default, the aggregation will start at the lowest assigned organisation unit. If e.g. Chiefdom is selected below it means that Chiefdom, District, and National aggregates will use Chiefdom (the highest aggregation level available) as the data source, and PHU data will not be included. PHU data will still be available for the PHU level, but not included in aggregations to the levels above. If District and Chiefdom are both selected then the District and National level aggregates will use District data as their source, Chiefdom will use Chiefdom, and PHU will use PHU. Read more about aggregation levels in the Reporting chapter i the section on data sources for reporting.</para>
- </listitem>
- </itemizedlist>
- <para>After making the required changes, click ‘Save’ to institute them. The ‘Cancel’ button aborts all changes made.</para>
- </section>
- <section>
- <title>Data element translation</title>
- <para>DHIS2 provides functionality to translate existing data elements into other languages. Simply press the translate button <inlinegraphic fileref="resources/images/dhis2_images/i18n.png" align="center"/> to get started. The following dialogue will appear. </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/maintainence/data_element_translate.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>The reference language is displayed in the upper right portion of the dialogue. Choose a locale to translate the data element into by selecting an option from the locale drop-down menu. Specify the name, short-name and description in the target language. Press "Save" to save your changes. </para>
- <para>The "Details" section of this dialogue will allow you add a new locale if it is not already present in the database. There are two options:</para>
- <itemizedlist>
- <listitem>
- <para>Language code</para>
- <para>Refers to the ISO 639-1 (two-letter code) language code. Refer to this <ulink url="http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes";>web page</ulink> for a detailed listing of language codes. </para>
- </listitem>
- <listitem>
- <para>Country code</para>
- <para>Refers to the ISO 3166-1-alpha-2 code. A complete listing is available <ulink url="http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm";>here</ulink>. </para>
- </listitem>
- </itemizedlist>
- <para>The combination of these two codes together, forms a "locale" code, which is composed of the combination of the location and language. A very comprehensive discussion of the technical standard (RFC 3066) is available <ulink url="http://www.ietf.org/rfc/rfc3066.txt";>here</ulink>. This <ulink url="http://www.i18nguy.com/unicode/language-identifiers.html";>page</ulink> provides a very comprehensive list of recognised locale codes. </para>
- </section>
- <section>
- <title>Deleting a data element</title>
- <para>Simply press the delete button <inlinegraphic fileref="resources/images/dhis2_images/delete.png" align="center"/> to delete a data element. Note that this operation is only possible if there is no data attached to the data element itself. The user will be prompted to ensure that the data element should be deleted.</para>
- </section>
- <section>
- <title>Displaying data element details</title>
- <para>This operation displays an in-line panel in the browser which displays all metadata about a given data element. Press the information button <inlinegraphic fileref="resources/images/dhis2_images/information.png" align="center"/>to access this view. </para>
- </section>
- </section>
- <section id="dataElementGroup">
- <title>Data element groups</title>
- <para>Data element groups provide a mechanism for classifying related data elements into a common theme. For instance, two data elements "Measles immunisation" and "BCG Immunisation" might be grouped together into a data element group "Childhood immunisation". To access the data element group maintenance page, click Maintenance -> Data elements and Indicators -> Data Element Group.</para>
- <para>Similar to the "Data element" maintenance page, data elements groups can be searched with by entering a search string in the "Filter by name" field. </para>
- <para>To add a new data element group, click the <guibutton>"Add new"</guibutton> button and the following screen will be displayed:</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/maintainence/data_element_group_add.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Fill in the "Name" field and then select all data elements that should belong to the group from the left panel. Click the "Move selected" <inlinegraphic fileref="resources/images/dhis2_images/move_right.png" align="center"/>button to add the selected data elements to the data element group. Click the "Remove selected" button to remove all data elements from the group that have been selected in the right panel. Finally, click the "Add" button to save changes, or the "Cancel" button to discard any changes. </para>
- </section>
- <section id="dataElementGroupEditor">
- <title>Data element group editor</title>
- <para>The data element group editor provides advanced functionality to the administrator to allow multiple data elements to be added or removed from a group. It is also possible to create new data element groups, rename existing groups, and delete groups entirely. To access the data element group editor, go to <guimenu>"Maintenance -> Data elements and Indicators -> Data Element Group Editor"</guimenu>. The following screen will appear.<screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/maintainence/data_element_group_editor_start.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot></para>
- <para>Data element groups area listed alphabetically in the leftmost panel. By clicking on a data element group, the current members of that group (data elements) are listed in the centre panel. Available data elements that can be added to the data element group appear are listed alphabetically in the rightmost panel. To remove an existing data element from the group, click the name of the data element in the centre panel, and then press the "Move right" <inlinegraphic fileref="resources/images/dhis2_images/move_right.png" align="center"/> button. To add data elements to the group, select them from the leftmost panel, and click the "Move left" <inlinegraphic fileref="resources/images/dhis2_images/move_left.png" align="center"/> button. Press the <guibutton>"Update data element group member"</guibutton> button to save your changes.</para>
- </section>
- <section id="dataElementGroupSet">
- <title>Data element group sets</title>
- <para>Data element group sets allow multiple data element groups to be categorised into a set. Data element group sets are used during analysis and reporting to combine similar data element groups into a common theme. To access the data element group set maintenance module, choose "Maintenance -> Data elements and Indicators -> Data Element Group Set". Similar to the other data element maintenance modules, new data element group sets can be added by pressing the "Add new button". Other operations include Edit, Translate, Delete and Information, similar to the other modules in this section.</para>
- <para>Existing data element group set members can be edited by clicking the "Edit" button <inlinegraphic fileref="resources/images/dhis2_images/edit.png" align="center"/> of the desired data element group set as seen below.</para>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/maintainence/data_element_group_set.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- <para>Available data element groups are displayed in the left panel. They can be moved into the selected data element group set by pressing the "Move right" <inlinegraphic fileref="resources/images/dhis2_images/move_right.png" align="center"/> button. Data element groups that are currently members of the data element group set are displayed in the right hand panel. They can be removed from the data element group set by clicking the desired data element group and pressing the "Move left"<inlinegraphic fileref="resources/images/dhis2_images/move_left.png" align="center"/> button. The ordering of the data element groups can be set with the "Move Up" <inlinegraphic fileref="resources/images/dhis2_images/move_up.png" align="center"/> and "Move Down" <inlinegraphic fileref="resources/images/dhis2_images/move_down.png" align="center"/>arrows. This ordering will be used in the datamart and reports to order the data element groups. Press the <guibutton>"Update"</guibutton> button to save any changes and the <guibutton>"Cancel"</guibutton> button to discard all changes. </para>
- </section>
- <section id="dataElementCategory">
- <title>Data element categories</title>
- <para>Data element categories can be used to disaggregate data elements into individual atomic components. Data element categories are typically a concept, such as Gender, Age or Disease Status. Data elements such as "Number of cases of confirmed malaria" are often broken into smaller component parts to determine, for instance, the number of confirmed malaria cases of particular age groups. As an example, three data element categories: Under 1, 1-5 and Over 5 could be created. They could be assigned as categories to the data element, which would then create in the data entry screens, three separate fields for this data element namely: </para>
- <itemizedlist>
- <listitem>
- <para>Number of confirmed malaria cases (Under 1)</para>
- </listitem>
- <listitem>
- <para>Number of confirmed malaria cases (1-5)</para>
- </listitem>
- <listitem>
- <para>Number of confirmed malaria cases (Over 5)</para>
- </listitem>
- </itemizedlist>
- <para>Effective use of data element categories greatly simplifies the process of setting up the DHIS2 system, as the data element categories can be reused to disaggregate many different data elements. Otherwise, each of the data elements listed above, would need to be created separately. Judicious use of data element categories will greatly simplify the DHIS2 implementation, and allow for subsequent advanced analysis. </para>
- <para>Data element categories are composed of category options. Category options must be defined when a data element category is created for the first time. Subsequent changes to the data element category, i.e. adding or deleting new category options, are not allowed once the data element category has been created. </para>
- <para>It is critical that the proper categories and category options are defined in the initial definition step, as further changes to the category and its options will are not possible. </para>
- <para>To access the data element category maintenance module, press "Maintenance -> Data Elements and Indicators->Data Element Category". The following screen will be displayed:</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/maintainence/data_element_categories_start.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Similar to the other data element maintains modules, data element categories can be filtered by typing the name of the data element category (or a portion of it) into the "Filter by name" field. To add a new data element category, press the "Add new" button which will then display the following screen:</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/maintainence/data_element_categories_add_new.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Type the name of the new data element category in the "Name" field in the "Details" region. Category options can be added by typing the name of the category option in the "Category option" region and pressing the <guibutton>"Add category option"</guibutton> button. Category options can be reordered using the "Move Up"<inlinegraphic fileref="resources/images/dhis2_images/move_up.png" align="center"/> and "Move Down"<inlinegraphic fileref="resources/images/dhis2_images/move_down.png" align="center"/> buttons. Categories options can be deleted by selecting the data element category option and pressing the "Delete"<inlinegraphic fileref="resources/images/dhis2_images/delete.png" align="center"/> button. Once all data element categories options have been added to the data element category, press the <guibutton>"Add"</guibutton> button to save all changes or the <guibutton>"Cancel"</guibutton> button to discard any changes.</para>
- <para>All data element category options must be added and defined properly in this step. Subsequent alterations to the data element category (other than reordering of the category options themselves) is not possible. </para>
- </section>
- <section id="dataElementCategoryCombo">
- <title>Data element category combinations</title>
- <para>Data element category combinations allow multiple data element categories to be combined into a related set. As an example, a data element "Number of new HIV infections" might be disaggregated according to the following categories. </para>
- <itemizedlist>
- <listitem>
- <para>Age: "Under 5", "5-15", "15-24", "24 and above"</para>
- </listitem>
- <listitem>
- <para>Gender: Male, Female</para>
- </listitem>
- </itemizedlist>
- <para> In this example, there would be two levels of disaggregation, consisting of two separate data element categories, each consisting of several data element category options. In most HMIS systems, different data elements are disaggregated according to a common set of categories. By combining these different categories into a data element category combination and assigning these combinations to data elements, the appropriate disaggregation levels can be applied efficiently and quickly to a large number of data elements. </para>
- <para>To access the data element category combination maintenance module, select "Maintenance->Data element and indicators->Data element category combinations" from the main DHIS2 menu. As with the other maintains modules, you can filter the listed category combinations by entering the name (or portion thereof) of the category combination. Other operations such as "Edit", "Delete" and "Information" should be familiar to the reader. </para>
- <para>To add a new category combination, click the "Add new" button. The following dialogue will be displayed. </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/maintainence/data_element_category_combo_add_new.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Type the name of the category combination in the "Name" field, and then select the desired categories from the left panel. Press the "Move right" button to add the selected categories to the category combination. Press "Move left" to remove any categories that should not be part of the category combination. </para>
- <para>Categories can only be added to a category combination at this step. Categories can be removed from category combinations later by editing the category combination, however, it is not allowed to add additional categories once the combination has been created. Ensure that the category combination and its respective categories is final before you create the category combination and assign it to a data element. </para>
- </section>
- <section id="dataDictionary">
- <title>Data dictionaries</title>
- <para>Data dictionaries are used to group data elements and indicators during filtering operations. They are useful for combining related groups of data elements and indicators according to the programs to which they belong. For instance a data dictionary called "MCH" could be created, and all maternal and child health data elements and indicators could be added to the dictionary. The data dictionary can be access by choosing Maintenance->Data elements and indicators->Data dictionary. The following screen will be displayed in the browser. </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/maintainence/data_dictionary.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Provide a name for the data dictionary in the "Name" field and a description of its contents. Data elements and indicators can be added or removed from the dictionary. Click "Save" if you are creating a new data dictionary or "Add" if you are editing the contents of an existing data dictionary. </para>
- </section>
- <section id="translation">
- <title>Translations</title>
- <para>DHIS 2 provides functionality for translations of database content like data elements, data element groups, indicators, indicator groups, validation rules and more. These elements can be translated to any number of locales. A locale represents a specific geographical, political, or cultural region. </para>
- <para>To add a translation click the Translate icon next to the element you would like to translate. Start by selecting the desired locale from the Locale select box. In the Translate screen, select your locale and enter values for the avaliable element properties. The reference property values are shown on the right. These values are the values which have been entered in the regular add or update user interface for the current object.</para>
- <para>Translations can be enabled by selecting the desired locale under Database Language under User General Settings in the Settings module.</para>
- </section>
- </section>
-</chapter>
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>
+<chapter>
+ <title>Data elements</title>
+ <para>When the ‘Data Elements and Indicators’ options is chosen from the main Maintenance menu, the following screen appears:</para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/maintainence/data_element_main.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>From the left side menu or by clicking on the sections listed in the central area you can access the various sections on data elements;</para>
+ <para>Data Element, Data Element Group, Data Element Group Editor, Data Element Group Set, Data Element Category, Data Element Category Combination. </para>
+ <section>
+ <title>Data element maintenance</title>
+ <para>Each of the options for maintenance of data elements will be described in the following section.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Data element</para>
+ <para>Create, modify, view and delete data elements. </para>
+ </listitem>
+ <listitem>
+ <para>Data element group</para>
+ <para>Create, modify, view and delete data element groups. </para>
+ </listitem>
+ <listitem>
+ <para>Data element group editor</para>
+ <para>Easily add or remove data elements to and from data element groups. </para>
+ </listitem>
+ <listitem>
+ <para>Data element group set editor</para>
+ <para>Create, modify, view and delete data elements group sets. </para>
+ </listitem>
+ <listitem>
+ <para>Data element category options, categories and category combinations</para>
+ <para>Create, modify, view and delete data element categories. </para>
+ </listitem>
+ </itemizedlist>
+ <section id="dataElement">
+ <title>Data elements</title>
+ <para><?inline true?>Data elements form the basis of DHIS2. Data elements define what is actually recorded in system, e.g. number of immunisations or number of cases of malaria. The actual creation and definition of the data elements themselves are far beyond the scope of this manual to describe, but it is assumed that an administrator will be provided with a list of standardised data elements for inclusion into the DHIS2 system. </para>
+ <para>To access the data element maintenance module, choose Maintenance -> Data elements and Indicators -> Data element. </para>
+ <para>The ‘Filter by name’ will allow you to filter a range of data elements if you know either the full name of the data element, or just a part of it. Type the name
+ into the search field and any matching data elements are displayed below.
+ You can also choose ‘Filter by group/view all’ to narrow down a data
+ element search within a particular data element group. In default mode, this
+ field will display all the data elements in the application.
+ The ‘Get PDF’ button can be clicked to generate a .pdf file of all the data
+ elements. The 'Sort' button can be used to sort the data elements into alphabetical order. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/maintainence/data_element_main2.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>To add a new data element, click the 'Add new' button. There are various options available from this page that allow the user to modify data elements already present in the database. Each of the options are described below in the "Editing data elements". </para>
+ <section>
+ <title>Editing data elements</title>
+ <para>Click the "Edit"<inlinegraphic fileref="resources/images/dhis2_images/edit.png" align="center"/> button to modify the properties of a data element that has been previously defined. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/maintainence/data_element_edit.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Name:</emphasis> Define the precise name of the data element in this field. Each data element must have a unique name. </para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Short name:</emphasis> Typically, an abbreviation of the full data element name. This attribute is often used in reports to display the name of the data element, where there is limited space available. </para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Code:</emphasis> In many countries, data elements are assigned a code. This code can be entered in this field. </para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Description:</emphasis> Allows a full textual description of the data element to be entered. The user should be as precise as possible, and include full information on how the data element is measured and what its meaning is. </para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Active:</emphasis> Defines whether a given data element is active or not. Data elements marked as inactive, will not be displayed in the data entry screens. </para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Domain type:</emphasis> Defines whether a data element is an aggregate or patient type of data element. </para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Value type: </emphasis>Defines the type of data this data element will be used to record. Currently there are four options: number, text, yes/no (boolean), and date. </para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Number type:</emphasis> In order to increase the robustness of data entry, DHIS2 supports several different number types. During data entry, users will be restricted to enter the defined number types only. Each of the available options are described below. </para>
+ <orderedlist>
+ <listitem>
+ <para>Number: This number type supports any real value with a single decimal point, an optional negative sign, and no thousands separators. </para>
+ </listitem>
+ <listitem>
+ <para>Integer: Any whole number (positive and negative), including zero.</para>
+ </listitem>
+ <listitem>
+ <para>Positive integer: Any whole number greater than (but not including) zero.</para>
+ </listitem>
+ <listitem>
+ <para>Negative integer: Any whole number less than (but not including) zero.</para>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Aggregation operator: </emphasis>Defines the default aggregation operation that will be used on this data element. Most data elements should have the "SUM" option set. This includes all data elements which should be added together. Other data elements, such as staffing levels, should be set to use the "AVERAGE" operator, when values along the time dimension should not be added together, but rather averaged.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Store Zero Data Value</emphasis>: By default, DHIS2 will not store zeros which are entered in the data entry module. If zeros need to be saved for a particular reason, this option can be set to "Yes". </para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">URL:</emphasis> A URL having an in-depth description of the data element can be entered in the ‘URL’ field. This could be for instance, a link to a metadata repository or registry that contains detailed technical information about the definition and measurement of the data element. </para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Combination of categories:</emphasis> Defines which category combination the data element should have. </para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Aggregation levels:</emphasis> The Aggregation Levels option allows the data element to be aggregated at one or more levels. When the user clicks on the Aggregation levels option, a drop down menu appears which displays available aggregation levels. The desired aggregation level is then selected by clicking the ‘Add Selected’ button. By default, the aggregation will start at the lowest assigned organisation unit. If e.g. Chiefdom is selected below it means that Chiefdom, District, and National aggregates will use Chiefdom (the highest aggregation level available) as the data source, and PHU data will not be included. PHU data will still be available for the PHU level, but not included in aggregations to the levels above. If District and Chiefdom are both selected then the District and National level aggregates will use District data as their source, Chiefdom will use Chiefdom, and PHU will use PHU. Read more about aggregation levels in the Reporting chapter i the section on data sources for reporting.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Option set: </emphasis>This property is only relevant for data elements with a domain type of "Patient". Option sets are predefined lists of options. </para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Legend set</emphasis>: Legend sets can be used in the GIS module to diplay certain data elements with certain icons. Refer to the GIS module documentation for more information on legend sets. </para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Attributes</emphasis>: Data element attributes (if they have been defined) can be defined. In this example, "Rationale" and "Unit of measure" are both data element attributes. </para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Data element group sets: </emphasis>If data element group sets have been defined, each will appear in the "Data element groups" section. Select each data element group from the list of group sets provided. </para>
+ </listitem>
+ </itemizedlist>
+ <para>After making all the required changes, click ‘Save’. The ‘Cancel’ button aborts all changes made.</para>
+ </section>
+ <section>
+ <title>Data element translation</title>
+ <para>DHIS2 provides functionality to translate existing data elements into other languages. Simply press the translate button <inlinegraphic fileref="resources/images/dhis2_images/i18n.png" align="center"/> to get started. The following dialogue will appear. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/maintainence/data_element_translate.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>The reference language is displayed in the upper right portion of the dialogue. Choose a locale to translate the data element into by selecting an option from the locale drop-down menu. Specify the name, short-name and description in the target language. Press "Save" to save your changes. </para>
+ <para>The "Details" section of this dialogue will allow you add a new locale if it is not already present in the database. There are two options:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Language code</para>
+ <para>Refers to the ISO 639-1 (two-letter code) language code. Refer to this <ulink url="http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes";>web page</ulink> for a detailed listing of language codes. </para>
+ </listitem>
+ <listitem>
+ <para>Country code</para>
+ <para>Refers to the ISO 3166-1-alpha-2 code. A complete listing is available <ulink url="http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm";>here</ulink>. </para>
+ </listitem>
+ </itemizedlist>
+ <para>The combination of these two codes together, forms a "locale" code, which is composed of the combination of the location and language. A very comprehensive discussion of the technical standard (RFC 3066) is available <ulink url="http://www.ietf.org/rfc/rfc3066.txt";>here</ulink>. This <ulink url="http://www.i18nguy.com/unicode/language-identifiers.html";>page</ulink> provides a very comprehensive list of recognised locale codes. </para>
+ </section>
+ <section>
+ <title>Deleting a data element</title>
+ <para>Simply press the delete button <inlinegraphic fileref="resources/images/dhis2_images/delete.png" align="center"/> to delete a data element. Note that this operation is only possible if there is no data attached to the data element itself. The user will be prompted to ensure that the data element should be deleted.</para>
+ </section>
+ <section>
+ <title>Displaying data element details</title>
+ <para>This operation displays an in-line panel in the browser which displays all metadata about a given data element. Press the information button <inlinegraphic fileref="resources/images/dhis2_images/information.png" align="center"/>to access this view. </para>
+ </section>
+ </section>
+ <section id="dataElementGroup">
+ <title>Data element groups</title>
+ <para>Data element groups provide a mechanism for classifying related data elements into a common theme. For instance, two data elements "Measles immunisation" and "BCG Immunisation" might be grouped together into a data element group "Childhood immunisation". To access the data element group maintenance page, click Maintenance -> Data elements and Indicators -> Data Element Group.</para>
+ <para>Similar to the "Data element" maintenance page, data elements groups can be searched with by entering a search string in the "Filter by name" field. </para>
+ <para>To add a new data element group, click the <guibutton>"Add new"</guibutton> button and the following screen will be displayed:</para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/maintainence/data_element_group_add.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Fill in the "Name" field and then select all data elements that should belong to the group from the left panel. Click the "Move selected" <inlinegraphic fileref="resources/images/dhis2_images/move_right.png" align="center"/>button to add the selected data elements to the data element group. Click the "Remove selected" button to remove all data elements from the group that have been selected in the right panel. Finally, click the "Add" button to save changes, or the "Cancel" button to discard any changes. </para>
+ </section>
+ <section id="dataElementGroupEditor">
+ <title>Data element group editor</title>
+ <para>The data element group editor provides advanced functionality to the administrator to allow multiple data elements to be added or removed from a group. It is also possible to create new data element groups, rename existing groups, and delete groups entirely. To access the data element group editor, go to <guimenu>"Maintenance -> Data elements and Indicators -> Data Element Group Editor"</guimenu>. The following screen will appear.<screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/maintainence/data_element_group_editor_start.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot></para>
+ <para>Data element groups area listed alphabetically in the leftmost panel. By clicking on a data element group, the current members of that group (data elements) are listed in the centre panel. Available data elements that can be added to the data element group appear are listed alphabetically in the rightmost panel. To remove an existing data element from the group, click the name of the data element in the centre panel, and then press the "Move right" <inlinegraphic fileref="resources/images/dhis2_images/move_right.png" align="center"/> button. To add data elements to the group, select them from the leftmost panel, and click the "Move left" <inlinegraphic fileref="resources/images/dhis2_images/move_left.png" align="center"/> button. Press the <guibutton>"Update data element group member"</guibutton> button to save your changes.</para>
+ </section>
+ <section id="dataElementGroupSet">
+ <title>Data element group sets</title>
+ <para>Data element group sets allow multiple data element groups to be categorised into a set. Data element group sets are used during analysis and reporting to combine similar data element groups into a common theme. To access the data element group set maintenance module, choose "Maintenance -> Data elements and Indicators -> Data Element Group Set". Similar to the other data element maintenance modules, new data element group sets can be added by pressing the "Add new button". Other operations include Edit, Translate, Delete and Information, similar to the other modules in this section.</para>
+ <para>Existing data element group set members can be edited by clicking the "Edit" button <inlinegraphic fileref="resources/images/dhis2_images/edit.png" align="center"/> of the desired data element group set as seen below.</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/maintainence/data_element_group_set.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ <para>Available data element groups are displayed in the left panel. They can be moved into the selected data element group set by pressing the "Move right" <inlinegraphic fileref="resources/images/dhis2_images/move_right.png" align="center"/> button. Data element groups that are currently members of the data element group set are displayed in the right hand panel. They can be removed from the data element group set by clicking the desired data element group and pressing the "Move left"<inlinegraphic fileref="resources/images/dhis2_images/move_left.png" align="center"/> button. The ordering of the data element groups can be set with the "Move Up" <inlinegraphic fileref="resources/images/dhis2_images/move_up.png" align="center"/> and "Move Down" <inlinegraphic fileref="resources/images/dhis2_images/move_down.png" align="center"/>arrows. This ordering will be used in the datamart and reports to order the data element groups. Press the <guibutton>"Update"</guibutton> button to save any changes and the <guibutton>"Cancel"</guibutton> button to discard all changes. </para>
+ </section>
+ <section id="dataElementCategory">
+ <title>Data element categories</title>
+ <para>Data element categories can be used to disaggregate data elements into individual atomic components. Data element categories are typically a concept, such as Gender, Age or Disease Status. Data elements such as "Number of cases of confirmed malaria" are often broken into smaller component parts to determine, for instance, the number of confirmed malaria cases of particular age groups. As an example, three data element categories: Under 1, 1-5 and Over 5 could be created. They could be assigned as categories to the data element, which would then create in the data entry screens, three separate fields for this data element namely: </para>
+ <itemizedlist>
+ <listitem>
+ <para>Number of confirmed malaria cases (Under 1)</para>
+ </listitem>
+ <listitem>
+ <para>Number of confirmed malaria cases (1-5)</para>
+ </listitem>
+ <listitem>
+ <para>Number of confirmed malaria cases (Over 5)</para>
+ </listitem>
+ </itemizedlist>
+ <para>Effective use of data element categories greatly simplifies the process of setting up the DHIS2 system, as the data element categories can be reused to disaggregate many different data elements. Otherwise, each of the data elements listed above, would need to be created separately. Judicious use of data element categories will greatly simplify the DHIS2 implementation, and allow for subsequent advanced analysis. </para>
+ <para>Where possible, data element category options should be recycled. For instance, there might be two categories which might share a particular category option (e.g. <1 year of age). When creating the data element categories, this category option could be reused. This is important if particular category options (or category option combinations) need to be analyzed together. </para>
+ <orderedlist>
+ <listitem>
+ <para> All possible category options should be defined.</para>
+ </listitem>
+ <listitem>
+ <para>Categories should be composed of multiple category options created in Step 1. </para>
+ </listitem>
+ <listitem>
+ <para>Category combinations should be composed of either one, or multiple categories.</para>
+ </listitem>
+ <listitem>
+ <para>Data elements should be created and assigned a particular category combination. </para>
+ </listitem>
+ </orderedlist>
+ <para>A data element category option consists of a name, along with an optional code, and a concept. </para>
+ <para>Data element categories can be added by accessing the "Data Element Category Option" dialog. (Maintenance -> Data Elements and Indicators->Data Element Category Options" as seen below. The category option must consist of a name, an optional code, and a concept. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="60%" align="center" fileref="resources/images/maintainence/data_element_category_options.PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Once all category options have been defined for a particular category, the category can be defined with the "Data Element Category" dialog.(Maintenance -> Data Elements and Indicators->Data Element Category) as seen below. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="80%" fileref="resources/images/maintainence/data_element_categories_add_new.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Type the name of the new data element category in the "Name" field in the "Details" region and assign a concept to the category. Category options can be added by moving category options from the left-side pane (Available category options) into the right-side pane(Selected category options). Category options can be reordered using the "Move Up"<inlinegraphic fileref="resources/images/dhis2_images/move_up.png" align="center"/> and "Move Down"<inlinegraphic fileref="resources/images/dhis2_images/move_down.png" align="center"/> buttons. Categories options can be deleted by selecting the data element category option and pressing the "Delete"<inlinegraphic fileref="resources/images/dhis2_images/delete.png" align="center"/> button. Once all data element categories options have been added to the data element category, press the <guibutton>"Add"</guibutton> button to save all changes or the <guibutton>"Cancel"</guibutton> button to discard any changes.</para>
+ </section>
+ <section id="dataElementCategoryCombo">
+ <title>Data element category combinations</title>
+ <para>Data element category combinations allow multiple data element categories to be combined into a related set. As an example, a data element "Number of new HIV infections" might be disaggregated according to the following categories. </para>
+ <itemizedlist>
+ <listitem>
+ <para>Age: "Under 5", "5-15", "15-24", "24 and above"</para>
+ </listitem>
+ <listitem>
+ <para>Gender: Male, Female</para>
+ </listitem>
+ </itemizedlist>
+ <para> In this example, there would be two levels of disaggregation, consisting of two separate data element categories, each consisting of several data element category options. In most HMIS systems, different data elements are disaggregated according to a common set of categories. By combining these different categories into a data element category combination and assigning these combinations to data elements, the appropriate disaggregation levels can be applied efficiently and quickly to a large number of data elements. </para>
+ <para>To access the data element category combination maintenance module, select "Maintenance->Data element and indicators->Data element category combinations" from the main DHIS2 menu. As with the other maintains modules, you can filter the listed category combinations by entering the name (or portion thereof) of the category combination. Other operations such as "Edit", "Delete" and "Information" should be familiar to the reader. </para>
+ <para>To add a new category combination, click the "Add new" button. The following dialogue will be displayed. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/maintainence/data_element_category_combo_add_new.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Type the name of the category combination in the "Name" field, and then select the desired categories from the left panel. Press the "Move right" button to add the selected categories to the category combination. Press "Move left" to remove any categories that should not be part of the category combination. </para>
+ <para>Categories can only be added to a category combination at this step. Categories can be removed from category combinations later by editing the category combination, however, it is not allowed to add additional categories once the combination has been created. Ensure that the category combination and its respective categories is final before you create the category combination and assign it to a data element. </para>
+ </section>
+ <section id="dataDictionary">
+ <title>Data dictionaries</title>
+ <para>Data dictionaries are used to group data elements and indicators during filtering operations. They are useful for combining related groups of data elements and indicators according to the programs to which they belong. For instance a data dictionary called "MCH" could be created, and all maternal and child health data elements and indicators could be added to the dictionary. The data dictionary can be access by choosing Maintenance->Data elements and indicators->Data dictionary. The following screen will be displayed in the browser. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/maintainence/data_dictionary.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Provide a name for the data dictionary in the "Name" field and a description of its contents. Data elements and indicators can be added or removed from the dictionary. Click "Save" if you are creating a new data dictionary or "Add" if you are editing the contents of an existing data dictionary. </para>
+ </section>
+ <section id="translation">
+ <title>Translations</title>
+ <para>DHIS 2 provides functionality for translations of database content like data elements, data element groups, indicators, indicator groups, validation rules and more. These elements can be translated to any number of locales. A locale represents a specific geographical, political, or cultural region. </para>
+ <para>To add a translation click the Translate icon next to the element you would like to translate. Start by selecting the desired locale from the Locale select box. In the Translate screen, select your locale and enter values for the available element properties. The reference property values are shown on the right. These values are the values which have been entered in the regular add or update user interface for the current object.</para>
+ <para>Translations can be enabled by selecting the desired locale under Database Language under User General Settings in the Settings module.</para>
+ </section>
+ </section>
+</chapter>
=== modified file 'src/docbkx/en/resources/images/maintainence/data_element_categories_add_new.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_categories_add_new.png 2011-01-13 16:35:18 +0000 and src/docbkx/en/resources/images/maintainence/data_element_categories_add_new.png 2013-04-20 05:48:11 +0000 differ
=== modified file 'src/docbkx/en/resources/images/maintainence/data_element_categories_start.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_categories_start.png 2011-01-13 16:35:18 +0000 and src/docbkx/en/resources/images/maintainence/data_element_categories_start.png 2013-04-20 05:48:11 +0000 differ
=== modified file 'src/docbkx/en/resources/images/maintainence/data_element_edit.png'
Binary files src/docbkx/en/resources/images/maintainence/data_element_edit.png 2011-01-13 16:35:18 +0000 and src/docbkx/en/resources/images/maintainence/data_element_edit.png 2013-04-20 05:48:11 +0000 differ
