Configure programas no aplicativo de manutenção¶

Sobre programas¶

Traditionally, public health information systems have been reporting aggregated data of service provision across their health programs. This does not allow you to trace the people provided with these services. In DHIS2, you can define your own programs with stages. These programs are an essential part of the "tracker" functionality which lets you track individual records. You can also track other ‘entities’ such as wells or insurances. You can create two types of programs:

To create a program, you must first configure several types of metadata objects. You create these metadata objects in the Maintenance app.

Configure programas de eventos no aplicativo de manutenção¶

Sobre programas de eventos¶

Single event without registration programs are called event programs. You configure them in the Maintenance app. Event programs can have three types of data entry forms:

Note

• Custom forms take precedence over section forms if both are present.

• If no custom or section form is defined, the basic form will be used.

• The Android apps only support section forms.

You can create program notifications for event programs. The notifications are sent either via the internal DHIS2 messaging system, via e-mail or via text messages (SMS). You can use program notifications to, for example, send an automatic reminder to a tracked entity 10 days before a scheduled appointment. You use the program’s tracked entity attributes (for example first name) and program parameters (for example enrollment date) to create a notification template. In the Parameters field, you'll find a list of available tracked entity attributes and program parameters.

Fluxo de trabalho: crie um programa de evento¶

1. Insira os detalhes do programa do evento.

2. Atribuir elementos de dados.

3. Crie formulário (s) de entrada de dados: ** Básico **, ** Seção ** ou ** Personalizado **.

4. Atribua o programa à (s) unidade (s) de organização.

5. Crie notificações de programa.

Crie ou edite um programa de evento¶

Insira os detalhes do programa do evento¶

1. Abra o aplicativo de ** Manutenção ** e clique em ** Programa ** > ** Programa **.

2. Clique no botão Adicionar e selecione ** Programa de Evento ** no menu pop-up.

3. Insira os detalhes do programa e clique em Avançar.

   Field	Description
   Name	The name of the program.
   Color	Color used for this program in the data capture apps.
   Icon	Icon used for this program in the data capture apps.
   Short name	A short name of the program. The short name is used as the default chart or table title in the analytics apps.
   Description	A detailed description of the program.
   Version	The version of the program. This is used for example when people collect data offline in an Android implementation. When they go online and synchronize their metadata, they should get the latest version of the program.
   Category combination	The category combination you want to use. The default setting is None.
   Open days after category option end date	If you selected a category combination other than None, you may enter zero or a positive number. This lets you enter data for this program for a category option up to the specified number of days after that category option's end date.
   Completed events expiry date	Defines the number of days for which you can edit a completed event. This means that when an event is completed and the specified number of expiry days has passed, the event is locked. If you set "Completed events expiry days" to 10", an event is locked ten days after the completion date. After this date you can no longer edit the event.
   Expiry period type Expiry days	The expiry days defines for how many days after the end of the previous period, an event can be edited. The period type is defined by the expiry period type. This means that when the specified number of expiry days has passed since the end date of the previous period, the events from that period are locked. If you set the expiry type to "Monthly" and the expiry days to "10" and the month is October, then you can't add or edit an event to October after the 10th of November.
   User assignment of events	Select check box to enable user assignment of the event This means that in the form there will be a list of users to which the event can be assigned.
   Block entry form after completed	Select checkbox to block the entry form after completion of the event of this program. This means that the data in the entry form can't be changed until you reset the status to incomplete.
   Feature type	Sets whether the program is going to capture a geographical feature type or not. - None Nothing is captured. - Polygon An area is captured. For single event programs the area will be the area representing the event being captured. For tracker programs, the area will represent the area of the enrollment. - Point A point/coordinate is captured. For single event programs the point will be representing the event being captured. For tracker programs, the point will represent the enrollment.
   Validation strategy	Sets the server and client side validation requirement. Data type validation is always performed regardless of the validation strategy. An integer field is never stored containing text, for example. - On complete This option will enforce required field and error messages to be fixed when completing the event, but the event can be saved to the server without passing these validation requirements. For legacy reasons, this is always the validation strategy for tracker programs, where each data value in the event is stored to the server while entering data. - On update and insert This option will enforce required field validation when saving the event to the server regardless of the completion status. When using this option no events can be stored without passing validations.
   Pre-generate event UID	Select checkbox to pre-generate unique event id numbers.
   Custom label for report date	Type a description of the report date. This description is displayed in the case entry form.

4. Clique próximo.

Atribuir elementos de dados¶

1. Clique em ** Atribuir elementos de dados **.

2. In the list of available items, double-click the data elements you want to assign to the event program.

3. (Opcional) Para cada elemento de dados, adicione configurações adicionais:

   Setting	Description
   Compulsory	The value of this data element must be filled into data entry form before you can complete the event.
   Allow provided elsewhere	Specify if the value of this data element comes from other facility, not in the facility where this data is entered.
   Display in reports	Displays the value of this data element into the single event without registration data entry function.
   Date in future	Will allow user to select a date in future for date data elements.
   Mobile render type	Can be used to select different render types for mobile devices. Available options vary depending on the data element's value type. For example, for a numerical value you may select "Default", "Value", "Slider", "Linear scale", and "Spinner".
   Desktop render type	WARNING: NOT IMPLEMENTED YET. Can be used to select different render types for desktop (i.e. the web interface). Available options vary depending on the data element's value type. For example, for a numerical value you may select "Default", "Value", "Slider", "Linear scale", and "Spinner".

4. Clique próximo.

Crie formulários de entrada de dados¶

The data entry forms decide how the data elements will be displayed to the user in the Event Capture app.

1. Clique em ** Criar formulário de entrada de dados **.

2. Clique em ** Básico **, ** Seção ** ou ** Personalizado **.

3. To create a Basic data entry form: Drag and drop the data elements in the order you want.

4. Para criar um formulário de entrada de dados de ** Seção **:

   1. Click the add button and enter a section's name, description and render type for desktop and mobile.

   2. Clique na seção para que seja destacada por uma linha preta.

   3. Add data elements by clicking the plus sign next to the data elements' names.

   4. Repeat the above steps until you have all the sections you need.

   5. Change the section order: click the options menu, then drag the section to the place you want.

5. To create a Custom data entry form: Use the WYSIWYG editor to create a completely customized form. If you select Source, you can paste HTML code directly in the editing area. You can also insert images for example flags or logos.

6. Clique próximo.

Acesso¶

Access options decide who can capture data for the program or view/edit the program's metadata. A program can be shared to organisation units, and in addition, the main program and any program stages' access options can be configured through the Sharing dialog. Access options are available in the Access tab.

Atribuir unidades de organização:

1. In the organisation tree, double-click the organisation units you want to add to the program.

   You can locate an organisation unit in the tree by expanding the branches (click on the arrow symbol), or by searching for it by name. The selected organisation units display in orange.

Alterar funções e acesso:

1. Role para baixo até a seção ** Funções e acesso **.

   The first row shows the main program's access options, and each subsequent row shows the options of one program stage. Program stages with a warning icon (exclamation mark) contain access options that deviate from the main program, meaning they are accessed by a different combination of users.

2. Clique em uma das linhas e a ** caixa de diálogo Compartilhamento ** será exibida.

3. Modify the access options accordingly. See documentation on the sharing dialog for details.

4. Clique no botão ** Aplicar **.

5. Repeat the process for each program/program stage. You can also copy all access options from the main program to your child programs:

   1. Select the program stages you want to have similar access options as the main program by toggling the checkboxes on the right hand side of the program stages. You can also choose to Select all program stages, Deselect all program stages or Select similar stages, in terms of access options, to that of the main program. Similar stages are toggled by default.

   2. Clique em ** Aplicar aos estágios selecionados **

Criar notificações de programa¶

1. Crie a mensagem que deseja enviar:

   1. Clique em ** O que enviar? **.

   2. Insira um nome.

   3. Create the Subject template: Double-click the parameters in the Template variables field to add them to your subject.

      Note

      The subject is not included in text messages.

   4. Create the Message template: Double-click the parameter names in the Template variables list to add them to your message.

      Dear A{w75KJ2mc4zz}, You're now enrolled in V{program_name}.

2. Define when you want to send the message:

   1. Clique em ** Quando enviar? **.

   2. Selecione um ** Gatilho de notificação **.

      Notification trigger	Description
      Program stage completion	The program stage notification is sent when the program stage is completed
      Days scheduled (due date)	The program stage notification is sent XX number of days before or after the due date You need to enter the number of days before or after the scheduled date that the notification will be sent.

3. Define who you want to send the message to:

   1. Clique em ** Quem enviar? **.

   2. Selecione um ** Destinatário da notificação **.

      Notification recipient	Description
      Tracked entity instance	Receives program notifications via e-mail or text message. To receive a program notification, the recipient must have an e-mail address or a phone number attribute.
      Organisation unit contact	Receives program notifications via e-mail or text message. To receive a program notification, the receiving organisation unit must have a registered contact person with e-mail address and phone number.
      Users at organisation unit	All users registered to the selected organisation unit receive program notifications via the internal DHIS2 messaging system.
      User group	All members of the selected user group receive the program notifications via the internal DHIS2 messaging system
      Program attribute	Receives program notifications via e-mail or text message. To receive a program notification, the recipient must have an e-mail address or a phone number attribute.
      Data element	Receives program notifications via e-mail or text message. To receive a program notification, the recipient must have an e-mail address or a phone number data element.
      Web hook	TBA

   3. Click Save.

4. Repita as etapas acima para criar todas as notificações de programa de que você precisa.

5. Clique em Salvar.

Note

You configure when the program notifications are sent in the Data Administration app > Scheduling > Program notifications scheduler.

• Click Run now to send the program notifications immediately.

• Select a time and click Start to schedule the program notifications to be sent at a specific time.

Informações de referência: Parâmetros de notificação do programa¶

Configure programas rastreadores no aplicativo de manutenção¶

Sobre os programas Tracker¶

Single or multiple event programs with registration are called Tracker programs. A program must be specified with only one tracked entity. Only tracked entities that are the same as the tracked entity of program can enroll into that program. A program needs several types of metadata that you create in the Maintenance apps.

Fluxo de trabalho: crie um programa rastreador¶

1. Insira os detalhes do programa rastreador.

2. Insira os detalhes da inscrição.

3. Atribuir atributos e criar ** seção ** ou formulário de registro ** personalizado **.

4. Crie estágios do programa.

5. Configure o acesso e atribua às unidades de organização.

6. Criar programa e notificação (ões) de estágio do programa.

Crie ou edite um programa Tracker¶

1. Abra o aplicativo de ** Manutenção ** e clique em ** Programa ** > ** Programa **.

2. Clique no botão Adicionar e selecione ** Programa Rastreador ** no menu pop-up.

Insira os detalhes do programa¶

Enter enrollment details¶

Atribuir atributos de entidade rastreados.¶

1. In the list of Available program tracked entity attributes, double-click the attributes you want to assign to the program.

2. (Optional) For each assigned attribute, add additional settings:

1. Criar formulário de registro

O formulário de registro define como os atributos serão exibidos ao usuário em aplicativos de consumo, como Android e Tracker Capture.

1. Clique em ** Criar formulário de registro **.

2. Clique em ** Seção ** ou ** Personalizado **.

3. Para criar um formulário de ** Seção **:

    1. Clique no botão Adicionar e insira o nome da seção, a descrição e o tipo de renderização para desktop e celular.
    2. Clique na seção para que seja destacada por uma borda preta.
    3. Adicione elementos de dados clicando no sinal de mais ao lado do nome dos elementos de dados que deseja adicionar.
    4. Repeat above steps until you have all the sections you need.
        To change the section order: click the options menu, then drag the section to the place you want.

4. Para criar um formulário de registro ** Personalizado **: Use o editor WYSIWYG para criar um formulário totalmente personalizado. Se você selecionar Código-fonte, poderá colar o código HTML diretamente na área de edição. Você também pode inserir imagens como bandeiras ou logotipos.

5. Clique em adicionar estágio.

Crie estágios do programa¶

A program consists of program stages. A program stage defines which actions should be taken at each stage.

Note

Changes to a program stage are not saved until you save the program.

1. Clique no sinal de mais para criar um estágio do programa.
2. Enter program stage details:
   1. Insira um nome.
   2. (Optional) select a Color and an Icon that will be used by the data capture apps to identify this program stage.
   3. Insira uma ** Descrição **.
   4. Enter the required number of days into the Scheduled days from start field: The first event in this program stage will be scheduled this many days after the enrollment or the incident date, depending on the configuration. If Show incident date in Enrollment details is configured, the system will use incident date as start. If Generate events based on enrollment date in Program stage details is configured the system will use enrollment date as start.
3. Insira os detalhes do estágio do programa que podem ser repetidos.
   1. Especifique se o estágio do programa é ** Repetível ** ou não.
   2. Selecione um ** Tipo de período **.
   3. Clear Display generate event box after completed if you don't want to display Create new event box to create new event for a repeatable stage after you click Complete for an event of the stage in data entry form. This field is selected by default.
   4. Enter Standard interval days. This value will be the suggested interval between the last event in a repeatable stage and the scheduled date of the next event.
   5. (Optional) Select a Default next scheduled date. This will show a list of assigned data elements of type date. If an element is selected, the Tracker client will use this as the default scheduled date. The data element can be used by program rules to dynamically schedule intervals between events.
4. Insira os detalhes do formulário

1. Atribua elementos de dados ao estágio do programa:

   1. In the list of Available data elements, double-click the data elements you want to assign to the program stage.

   2. For each assigned data element, review the properties. You can select:

1. Crie formulários de entrada de dados para a fase do programa

   The data entry forms decide how the data elements will be displayed to the user in the Tracker Capture app.

2. Clique em ** Criar formulário de entrada de dados **.

3. Clique em ** Básico **, ** Seção ** ou ** Personalizado **.

4. To create a Basic data entry form: Drag and drop the data elements in the order you want.

5. Para criar um formulário de entrada de dados de ** Seção **:

   1. Click the add button and enter a section's name, description and render type for desktop and mobile.

   2. Clique na seção para que seja destacada por uma borda preta.

   3. Add data elements by clicking the plus sign next to the data elements' names.

   4. Repeat the above steps until you have all the sections you need.

   5. Change the section order: click the options menu, then drag the section to the place you want.

6. To create a Custom data entry form: Use the WYSIWYG editor to create a completely customized form. If you select Source, you can paste HTML code directly in the editing area. You can also insert images for example flags or logos.

7. Clique em adicionar estágio.

Acesso¶

Access options decide who can capture data for the program or view/edit the program's metadata. A program can be shared to organisation units, and in addition, the main program and any program stages' access options can be configured through the Sharing dialog. Access options are available in the Access tab.

Atribuir unidades de organização:

1. In the organisation tree, double-click the organisation units you want to add to the program.

   You can locate an organisation unit in the tree by expanding the branches (click on the arrow symbol), or by searching for it by name. The selected organisation units display in orange.

Alterar funções e acesso:

1. Role para baixo até a seção ** Funções e acesso **.

   The first row shows the main program's access options, and each subsequent row shows the options of one program stage. Program stages with a warning icon (exclamation mark) contain access options that deviate from the main program, meaning they are accessed by a different combination of users.

2. Clique em uma das linhas e a ** caixa de diálogo Compartilhamento ** será exibida.

3. Modify the access options accordingly. See documentation on the sharing dialog for details.

4. Clique no botão ** Aplicar **.

5. Repeat the process for each program/program stage. You can also copy all access options from the main program to your child programs:

   1. Select the program stages you want to have similar access options as the main program by toggling the checkboxes on the right hand side of the program stages. You can also choose to Select all program stages, Deselect all program stages or Select similar stages, in terms of access options, to that of the main program. Similar stages are toggled by default.

   2. Clique em ** Aplicar aos estágios selecionados **

Criar notificações de programa¶

You can create program notifications for programs with registration and their program stages. The notifications are sent either via the internal DHIS2 messaging system, via e-mail or via text messages (SMS). You can use program notifications to, for example, send an automatic reminder to a tracked entity 10 days before a scheduled appointment. You use the program’s tracked entity attributes (for example first name) and program parameters (for example enrollment date) to create a notification template.

1. Open the Maintenance app and click Program and then notifications.

   A list of existing program notifications for the selected program opens. If the program doesn't have any program notifications, the list is empty.

2. Clique no botão Adicionar e selecione ** Notificação do Programa **.

   

3. Insira um nome.

4. Crie o ** modelo de assunto **.

   Double-click the parameters in the Parameters field to add them to your subject.

   Note

   The subject is not included in text messages.

5. Crie o ** modelo de mensagem **.

   Double-click the parameter names in the Parameters field to add them to your message.

   Dear A{w75KJ2mc4zz}, You're now enrolled in V{program_name}.

6. In the When-to-send it field, select what should trigger the notification.

   Trigger	Description	Note
   Program enrollment	The program notification is sent when the TEI enrols in the program.	-
   Program completion	The program notification is sent when the program of TEI is completed	-
   Days scheduled (incident date)	The program notification is sent XX number of days before or after the incident date	You need to enter the number of days before or after the scheduled date that the notification will be sent.
   Days scheduled (enrollment date)	The program notification is sent XX number of days before or after the enrollment date	You need to enter the number of days before or after the scheduled date that the notification will be sent.
   Program Rule	Notification will be triggered as a result of program rule execution.	Program rule with ProgramRuleActionType.SENDMESSAGE need to be in place to make this trigger successful.

7. In the Who-to-send-it field, select who should receive the program notification.

   Recipient type	Description	Note
   Tracked entity instance	Receives program notifications via e-mail or text message.	To receive a program notification, the recipient must have an e-mail address or a phone number attribute.
   Organisation unit contact	Receives program notifications via e-mail or text message.	To receive a program notification, the receiving organisation unit must have a registered contact person with e-mail address and phone number.
   Users at organisation unit:	All users registered to the selected organisation unit receive program notifications via the internal DHIS2 messaging system.	-
   User group	All members of the selected user group receive the program notifications via the internal DHIS2 messaging system	-
   Limit To Hierarchy	Send notification only to those users who belong to any of the organisation unit in the hierarchy.	This option is only available when User Group is selected as recipient.
   Parent OrgUnit Only	Send notification only to those users who belong to parent organisation unit.	This option is only available when User Group is selected as recipient.
   Program Attribute	TrackedEntityAttribute can also be selected as recipient.	This parameter will only be effective if TrackedEntityAttribute value type is PHONE_NUMBER/EMAIL.

8. Clique em Salvar.

Crie uma notificação de estágio do programa¶

1. Open the Maintenance app and click Program and then notifications.

   A list of existing program stage notifications for the selected program stage opens. If the program stage doesn't have any program stage notifications, the list is empty.

2. Clique no botão Adicionar e selecione ** Notificação de estágio do programa **.

3. Clique em ** Adicionar novo **.

4. Insira um nome.

5. Crie o ** modelo de assunto **.

   Double-click the parameter names in the Parameters field to add them to your subject.

   Note

   The subject is not included in text messages.

6. Crie o ** modelo de mensagem **.

   Double-click the parameter names in the Parameters field to add them to your message.

   Dear A{w75KJ2mc4zz}, please come to your appointment the V{due_date}.

7. In the When-to-send-it field, select what should trigger the notification.

   Trigger	Description	Note
   Program stage completion	The program stage notification is sent when the program stage is completed	-
   Days scheduled (due date)	The program stage notification is sent XX number of days before or after the due date	You need to enter the number of days before or after the scheduled date that the notification will be sent.
   Program Rule	Notification will be triggered as a result of program rule execution.	Program rule with ProgramRuleActionType.SENDMESSAGE need to be in place to make this trigger successful.

   1. Allow notification to be sent multiple times

      This flag can be used if notification is required to be sent multiple times. For example in case of repeatable program stage, same notification will be sent as many times as the stage is repeated.

8. In the Recipients field, select who should receive the program stage notification. You can select:

   Recipient type	Description	Note
   Tracked entity instance	Receives program notifications via e-mail or text message.	To receive a program stage notification, the recipient must have an e-mail address or a phone number attribute.
   Organisation unit contact	Receives program notifications via e-mail or text message.	To receive a program stage notification, the receiving organisation unit must have a registered contact person with e-mail address and phone number. The system selects the same organisation unit as where the event took place.
   Users at organisation unit:	All users registered to the selected organisation unit receive program notifications via the internal DHIS2 messaging system.	-
   User group	All members of the selected user group receive the program notifications via the internal DHIS2 messaging system	-
   Limit To Hierarchy	Send notification only to those users who belong to any of the organisation unit in the hierarchy.	-
   Parent OrgUnit Only	Send notification only to those users who belong to parent organisation unit.	-
   Data Element	Data Element associated with ProgramStage can be selected as recipient.	Data Element will only be effective if DataElement has value type PHONE_NUMBER/EMAIL.
   Tracked Entity Attribute	Tracked Entity Attribute associated with ProgramInstance/Enrollment can be selected as recipient.	Attribute will only be effective if it has value type PHONE_NUMBER/EMAIL.
   Web Hook	Web hooks are automated HTTP messages sent to an external URL configured in web hook URL field. Notification template variables will be sent as key-value pairs in the HTTP request.	-

9. Clique em Salvar.

Informações de referência: Parâmetros de notificação do programa¶

Configurar indicadores de programa¶

Sobre os indicadores do programa¶

Program indicators are expressions based on data elements and attributes of tracked entities which can be used to calculate values based on a formula. Program indicators consist of an aggregation type, an analytics type, an expression and a filter.

Program indicators are evaluated based on the assigned aggregation type, expression and filter. The order of evaluation is:

1. The filter will filter the events which become part of the evaluation/aggregation routine.

2. The expression will be evaluated per event.

3. All evaluated expression values will be aggregated according to the aggregation type of the program indicator.

In the Maintenance app, you manage the following program indicator objects:

Crie ou edite um indicador de programa¶

** Nota **

Um indicador de programa pertence a exatamente um programa.

1. Open the Maintenance app and click Indicator > Program indicator.

2. Clique no botão adicionar.

3. Selecione um ** Programa ** e digite:

   • Nome

   • Nome curto

   • Código

   • Cor

   • Ícone

   • Descrição

   • Selecione o número de ** decimais na saída de dados **.

4. Selecione um ** Tipo de agregação **.

5. Select if you want to Display in form.

6. Atribua uma ou várias ** Legenda ** s.

7. (Optional) Enter a Category option combination for aggregate data export.

8. (Optional) Enter an Attribute option combination for aggregate data export.

9. Crie a expressão.

   1. Clique em ** Editar expressão **.

   2. Create the expression based on mathematical operators and the attributes, variables and constants listed to the right.

10. Crie o filtro.

    1. Clique em ** Editar filtro **.

    2. Create the expression based on mathematical operators and the attributes, variables and constants listed to the right.

11. Clique em Salvar.

Criar ou editar um grupo indicador de programa¶

1. Open the Maintenance app and click Indicator > Program indicator group.

2. Clique no botão adicionar.

3. Insira ** Nome ** e ** Código **.

4. In the list of available program indicators, double-click the program indicators you want to assign to your group.

5. Clique em Salvar.

Informações de referência: exemplos de expressão e filtro por tipo de valor¶

The table below shows examples of how to write expressions and filters for different data element and attribute value types:

Informações de referência: funções, variáveis e operadores para usar em expressões e filtros de indicadores de programa¶

An expression that includes both attributes, data elements and constants looks like this:

(A {GPkGfbmArby} + # {mCXR7u4kNBW.NFkjsNiQ9PH}) * C {bCqvfPR02Im}

An expression which uses the custom aggregation type and hence can use inline aggregation types looks like this:

(sum (# {mCXR7u4kNBW.K0A4BauXJDl} * # {mCXR7u4kNBW.NFkjsNiQ9PH}) / sum (# {mCXR7u4kNBW.NFkjsNiQ9PH})) * 100

Note how the "sum" aggregation operator is used inside the expression itself.

Adding comments in program indicator expression or filter¶

Uniform syntax is supported for both singleline and multiline comments

d2:hasValue(#{mCXR7u4kNBW.NFkjsNiQ9PH}) /* this is comment */

d2:hasValue(#{mCXR7u4kNBW.NFkjsNiQ9PH}) && /* this is 
comment */
d2:daysBetween(V{enrollment_date},PS_EVENTDATE:mCXR7u4kNBW)

Funções para usar em uma expressão ou filtro de indicador de programa¶

The program indicator expression and filter support a range of functions. The functions can be applied to data elements and attributes:

Um filtro que usa a função "hasValue" tem a seguinte aparência:

d2: hasValue (# {mCXR7u4kNBW.NFkjsNiQ9PH})

Um filtro que usa a função "relationshipCount (relationshipTypeUid)" tem a seguinte aparência:

d2: relationshipCount ('KLkjshoQ90U')

A filter that uses the "is( x in y, z )" function looks like this:

is(#{oahc9ooVema} in 'New', 'Relapse')

Uma expressão que usa as funções "zing" e "oizp" tem esta aparência:

d2: zing (A {GPkGfbmArby}) + d2: oizp (# {mCXR7u4kNBW.NFkjsNiQ9PH}))

Uma expressão que usa a função "daysBetween" tem a seguinte aparência:

d2: daysBetween (# {mCXR7u4kNBW.k8ja2Aif1Ae}, '2015-06-01')

Uma expressão que usa a função "yearBetween" para comparar o último evento do estágio do programa 'mCXR7u4kNBW' com a data de inscrição se parece com isto:

d2: dias entre (V {enrollment_date}, PS_EVENTDATE: mCXR7u4kNBW)

Uma expressão que usa a função "condição" tem a seguinte aparência:

d2: condição ('# {mCXR7u4kNBW.NFkjsNiQ9PH}> 100', 150,50)

Uma expressão que usa a função "countIfValue" para contar apenas o número de vezes que o valor 10 foi coletado tem a seguinte aparência:

d2: countIfValue (# {mCXR7u4kNBW.NFkjsNiQ9PH}), 10)

Uma expressão que usa a função "zpvc" tem esta aparência:

d2: zpvc (A {GPkGfbmArby}), # {mCXR7u4kNBW.NFkjsNiQ9PH}), 4, -1)

Uma expressão que usa as funções "if" e "isnull" tem a seguinte aparência:

if (isNull (A {GPkGfbmArby}), 10,20)

Uma expressão que usa a função "firstNonNull" tem a seguinte aparência:

firstNonNull (A {GPkGfbmArby}), # {mCXR7u4kNBW.NFkjsNiQ9PH}, 44)

Uma expressão que usa a função "maior" tem esta aparência:

maior (# {mCXR7u4kNBW.k8ja2Aif1Ae}, # {mCXR7u4kNBW.NFkjsNiQ9PH}, 1)

Variáveis para usar em uma expressão ou filtro de indicador de programa¶

The program indicator expression and filter support a range of variables:

A filter that uses the "Analytics period end" variable to only include women who has an LMP that would be in the first trimester:

d2: daysBetween (# {WZbXY0S00lP.w4ky6EkVahL}, V {analytics_period_end}) <= 84

An expression that uses the "value count" variable looks like this:

(# {A03MvHHogjR.a3kGcGDCuk6} + # {A03MvHHogjR.wQLfBvPrXqq}) / V {value_count}

An expression that uses the "event_date" and "incident_date" variables looks like this:

d2: daysBetween (V {incident_date}, V {event_date})

Operadores para usar em um filtro de indicador de programa¶

These operators can be used to form logical expressions which ultimately evaluate to either true or false. For example you can assert that multiple data elements must be a specific value, or that specific attributes must have numerical values less or greater than a constant.

Um filtro que usa atributos e elementos de dados tem a seguinte aparência:

A {cejWyOfXge6} == 'Feminino' e # {A03MvHHogjR.a3kGcGDCuk6} <= 2

Tip

DHIS2 is using the JEXL library for evaluating expressions which supports additional syntax beyond what is covered in this documentation. See the reference at the project home page to learn how you can create more sophisticated expressions

Setting up new Program disaggregation Mappings¶

DHIS2 v42 introduces the ability to assign Disaggregation Category Combinations to a Program Indicator and create a mapping between the program data and each category option contained in the combination. This creates a relationship between the tracker and aggregate data models which allows for analysing individual data in the same way and alongside aggregated data.

The Program Indicator Disaggregation mappings, defined at the Program level, provide a connection between the two data models within DHIS2. This ultimately allows a user to create disaggregated views of program data within the Data Visualizer using a single Program Indicator where previously one for each disaggregation was needed.

1. Install or update the new Maintenance app (Preview)

   If your instance does not already have the new version of the maintenance app installed go to the App Management App and search for Maintenance in the App Hub and install the app. If you already have it installed, then you should update the app to the latest version. Updates to this app are continuously released so it is good to make sure that you are using the most recent release.

   

2. Load the Program Disaggregation section of the Maintenance (Preview) App by selecting Program Disaggregations under the Other section or browsing to yourinstanceurl/apps/maintenance-preview#/programDisaggregations/

   

3. Select a Program from the drop down to enter the edit section and add Mappings to, for this example we will use the Inpatient morbidity and mortality program

4. This will load the Program Indicator Mapping and Categories definition screen

   

5. Select a Program Indicator from the drop down list, in this example we will use BMI

6. Under Disaggregation category combination Select Gender and U5y (you may need to create a new category combination containing the categories Gender and Under 5/5 and above of age if not present)

   

   Loading this category combination will display the Mapping selection drop down for each of the categories defined, as this is the first time these categories have been selected there are no mappings currently available.

7. Under the Disaggregation categories section you should see both of the categories from the combination added as suggestion. Click Add category for both Gender and U5y

   

Create the category mappings¶

1. In the text field under each Category enter an expression using the Program Data Elements and Attributes that defines the category. The expression uses the same syntax as the Filter section of the Program Indicator creation screen. It is recommended to open a Program Indicator within the Program you are mapping, use the Filter screen to construct the expression and then copy it into this field. This allows you to use the inbuilt expression validation of the Program Indicator filter builder. Program Indicator functions and Variale operators

   

   This example is linking the value selected in the Gender data element in the Program to the category option. Since the Option set in this case is a text field the expression is set to match the text ‘Female’. The next example for age shows a different way to define the relationship.

   

   To add the mapping for the Under 5 years and 5 years and above, since it is a numerical field you can use the operators > >= < <= == != to define the relationship

   

2. When mappings for all the category options are complete, click Save and exit

3. Open Data Visualizer, first let’s look at how these data were previously displayed. To do this create a visualisation to show the data of the 5 existing Program indicators with the built in disaggregations shown below.

   

   

4. Now remove the 4 Program Indicators with disaggregations specified and leave only the BMI Program Indicator.

   

5. You can now add Gender and Under 5/5 and above of age as disaggregation categories from the Your Dimensions column for the Program Indicator, click update and see the results.

   

   You can now compare the data from the two separate program indicators and the single program indicator that has been disaggregated.

Transferring Program Indicator data via the Aggregate data exchange app¶

In addition to viewing a disaggregated Program Indicator in the Data Visualiser you can now transfer the Program Data, via the Disaggregated Program indicator, into a Data Element that shares the same Category Combination.

By adding the ID of a Data Element in the Data element for aggregate data export field and then setting up the aggregate data exchange app* to transfer data you can save Program data in the aggregate data model

Configurar regras de programa¶

Sobre as regras do programa¶

Program rules allow you to create and control dynamic behaviour of the user interface in the Tracker Capture and Event Capture apps. During data entry, the program rules expressions are evaluated each time the user interface is displayed, and each time a data element is changed. Most types of actions will take effect immediately when the user enters values in the Tracker Capture and Event Capture apps.

In the Maintenance app, you manage the following program rule objects:

Fluxo de Trabalho¶

1. In the Maintenance app, create program rule variable(s) if needed.

2. No aplicativo ** Manutenção **, crie a regra do programa:

   1. Insira os detalhes da regra do programa.

   2. Crie a expressão de regra do programa.

   3. Defina as ações da regra do programa.

3. In the Tracker Capture or Event Capture apps, verify that the program rule behaves as expected.

Crie ou edite uma variável de regra de programa¶

1. Open the Maintenance app and click Program > Program rule variable.

2. Clique no botão adicionar.

3. Select a Program and enter a Name

   Please note that the name of the program may not contain any of the following excluded keywords: - and - or - not

4. Selecione se deseja ** Usar código para conjunto de opções **.

   This option is only effective when the data element or tracked entity attribute is connected to an option set. If you don't select this option, the program rule variable will be populated with the option set's name. If you select the option, the program rule variable will be populated with the option set's code instead.

5. Selecione um ** Tipo de fonte ** e insira as informações necessárias.

   Depending on the source type, you'll have to select, for example, a Program stage, Data element or Tracked entity attribute.

   The source types determine how the program rule variable is populated with a value.

   Source type	Description
   Data element from the newest event for a program stage	This source type works the same way as Data element from the newest event in the current program, except that it only evaluates values from one program stage. This source type can be useful in program rules where the same data element is used in several program stages, and a rule needs to evaluate the newest data value from within one specific stage. In order to know what event is the newest, the report date (event date) is used. If you have many events with the same report date, the system choose the one with the latest createdAt property of the event.
   Data element from the newest event in the current program	This source type is used when a program rule variable needs to reflect the newest known value of a data element, regardless of what event the user currently has open. This source type is populated slightly differently in Tracker Capture and Event Capture apps: Tracker Capture: the program rule variable will be populated with the newest data value collected for the given data element within the enrollment. Event Capture: the program rule variable will be populated with the current events data. NB Future dates are "newer" than current or past dates. In order to know what event is the newest, the report date (event date) is used. If you have many events with the same report date, the system choose the one with the latest createdAt property of the event.
   Data element in current event	Program rule variables with this source type will contain the data value from the same event that the user currently has open. This is the most commonly used source type, especially for skip logic (hide actions) and warning/error rules.
   Data element from previous event	Program rule variables with this source type will contain the value from a specified data element from a previous event. Only older events is evaluated, not including the event that the user currently has open. This source type is commonly used when a data element only should be collected once during an enrollment, and should be hidden in subsequent events. Another use case is making rules for validating input where there is an expected progression from one event to the next - a rule can evaluate whether the previous value is higher/lower and give a warning if an unexpected value is entered.
   Calculated value	Program rule variable with this source type is not connected directly to any form data - but will be populated as a result of some other program rules ASSIGN action. This variable will be used for making preliminary calculations, having a ASSIGN program rule action and assigning a value, this value can be used by other program rules - potentially making the expressions simpler and more maintainable. These variables will not be persisted and will stay in memory only during the execution of the set of program rules. Any program rule that assigns a data value to a preliminary calculated value would normally also have a priority assigned - to make sure that the preliminary calculation is done before the rule that consumes the calculated value.
   Tracked entity attribute	Populates the program rule variable with a specified tracked entity attribute for the current enrollment. Use this is the source type to create program rules that evaluate data values entered during registration. This source type is also useful when you create program rules that compare data in events to data entered during registration. This source type is only used for tracker programs (programs with registration).

6. Clique em Salvar.

Crie ou edite uma regra de programa¶

** Nota **

Uma regra de programa pertence a exatamente um programa.

1. Open the Maintenance app and click Program > Program rule.

2. Clique no botão adicionar.

3. Enter the program rule details. These fields are not shown to the end user, they are only meant for the program administrator.

   • Programa

   • ** Regra de gatilho apenas para a fase do programa **

     If a program stage is selected, the program rule will only run for the selected program stage, as opposed to being run for every program stage in the program.

   • Nome

   • Descrição

   • Prioridade

     Let's say you have 16 program rules in your program. You configure the program rules with the following priority settings:

     • Prioridade 1 para regra de programa A

     • Prioridade 2 para regras de programa B - K

     • Sem prioridade para regras de programa L - P

     Result: the system runs the program rules in the following order:

     1. Regra do programa A

     2. Program rules B - K (you can't find out or configure in which order the system runs these program rules)

     3. Regras do programa L - P.

4. Click Enter program rule expression and create the program rule expression with the help of variables, functions and operators.

5. Click Define program rule actions and create the actions executed when the expression is true.

   1. Click the add button, select an Action and enter the required information.

      Depending on the action type, you'll have to perform different types of settings. For some action types, you must also enter free text or create expressions.

      Action type	Required settings	Description
      Assign value	Data element to assign value to Tracked entity attribute to assign value to Program rule variable to assign value to Expression to evaluate and assign	Used to help the user calculate and fill out fields in the data entry form. The idea is that the user shouldn’t have to fill in values that the system can calculate, for example BMI. When a field is assigned a value, the user sees the value but the user can't edit it. NOTE: To assign a value to a tracked entity attribute, the user needs to open the tracked entity profile widget for the rule to trigger. Example from Immunization stock card i Zambia: The data element for vaccine stock outgoing balance is calculated based on the data element for incoming stock balance minus the data elements for consumption and wastage. Advanced use: configure an 'assign value' to do a part of a calculation and then assign the result of the calculation to a program rule variable. This is the purpose with the "Calculated value" program rule variable.
      Display text	Display widget Static text Expression to evaluate and display after static text	Used to display information that is not an error or a warning, for example feedback to the user. You can also use this action to display important information, for example the patient's allergies, to the user.
      Display key/value pair	Display widget Key label Expression to evaluate and display as value	Used to display information that is not an error or a warning. Example: calculate number of weeks and days in a pregnancy and display it in the format the clinician is used to see it in. The calculation is based on previous recorded data.
      Error on complete	Data element to display error next to Tracked entity attribute to display error next to Static text Expression to evaluate and display after static text	Used whenever you've cross-consistencies in the form that must be strictly adhered to. This action prevents the user from continuing until the error is resolved. This action differs from the regular Show error since the error is not shown until the user tries to actually complete the form. If you don't select a data element or a tracked entity attribute to display the error next to, make sure you write a comprehensive error message that helps the user to fix the error.
      Hide field	Data element to hide Tracked entity attribute to hide Custom message for blanked field	Used when you want to hide a field from the user. Custom message for blanked field allows you to define a custom message displayed to the user in case the program rule hides and blanks out the field after the user typed in or selected a value. If a hide field action hides a field that contains a value, the field will always removed. If no message is defined, a standard message will be displayed to alert the user.
      Hide section	Program stage section to hide	Used when you want to hide a section in a program stage from the user.
      Prevent adding new events to stage	Program stage where users will not be able to add new events	Used when you do not want users to add any more events to a program stage. Existing events will not be hidden.
      Make field mandatory	Data element to make mandatory Tracked entity attribute to make mandatory	Used when you want to make a data element or tracked entity attribute mandatory so they have to be filled out before the form can be saved.
      Show error	Data element to display error next to Tracked entity attribute to display error next to Static text Expression to evaluate and display after static text	Used whenever there are rules which must strictly be adhered to. The show error action prevents the user from continuing until the error is resolved. Such a strict validation should only be used when it's certain that the evaluated expression is never true unless the user has made a mistake in data entry. It's mandatory to define a message that is shown to the user when the expression is true and the action is triggered. You can select which data element or tracked entity attribute to link the error to. This will help the user to fix the error. In case several data elements or attributes are involved, select the one that is most likely that the user would need to change.
      Show warning	Data element to display warning next to Tracked entity attribute to display warning next to Static text Expression to evaluate and display after static text	Used to give the user a warning about the entered data, but at the same time to allow the user to save and continue. You can use warnings to help the user avoid errors in the entered data, while at the same time allow the user to consciously disregard the warnings and save a value that is outside preset expectations. Static text defines the message shown to the user when the expression is true and the action is triggered. You can select which data element or tracked entity attribute to link the error to. This will help the user to fix the error. In case several data elements or attributes are involved, select the one that is most likely that the user would need to change.
      Warning on complete	Data element to display warning next to Tracked entity attribute to display warning next to Static text Expression to evaluate and display after static text	Used to give the user a warning if he/she tries to complete inconsistent data, but at the same time to allow the user to continue. The warning is shown in a dialog when the user completes the form. Static text defines the message shown to the user when the expression is true and the action is triggered. This field is mandatory. You can select which data element or tracked entity attribute to link the error to. This will help the user to fix the error. If you don't select a data element or a tracked entity attribute to display the error next to, make sure you write a comprehensive error message that helps the user to fix the error.
      Send Message	Message template to send	Send Message triggers a notification based on provided message template. This action will be taken immediately. The message template will be parsed and variables will be substituted with actual values.
      Schedule Message	Message template to send Data field which contains expression to evaluate the date which notification should be sent at. If this expression results in any value other than Date, then resultant will be discarded and notification will not get scheduled.	Schedule Message will schedule notification at date provided by Expression in the data field. Sample expression is given below d2:addDays( '2018-04-20', '2' ) Message template will be parsed and variables will be substituted with actual values.
      Schedule event	Program stage to schedule event for Expression to evaluate the scheduled date	Automatically schedules a new event for the specified program stage on the date returned by the expression. The expression must evaluate to a valid date; if it does not, no event will be scheduled. The event is only scheduled once — if the rule condition evaluates to true again, no duplicate event is created. Useful for programs where the timing of the next visit or follow-up can be derived from existing data, for example scheduling a second vaccination dose a fixed number of days after the first. Example expression that schedules an event 28 days after a recorded date: d2:addDays(#{dateOfFirstDose}, 28)
      Hide option	Data element to hide option for Tracked entity attribute to hide option for Option that should be hidden	Used to selectively hide a single option for an option set in a given data element/tracked entity attribute. When combined with show option group the hide option takes precedence.
      Hide option group	Data element to hide option group for Tracked entity attribute to hide option group for Option group that should be hidden	Used to hide all options in a given option group and data element/tracked entity attribute. When combined with show option group the hide option group takes precedence.
      Show option group	Data element to show option group for Tracked entity attribute to show option group for Option group that should be shown	Used to show only options from a given option group in a given data element/tracked entity attribute. To show an option group implicitly hides all options that is not part of the group(s) that is shown.

   2. Click Save.

   3. (Optional) Repeat above steps to add more actions.

6. Clique em Salvar.

Exemplo: regras do programa¶

Note

You can view all examples on the demo server: https://play.dhis2.org/dev/dhis-web-maintenance/#/list/programSection/programRule

This example shows how to configure a program rule which calculates number of weeks and days in a pregnancy and display the result in the format the clinician is used to see it in. The calculation is based on previous recorded data.

1. 

2. 

3. 

   A expressão completa no campo ** Dados **:

   d2: concatenar (d2: semanasEntre (# {lmp}, V {current_date}), '+',
   d2: módulo (d2: daysBetween (# {lmp}, V {current_date}), 7))
   

This example shows how to configure a program rule to display text in the Feedback widget in the Tracker Capture app.

This example shows how to configure a program rule to always display certain data in the Feedback widget in the Tracker Capture app. This is useful when you want to make sure that vital data, for example medicine allergies, is always visible.

By using a program rule of type "Assign value" you can calculate the "Gestational age at visit" value and fill it in the data entry form. You configure the program rule to calculate "Gestational age at visit" based on either "LMP date" or "Ultrasound estimated due date".

Informações de referência: operadores e funções para usar na expressão de regra de programa¶

Note

When using absolute dates in program rule expressions, always use 'YYYY-MM-DD' date format irrespective of the System Date format setting.

Tip

You can nest functions within each other and with sub-expressions to form more complex conditions. An example that produces the gestational age in weeks, based on last menstrual date:

d2:floor( d2:daysBetween(#{lastMenstrualDate},V{event_date}) / 7 )

Tip

The source type will determine how the d2: function calls will evaluate a (sourcefield) parameter.

Example: where #{hemoglobinCurrent} is set to source type Data element in current event. The following function call with evaluate whether haemoglobin is entered in the current event.

d2:hasValue( 'hemoglobinCurrent' )

Example: where #{hemoglobin} is set to source type Data element from the newest event in the current program. The following function call with evaluate whether there exists a value for the haemoglobin in any event in the enrollment.

d2:hasValue( 'hemoglobin' )

Example: where #{hemoglobinPrevious} is set to source type Data element from previous event . The following function call with evaluate whether there exists a value for the haemoglobin among the events preceding the current event.

d2:hasValue( 'hemoglobinPrevious' )

Configurar tipos de relacionamento¶

Sobre tipos de relacionamento¶

A relationship represents a link between two entities in the Tracker-model. A relationship is considered data in DHIS2 and is based on a Relationship Type, similar to how a Tracked Entity is based on a Tracked Entity Type.

Relationships always include two entities, and these entities can include Tracked Entities, Enrollments and Events, and any combination of these.

[!NOTE] Note that not all of these combinations are available in the current apps. Currently in the Capture app, you can create: * Tracked Entity to Tracked Entity Relationships * Event in Event Programs to Tracked Entity Relationships (Only from the Event side) * Event in one Program Stage to Event in another Program Stage in the same Program (Related stages - see more information here)

Além disso, os relacionamentos podem ser definidos como unidirecionais ou bidirecionais. A única diferença funcional atualmente é que eles requerem diferentes níveis de acesso para criar. Os relacionamentos unidirecionais requerem que o usuário tenha acesso de gravação de dados para a entidade “de” e acesso de leitura de dados para a entidade “para”, enquanto os relacionamentos bidirecionais requerem acesso de gravação de dados para ambos os lados.

For more information about configuration and the meaning of 'From constraint' and 'To constraint', see Relationship model.

Criar ou editar um tipo de relacionamento¶

1. Open the Maintenance app and click Program > Relationship type.

2. Clique no botão adicionar.

3. Digite um ** Nome ** do tipo de relacionamento.

4. (Opcional) Atribua um ** Código **.

5. (Opcional) Forneça uma ** Descrição ** do relacionamento.

6. (Opcional) Selecione se o relacionamento deve ser bidirecional

7. Provide Relationship name seen from initiating entity. This is the name of the relationship that will be shown in the Data Entry app at the 'left' side of the relationship. E.g. in a Mother-child relationship this could be 'Mother of'.

8. (Opcional) Forneça ** Nome do relacionamento visto da entidade receptora **. Este é o nome do relacionamento que será mostrado no lado 'direito' do relacionamento no aplicativo de entrada de dados. Por exemplo. em um relacionamento mãe-filho, pode ser 'mãe'.

9. Select a 'From constraint'. This limits what kind of entities can be included in the relationship. Relationship model. After selecting a 'From constraint', you have the option to choose which attributes or data elements should be shown in the relationship widget in Tracker Capture and Capture for the "From constraint". The list will vary based on the constraint:

   • When selecting “Tracked Entity Instance”, then a Tracked Entity Type only, choose between the configured Tracked Entity Type Attributes
   • When selecting “Tracked Entity Instance”, then a Tracked Entity Type and a Program, choose between the attributes that have been configured for both the Tracked Entity Type and for the Program
   • When selecting “Enrollment in program”, choose between the attributes that have been configured for the Program
   • When selecting “Event in program or program stage”, choose between the data elements that have been configured for that Event program or Program stage

10. Select a 'To constraint'. This limits what kind of entities that can be included in the relationship. Relationship model. Repeat the selection of attributes or data elements that should be shown in the relationship widget for the "To constraint".

11. Clique em Salvar.

Configurar tipos de entidades rastreadas¶

Sobre tipos de entidades rastreadas¶

A tracked entity is a type of entity which can be tracked through the system. It can be anything from persons to commodities, for example a medicine or a person.

A program must have one tracked entity. To enroll a tracked entity instance into a program, the tracked entity type of the entity and the tracked entity type of the program must be the same.

Tracked entity attributes are used to register extra information for a tracked entity. Tracked entity attributes can be shared between programs.

Criar ou editar um atributo de entidade rastreada¶

1. Open the Maintenance app and click Program > Tracked entity attribute.

2. Clique no botão adicionar.

3. No campo ** Nome **, digite o nome do atributo da entidade rastreada.

4. (Opcional) Digite um ** Nome abreviado **.

5. (Opcional) Digite um ** Nome do formulário **.

6. (Opcional) No campo ** Código **, atribua um código.

7. (Opcional) Digite uma ** Descrição **.

8. (Optional) In the Field mask field, you may type a template that's used to provide hints for correct formatting of the attribute. NOTE: So far only implemented in the DHIS2 Android Capture app, not in the Capture and Tracker Capture web apps. A seguir estão os caracteres especiais que podem ser usados na máscara. Os caracteres especiais correspondem exatamente a um caractere do tipo fornecido.

For example, the pattern can be used to show hyphens as needed in the input field of the data element. E.g "\d\d\d-\d\d\d-\d\d\d, would show an hyphen for every third digit.

1. Selecione um ** Conjunto de opções **.

2. In the Value type field, select the type of data that the tracked entity attribute will record.

   Value types

   Value type	Description
   Age	Dates rendered as calendar widget OR by entering number of years, months and/or days which calculates the date value based on current date. The date will be saved in the backend.
   Coordinate	A point coordinate specified as longitude and latitude in decimal degrees. All coordinate should be specified in the format "-19.23 , 56.42" with a comma separating the longitude and latitude.
   Date	Dates render as calendar widget in data entry.
   Date & time	Is a combination of the DATE and TIME data elements.
   E-mail	Valid email address.
   File	A file resource where you can store external files, for example documents and photos.
   Image	A file resource where you can store photos. Unlike the FILE data element, the IMAGE data element can display the uploaded image directly in forms.
   Integer	Any whole number (positive and negative), including zero.
   Letter	A single letter.
   Long text	Textual value. Renders as text area with no length constraint in forms.
   Negative integer	Any whole number less than (but not including) zero.
   Number	Any real numeric value with a single decimal point. Thousands separators and scientific notation is not supported.
   Percentage	Whole numbers inclusive between 0 and 100.
   Phone number	Phone number.
   Positive integer	Any whole number greater than (but not including) zero.
   Positive of zero integer	Any positive whole number, including zero.
   Organisation unit	Organisation units rendered as a hierarchy tree widget. If the user has assigned "search organisation units", these will be displayed instead of the assigned organisation units.
   Unit interval	Any real number greater than or equal to 0 and less than or equal to 1.
   Text	Textual value. The maximum number of allowed characters per value is 50,000.
   Time	Time is stored in HH:mm format. HH is a number between 0 and 23 mm is a number between 00 and 59
   Username	DHIS2 user. Rendered as a dialog with a list of users and a search field. The user will need the "View User" authority to be able to utilise this data type.
   Yes/No	Boolean values, renders as drop-down lists in data entry.
   Yes only	True values, renders as check-boxes in data entry.

3. Selecione um ** Tipo de agregação **.

   Table: Aggregation operators

Existem duas opções para a configuração única:

  - **Entire system**: The values of the tracked entity attribute
    can duplicate with values which belong to other tracked entity
    attributes. But the values in this tracked entity attribute must
    not duplicate.

    Select **Automatically generated** to allow automatic generation
    of the tracked entity attribute value. When the generate setting
    is selected on, an optional field for specifying pattern also
    displays. This field should contain a pattern based on the
    TextPattern syntax. When the value is automatically generated,
    it will be unique for this attribute for the entire system. See
    the TextPattern section for more information on how it works.

  - **Organisation unit**: The values of the tracked entity
    attribute must not duplicate in the same organisation unit.

1. Select Inherit to registry a new entity for relationship with an available entity, all inherit entity attribute values of the entity will be pre-filled in the registration form.

2. (Opcional) Selecione ** Confidencial **.

   This option is only available if you have configured encryption for the system.

[!WARNING] The Confidential flag does not guarantee encryption of data at rest and is not currently functioning as intended. Currently, values are stored as both encrypted and plain text values in the database.

For implementations requiring encryption of sensitive data, it is recommended to use encryption-at-rest features provided by the underlying operating system at the file system level or the block level. Many operating systems support this functionality, including Windows.

Going forward, the Confidential flag should be understood strictly as a visibility control mechanism at Analytics Output level, and not as an encryption feature.

The DHIS2 Core team therefore discourages use of the Confidential flag for data protection or encryption purposes. Upcoming versions will implement and document consistent functionality and recommendations for security approaches.

1. (Opcional) Selecione ** Exibir na lista sem programa **.

2. (Opcional) Atribua uma ou várias ** Legendas **.

3. Clique em Salvar.

Criar ou editar um tipo de entidade rastreada¶

1. Open the Maintenance app and click Program > Tracked entity type.

2. Click the add button or an already existing tracked entity type.

3. Digite um ** Nome ** da entidade rastreada.

4. (Optional) select a Color and an Icon that will be used by the data capture apps to identify this tracked entity type.

5. (Opcional) Insira uma ** Descrição ** da entidade rastreada.

6. (Optional) Enter a Minimum number of attributes required to search. This specifies the amount of attributes that need to be filled out in order to be able to search for this tracked entity type in a global search. See Configure Search for more information.

7. (Optional) Enter a Maximum number of tracked entities to return in search. This specifies the number of tracked entities that will be returned in when searching outside capture scope. See Configure Search for more information.

8. (Optional) Add Tracked entity type attributes. This is used to configure search, see Configure Search for more information.

9. (Opcional) Insira um ** Nome alternativo ** da entidade rastreada.

10. Clique em Salvar.

Configurar pesquisa¶

Users can be given search organisation units, which makes it possible to search for tracked entity instances outside their data capture organisation units.

Searching can be done either in the context of a program, or in the context of a tracked entity type. To give users the option of searching in the context of a program, it is necessary to configure which of the programs tracked entity attributes is searchable. To give users the option of searching in the context of a tracked entity type, you will have to configure which of the tracked entity type attributes is searchable.

Configure a pesquisa para o programa rastreador¶

To be able to search with a program, you will have to make some of the program attributes searchable. Unique program attributes will always be searchable.

1. Open Maintenance app and click Program

2. Open or create a Tracker program

3. Vá para ** Atributos **

4. Se você não tem atributos, adicione um

5. Defina o atributo pesquisável

Searchable program attributes will be assigned to a search group.

• Unique group. One group per unique program attribute. Unique attributes cannot be combined with other program attributes in a search. The result from the search can only be 0 or 1 tracked entity instance.

• Non-unique group. This group contains all non-unique program attributes and makes it possible to combine multiple attributes in a search.

There are two limits that can be set for a program search, as part of the Program details configuration.

• Minimum number of attributes required to search: This property defines how many of the non-unique attributes that must be entered before a search can be performed.

• Maximum number of tracked entities to return: This property defines how specific a search must be, by limiting the number of matching tracked entities a user is allowed to get for their search criteria. If the number of matching records is larger than this setting, they will not be returned. The user must then provide more specific search criteria, in order to reduce the number of matching records, before they are returned. More on limits here.

  NOTE

  This maximum limit setting is only applied to search results when searching outside the users capture org unit. Within the capture scope, the user can see any number of results.

Configure a pesquisa para o tipo de entidade rastreada¶

** Nota **

TET = tipo de entidade rastreada

To be able to search without a program, you will have to make some of the TET attributes searchable. Unique TET attributes will always be searchable.

1. Abra o ** aplicativo de tipo de entidade rastreada **

2. Abra um tipo de entidade rastreada

3. Se o TET não tiver atributos, adicione um

4. Defina o atributo pesquisável

Searchable TET attributes will be assigned to a search group.

• Unique group. One group per unique TET attribute. Unique attributes cannot be combined with other TET attributes in a search. The result from the search can only be 0 or 1 tracked entity instance.

• Non-unique group. This group contains all non-unique TET attributes and makes it possible to combine multiple attributes in a search.

Existem dois limites que podem ser definidos para uma pesquisa TET

• Minimum number of attributes required to search: This property defines how many of the non-unique attributes that must be entered before a search can be performed.

• Maximum number of tracked entity types to return: This property defines how specific a search must be, by limiting the number of matching tracked entity types a user is allowed to get for her search criteria. If the number of matching records is larger than this maximum, they will not be returned. The user must provide more specific search criteria, in order to reduce the number of matching records, before they are returned.

  NOTE

  This maximum is only applied to search results outside the users capture org unit. Within the capture scope, the user can see any number of results.

Configurar unidades de organização de pesquisa para um usuário¶

To be able to search in other organisation units than the users data capture organisation units, the user must be assigned with search organisation units. Giving a user a search organisation unit will also give them access to search in all children of that organisation unit.

1. Abra o ** aplicativo Usuários **

2. Clique em um usuário

3. Abrir ** Atribuir unidades de organização de pesquisa **

4. Selecione as unidades de organização

5. Clique em ** Salvar **

Clonar objetos de metadados¶

Cloning a data element or other objects can save time when you create many similar objects.

1. Open the Maintenance app and find the type of metadata object you want to clone.

2. Na lista de objetos, clique no menu de opções e selecione ** Clonar **.

3. Modifique as opções que você deseja.

4. Clique em Salvar.

Excluir objetos de metadados¶

Note

You can only delete a data element and other data element objects if no data is associated to the data element itself.

Warning

Any data set that you delete from the system is irrevocably lost. All data entry forms, and section forms which may have been developed will also be removed. Make sure that you have made a backup of your database before deleting any data set in case you need to restore it at some point in time.

1. Open the Maintenance app and find the type of metadata object you want to delete.

2. Na lista de objetos, clique no menu de opções e selecione ** Excluir **.

3. Clique em ** Confirmar **.

Alterar as configurações de compartilhamento para objetos de metadados¶

You can assign different sharing settings to metadata objects, for example organisation units and tracked entity attributes. These sharing settings control which users and users groups that can view or edit a metadata object.

Some metadata objects also allow you to change the sharing setting of data entry for the object. These additional settings control who can view or enter data in form fields using the metadata.

Note

The default setting is that everyone (Public access) can find, view and edit metadata objects.

1. Open the Maintenance app and find the type of metadata object you want to modify.

2. In the object list, click the context menu and select Sharing settings.

3. (Optional) Add users or user groups: search for a user or a user group and select it. The user or user group is added to the list.

4. Altere as configurações de compartilhamento dos grupos de acesso que você deseja modificar.

   • Can edit and view: The access group can view and edit the object.

   • ** Pode visualizar apenas **: O grupo de acesso pode visualizar o objeto.

   • No access (only applicable to Public access): The public won't have access to the object.

5. Change data sharing settings for the access groups you want to modify.

   • Can capture data: The access group can view and capture data for the object.

   • Can view data: The access group can view data for the object.

   • No access: The access group won't have access to data for the object.

6. Clique em ** Fechar **.

Exibir detalhes de objetos de metadados¶

1. Open the Maintenance app and find the type of metadata object you want to view.

2. In the object list, click the options menu and select Show details.

Traduzir objetos de metadados¶

DHIS2 provides functionality for translations of database content, for example data elements, data element groups, indicators, indicator groups or organisation units. You can translate these elements to any number of locales. A locale represents a specific geographical, political, or cultural region.

Tip

To activate a translation, open the System Settings app, click > Appearance and select a language.

1. Open the Maintenance app and find the type of metadata object you want to translate.

2. Na lista de objetos, clique no menu de opções e selecione ** Traduzir **.

   Tip

   If you want to translate an organisation unit level, click directly on the Translate icon next to each list item.

3. Selecione um local.

4. Digite um ** Nome **, ** Nome curto ** e ** Descrição **.

5. Clique em Salvar.