dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #30321
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 1077: Update tracker document ( WIP )
------------------------------------------------------------
revno: 1077
committer: Tran Chau <tran.hispvietnam@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Sat 2014-05-24 20:47:55 +0800
message:
Update tracker document ( WIP )
modified:
src/docbkx/en/dhis2_user_man_tracker.xml
--
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_tracker.xml'
--- src/docbkx/en/dhis2_user_man_tracker.xml 2014-05-23 14:55:47 +0000
+++ src/docbkx/en/dhis2_user_man_tracker.xml 2014-05-24 12:47:55 +0000
@@ -230,11 +230,11 @@
<para>Check on<emphasis role="italic"> Auto save registration form</emphasis> checkbox in <emphasis role="italic">Design tracked entity form </emphasis>to save the custom registration form to being designed automatically.</para>
</note>
</section>
- <section id="program">
+ <section id="program_program_stage">
<title>Program and Program stage</title>
<para>The section provides a mechanism for defining health programmes and action for each stage of the programme. </para>
- <section>
- <title>Program</title>
+ <section id="program">
+ <title id="program_title">Program</title>
<para>A program must be specified with only one tracked entity. And just entities what/who have the tracked entity as same as the tracked entity of program can enroll into that program.</para>
<para>There are three type of program, include -</para>
<orderedlist>
@@ -372,11 +372,10 @@
</listitem>
</itemizedlist>
<para>To assign a program for organisation units, click on the program which you would like and select<emphasis role="italic"> Assign program to organisation units</emphasis> menu. Then select organisation units where provide the program.</para>
- <para>To assign a program for user roles, click <emphasis role="italic">Assign program to userroles</emphasis> icon, the second icon under Operations, corresponding to the
- program you would like. Please select user role which you want in <emphasis role="italic">Available</emphasis> section and click <emphasis role="italic">Move selected items</emphasis> button or double click on the user role to move to <emphasis role="italic">Selected</emphasis> section. Finally, click <emphasis role="italic">OK</emphasis> to finish.</para>
- <para>To create validation rules for programs, click <emphasis role="italic">Program validation rule management</emphasis> icon, the fifth icon under Operations, corresponding to the program you would like. Then click <emphasis role="italic">Add</emphasis> button and enter values for the fields in form to create a new one. A validation rule is based on an expression which defines a relationship between data element values. The expression has a left side and a right side and an operator which defines whether the former must be less than, equal to or greater than the latter. The expression forms a condition which should assert that certain logical criteria are met. For instance, a validation rule could assert that an admitted date given is before the discharged date. </para>
- <para>To define a program indicator, click <emphasis role="italic">Program Indicator management </emphasis>icon under Operations, corresponding to the program you would like. </para>
- <para>To set authority for sharing the program, click Sharing Settings icon, the seventh icon under Operations, corresponding to the program you would like. You can see a default authority and <emphasis role="italic">Public Access</emphasis> in the form with three authorities as follows -</para>
+ <para>To assign a program for user roles, click on the program which you would like and select <emphasis role="italic">Assign program to userroles</emphasis> menu. Then select user roles which you want in <emphasis role="italic">Available</emphasis> section and click <emphasis role="italic">Move selected items</emphasis> button or double click on the user role to move to <emphasis role="italic">Selected</emphasis> section. Finally, click <emphasis role="italic">OK</emphasis> to finish.</para>
+ <para>To create validation rules for programs, click on the program which you would like and select <emphasis role="italic">Program validation rule management</emphasis> menu. Then click <emphasis role="italic">Add</emphasis> button and enter values for the fields in form to create a new one. A validation rule is based on an expression which defines a relationship between data element values. The expression has a left side and a right side and an operator which defines whether the former must be less than, equal to or greater than the latter. The expression forms a condition which should assert that certain logical criteria are met. For instance, a validation rule could assert that an admitted date given is before the discharged date. </para>
+ <para>To define a program indicator, click on the program which you would like and select <emphasis role="italic">Program Indicator management </emphasis>menu. </para>
+ <para>To set authority for sharing the program, click on the program which you would like and select Sharing Settings menu. You can see two parametters for authority, include <emphasis role="italic">External access (without login)</emphasis> and <emphasis role="italic">Public Access</emphasis> in the form with three authorities. There are three options for the public access as follows -</para>
<itemizedlist>
<listitem>
<para><emphasis role="italic">None</emphasis> - The program is private one. Just the user who created it can see and use it.</para>
@@ -391,9 +390,9 @@
<para>Besides, you can search user groups by typing a key in text field to set authorities. The result will loaded and you can select the group you want. Then click (+) button and the selected one will be displayed in below.</para>
<para>To translate the name of a program, click <emphasis role="italic">Translation</emphasis> icon, the seventh icon under Operations, corresponding to the program you would like.</para>
</section>
- <section>
+ <section id="program_stage">
<title>Program stage</title>
- <para>To define a program stage, click the row corresponding to the program you would like, then View program stages link in context menu. In Program stage management form, click <emphasis role="italic">Add new</emphasis> button. Fill in the <emphasis role="italic">Name</emphasis> and <emphasis role="italic">Description</emphasis> fields and then select the data elements that should belong to the group from the left panel. Click the <emphasis role="italic">Move</emphasis> selected button to add the selected data elements to the right panel. Click the Remove selected button to remove data elements that have been selected in the right panel. Finally, click the <emphasis role="italic">Add</emphasis> button to save changes, or the <emphasis role="italic">Cancel</emphasis> button to discard any changes.</para>
+ <para>To define a program stage, click the row corresponding to the program you would like, then <emphasis role="italic">View program stages</emphasis> link in context menu. In <emphasis role="italic">Program stage management</emphasis> form, click <emphasis role="italic">Add new</emphasis> button.</para>
<para>Basic information -</para>
<para><emphasis role="italic">Program stage details</emphasis> section - </para>
<itemizedlist>
@@ -430,19 +429,21 @@
the program.</para>
</listitem>
<listitem>
- <para><emphasis role="italic">Open data entry form after enrollment</emphasis> - After a entity enrolls into the program successfull, the event of this stage is opened.</para>
- </listitem>
- <listitem>
- <para><emphasis role="italic">Report Date to use</emphasis> - The date is used for report date of the event. When a data entry of this event are opened after registration, the system use date of incident or date of enrollment for report date. </para>
- </listitem>
- <listitem>
- <para><emphasis role="italic">Block entry form after completed</emphasis> - Check on it for blocking entry form after completed. The data values in the entry form cannot be changed until the status of the event is reset as incomplete.</para>
- </listitem>
- <listitem>
- <para><emphasis role="italic">Remind completing program after a program stage completed</emphasis> - After an event is completed, the system remind if the user want to complete the program.</para>
- </listitem>
- <listitem>
- <para><emphasis role="italic">Remind creating next event on this event completed</emphasis> - When the event of this stage completed, an alert is displayed and ask user to complete the program.</para>
+ <para><emphasis role="italic">Open data entry form after enrollment</emphasis> - Automatically open the event of this stage as soon as the entity has enrolled into the program.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">Report Date to use</emphasis> - The date is used for report date of the event opened automatically. There are two options , include <emphasis role="italic">Incident date</emphasis> or <emphasis role="italic">Enrollment date</emphasis>. </para>
+ <para>If the Report date to use is selected as one of those two('incident date'/'enrollment date'), in Dashboard, the 'Report date' of the event will be set as one of those two.
+</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">Block entry form after completed</emphasis> - Check on it for blocking entry form after completed the event of this stage. The data values in the entry form cannot be changed until the status of the event is reset as incomplete.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">Ask user to complete program when stage is completed</emphasis> - If this property is set, a popup will come up to ask if user wants to create the event of next stage.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">Ask user to create new event when stage is complete</emphasis> - If this property is set, a popup will come up to ask if user wants to create a new event of this stage when an event of this stage completed. This property is active only when Repeatable field is set.</para>
</listitem>
<listitem>
<para><emphasis role="italic">Generate events by enrollment date</emphasis> - Check on it for auto-generating due dates of events from program-stages of this program based on the enrollment date. If it is not checked, the due dates are generated based on incident date.</para>
@@ -451,57 +452,100 @@
<para><emphasis role="italic">Capture coordinates</emphasis> - Many types of events may be recorded at a facility or be <emphasis role="italic">owned-by</emphasis> a health worker at a facility, but actually take place somewhere in the community. This field is checked to get coordinates of the place.</para>
</listitem>
<listitem>
- <para><emphasis role="italic">Complete allowed only if validation passes</emphasis> - The event created by this program stage is completed if all validation rules are passed.</para>
+ <para><emphasis role="italic">Complete allowed only if validation passes</emphasis> - The event created by this program stage is completed only when all validation rules are passed.</para>
</listitem>
<listitem>
<para><emphasis role="italic">Description of report date</emphasis> - The description for report date which is displayed in case entry form.</para>
</listitem>
</itemizedlist>
- <para><emphasis role="italic">Data elements <emphasis role="italic">section</emphasis></emphasis> - Select entity data elements which belong to the program stage. We have three options for each selected data element. The first one is <emphasis role="italic">Compulsory</emphasis> option. Please check it if the data value of the selected one is compulsory. The second one is <emphasis role="italic">Allow provided elsewhere</emphasis> option, please check it if the data value of this one can be provided by other facilities. The last one is<emphasis role="italic"> Display in reports</emphasis> option. Please check it of you want to display the data value of this one in event list of single event without registration into data entry form.</para>
- <para><emphasis role="italic">Template reminder message<emphasis role="italic"> section</emphasis></emphasis> - Define template reminder messages which are used for sending messages for entity automatically. There are two params -</para>
+ <para><emphasis role="italic">Data elements <emphasis role="italic">section</emphasis></emphasis> - Select entity data elements which belong to the program stage. There are four properties for each data element selected-</para>
+ <orderedlist>
+ <listitem>
+ <para><emphasis role="italic">Compulsory</emphasis> - The value of this data element must be filled into data entry form before completing the event.
+</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">Allow provided elsewhere</emphasis> - Specify if the value of this data element comes from other facility, not in the facility where this data is entered.
+</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">Display in reports </emphasis>- Display the value of this data element into the SEWoR data entry function.
+</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">Date in future</emphasis> - Allow to select a date in future for date data elements.</para>
+ </listitem>
+ </orderedlist>
+ <para>This module also supports to define template message reminders which are sent to users/entities. To access to this function, click on the program stage which you would like to define template message reminder and select <emphasis role="italic"> View template reminder message</emphasis> link. </para>
<itemizedlist>
<listitem>
- <para><emphasis role="italic"><emphasis role="italic">Send base on</emphasis> - There are two ptions, Days scheduled and Complete event.</emphasis></para>
- </listitem>
- <listitem>
- <para><emphasis role="italic">Days before/after due date</emphasis> - Enter a positive number of days if sending process happens after due-date of events which are generated from this program stage. Enter a negative number of days if sending process happens before due-date of events.</para>
- </listitem>
- <listitem>
- <para><emphasis role="italic">Parameters</emphasis> - Provide parameters which are used for generating a message for each entity. The parameters include entity's first name, program's name, program stage's name, due date of event, interval between current date and due date and organisation unit's name. </para>
- </listitem>
- <listitem>
- <para>Double-click on an option to insert it into template message field below.</para>
+ <para><emphasis role="italic">Name</emphasis> - Name of description</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">Send base on</emphasis> - There are two options, include :</para>
+ <para>1) <emphasis role="italic">Days scheduled</emphasis> - The message is sent in day ( datesToCompare + daysAllowedSendMessage ).
+</para>
+ <para>2) Complete event - The message is sent when the event of an entity is completed.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">Date to compare</emphasis> - This is the date used for calculating the date to send the message. There are 2 options, include:</para>
+ <para>1) Enrollment Date</para>
+ <para>2) Incident Date </para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">Send message X days before/after scheduled date </emphasis>- The number of days needs to calculate the date for sending the message by scheduled. Just enter a number for this field in the case <emphasis role="italic">Send base on</emphasis> with value as Days schedule.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">Recipients</emphasis> - Specify the kind of persons who will receive the message. There are 5 options, include
+- </para>
+ <para>1) Tracked entity instance (SMS only)</para>
+ <para>2) Attribute users </para>
+ <para>3) Organisation unit phone number (SMS only)</para>
+ <para>4) All users in organisation unit</para>
+ <para>5) User group</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">User group</emphasis> - Select one user group if <emphasis role="italic">Recipients</emphasis> field is selected as User group.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">Message type</emphasis> - This is the types of message. There are 3 options, include - </para>
+ <para>1) Direct SMS - This kind of SMS message is linked to the program of an entity after sending to recipients.</para>
+ <para>2) Message</para>
+ <para>3) Both</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">Parameters</emphasis> - Provide parameters which are used for generating a message for each entity. The parameters include <emphasis role="italic">entity name</emphasis>,<emphasis role="italic"> program name</emphasis>, <emphasis role="italic">incident date, days since incident date, enrollment date, days since enrollment date, organisation unit name</emphasis>. Double-click on an option to insert it into template message field below.
+</para>
</listitem>
<listitem>
<para><emphasis role="italic">Message</emphasis> - Content of template message. E.g.
- Dear {patient-name}, please come to your appointment at {due-date}.</para>
+ Dear {patient-name}, please come to your appointment at {due-date}.
+</para>
</listitem>
</itemizedlist>
- <note>
- <para>Click <emphasis role="italic">Add more... </emphasis>button to add more template reminder messages.</para>
- </note>
<para>A program stage has three types of data entry form - </para>
<orderedlist>
<listitem>
- <para><emphasis role="italic">Custom data entry form</emphasis> - Define a data entry form as HTML page. Click<emphasis role="italic"> Design data entry form <emphasis role="italic">icon, the fifth icon</emphasis></emphasis> under <emphasis role="italic">Operations</emphasis>, corresponding to the program stage you would like to define custom data entry form. The system supports to define a custom entry form with multi stages. So this form can be re-used in other stages of the same program.</para>
+ <para><emphasis role="italic">Custom data entry form</emphasis> - Define a data entry form as HTML page. click on the program stage which you would like and select to define custom data entry form. The system supports to define a custom entry form with multi stages. So this form can be re-used in other stages of the same program.</para>
</listitem>
<listitem>
- <para><emphasis role="italic">Section data entry form</emphasis> - Group some data elements which belong to the program stage as sections and display data elements by each section. Click <emphasis role="italic">Section management</emphasis> icon, the <emphasis role="italic">
- <emphasis role="italic">forth icon</emphasis>
- </emphasis> under <emphasis role="italic">Operations</emphasis>, corresponding to the program stage you would like to define section data entry form.</para>
+ <para><emphasis role="italic">Section data entry form</emphasis> - Group some data elements which belong to the program stage as sections and display data elements by each section. Click on the program stage which you would like and select <emphasis role="italic">Section management</emphasis> link to define section data entry form.</para>
</listitem>
<listitem>
<para><emphasis role="italic">Default data entry form</emphasis> - List all data elements which belong to the program stage.</para>
</listitem>
</orderedlist>
+ <note>
+ <para>A custom data entry form can have data elements which belong to other stages of the program. This form can be reused for the stages of program. When the form is opened to enter data, the data values which belong to other events will be displayed if any, but user can not modify them. Just only data values with data elements which belong to the stage selected are editable.</para>
+ </note>
<para>To sort program stages by scheduled days, click <emphasis role="italic">Sort by scheduled</emphasis> days button.</para>
</section>
<section id="validation_criteria">
<title>Validation criteria</title>
- <para>Validation criteria section provides a mechanism for defining criteria for entitys when enrolling a program.</para>
- <para>To access the validation criteria maintenance module, from <emphasis role="italic">Apps</emphasis> menu, go to <emphasis role="italic">entitys and Programs</emphasis> option and click on it. Select <emphasis role="italic">Progam</emphasis> option and click on the row corresponding the program you want to design. Then select <emphasis role="italic">View validation criteria</emphasis> link on context menu to open <emphasis role="italic">Validation criteria management</emphasis> form.</para>
+ <para>Validation criteria section provides a mechanism for defining criteria which validate if an entity can enrol into the program.</para>
+ <para>To access the validation criteria maintenance module, click on the program which you would like and select <emphasis role="italic">View validation criteria</emphasis> link on context menu to open <emphasis role="italic">Validation criteria management</emphasis> form.</para>
<para>To create a new validation criterion, click the <emphasis role="italic">Add new</emphasis> button. Fill all fields with read asterisk, and click <emphasis role="italic">Add</emphasis> button.</para>
- <para>To translate the name of a program, click <emphasis role="italic">Translation</emphasis> icon, the third icon under Operations, corresponding to the validation criteria you would like.</para>
+ <para>To translate the name of a validate criteria, click on the program stage which you would like and select <emphasis role="italic">Translation</emphasis> link.</para>
</section>
</section>
<section id="patient_aggregation_query_builder">
@@ -510,15 +554,15 @@
<para>This provides two functions - </para>
<itemizedlist>
<listitem>
- <para><emphasis role="italic">Aggregation query builder management</emphasis> is a tool for defining formulas, expressions, rules for aggregation data from tracker to aggregation module. </para>
+ <para><emphasis role="italic">Apps > Programs / Attributes > Aggregation query builder</emphasis> is a tool for defining formulas, expressions, rules for aggregation data from tracker to aggregation module. </para>
</listitem>
<listitem>
- <para><emphasis role="italic">Manual entity aggregation</emphasis> is used for generating routine data values from individual data by period and organization unit. Please refer the <emphasis role="italic">Service</emphasis> module to see this part.</para>
+ <para><emphasis role="italic">Apps > Individual Records > Manual Aggregation</emphasis> is used for generating routine data values from individual data by period and organization unit.</para>
</listitem>
</itemizedlist>
<section>
- <title>entity Aggregation Query Builder Management</title>
- <para>To access <emphasis role="italic">Aggregation Query Builder</emphasis> module, from the <emphasis role="italic">Apps</emphasis> menu, go to the <emphasis role="italic">entitys and Programs</emphasis> option. Select <emphasis role="italic">Aggregation Query Builder</emphasis> option on left menu to proceed.</para>
+ <title>Aggregation Query Builder </title>
+ <para>To access <emphasis role="italic">Aggregation Query Builder</emphasis> module, from the <emphasis role="italic">Apps</emphasis> menu, go to the <emphasis role="italic">Programs / Attributes</emphasis> option. Select <emphasis role="italic">Aggregation Query Builder</emphasis> option on left menu to proceed.</para>
<para>To define a formula, click the <emphasis role="italic">Add new</emphasis> button.</para>
<screenshot>
<mediaobject>
@@ -540,7 +584,7 @@
</listitem>
<listitem>
<para><emphasis role="italic">Operator</emphasis> - There are six operators</para>
- <para>1) Select <emphasis role="italic">Number of entitys</emphasis> if aggregate based on entitys;</para>
+ <para>1) Select <emphasis role="italic">Number of tracked entity instances</emphasis> if aggregate based on entities;</para>
<para>2) Select <emphasis role="italic">Number of visits</emphasis> if aggregate data based on times that entitys received services.</para>
<para>3) Select <emphasis role="italic">Sum of data element values </emphasis>to get sum of data values of data element in <emphasis role="italic">Data element for sum/average</emphasis> field with the criteria in the condition field.</para>
<para>4) Select <emphasis role="italic">Average of data element values </emphasis>to get average of data values of data element in <emphasis role="italic">Data element for sum/average</emphasis> field with the criteria in the condition field.</para>
@@ -577,9 +621,9 @@
</note>
<para><emphasis role="bold">
<emphasis role="underline">
- <emphasis role="italic">entity attribute tab</emphasis>
+ <emphasis role="italic">Attribute tab</emphasis>
</emphasis>
- </emphasis>- List all available fixed attributes, such as gender, DOB type, Age (days), .. and user-defined attributes. Besides, provide a formula for calculating number of entitys who registered in system. However, if a program without registration is selected, entity attributes aren't displayed.</para>
+ </emphasis>- List all available fixed attributes, such as gender, DOB type, Age (days), .. and user-defined attributes. Besides, provide a formula for calculating number of entities who registered in system. However, if a program without registration is selected, entity attributes aren't displayed.</para>
<para><emphasis role="bold">
<emphasis role="underline">
<emphasis role="italic">Program tab</emphasis>
@@ -587,16 +631,16 @@
</emphasis> - Provide formulas for calculating data value related to the selected program and program stage - </para>
<itemizedlist>
<listitem>
- <para>The number of entitys who enrolled the selected program.</para>
- </listitem>
- <listitem>
- <para>The number of entitys / times that ( Date of enrollment - Date of incident ) is greater then a certain number.</para>
- </listitem>
- <listitem>
- <para>The number of entitys who visited the selected program stage OR the number of visits what are registered in the system.</para>
- </listitem>
- <listitem>
- <para>The number of entitys by age at the report-time.</para>
+ <para>The number of entities who enrolled the selected program.</para>
+ </listitem>
+ <listitem>
+ <para>The number of entities / times that ( Date of enrollment - Date of incident ) is greater then a certain number.</para>
+ </listitem>
+ <listitem>
+ <para>The number of entities who visited the selected program stage OR the number of visits what are registered in the system.</para>
+ </listitem>
+ <listitem>
+ <para>The number of entities by age at the report-time.</para>
</listitem>
</itemizedlist>
<para><emphasis role="bold">
@@ -619,7 +663,7 @@
which user will select when generate report. It is not set in the query.</para>
</section>
<section>
- <title>Sample of entity aggregation</title>
+ <title>Sample of aggregation query builder</title>
<para>E.g. Find the number of the children vaccinated BCG by defining a linking rule between the data elements of aggregate dataset named <emphasis role="italic">Number of children - BCG</emphasis> and the data element of a program stage named <emphasis role="italic">BCG dose given</emphasis>.</para>
<orderedlist>
<listitem>
@@ -631,13 +675,13 @@
<para>From <emphasis role="italic">Apps</emphasis> menu, go to <emphasis role="italic">Datasets</emphasis> option and click on it. Select <emphasis role="italic">Dataset</emphasis> option to create a new dataset named <emphasis role="italic">BCG Report</emphasis> and add <emphasis role="italic">Number of children - BCG</emphasis> data element into the dataset.</para>
</listitem>
<listitem>
- <para>From <emphasis role="italic">Apps</emphasis> menu, go to <emphasis role="italic">entitys and Programs</emphasis> option and click on it. Select <emphasis role="italic">Program</emphasis> option to create a program named <emphasis role="italic">Child Health Program</emphasis> with a stage named <emphasis role="italic">Birth Details</emphasis> and add the <emphasis role="italic">BCG dose given</emphasis> data element into this stage.</para>
+ <para>From <emphasis role="italic">Apps</emphasis> menu, go to <emphasis role="italic">Programs / Attributes</emphasis> option and click on it. Select <emphasis role="italic">Program</emphasis> option to create a program named <emphasis role="italic">Child Health Program</emphasis> with a stage named <emphasis role="italic">Birth Details</emphasis> and add the <emphasis role="italic">BCG dose given</emphasis> data element into this stage.</para>
</listitem>
<listitem>
<para>Create a new aggregation query builder named <emphasis role="italic">Number of children - BCG Builder </emphasis>to linking between the data elements.</para>
</listitem>
<listitem>
- <para>From <emphasis role="italic">Services</emphasis> menu, go to <emphasis role="italic">Individual Records </emphasis>option and click on it. Select <emphasis role="italic">entity</emphasis> option below <emphasis role="italic">Registration</emphasis> header in the left menu to register three entitys named <emphasis role="italic">Micheal</emphasis>, <emphasis role="italic">Alice</emphasis> and <emphasis role="italic">Tom</emphasis> in <emphasis role="italic">Ngelehun CHC</emphasis> and enroll them into <emphasis role="italic">Child Health Program</emphasis>.</para>
+ <para>From <emphasis role="italic">Services</emphasis> menu, go to <emphasis role="italic">Individual Records </emphasis>option and click on it. Select <emphasis role="italic">entity</emphasis> option below <emphasis role="italic">Registration</emphasis> header in the left menu to register three entities named <emphasis role="italic">Micheal</emphasis>, <emphasis role="italic">Alice</emphasis> and <emphasis role="italic">Tom</emphasis> in <emphasis role="italic">Ngelehun CHC</emphasis> and enroll them into <emphasis role="italic">Child Health Program</emphasis>.</para>
<para>1) For <emphasis role="italic">Micheal</emphasis>, open the <emphasis role="italic">Birth Details</emphasis> stage into <emphasis role="italic">Child Health Program</emphasis>. Enter value for <emphasis role="italic">BCG dose give date</emphasis> data element as "<emphasis role="italic">2012-01-18</emphasis>".</para>
<para>2) For <emphasis role="italic">Alice</emphasis>, open the <emphasis role="italic">Birth Details</emphasis> stage into Child Health Program. Enter
value for <emphasis role="italic">BCG dose give date</emphasis> data element as
@@ -673,7 +717,7 @@
</section>
<section id="schedule_sending_message">
<title>Schedule automated message reminder</title>
- <para>This function is used for scheduling message reminders to be automatically sent to enrolled entitys XX days before scheduled appointments and/or XX days after a missed visit. When the schedule is started, messages for each entity are generated based on templates defined in each stage at midnight (Ref.<emphasis role="italic"> Add program stage </emphasis>section for defining a template message). On the time, the scheduled messages are sent.</para>
+ <para>This function is used for scheduling message reminders to be automatically sent to enrolled entities XX days before scheduled appointments and/or XX days after a missed visit. When the schedule is started, messages for each entity are generated based on templates defined in each stage at midnight (Ref.<emphasis role="italic"> Add program stage </emphasis>section for defining a template message). On the time, the scheduled messages are sent.</para>
<para>Click <emphasis role="italic">Start</emphasis> button will enable the scheduled job to run the task. Messages are generated based on templates defined in each stages at mid-night and sent at a pre-determined time or can be run immediately by pressing <emphasis role="italic">Execute</emphasis> button.</para>
<para>Click <emphasis role="italic">Execute</emphasis> button to generate and send each message for each entity at the time the button clicked.</para>
</section>
@@ -699,12 +743,12 @@
</section>
</section>
<section>
- <title>Individual records module</title>
+ <title>Individual records </title>
<para>Each of the options for the services will be described in the following section -</para>
<itemizedlist>
<listitem>
- <para>Find/Add entity</para>
- <para>Register, edit and search private information of entitys. Support entity dashboard for managing relationships, program enrollment, entering case entry form, ....
+ <para>Find/Add Instance</para>
+ <para>Register, edit and search private information of entities. Support entity dashboard for managing relationships, program enrollment, entering case entry form, ....
</para>
</listitem>
<listitem>
@@ -712,33 +756,19 @@
<para>Visit Schedule provides for the user at a facility or in an area a list of upcoming visits to better plan for daily/weekly activities.</para>
</listitem>
<listitem>
- <para>Lost to follow-up</para>
- <para>Support the work practices around tracking entitys within a health program that have not shown up for a scheduled visit (stage), e.g. that are lost to follow-up. </para>
- </listitem>
- <listitem>
- <para>Multiple Individual records</para>
- <para>Enter data for multiple program stages and entitys for a program. The entry screen gives an overview of the stage status.
- </para>
- </listitem>
- <listitem>
- <para>Single event with registration </para>
+ <para>Lost To Follow-Up</para>
+ <para>Support the work practices around tracking entities within a health program that have not shown up for a scheduled visit (stage), e.g. that are lost to follow-up. </para>
+ </listitem>
+ <listitem>
+ <para>Single Event With Registration </para>
<para>The data to register is defined by a single event with registration program.</para>
</listitem>
<listitem>
- <para>Single event without registration</para>
- <para>Register Single events without registration. The data to register is defined by a single event without registration program.</para>
- </listitem>
- <listitem>
<para>Program summary</para>
<para>View the summary report to get an overview of the services provided for a program.
</para>
</listitem>
<listitem>
- <para>Tabular report</para>
- <para>Use an interactive reporting tool for tracker-data using tabular presentation with dynamic filters for each entity attribute, entity identifier and data element.
- </para>
- </listitem>
- <listitem>
<para>Program Statistics </para>
<para>Program statistics on program performance, e.g. drop-out rates, how many completed every month/year - counts/percentages etc. </para>
</listitem>
@@ -747,34 +777,34 @@
<para>Monitor the completeness of events and produce completeness reports for each program </para>
</listitem>
<listitem>
- <para>Manual entity Aggregation</para>
+ <para>Manual Aggregation</para>
<para>Generate routine data values from patient data by month (or other intervals if desired) and organisation unit.
</para>
</listitem>
</itemizedlist>
<section id="patient">
- <title>Find/Add entity</title>
+ <title>Find/Add instance</title>
<para>The first step in the tracking is the registration of entity/case in the application. In the registration process, the details - which are related to the entityal information, identification, contract and location details & health provider details, are entered in the application. In the registration itself, entity is provided with the unique identification number. This number will be unique and will not match with the identification number of any entity in the state jurisdiction. The issue of identification number will be the responsibility of facility where entity is registered first time.</para>
<warning>
- <para>No matter what program entitys need to enroll, they must register into the system first. Then health providers will enroll the entitys into relevant programs. E.g. every pregnant women and the child need to be registered first as a entity, then they will be enrolled in Mother Care program or Child Health program.</para>
+ <para>No matter what program entities need to enroll, they must register into the system first. Then health providers will enroll the entities into relevant programs. E.g. every pregnant women and the child need to be registered first as a entity, then they will be enrolled in Mother Care program or Child Health program.</para>
</warning>
- <para>To access <emphasis role="italic">entity management </emphasis>function, from the
- <emphasis>Services</emphasis> menu, go the <emphasis>Individual Records </emphasis>option and click on it. Select <emphasis>Find/Add entity</emphasis> option on
+ <para>To access <emphasis role="italic">Tracked entity instance management </emphasis>function, from the
+ <emphasis>Apps</emphasis> menu, click <emphasis>Individual Records </emphasis>and click on it. Select <emphasis>Find/Add Instance</emphasis> option on
the left menu to proceed. Then, after to select organisation unit.</para>
- <para>Click the<emphasis role="italic"> List All entitys</emphasis> button to list all
-entitys in the selected organisation unit. If a program in list on the right side is
- selected, the system will load entitys who enrolled into the program.</para>
- <para>For the registration process, the details - which are related to the entityal information, identification, contact and location details, and health provider details, are entered.</para>
+ <para>Click the<emphasis role="italic"> List All instances</emphasis> button to list all
+entities in the selected organisation unit. If a program in list on the right side is
+ selected, the system will load entities who enrolled into the program.</para>
+ <para>The registration process is below - </para>
<orderedlist inheritnum="inherit" continuation="restarts" arch="">
<listitem>
- <para>To register a entity, go to the <emphasis role="italic">Services</emphasis> menu, select option <emphasis role="italic">Individual Records</emphasis>.</para>
+ <para>To register a entity, go to the <emphasis role="italic">Apps</emphasis> menu, select <emphasis role="italic">Individual Records</emphasis>.</para>
</listitem>
<listitem>
<para>Click the <emphasis role="italic">
<emphasis>
- <emphasis role="italic">Find/Add entity</emphasis>
+ <emphasis role="italic">Find/Add Instance</emphasis>
</emphasis>
- </emphasis> option below <emphasis role="italic">entity</emphasis> header to go to <emphasis>entity management</emphasis> window.</para>
+ </emphasis> menu below <emphasis role="italic">Tracked entity instance</emphasis> header to go to <emphasis>Tracked entity instance management</emphasis> window.</para>
</listitem>
<listitem>
<para>Select a facility from the facilities hierarchy displayed on the left side of the screen. Then click the <emphasis role="italic">Add new</emphasis> button on the right side.</para>
@@ -783,7 +813,7 @@
</note>
</listitem>
<listitem>
- <para>Start process of registration by providing name, location details, identification details, contact details and other details like <emphasis role="italic">child contact name</emphasis> and <emphasis role="italic">child contact type</emphasis>. Then click the <emphasis role="italic">Add</emphasis> button to complete to process of registration or click the <emphasis role="italic">entity management</emphasis> to navigate to previous page. </para>
+ <para>Fill data into the registration form. Then click the <emphasis role="italic">Add</emphasis> button to complete to process of registration. </para>
<para>To continue to register other new entity, click the <emphasis role="italic">Add && Register new </emphasis>button.</para>
<screenshot>
<mediaobject>
@@ -792,11 +822,10 @@
</imageobject>
</mediaobject>
</screenshot>
- <para>To check the duplicated entity or to avoid double registration, after providing name and demographic details, click the <emphasis role="italic">Check duplicate</emphasis> button. Checking process bases on full name, gender and birthday of the registering entity to look for the available entitys with the similar information in the database. The result list will be displayed if the system finds out the same entitys. Now health providers can cancel the registration process and update the existing entity or continue the process of registration.</para>
- <para>To register representative for the registering entity, check on the <emphasis role="italic">Has guardian/caretaker</emphasis> checkbox in <emphasis role="italic">Register new entity</emphasis> form. The sub-function has two tab -</para>
+ <para>For tracked association attribute which is used to register representative for the registering entity, in registration form, check on the checkbox of this attribute, the sub-function has two tab -</para>
<itemizedlist>
<listitem>
- <para><emphasis role="italic">Search existing entity</emphasis> tab is used for searching available entitys and users can select one entity in the result list to set relationship. The criteria to search is based on identifier, attribute and name of entitys.</para>
+ <para><emphasis role="italic">Search existing entity</emphasis> tab is used for searching available entities and users can select one entity in the result list to set relationship. The criteria to search is based on attribute of entities.</para>
</listitem>
<listitem>
<para><emphasis role="italic">Add new entity</emphasis> tab is used for registering a new entity for relationship. When adding a entity in this form, you need to select one user-defined relationship type in the list. Finally, click <emphasis role="italic">Add</emphasis> button.</para>
@@ -812,9 +841,9 @@
</listitem>
</orderedlist>
<section>
- <title>entity dashboard</title>
- <para>The function provides quick access to individual data of a entity. Dashboards consist of several sections, some of which provide links to activity programs or relationships of the entity . Other sections of the dashboard allow users to enter data values into case entry form, reschedule and set status for each events of activity plan and show messages and report of the program.</para>
- <para>The dashboard of a entity is opened after register successfully or click the <emphasis role="italic">first icon</emphasis> under <emphasis role="italic">Operations</emphasis>, corresponding to the entity who you would like.</para>
+ <title>Tracked entity instance dashboard</title>
+ <para>The function provides quick access to individual data of an entity. Dashboards consist of several sections, some of which provide links to activity programs or relationships of the entity . Other sections of the dashboard allow users to enter data values into case entry form, reschedule and set status for each events of activity plan and show messages and report of the program.</para>
+ <para>The dashboard of an entity is opened after register successfully or click the <emphasis role="italic">first icon</emphasis> under <emphasis role="italic">Operations</emphasis>, corresponding to the entity who you would like.</para>
<screenshot>
<mediaobject>
<imageobject>
@@ -824,14 +853,14 @@
</screenshot>
<para>Click on the<emphasis role="italic"> View access log link </emphasis>in the top-right of the dashboard to open history of access log to this entity.</para>
<para>The <emphasis role="italic">Demographics</emphasis> section provides links for editing profile and changing other location of the entity. Click on <emphasis role="italic">Edit profile</emphasis> link to update individual information of entity. Click on <emphasis role="italic">Change location</emphasis> link to change other location for the entity.</para>
- <para>Click on a program link in <emphasis role="italic">Active programs</emphasis> section to open the data entry form for the next visit of the selected program. A form is open below with five tab - </para>
+ <para>Click on a program link in <emphasis role="italic">Active programs</emphasis> section to open the data entry form for the next visit of the selected program. A form is opened below with five tab - </para>
<orderedlist>
<listitem>
<para><emphasis role="italic">Data entry screen </emphasis>tab - Where data is manually registered for each entity. Click on a event box in tab. Then fill a report date to open data entry form of the selected event. </para>
<para>After entering data values into the data entry form, user should click on <emphasis role="italic">Run validation </emphasis> button before clicking on <emphasis role="italic">Complete</emphasis> button to check reality of data. The event is only completed successfully if all validation is valid.</para>
</listitem>
<listitem>
- <para><emphasis role="italic">Identifier / Attribute</emphasis> tab - Load identifier-types and entity-attributes which belong to the selected program for users to enter values for this program.</para>
+ <para><emphasis role="italic">Attribute</emphasis> tab - Load identifier-types and entity-attributes which belong to the selected program for users to enter values for this program.</para>
</listitem>
<listitem>
<para><emphasis role="italic">Reschedule and set status</emphasis> tab - Provides function for re-scheduling, setting status and sending messages/comments or deleting for each events.</para>
@@ -859,6 +888,9 @@
<para><emphasis role="italic">Program report </emphasis>tab - Summary report for the program.</para>
</listitem>
</orderedlist>
+ <note>
+ <para>Belong to the authorities of the user logged, some tabs can be hidden.</para>
+ </note>
<para>The <emphasis role="italic">Active programs</emphasis> section consists of active programs of the entity. Click on a program to show detail information below. Besides, there are two link in this tab - </para>
<orderedlist>
<listitem>
@@ -871,7 +903,7 @@
<para>To enroll the entity into a program, click <emphasis role="italic">Enroll</emphasis> link.</para>
</listitem>
</orderedlist>
- <para>The <emphasis role="italic">Relationship</emphasis> section consists of relationships of the entity. Click on a entity in list to open his/her dashboard. Besides, there are two link in this tab - </para>
+ <para>The <emphasis role="italic">Relationship</emphasis> section consists of relationships of the entity. Click on an entity in list to open his/her dashboard. Besides, there are two link in this tab - </para>
<orderedlist>
<listitem>
<para>To open <emphasis role="italic">Relationship management</emphasis> section, click <emphasis role="italic">Management</emphasis> link.</para>
@@ -883,7 +915,7 @@
<para>Besides, the system audits user's information who accessed on the dashboard. Click on the <emphasis role="italic">History</emphasis> link in the header to display this information.</para>
</section>
<section>
- <title>entity enrollment</title>
+ <title>Enrollment</title>
<para>After the registration, the entity needs to be enrolled in any available program. To enroll -</para>
<orderedlist>
<listitem>
@@ -904,23 +936,23 @@
<para>1) <emphasis role="italic">Date of enrollment ( the first field )</emphasis> - The date when entity enrolls into the selected program.</para>
<para>2) <emphasis role="italic">Date of incident ( the second field )</emphasis> - The date when the entity got the disease or he/she has just been committed to an equivalent program for being followed-up.</para>
<warning>
- <para>If the selected program has any identifier types or entity attributes, they are displayed below. Users can enter values for them at this time.</para>
+ <para>If the selected program has any attributes, they are displayed below. Users can enter values for them at this time.</para>
<para>The <emphasis role="italic">date of incident</emphasis> are important to generate the activity plan for each entity. Health provider needs to ensure recording and reporting date of incidence with each case of multi events with registration. However, when to define a program, if it can be set <emphasis role="italic">Generated by enrollment date</emphasis> property as true, the activity plan is generated based on the enrollment date, not incident date. </para>
<para>However, the <emphasis role="italic">date of incident </emphasis>is ignored with single event programs. </para>
</warning>
</listitem>
<listitem>
<para>Click the <emphasis role="italic">Enroll</emphasis> button to complete the enrollment process.</para>
- <para>The system will automatically calculate due-date for each event of program and will show it in the <emphasis role="italic">Re-schedule and set status</emphasis> tab. In health programme, a entity registered and enrolled, needs to be checked from time to time by health providers.
-The case update is designed in the same manner so that services which are received by the entitys can be updated from time to time when they visit the facility or whenever the health providers need to <emphasis role="italic">track</emphasis>.</para>
- <para>The system will automatically calculate due-date for each the program stage and will show same the below enrollment. In health program, a entity registered and enrolled, needs to be checked from time to time by health providers.
-The case update is designed in the same manner so that services which are received by the entitys can be updated from time to time when they visit the facility or whenever the health providers need to track.</para>
+ <para>The system will automatically calculate due-date for each event of program and will show it in the <emphasis role="italic">Re-schedule and set status</emphasis> tab. In health programme, an entity registered and enrolled, needs to be checked from time to time by health providers.
+The case update is designed in the same manner so that services which are received by the entities can be updated from time to time when they visit the facility or whenever the health providers need to <emphasis role="italic">track</emphasis>.</para>
+ <para>The system will automatically calculate due-date for each the program stage and will show same the below enrollment. In health program, an entity registered and enrolled, needs to be checked from time to time by health providers.
+The case update is designed in the same manner so that services which are received by the entities can be updated from time to time when they visit the facility or whenever the health providers need to track.</para>
</listitem>
</orderedlist>
</section>
<section>
<title>Editing entity profile</title>
- <para>After registering a entity to a certain program, you can edit profile for that entity.</para>
+ <para>After registering an entity to a certain program, you can edit profile for that entity.</para>
<orderedlist>
<listitem>
<para>Click the second icon under <emphasis>Operations</emphasis>, corresponding to the entity you would like to edit. Or click the <emphasis>Edit profile</emphasis> link in Dashboard of entity.</para>
@@ -935,7 +967,7 @@
</section>
<section>
<title>Adding relationship</title>
- <para>To open <emphasis role="italic">relationship management</emphasis> for a entity, click on the <emphasis>Relationship management</emphasis> icon under <emphasis>Operations</emphasis> or click on the <emphasis role="italic">Management</emphasis> link on <emphasis role="italic">Relationships</emphasis> section in Dashboard. The management page appears...</para>
+ <para>To open <emphasis role="italic">relationship management</emphasis> for an entity, click on the <emphasis>Relationship management</emphasis> icon under <emphasis>Operations</emphasis> or click on the <emphasis role="italic">Management</emphasis> link on <emphasis role="italic">Relationships</emphasis> section in Dashboard. The management page appears...</para>
<screenshot>
<mediaobject>
<imageobject>
@@ -943,7 +975,7 @@
</imageobject>
</mediaobject>
</screenshot>
- <para>To add relationship for a entity, you have to click on <emphasis>Search available entity</emphasis> link to navigate to <emphasis>search page.</emphasis></para>
+ <para>To add relationship for an entity, you have to click on <emphasis>Search available entity</emphasis> link to navigate to <emphasis>search page.</emphasis></para>
<para>To register a new entity and create relationship with the selected entity, click <emphasis role="italic">Register new entity</emphasis> link.</para>
<para>To set a relative entity as representative, click on the <emphasis role="italic">Set as representative</emphasis> icon, the first icon under <emphasis>Operations</emphasis> according to the entity you would like.</para>
</section>
@@ -961,8 +993,8 @@
</screenshot>
</section>
<section>
- <title>Advanced search entitys</title>
- <para>The <emphasis>Advanced search</emphasis> function is used for searching available entitys based on full-name, identifiers and entity attribute values.</para>
+ <title>Advanced search entities</title>
+ <para>The <emphasis>Advanced search</emphasis> function is used for searching available entities based on full-name, identifiers and entity attribute values.</para>
<para>To access <emphasis role="italic">Advanced search</emphasis> function, from the
<emphasis>Services</emphasis> menu, go the <emphasis>Individual Records </emphasis>option and click on it. Select <emphasis>Find/Add entity</emphasis> option on
the left menu to proceed. Then, after selecting organisation unit, click on the
@@ -975,7 +1007,7 @@
</imageobject>
</mediaobject>
</screenshot>
- <para>After selecting a type for searching, entering keyword and clicking on <emphasis role="italic">Search</emphasis> button, the search result will display on the screen, and then user can interact with these entitys.</para>
+ <para>After selecting a type for searching, entering keyword and clicking on <emphasis role="italic">Search</emphasis> button, the search result will display on the screen, and then user can interact with these entities.</para>
<screenshot>
<mediaobject>
<imageobject>
@@ -983,16 +1015,12 @@
</imageobject>
</mediaobject>
</screenshot>
- <note>
- <para>Please check <emphasis role="italic">Search in all facilities</emphasis> checkbox
- for searching whole organisation hierarchy tree.</para>
- </note>
</section>
</section>
<section id="visit_schedule">
<title>Visit Schedule</title>
<para>This will be used to provide the user at a facility or in an area with a list of upcoming visits to better plan for daily/weekly activities. This can also be used as quick navigation to the data entry screen when using the system as a live/real-time data entry system.</para>
- <para>To access <emphasis role="italic">Visit Schedule </emphasis>module, from the <emphasis role="italic">Services</emphasis> menu, go to the<emphasis role="italic"> Individual Records </emphasis>option. Select <emphasis role="italic">Visit Schedule</emphasis> option on left menu. Visit schedule management is opened. </para>
+ <para>To access <emphasis role="italic">Visit Schedule </emphasis>module, from the <emphasis role="italic">Apps</emphasis> menu, go to the<emphasis role="italic"> Individual Records</emphasis>. Select <emphasis role="italic">Visit Schedule</emphasis> option on left menu. Visit schedule management form is opened. </para>
<para>To get visit schedule for a program, please do as follows - </para>
<orderedlist>
<listitem>
@@ -1005,7 +1033,7 @@
<para>Use data from level(s) - Specify the level which you need to get events. If the option is Children only, individual data will be get from the children of the selected organisation unit. If the option is Selected, individual data will be get from the selected organisation unit. If the option is All, individual data will be get from both selected organisation unit and its children.</para>
</listitem>
<listitem>
- <para>Click <emphasis role="italic">Show Event List</emphasis> button to generate visit schedule. The result is displayed below. And click <emphasis role="italic">Export XLS </emphasis>button to export the result to excel file.</para>
+ <para>Click <emphasis role="italic">Show Event List</emphasis> button to generate visit schedule. The result is displayed below.</para>
</listitem>
</orderedlist>
<screenshot>
@@ -1015,14 +1043,14 @@
</imageobject>
</mediaobject>
</screenshot>
- <para>Click active event below <emphasis role="italic">Program stage </emphasis>column or <emphasis role="italic">second icon</emphasis>, corresponding to the event which you would like to open the data entry screen.</para>
- <para>Click <emphasis role="italic">entity Dashboard</emphasis> icon, the <emphasis role="italic">first icon</emphasis> under <emphasis role="italic">Operations</emphasis>, corresponding to the event which you would like to open dashboard of the entity corresponding to the event.</para>
- <para>Click <emphasis role="italic">entity details and history</emphasis> icon, the <emphasis role="italic">third icon</emphasis> under <emphasis role="italic">Operations</emphasis>, corresponding to the event which you would like to open the entity history.</para>
+ <para>Click <emphasis role="italic">Events <emphasis role="italic">icon</emphasis>,</emphasis> <emphasis role="italic">first icon</emphasis> under <emphasis role="italic">Operations</emphasis>, corresponding to the entity which you would like to open event list according to the search event criteria. Then click on a date in event list to open the data entry screen.</para>
+ <para>Click <emphasis role="italic">Dashboard</emphasis> icon, the <emphasis role="italic">secord icon</emphasis> under <emphasis role="italic">Operations</emphasis>, corresponding to the entity which you would like to open dashboard of the entity corresponding to the event.</para>
+ <para>Click <emphasis role="italic">Tracked entity instance details and history</emphasis> icon, the <emphasis role="italic">third icon</emphasis> under <emphasis role="italic">Operations</emphasis>, corresponding to the entity which you would like to open the entity history.</para>
</section>
<section id="program_tracking">
<title>Lost to follow-up</title>
- <para>This function supports the work practices around tracking entitys within a health program that have not shown up for a scheduled visit, e.g. that are lost to follow-up.</para>
- <para>To access <emphasis role="italic">Program Tracking </emphasis>module, from the <emphasis role="italic">Services</emphasis> menu, go to the<emphasis role="italic"> Individual Records </emphasis>option and select <emphasis role="italic">Program Tracking</emphasis> option on left menu. </para>
+ <para>This function supports the work practices around tracking entities within a health program that have not shown up for a scheduled visit, e.g. that are lost to follow-up.</para>
+ <para>To access <emphasis role="italic">Lost to follow up </emphasis>module, from the <emphasis role="italic">Apps</emphasis> menu, go to the<emphasis role="italic"> Individual Records </emphasis>option and select <emphasis role="italic">Lost to follow up</emphasis> option on left menu. </para>
<para>To get tracking for a program, please do as follows - </para>
<orderedlist>
<listitem>
@@ -1048,10 +1076,11 @@
</imageobject>
</mediaobject>
</screenshot>
- <para>Click on an event to re-schedule and set status for the selected event or see all tracking history for this event.</para>
- <para>Click on <emphasis role="italic">entity's name</emphasis> link or <emphasis role="italic">entity Dashboard</emphasis> icon, the<emphasis role="italic"> first ico</emphasis>n under <emphasis role="italic">Operations</emphasis> to open his/her dashboard.</para>
- <para>Click <emphasis role="italic">entity details and history</emphasis> icon, the <emphasis role="italic">second icon</emphasis> under <emphasis role="italic">Operations</emphasis>, corresponding to the event which you would like to open the entity history.</para>
- <para>To search events by status and some criteria such as name, identifiers or attributes, click on <emphasis role="italic">Search</emphasis> button next to <emphasis role="italic">List All entitys</emphasis>. A advanced search criteria is shown. After to fill search key values, click on <emphasis role="italic">Search</emphasis> button on this form to display result or click on <emphasis role="italic">Send message</emphasis> button to send a reminder message for entity in result.</para>
+ <para>Click <emphasis role="italic">Events</emphasis> icon, <emphasis role="italic">first icon</emphasis> under <emphasis role="italic">Operations</emphasis>, corresponding to the entity which you would like to open event list according to the search event criteria. Then click on a date in event list to open the data entry screen.</para>
+ <para>Click on <emphasis role="italic">Dashboard</emphasis> icon, the<emphasis role="italic"> second ico</emphasis>n under <emphasis role="italic">Operations</emphasis> to open his/her dashboard.</para>
+ <para>Click on Edit icon, the <emphasis role="italic">third icon</emphasis> under <emphasis role="italic">Operations</emphasis> to edit program tracking information.</para>
+ <para>Click <emphasis role="italic">Tracked entity instance details and history</emphasis> icon, the <emphasis role="italic">forth icon</emphasis> under <emphasis role="italic">Operations</emphasis>, corresponding to the event which you would like to open the entity history.</para>
+ <para>To search events by status and some attributes, click on <emphasis role="italic">Advanced Search</emphasis> button. A advanced search criteria is shown. After filling search key values, click on <emphasis role="italic">Search</emphasis> button on this form to display result.</para>
<screenshot>
<mediaobject>
<imageobject>
@@ -1062,46 +1091,11 @@
</section>
<section>
<title>Data entry</title>
- <section id="multiple_individual_records">
- <title>Multiple individual records</title>
- <para>The multiple individual records function is where individual data is manually registered in the DHIS database. A list events with visited date as current date for each entity who enrolled into the selected program are displayed after clicking a multi events with registration.</para>
- <para>To access the multiple individual records function, from the <emphasis role="italic">Services</emphasis> menu, go to the <emphasis role="italic">Individual Records</emphasis> option and click on it. Select <emphasis role="italic">Multiple individual records</emphasis> option on left menu to proceed.</para>
- <para>To start enter data values, the first step is to open a list events of entity who enrolled a certain program by selecting a program in the list on the main page. Follow these steps:</para>
- <orderedlist>
- <listitem>
- <para>Locate the organisation unit you want to register data for in the tree menu to the left. Expand and close branches by clicking on the +/- symbols. A quick way to find an organisation unit is to use the search box just above the tree (the green symbol), but you need to write in the full name to get a match.</para>
- <para>The system loads multi events with registration which belong to the selected organisation unit.</para>
- </listitem>
- <listitem>
- <para>Select a <emphasis role="italic">program</emphasis> in the list </para>
- </listitem>
- <listitem>
- <para>Select an option in <emphasis role="italic">Schedule visits</emphasis> combobox to get events corresponding to the period options. There are three options, includes <emphasis role="italic">Today</emphasis>, <emphasis role="italic">Last 7 days</emphasis> and <emphasis role="italic">Last 30 days</emphasis>.</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="70" fileref="resources/images/patients_programs/multi_individual_records_list.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Click on <emphasis role="italic">entity's name</emphasis> link or <emphasis role="italic">entity Dashboard</emphasis> icon, the<emphasis role="italic"> first ico</emphasis>n under <emphasis role="italic">Operations</emphasis> to open his/her dashboard.</para>
- <para>Click on an <emphasis role="italic">event <emphasis role="italic">or</emphasis> the Reschedule and set status<emphasis role="italic"> icon</emphasis>, <emphasis role="italic">the <emphasis role="italic">second icon </emphasis><emphasis role="italic">
- <emphasis role="italic">under</emphasis>
- </emphasis></emphasis> Operations</emphasis> to re-schedule and set status for the selected event or see all tracking history for this event.</para>
- <para>To search events by status and some criteria such as name, identifiers or attributes, click on <emphasis role="italic">Search</emphasis> button next to <emphasis role="italic">List All entitys</emphasis>. A advanced search criteria is shown. After to fill search key values, click on <emphasis role="italic">Search</emphasis> button on this form to display result or click on <emphasis role="italic">Send message</emphasis> button to send a reminder message for entity in result.</para>
- </listitem>
- </orderedlist>
- <note>
- <para>You can see/post comments for each event into case entry form.</para>
- </note>
- </section>
<section id="single_event_with_registration">
<title>Single event with registration</title>
<para>The data to register is defined by a single event with registration program. The functionality supports health providers to register entity information and input data values for a program into one form.</para>
- <para>In order to register an event, from the <emphasis role="italic">Services</emphasis> option, go to the <emphasis role="italic">Individual Records</emphasis> option and click it. Then select <emphasis role="italic">Single event with registration</emphasis> option on left menu to proceed.</para>
- <para>To list all entitys in the selected facility, click <emphasis role="italic">List All entitys</emphasis> button.</para>
+ <para>In order to register an event, from the <emphasis role="italic">Apps</emphasis> option, go to the <emphasis role="italic">Individual Records</emphasis> and click it. Then select <emphasis role="italic">Single event with registration</emphasis> option on left menu to proceed.</para>
+ <para>To list all entities in the selected facility, click <emphasis role="italic">List All entities</emphasis> button.</para>
<para>To add new event, select a program in the combo box. And then click <emphasis role="italic">Add new</emphasis> button.</para>
<screenshot>
<mediaobject>
@@ -1113,42 +1107,19 @@
<para>To update event of a registered entity:</para>
<orderedlist>
<listitem>
- <para>Click <emphasis role="italic">Advanced search</emphasis> button. Then enter criterion for searching available entitys. The search result is displayed below. User can read the user guide for <emphasis>Advanced search</emphasis> function in <emphasis>entity registration</emphasis> section.</para>
+ <para>Click <emphasis role="italic">Advanced search</emphasis> button. Then enter criterion for searching available entities. The search result is displayed below. User can read the user guide for <emphasis>Advanced search</emphasis> function in <emphasis>entity registration</emphasis> section.</para>
</listitem>
<listitem>
<para>Click on <emphasis role="italic">Data entry</emphasis> icon - the first icon under <emphasis>Operations</emphasis>, corresponding to the entity you would like to edit, to update data values for the event.</para>
</listitem>
</orderedlist>
</section>
- <section id="single_event_without_registration">
- <title>Single event without registration</title>
- <para>The data to register is defined by a single event without registration program.</para>
- <para>To register an event, from the <emphasis role="italic">Services</emphasis> option, go to the <emphasis role="italic">Individual Records</emphasis> option and click it. Then select <emphasis role="italic">Single event without registration</emphasis> option on left menu to proceed.</para>
- <para>To list all events by program in the selected facility, select a program in list.</para>
- <para>To remove empty events of the selected program, click <emphasis role="italic">Remove empty events</emphasis> button.</para>
- <para>To add new event, click <emphasis role="italic">Add new</emphasis> button.</para>
- <para>To update an event -</para>
- <orderedlist>
- <listitem>
- <para>Click <emphasis role="italic">Search</emphasis> button. Then enter criterion for searching entity. The entity list are displayed below.</para>
- </listitem>
- <listitem>
- <para>Click on <emphasis role="italic">Data entry</emphasis> icon - the first icon, to update value for the event.</para>
- </listitem>
- </orderedlist>
- <note>
- <para>Currently, we supported offline functionality for single event without registration entry form.</para>
- </note>
- </section>
</section>
<section>
<title>Reports</title>
<para>The sub module provides two functions for individual reports -<itemizedlist>
<listitem>
- <para><emphasis role="italic">Program summary</emphasis> - View the summary report to get an overview of the services provided for a program.</para>
- </listitem>
- <listitem>
- <para><emphasis role="italic">Tabular report</emphasis> - An interactive reporting tool for tracker-data using tabular presentation with dynamic filters for each entity attribute and data element. </para>
+ <para><emphasis role="italic">Program Summary</emphasis> - View the summary report to get an overview of the services provided for a program.</para>
</listitem>
<listitem>
<para><emphasis role="italic">Statistical Program</emphasis> - Statistical reports on program performance, e.g. drop-out rates, how many completed every month/year - counts/percentages etc.</para>
@@ -1160,7 +1131,7 @@
<section id="program_summary_report">
<title>Program summary</title>
<para>The function provides a tool for generating summary list of individual information with color shown on program stages to identify status of receiving services in each stage.</para>
- <para>To access the program summary report, choose <emphasis role="italic">Services</emphasis> -> <emphasis role="italic">Individual Records</emphasis> > <emphasis role="italic">Program summary</emphasis>.</para>
+ <para>To access the program summary report, choose <emphasis role="italic">Apps</emphasis> > <emphasis role="italic">Individual Records</emphasis> > <emphasis role="italic">Program summary</emphasis>.</para>
<para>Select a <emphasis role="italic">organisation unit</emphasis> which provides services on the left menu. Then on the main page, select <emphasis role="italic">Program</emphasis>, <emphasis role="italic">Start date</emphasis>, <emphasis role="italic">End date </emphasis>to get period. After, select Use data from level(s). There are three levels <emphasis role="italic">Selected</emphasis>, <emphasis role="italic">Children Only</emphasis> and <emphasis role="italic">All</emphasis>. Finally, click <emphasis role="italic">Generate</emphasis> button. </para>
<para>The result is get based on the date of enrollment of each entity who registered the selected organisation unit and enrolled in the selected program in the interval from start-date and end-date what health provider entered.</para>
<screenshot>
@@ -1191,137 +1162,10 @@
</listitem>
</itemizedlist>
</section>
- <section>
- <title>Tabular report</title>
- <para>This is an interactive reporting tool for tracker-data using tabular presentation with dynamic filters for each entity attribute/data element.</para>
- <para>There are two types of reports. The first one is case-based report. It supports to
- filter events by each entity attributes and data elements. The second one is aggregate
- report. It allows for aggregation on simple filters and dynamic updates to report view
- based on changes to filters.</para>
- <para>To access the tabular report function, from the <emphasis role="italic">Services</emphasis> menu, go to the <emphasis role="italic">Individual Records</emphasis> option and click on it. Select <emphasis role="italic">Tabular report</emphasis> option below Reports header on left menu to proceed. </para>
- <para>To start a case-based report, the first step is to select a program in the list. Follow these steps -</para>
- <orderedlist>
- <listitem>
- <para>Select a program from list in the left panel. The system will be load data elements which belongs to the selected program.</para>
- </listitem>
- <listitem>
- <para>Choose start-date and end-date. The event list is loaded with report-date between the two dates.</para>
- </listitem>
- <listitem>
- <para>Select one or many <emphasis role="italic">organisation units</emphasis>.</para>
- </listitem>
- <listitem>
- <para>In <emphasis role="italic">Data element </emphasis>tab, Select a <emphasis role="italic">program stage</emphasis>. Double-click data elements which you need to show into the result to move it from <emphasis role="italic">Available</emphasis>field to the <emphasis role="italic">Selected</emphasis> field. Enter filter values for each data elements which you want into the fields below.</para>
- <note>
- <para>If the selected program has only one stage, this field is hidden and data element list of the stage is shown in the <emphasis role="italic">Available</emphasis> field.</para>
- </note>
- </listitem>
- <listitem>
- <para>In the Options tab, there are two options - </para>
- </listitem>
- </orderedlist>
- <itemizedlist>
- <listitem>
- <para><emphasis role="italic">Use data from level(s)</emphasis>: Specify the level which you need to get events -</para>
- <para>1)<emphasis role="italic"> Children only</emphasis>: Individual data will be aggregated from the children of the selected organisation unit.</para>
- <para>2) <emphasis role="italic">Selected</emphasis>: Individual data will be aggregated from the selected organisation unit. </para>
- <para>3) <emphasis role="italic">All</emphasis>: Individual data will be aggregated from both selected organisation unit and its children .</para>
- </listitem>
- <listitem>
- <para><emphasis role="italic">Show hierarchy from level:</emphasis> The level of organisation units which you want to show. E.g. If an event belongs to an organisation unit in district level and this option is selected as province level, the result is shown with the name of province.</para>
- </listitem>
- </itemizedlist>
- <orderedlist continuation="continues">
- <listitem>
- <para>Click <emphasis role="italic">Update</emphasis> button on toolbar. The result is shown on the main page.</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="60%" fileref="resources/images/patients_programs/tabular_report_result.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </orderedlist>
- <para>To start a aggregate report, the first step is to select a program in the list. Follow these steps:</para>
- <orderedlist>
- <listitem>
- <para>Select a program from list in the left panel. The system will be load data elements which belongs to the selected program.</para>
- </listitem>
- <listitem>
- <para>Select <emphasis role="italic">date</emphasis> period ranges / relative periods / fixed periods in corresponding tab.</para>
- </listitem>
- <listitem>
- <para>Select one or many <emphasis role="italic">organisation units</emphasis> by
- clicking on the hierarchy organisation tree or check on <emphasis role="italic">User organisation unit</emphasis> / <emphasis role="italic">User organisation unit children</emphasis> checkboxes. Besides, you can also select a group in list and
- system will load all organisation units which belong to the selected one.</para>
- </listitem>
- <listitem>
- <para>In <emphasis role="italic">Data filters </emphasis>tab, Select a <emphasis role="italic">program stage</emphasis>. Double-click data elements which you need to show into the result to move it from <emphasis role="italic">Available</emphasis>field to the <emphasis role="italic">Selected</emphasis> field</para>
- <note>
- <para>If the selected program has only one stage, this field is hidden and data element list of the stage is shown in the <emphasis role="italic">Available</emphasis> field.</para>
- </note>
- </listitem>
- <listitem>
- <para>In the Options tab, there are options as follows -</para>
- <para>1) <emphasis role="italic"> Position</emphasis> - Select positions for organisation unit, period and data. The system supports ten positions as follows - </para>
- <para><itemizedlist>
- <listitem>
- <para>Organisation unit: Rows; Period: Rows; Data: Filters </para>
- </listitem>
- <listitem>
- <para>Organisation unit: Rows; Period: Columns; Data: Filters </para>
- </listitem>
- <listitem>
- <para>Organisation unit: Rows; Period: Filters; Data: Filters</para>
- </listitem>
- <listitem>
- <para>Organisation unit: Rows; Period: Filters; Data: Columns</para>
- </listitem>
- <listitem>
- <para>Organisation unit: Columns; Period: Rows; Data: Filters</para>
- </listitem>
- <listitem>
- <para>Organisation unit: Columns; Period: Filters; Data: Rows</para>
- </listitem>
- <listitem>
- <para>Organisation unit: Filters; Period: Rows; Data: Filters</para>
- </listitem>
- <listitem>
- <para>Organisation unit: Filters; Period: Rows; Data: Columns</para>
- </listitem>
- <listitem>
- <para>Organisation unit: Filters; Period: Columns; Data: Rows</para>
- </listitem>
- <listitem>
- <para>Organisation unit: Filters; Period: Filters; Data: Rows</para>
- </listitem>
- </itemizedlist></para>
- <para>2) <emphasis role="italic">Aggregate type</emphasis> - Have three options. The
- first one is used for calculating number of events which satisfy the filters. The
- others are used for calculating sum/average data values of the select data element
- in <emphasis role="italic">Sum/Avg of </emphasis>option.</para>
- <para>3) <emphasis role="italic">Sum/Avg of </emphasis>- Select a number data element in list to calculate sum/avg data values of its if aggregate type option is sum or avg.</para>
- <para>4) <emphasis role="italic">Use completed events</emphasis> - Check it if you want to get only completed events.</para>
- <para>5) <emphasis role="italic">Use data from level(s) </emphasis>- Specify the level which you need to get events. If the option is <emphasis role="italic">Children only</emphasis>, individual data will be aggregated from the children of the selected organisation unit. If the option is <emphasis role="italic">Selected</emphasis>, individual data will be aggregated from the selected organisation unit. If the option is <emphasis role="italic">All</emphasis>, individual data will be aggregated from both selected organisation unit and its children.</para>
- <para>6) <emphasis role="italic">Group by</emphasis> - Group the result by data values of the selected data element.</para>
- <para>7) <emphasis role="italic">Limit records</emphasis> - Limit number of records in result returned.</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata width="80%" align="center" fileref="resources/images/patients_programs/aggregate_tabular_report.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- </orderedlist>
- <para>To save parameters on the left panel, click <emphasis role="italic">Favorites</emphasis> button on toolbar. The select <emphasis role="italic">Manage favorites</emphasis> option. A form is shown to enter name for favorite and click <emphasis role="italic">Save</emphasis> button.</para>
- <para>To export the result to excel file, click <emphasis role="italic">Download</emphasis> button, select XLS option. For the aggregate report, the system supports more two types of file as PDF and CSV.</para>
- </section>
<section id="program_statistics">
<title>Program Statistics </title>
<para>The tool provides a tool for generating a statistics report by program.</para>
- <para>To access <emphasis role="italic">Program Statistics</emphasis> module, from the <emphasis role="italic">Services</emphasis> menu, go to the <emphasis role="italic">Individual Records </emphasis>option. Select <emphasis role="italic">Program Statistics </emphasis>option on left menu. Program statistics is opened. </para>
+ <para>To access <emphasis role="italic">Program Statistics</emphasis> module, from the <emphasis role="italic">Apps</emphasis> menu, go to the <emphasis role="italic">Individual Records</emphasis>. Select <emphasis role="italic">Program Statistics </emphasis>option on left menu. Program statistics form is opened. </para>
<para>To get statistics report for a program, please do as follows -</para>
<orderedlist>
<listitem>
@@ -1347,7 +1191,7 @@
<para><emphasis role="italic">In result -</emphasis></para>
<orderedlist>
<listitem>
- <para><emphasis role="italic">Total new enrollments in this period</emphasis> - The number of entitys who enrolled the selected program from start-date to end-date.</para>
+ <para><emphasis role="italic">Total new enrollments in this period</emphasis> - The number of entities who enrolled the selected program from start-date to end-date.</para>
</listitem>
<listitem>
<para><emphasis role="italic">Total programs completed in this period </emphasis>- The number of programs completed.</para>
@@ -1392,9 +1236,9 @@
</section>
</section>
<section id="run_case_aggregation">
- <title>Manual entity aggregation</title>
- <para>The <emphasis role="italic">Manual entity Aggregation</emphasis> module is used for aggregating individual data and import into aggregated data element. </para>
- <para>To access <emphasis>Manual entity aggregation</emphasis> module, from the <emphasis role="italic">Services</emphasis> menu, go to the <emphasis role="italic">Individual Records</emphasis> option. Select <emphasis role="italic">Manual entity Aggregation</emphasis> option on left menu. <emphasis>Manual entity aggregation form</emphasis> is opened as below -</para>
+ <title>Manual aggregation</title>
+ <para>The <emphasis role="italic">Manual Aggregation</emphasis> module is used for aggregating individual data and import into aggregated data element. </para>
+ <para>To access <emphasis>Manual aggregation</emphasis> module, from the <emphasis role="italic">Apps</emphasis> menu, go to the <emphasis role="italic">Individual Records</emphasis>. Select <emphasis role="italic">Manual Aggregation</emphasis> option on left menu. <emphasis>Manual aggregation form</emphasis> is opened as below -</para>
<screenshot>
<mediaobject>
<imageobject>
@@ -1402,7 +1246,7 @@
</imageobject>
</mediaobject>
</screenshot>
- <para>In the <emphasis>entity aggregation form</emphasis> above</para>
+ <para>In the <emphasis>Manual aggregation</emphasis> form above - </para>
<orderedlist>
<listitem>
<para>Select <emphasis role="italic">dataset</emphasis> from Dataset List to get aggregate values. Note that only datasets which were assigned to at least one organisation unit will be shown in this list.</para>
