Ir para o conteúdo
For the complete DHIS2 documentation index, see llms.txt.

AEFI Tracker Installation Guide

Visão Geral

The AEFI tracker package was developed using DHIS2.33.2. This was done in order to support some of the latest features in DHIS2. In order to use the package, it is recommended that you install it into a DHIS2 instance using DHIS2 2.33.2 or above. If you will be setting this up on a new instance, please refer to the DHIS2 installation guide.

Instalação

A instalação do módulo consiste em várias etapas:

  1. Preparando o ficheiro de metadados para o DHIS2.
  2. Importando o ficheiro de metadados no DHIS2.
  3. [Configurando] (# configuração-adicional) os metadados importados.
  4. Adaptando o programa depois de ser importado

Recomenda-se ler primeiro cada secção antes de iniciar o processo de instalação e configuração no DHIS2. As secções que não são aplicáveis ​​foram identificadas, dependendo se estiver a importar para uma nova instância do DHIS2 ou uma instancia DHIS2 com metadados já presentes. O procedimento descrito neste documento deve ser testado em um ambiente de teste / preparado antes de ser repetido ou transferido para uma instância de produção do DHIS2.

Requisitos

Para instalar o módulo, precisa-se de uma conta de usuário administrador no DHIS2. O procedimento descrito neste documento deve ser testado em um ambiente de teste / preparo antes de ser executado em uma instância de produção do DHIS2.

Deve se ter muito cuidado para garantir que o próprio servidor e o aplicativo DHIS2 estejam bem protegidos, de modo a restringir o acesso aos dados que estão sendo coletados. Os detalhes sobre a proteção de um sistema DHIS2 estão fora do escopo deste documento e nos referimos ao [DHIS2 documentation] (http://dhis2.org/documentation).

Preparando o ficheiro de metadados

NOTE: If you are installing the package on a new instance of DHIS2, you can skip the “Preparing the metadata file” section and move immediately to the section on “Importing a metadata file into DHIS2.”

Embora nem sempre seja necessário, muitas vezes pode ser vantajoso fazer certas modificações no arquivo de metadados antes de importá-lo para o DHIS2.

Dimensão padrão dos dados

Nas versões anteriores do DHIS2, o UID da dimensão de dados padrão era gerado automaticamente. Assim, enquanto todas as instâncias DHIS2 têm uma opção de categoria padrão, categoria de elemento de dados, combinação de categorias e combinação de opções de categorias, os UIDs desses padrões podem ser diferentes. Versões posteriores do DHIS2 possuem UIDs codificados permanentemente para a dimensão padrão, e esses UIDs são usados ​​nos pacotes de configuração.

To avoid conflicts when importing the metadata, it is advisable to search and replace the entire .json file for all occurrences of these default objects, replacing UIDs of the .json file with the UIDs of the database in which the file will be imported. Table 1 shows the UIDs which should be replaced, as well as the API endpoints to identify the existing UIDs

Objecto UID API endpoint
Category GLevLNI9wkl ../api/categories.json?filter=name:eq:default
Category option xYerKDKCefk ../api/categoryOptions.json?filter=name:eq:default
Category combination bjDvmb4bfuf ../api/categoryCombos.json?filter=name:eq:default
Category option combination HllvX50cXC0 ../api/categoryOptionCombos.json?filter=name:eq:default

For example, if importing a configuration package into https://play.dhis2.org/demo, the UID of the default category option combination could be identified through https://play.dhis2.org/demo/api/categoryOptionCombos.json?filter=name:eq:default as bRowv6yZOF2.

Você poderia procurar e substituir todas as ocorrências de HllvX50cXC0 with bRowv6yZOF2 no ficheiro de .json, como esse é o ID do padrão no sistema para o qual você está importando. Notaque esta operação de pesquisa e substituição deve ser feita com um editor de texto sem formatação, não é um editor de texto como o Microsoft Word.

Tipos de indicadores

O tipo de indicador é outro tipo de objeto que pode criar conflito de importação porque certos nomes são usados ​​em bancos de dados DHIS2 diferentes (por exemplo, "Percentagem"). Como os tipos de indicadores são definidos simplesmente por seu fator e se são ou não números simples sem denominador, eles são inequívocos e podem ser substituídos por uma pesquisa e substituição dos UIDs. Isso evita possíveis conflitos de importação e cria tipos de indicadores duplicados. A Tabela 2 mostra os UIDs que podem ser substituídos, bem como os pontos de extremidade da API para identificar os UIDs existentes.

Objecto UID API endpoint
Apenas numerador (número) CqNPn5KzksS ../api/indicatorTypes.json?filter=number:eq:true&filter=factor:eq:1

Tipo de entidade rastreada

Tal como os tipos de indicadores, você já pode ter tipos de entidades rastreadas existentes no banco de dados DHIS2. As referências ao tipo de entidade rastreada devem ser alteradas para refletir o que está no seu sistema, para evitar a criação de duplicações. A Tabela 3 mostra os UIDs que podem ser substituídos, bem como os pontos de extremidade da API para identificar os UIDs existentes.

Objecto UID API endpoint
Pessoa MCPQUTHX1Ze ../api/trackedEntityTypes.json?filter=name:eq:Person

Event report organisation Unit

In the AEFI metadata package there are event reports tied to the root level unit of the organisation unit tree. The reference to the organisation unit needs to be replaced with the UID of the root unit of the organisation unit tree in your system. Table 4 shows the UID which need to be replaced, as well as the api endpoint to identify the existing organisation unit UID

Objecto UID API endpoint
Unidade organizacional GD7TowwI46c ../api/organisationUnits.json?level=1

Importando metadados

O arquivo de metadados .json é importado através do Importação / Exportação na plicação do Dhis2. É recomendável usar o recurso "dry run" para identificar problemas antes de tentar fazer uma importação real dos metadados. Se "dry run" relatar problemas ou conflitos, consulte os conflitos de importação secção abaixo. Se o"dry run"/"validate" importação funciona sem erro, tente importar os metadados. Se a importação for bem-sucedida sem erros, você pode prosseguir para configurar o módulo. Em alguns casos, conflitos ou problemas de importação não são mostrados durante o "dry run", mas aparece quando a importação real é tentada. Nesse caso, o resumo da importação listará todos os erros que precisam ser resolvidos.

Manipulando conflitos de importação

NOTA: Se estiver importando para uma nova instância DHIS2, não precisará se preocupar com conflitos de importação, pois não há nada no banco de dados para o qual esteja importando para entrar em conflito. Siga as instruções para importar os metadados e prossiga para a seção "[Configuração adicional] (# configuração adicional)".

Existem vários conflitos diferentes que podem ocorrer, embora o mais comum seja o fato de existirem objetos de metadados no pacote de configuração com um nome, nome curto e / ou código que já existe no base de dados de destino. Existem algumas soluções alternativas para esses problemas, com diferentes vantagens e desvantagens. Qual é o mais apropriado dependerá, por exemplo, do tipo de objeto para o qual ocorre um conflito.

Alternativa 1

Renomeie o objeto existente na base de dados DHIS2 para o qual existe um conflito. A vantagem dessa abordagem é que não há necessidade de modificar o ficheiro .json, pois as alterações são feitas na interface do usuário do DHIS2. É provável que seja menos propenso a erros. Isso também significa que o pacote de configuração é deixado como está, o que pode ser uma vantagem, por exemplo, quando o material de treinamento e documentação baseados no pacote de configuração serão usados.

Alternativa 2

Renomeie o objecto para o qual há um conflito no arquivo .json. A vantagem dessa abordagem é que os metadados DHIS2 existentes são deixados como estão. Isso pode ser um fator quando há material de treinamento ou documentação como SOPs de dicionários de dados vinculados ao objeto em questão, e não envolve nenhum risco de confundir os usuários ao modificar os metadados com os quais estão familiarizados.

Observe que, para as alternativas 1 e 2, a modificação pode ser tão simples quanto adicionar um pequeno pré/pós-correção ao nome, para minimizar o risco de confusão.

Alternativa 3

Uma terceira e mais complicada abordagem é modificar o ficheiro .json para reutilizar os metadados existentes. Por exemplo, nos casos em que um conjunto de opções já existe para um determinado conceito (por exemplo, "sexo"), esse conjunto de opções pode ser removido do ficheiro .json e todas as referências ao seu UID substituídas pela opção correspondente já existente na base de dados. A grande vantagem disso (que não se limita aos casos em que há um conflito direto de importação) é evitar a criação de metadados duplicados na base de dados. Existem algumas considerações importantes a serem feitas ao executar esse tipo de modificação:

  • Isto requer conhecimento especializado da estrutura detalhada dos metadados do DHIS2
  • a abordagem não funciona para todos os tipos de objec tos. Em particular, certos tipos de objectos têm dependências que são complicadas de resolver dessa maneira, por exemplo, relacionadas a desagregações.
  • futuras actualizações do pacote de configuração serão complicadas.

Configuração adicional

Depois que todos os metadados forem importados com sucesso, é necessário executar algumas etapas antes do funcionamento do módulo

Partilha

Primeiro, precisará usar a funcionalidade * Partilha * do DHIS2 para configurar quais utilizadores (grupos de utilizadores) devem ver os metadados e dados associados ao programa, bem como quem pode registrar / inserir dados no programa. Por padrão, a partilha foi configurada para o seguinte:

  • Tipo de entidade rastreada
  • Programa
  • Estagios de Programa
  • Painéis

There are six user groups that come with the package, the last three are recipients of program stage notifications:

  • AEFI access
  • AEFI admin
  • AEFI data capture
  • AEFI district
  • AEFI national
  • AEFI first-level decision making

Por padrão o seguinte é atribuído a esses grupos de utilizadores.

Objecto Grupo de usuários
AEFI access AEFI admin AEFI data capture
Tipo de entidade rastreada Metadados: pode ver
Dados: pode ver
Metadados: pode editar e visualizar
Dados: pode visualizar
Metadados: pode visualizar
Dados: pode capturar e visualizar
Programa Metadados: pode ver
Dados: pode ver
Metadados: pode editar e visualizar
Dados: pode visualizar
Metadados: pode visualizar
Dados: pode capturar e visualizar
Fases do programa Metadados: pode ver
Dados: pode ver
Metadados: pode editar e visualizar
Dados: pode visualizar
Metadados: pode visualizar
Dados: pode capturar e visualizar
_ Painéis _ Metadados: pode ver Metadados: pode editar e visualizar Metadata : none

Deseja atribuir seus utilizador ao grupo de utilizadores apropriado, com base em suas funções no sistema. Convém ativar a partilha para outros objetos no pacote, dependendo da sua configuração. Consulte o DHIS2 Documentation para obter mais informações sobre como configurar a partilha.

Funções do Utilizador

Os utilizadores precisarão de funções de utilizador para interagir com os vários aplicativos no DHIS2. As seguintes funções mínimas são recomendadas:

  1. Análise de dados do rastreador: pode ver análises de eventos e aceder a painéis, relatórios de eventos, visualizador de eventos, visualizador de dados, tabelas dinâmicas, relatórios e mapas.
  2. Captura de dados rastreados : Pode adicionar valores de dados, actualizar entidades rastreadas, pesquisar entidades rastreadas nas unidades organizacionais e acessar Track capture

Consulte a Documentação DHIS2 para obter mais informações sobre como configurar funções de utilizador

Unidades organizacionais

Atribua o programa às unidades organizacionais dentro de sua própria hierarquia para que possa visualizar o programa na captura de rastreamento.

Metadado duplicados

NOTA: Esta seção se aplica apenas se você estiver importando para um banco de dados DHIS2 no qual já haja metadados. Se você estiver trabalhando com uma nova instância do DHIS2, pule esta seção e vá para Adaptando o programa rastreador.”

Mesmo quando os metadados foram importados com sucesso sem nenhum conflito de importação, pode haver duplicação nos metadados - elementos de dados, atributos de entidade rastreados ou conjuntos de opções que já existem. Como foi observado na secção acima, sobre a resolução de conflitos, uma questão importante a ser lembrada é que as decisões sobre a alteração dos metadados no DHIS2 também precisam levar em consideração outros documentos e recursos que, de maneiras diferentes, estão associados aos metadados existentes, e os metadados que foram importados pelo pacote de configuração. Resolver duplicação é, portanto, não apenas uma questão de "limpar o banco de dados", mas também garantir que isso seja feito sem, por exemplo, quebrar o potencial de integração com outros sistemas, a possibilidade de usar material de treinamento, interromper SOPs, etc. tudo isto depende muito do contexto.

É importante ter em mente que o DHIS2 possui ferramentas que podem ocultar algumas das complexidades de possíveis duplicações em metadados. Por exemplo, onde existem conjuntos de opções duplicados, eles podem ser ocultados para grupos de usuários através de Partilhar.

Adaptando o programa rastreador

Depois que o programa for importado, convém fazer certas modificações no programa. Exemplos de adaptações locais que * poderiam * ser feitas incluem:

  • Acrescentando variáveis ​​adicionais ao formulário.
  • Adaptar os nomes de elemento de dados/opções de acordo com convenções nacionais.
  • Adicionando traduções às variáveis ​​e/ou ao formulário de entrada de dados.
  • Modificando indicadores de programa com base em definições de casos locais

Contudo, é recomendável ter cuidado ao alterar ou remover qualquer um dos formulários/metadados incluídos. Existe o perigo de que as modificações possam interromper a funcionalidade, por exemplo, regras e indicadores do programa.

Line Listing

Due to technical issues, two essential line lists are not included in the generic package. The implementers are required to configure these line lists following the steps below

AEFI Line listing (Event Report)

Line listing

  • note: the screenshot above does not represent the full line list

  • Go to DHIS 2 Event Reports app

  • Select Table style Line list
  • Select Output style Event
  • In Data section, select program Adverse events folloing immunization (AEFI)
  • Select Stage AEFI
  • Use the table below and add the Data elements / Program Attributes in the suggested order.
  • In Periods section, select This Year
  • In Organisation units section, select User org unit
  • CLick Favourites button and Save.
  • Add Name - AEFI LINE LISTING - this year
  • CLick Favourites button and Save.
  • Click Share. Restrict external and public access and share the event report with applicable user groups: AEFI access (can view) and AEFI admin (can edit and view)
  • Go to AEFI Dashboard and add the event report to the dashboard.
Field/column # Variable name Source Stage Object Type
1 Número
2 DOR (date of report - report compilation date)
3 DON (Date of Notification - date patient notified the event to the health system)
4 Incident date
5 Unidade organizacional
6 AEFI - Reporter of case AEFI Stage Elemento de dados uZ9c4fKXuNS
7 AEFI - Reporter’s address AEFI Stage Elemento de dados Q20pEixZxCs
8 AEFI Case ID Program attribute h5FuguPFF2j
9 Given name Program attribute TfdH5KvFmMy
10 Family name Program attribute aW66s2QSosT
11 Date of birth Program attribute BiTsLcJQ95V
12 Sexo Program attribute CklPZdOd6H1
13 AEFI - AEFI start date AEFI Stage Elemento de dados vNGUuAZA2C2
14 AEFI_Serious adverse event following immunization AEFI Stage Elemento de dados kQCVFWE2MPb
15 AEFI - AEFI outcome AEFI Stage Elemento de dados yRrSDiR5v1M
16 AEFI - Vaccination 1 date AEFI Stage Elemento de dados dOkuCjpD978
17 AEFI - Vaccine 1 name AEFI Stage Elemento de dados uSVcZzSM3zg
18 AEFI - batch/lot number (Vaccine 1) AEFI Stage Elemento de dados LNqkAlvGplL
19 AEFI - Diluent batch/lot number 1 AEFI Stage Elemento de dados FQM2ksIQix8
20 AEFI - Vaccination 2 date AEFI Stage Elemento de dados VrzEutEnzSJ
21 AEFI - Vaccine 2 name AEFI Stage Elemento de dados g9PjywVj2fs
22 AEFI - batch/lot number (Vaccine 2) AEFI Stage Elemento de dados b1rSwGRcY5W
23 AEFI - Diluent batch/lot number 2 AEFI Stage Elemento de dados ufWU3WStZgG
24 AEFI - Vaccination 3 date AEFI Stage Elemento de dados f4WCAVwjHz0
25 AEFI - Vaccine 3 name AEFI Stage Elemento de dados OU5klvkk3SM
26 AEFI - batch/lot number (Vaccine 3) AEFI Stage Elemento de dados YBnFoNouH6f
27 AEFI - Diluent batch/lot number 3 AEFI Stage Elemento de dados MLP8fi1X7UX
28 AEFI - Abdominal pain AEFI Stage Elemento de dados T6tsxbKzikz
29 AEFI - Abscess AEFI Stage Elemento de dados wce39JmsjIK
30 AEFI - Anaphylaxis AEFI Stage Elemento de dados MkIgCrCTFyE
31 AEFI - Bell's Palsy AEFI Stage Elemento de dados BKxtyqhIDkB
32 AEFI - Chills AEFI Stage Elemento de dados TPSvWhUfib3
33 AEFI - Congenital anomaly AEFI Stage Elemento de dados lSBsxcQU0kO
34 AEFI - Cough AEFI Stage Elemento de dados ZdFB8xUhOUM
35 AEFI - Diarrhoea AEFI Stage Elemento de dados NAiZTRCHRWL
36 AEFI - Dizziness AEFI Stage Elemento de dados XluNAFG1wj6
37 AEFI - Drowsiness AEFI Stage Elemento de dados rjjRNU5yDhT
38 AEFI - Encephalopathy AEFI Stage Elemento de dados pdpAEuUS1W9
39 AEFI - Fainting AEFI Stage Elemento de dados OhHYABXmGGe
40 AEFI - Fatigue AEFI Stage Elemento de dados owRcSysyioE
41 AEFI - Fever AEFI Stage Elemento de dados rzhHSqK3lQq
42 AEFI - Headache AEFI Stage Elemento de dados HY6NIt2FX4A
43 AEFI - Injection site soreness AEFI Stage Elemento de dados P4oSprWWqrn
44 AEFI - Injection site tenderness AEFI Stage Elemento de dados KqlCtmOWt4G
45 AEFI - Irritability AEFI Stage Elemento de dados PWOzcN7UCfW
46 AEFI - Itching AEFI Stage Elemento de dados FC54HsGMErl
47 AEFI - Joint pain AEFI Stage Elemento de dados vCfZD893IVe
48 AEFI - Loss of apetite AEFI Stage Elemento de dados QFMRugi3fm6
49 AEFI - Lymphadenopathy AEFI Stage Elemento de dados dDWYBYUNpaQ
50 AEFI - Lymph node enlargement AEFI Stage Elemento de dados GEkI9NzxTmM
51 AEFI - Mild fever AEFI Stage Elemento de dados nKLO8ZNdR0B
52 AEFI - Muscle pain AEFI Stage Elemento de dados pzOF4lGIyTU
53 AEFI - Nasal congestion AEFI Stage Elemento de dados wWDenTQ5xBR
54 AEFI - Nausea AEFI Stage Elemento de dados KOt0J61mF61
55 AEFI - Specify other (Adverse event) AEFI Stage Elemento de dados iTm5wvq16iq
56 AEFI - Specify other (Severe event) AEFI Stage Elemento de dados AfrWB2ofm7l
57 AEFI - Persistent crying AEFI Stage Elemento de dados GTyK3p976de
58 AEFI - Poor breast feeding AEFI Stage Elemento de dados sX1SvRadOmn
59 AEFI - Seizure type AEFI Stage Elemento de dados Zz4KYO4AsSY
60 AEFI - Seizures AEFI Stage Elemento de dados wCGZpudXuYx
61 AEFI - Sepsis AEFI Stage Elemento de dados tUmgO1Ugv6U
62 AEFI - Severe local reaction AEFI Stage Elemento de dados UNmEidE6M9K
63 AEFI - Severe local reaction > 3 days AEFI Stage Elemento de dados We87rvcvd8J
64 AEFI - Severe local reaction beyond nearest joint AEFI Stage Elemento de dados f8hjxmHOtAB
65 AEFI - Skin rash AEFI Stage Elemento de dados xgqzqv0p2Us
66 AEFI - Sore throat AEFI Stage Elemento de dados seXW1hERwOo
67 AEFI - Tiredness AEFI Stage Elemento de dados JaZ9yf1dDy3
68 AEFI - Thrombocytopenia AEFI Stage Elemento de dados GGLLaieVChK
69 AEFI - Toxic shock syndrome AEFI Stage Elemento de dados Apq4JaueuWR
70 AEFI - Vomiting AEFI Stage Elemento de dados cMEIyp0rMo1
71 AEFI - Death AEFI Stage Elemento de dados DOA6ZFMro84
72 AEFI - Hospitalization AEFI Stage Elemento de dados Il1lTfknLdd
73 AEFI - Life threatening AEFI Stage Elemento de dados lATDYNmTLKD
74 AEFI - Persistent or significant disability AEFI Stage Elemento de dados lsO8n8ZmLAB

AEFI national level summary (Event Report)

AEFI National Linelist

  • note: the screenshot above does not represent the full linelist

  • Go to DHIS 2 Event Reports app

  • Select Table style Line list
  • Select Output style Enrollment
  • In Data section, select program Adverse events folloing immunization (AEFI)
  • Select applicable Stage. See the table below
  • Use the table below and add the Data elements / Program Attributes in the suggested order.
  • In Periods section, select Last 12 months
  • In Organisation units section, select User org unit
  • Click Favourites button and Save.
  • Add Name - AEFI national level summary (this year)
  • Click Favourites button and Save.
  • Click Share. Restrict external and public access and share the event report with applicable user groups: AEFI access (can view) and AEFI admin (can edit and view)
  • Go to AEFI Dashboard and add the event report to the dashboard.
Field/column # Variable name Source Stage Object type UID
1 Número
2 DON (Date of Notification - date patient notified the event to the health system)
3 Incident date
4 Unidade organizacional
5 AEFI Case ID Program attribute h5FuguPFF2j
6 AEFI - Date when seen for approval at national level National level stage Elemento de dados cWMUoQEuvtR
7 AEFI - Date of final classification National level stage Elemento de dados wDijUvPYVne
8 AEFI - Valid Diagnosis National level stage Elemento de dados IZoGGNUkNl0
9 AEFI - Vaccine 1 name AEFI Stage Elemento de dados uSVcZzSM3zg
10 AEFI - Vaccination 1 date AEFI Stage Elemento de dados dOkuCjpD978
11 AEFI - Vaccine 2 name AEFI Stage Elemento de dados g9PjywVj2fs
12 AEFI - Vaccination 2 date AEFI Stage Elemento de dados VrzEutEnzSJ
13 AEFI - Vaccine 3 name AEFI Stage Elemento de dados OU5klvkk3SM
14 AEFI - Vaccination 3 date AEFI Stage Elemento de dados f4WCAVwjHz0
15 AEFI - Vaccine 4 name AEFI Stage Elemento de dados menOXwIFZh5
16 AEFI - Vaccination 4 date AEFI Stage Elemento de dados H3TKHMFIN6V
17 AEFI - Final causality assessment classification National level stage Elemento de dados DpgoIsq65SW
18 AEFI - Final causality assessment sub-classification National level stage Elemento de dados D42M2tdJo7R

Visualizações

Visualizations associated with the AEFI stage are detailed in the overview of the AEFI facility level line list. There are two key visualizations associated with causality assessment classification and sub-classification.