Electronic Immunization Registry Installation Guide¶
Deverá seguir na íntegra as instruções para cada pacote separado que instalar.
Instalação¶
A instalação do módulo consiste em várias etapas:
- Preparando o ficheiro de metadados para o DHIS2.
- Importing the metadata file into DHIS2.
- [Configurando] (# configuração-adicional) os metadados importados.
- 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.
Great care should be taken to ensure that the server itself and the DHIS2 application is well secured, to restrict access to the data being collected. Details on securing a DHIS2 system is outside the scope of this document, and we refer to the DHIS2 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. 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.
You could then search and replace all occurrences of HllvX50cXC0 with bRowv6yZOF2 in the .json file, as that is the ID of default in the system you are importing into. Note that this search and replace operation must be done with a plain text editor, not a word processor like 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 |
|---|---|---|
| Percentagem | hmSnCXmLYwt | ../api/indicatorTypes.json?filter=number:eq:false&filter=factor:eq:100 |
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 |
Visualizations using Root Organisation Unit UID¶
Visualizações, relatórios de eventos, tabelas de relatórios e mapas atribuídos a um nível de unidade organizacional específico ou grupo de unidades organizacionais têm uma referência à unidade organizacional raiz (nível 1). Tais objectos, se presentes no arquivo de metadados, contêm um espaço reservado <OU_ROOT_UID>. Use a função de pesquisa no editor de arquivos .json para possivelmente identificar esse espaço reservado e substituí-lo pelo UID da unidade organizacional de nível 1 na instância de destino.
Importando metadados¶
The .json metadata file is imported through the Import/Export app of DHIS2. It is advisable to use the "dry run" feature to identify issues before attempting to do an actual import of the metadata. If "dry run" reports any issues or conflicts, see the import conflicts section below. If the "dry run"/"validate" import works without error, attempt to import the metadata. If the import succeeds without any errors, you can proceed to configure the module. In some cases, import conflicts or issues are not shown during the "dry run", but appear when the actual import is attempted. In this case, the import summary will list any errors that need to be resolved.
Generic metadata¶
For generic metadata overview (identical metadata objects used by several packages), please refer to the installation annex of the individual package.
Manipulando conflitos de importação¶
NOTE: If you are importing into a new DHIS2 instance, you will not have to worry about import conflicts, as there is nothing in the database you are importing to to conflict with. Follow the instructions to import the metadata then please proceed to the “Additional configuration” section.
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
A metadata package usually contains several user groups:
- EIR - Immunization access
- EIR - Immunization admin
- EIR - Immunization data capture
Por padrão o seguinte é atribuído a esses grupos de utilizadores.
| Objecto | User Groups | ||
|---|---|---|---|
| EIR - Immunization access | EIR - Immunization admin | EIR - Immunization 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 |
| Program Stages | 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 Dados: pode ver | Metadados: pode editar e visualizar Dados: pode visualizar | Metadados: pode ver Dados: pode ver |
Please refere to the individual package installation annex for information about user groups.
You will want to assign your users to the appropriate user group based on their role within the system. You may want to enable sharing for other objects in the package depending on your set up. Refer to the DHIS2 Documentation for more information on configuring sharing.
Important note: there is a bug affecting versions 2.33 and 2.34 which overrides sharing properties of an object after importing the same object even though MERGE is selected as import parameter. This is especially critical for the object Tracked Entity Type - Person (UID: MCPQUTHX1Ze) which is typically shared with user groups of different packages.
If your TET Person already matches the one in the package and you want to avoid overriding the current sharing properties for this object in the database, you can follow these steps:
- Remove this TET from the package file
- Import the package
- Update sharing properties for this TET using the table above.
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:
- 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.
- Captura de dados rastreados : Pode adicionar valores de dados, actualizar entidades rastreadas, pesquisar entidades rastreadas nas unidades organizacionais e acessar Track capture
Refer to the DHIS2 Documentation for more information on configuring user roles.
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¶
NOTE: This section only applies if you are importing into a DHIS2 database in which there is already meta-data present. If you are working with a new DHIS2 instance, please skip this section and go to "Adapting the tracker program."
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.
Uma coisa importante a se ter em mente é que o DHIS2 tem 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 por meio de compartilhamento.
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.