For the complete DHIS2 documentation index, see llms.txt.

Immunization: Big Catch-Up Installation Guide¶

This document includes an installation guide for the Big-Catch Up package.

Idioma predeterminado del sistema: Inglés

Visión general¶

Los archivos de referencia de metadatos y los archivos json de metadatos proporcionan detalles técnicos sobre la versión y el contenido del paquete.

The metadata package consists of the following modules:

Immunization (EPI) Big Catch-Up: Complete
Immunization (EPI) Big Catch-Up: Dashboard

Instalación¶

La instalación del módulo consta de varios pasos:

Se recomienda leer primero cada sección de la guía de instalación antes de iniciar el proceso de instalación y configuración en DHIS2. Identifique las secciones aplicables según el tipo de importación:

importar a una instancia DHIS2 en blanco
importar a una instancia DHIS2 con metadatos existentes.

Los pasos descritos en este documento deben probarse en una instancia DHIS2 de prueba/staging y solo entonces aplicarse a un entorno de producción.

Requisitos¶

Para instalar el módulo, se requiere una cuenta de usuario administrador en DHIS2.

Se debe tener mucho cuidado para asegurar que el servidor en sí y la aplicación DHIS2 estén bien protegidos, y se deben definir los derechos de acceso a los datos recopilados. Los detalles sobre la seguridad de un sistema DHIS2 están fuera del alcance de este documento, y nos remitimos a la documentación de DHIS2.

Archivos de metadatos¶

Aunque no siempre es necesario, a menudo puede ser ventajoso realizar ciertas modificaciones al archivo de metadatos antes de importarlo en DHIS2.

Preparar el archivo de metadatos¶

Es necesario aplicar algunos cambios al archivo de metadatos antes de poder importarlo. El alcance del trabajo puede variar de un paquete a otro.

Dimensión de datos predeterminada¶

In early versions of DHIS2, the UIDs of the default data dimensions were auto-generated. Thus, while all DHIS2 instances have a default category option, data element category, category combination and category option combination, the UIDs of these defaults can be different. Later versions of DHIS2 have hardcoded UIDs for the default dimension, and these UIDs are used in the configuration packages.

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 from the instance 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

Objeto	UID	API endpoint
Categoría	`GLevLNI9wkl`	`../api/categories.json?filter=name:eq:default`
Opción de categoría	`xYerKDKCefk`	`../api/categoryOptions.json?filter=name:eq:default`
Combinación de categoría	`bjDvmb4bfuf`	`../api/categoryCombos.json?filter=name:eq:default`
Combinación de opciones de categoría	`HllvX50cXC0`	`../api/categoryOptionCombos.json?filter=name:eq:default`

Identify the UIDs of the default dimensions in your instance using the listed API requests and replace the UIDs in the json file with the UIDs from the instance.

NOTA

Tenga en cuenta que esta operación de búsqueda y reemplazo debe realizarse con un editor de texto plano, no con un procesador de textos como Microsoft Word.

Tipos de indicadores¶

Indicator type is another type of object that can create import conflict because certain names are used in different DHIS2 databases (.e.g "Percentage"). Since Indicator types are defined by their factor (including 1 for "numerator only" indicators), they are unambiguous and can be replaced through a search and replace of the UIDs. This method helps avoid potential import conflicts, and prevents the implementer from creating duplicate indicator types. The table below contains the UIDs which could be replaced, as well as the API endpoints to identify the existing UIDs:

Objeto	UID	API endpoint
Porcentaje	`hmSnCXmLYwt`	`../api/indicatorTypes.json?filter=number:eq:false&filter=factor:eq:100`
Sólo numerador (número)	`CqNPn5KzksS`	`../api/indicatorTypes.json?filter=number:eq:true&filter=factor:eq:1`

Visualizaciones utilizando el UID de la unidad organizativa raíz¶

Visualizations, event reports, report tables and maps that are assigned to a specific organisation unit level or organisation unit group, have a reference to the root (level 1) organisation unit. Such objects, if present in the metadata file, contain a placeholder <OU_ROOT_UID>. Use the search function in the .json file editor to possibly identify this placeholder and replace it with the UID of the level 1 organisation unit in the target instance.

Importar metadatos¶

Utilice la aplicación DHIS2 Importar/Exportar para importar paquetes de metadatos. Es recomendable utilizar la función de «ejecución en seco» para identificar problemas antes de intentar realizar una importación real de los metadatos. Si la «ejecución en seco» reporta algún problema o conflicto, consulte la sección conflictos de importación a continuación. Si la importación de «ejecución en seco»/«validación» se realiza sin errores, intente importar los metadatos. Si la importación se completa sin errores, puede proceder a configurar el módulo. En algunos casos, los conflictos o problemas de importación no se muestran durante la «ejecución en seco», sino que aparecen cuando se intenta la importación real. En este caso, el resumen de importación indicará los errores que deben resolverse.

Gestión de conflictos de importación¶

NOTA

Si está importando el paquete en una nueva instancia de DHIS2, no experimentará conflictos de importación, ya que no hay metadatos en la base de datos de destino. Después de importar los metadatos, proceda a la sección «Configuración».

Pueden ocurrir varios tipos de conflictos, aunque el más común es que existan objetos de metadatos en el paquete de configuración con un nombre, nombre corto y/o código que ya existen en la base de datos de destino. Existen varias soluciones alternativas a estos problemas, con diferentes ventajas y desventajas. La solución más apropiada dependerá, por ejemplo, del tipo de objeto para el cual ocurre el conflicto.

Alternativa 1¶

Renombrar el objeto existente en su base de datos DHIS2 para el cual existe un conflicto. La ventaja de este enfoque es que no es necesario modificar el archivo .json, ya que los cambios se realizan a través de la interfaz de usuario de DHIS2. Es probable que esto sea menos propenso a errores. También significa que el paquete de configuración se deja tal cual, lo que puede ser una ventaja, por ejemplo, cuando se publican actualizaciones del paquete. Los objetos del paquete original también suelen estar referenciados en materiales de capacitación y documentación.

Alternativa 2¶

Renombrar el objeto para el cual existe un conflicto en el archivo .json. La ventaja de este enfoque es que los metadatos DHIS2 existentes se dejan tal cual. Esto puede ser un factor cuando existe material de capacitación o documentación, como los POE de diccionarios de datos vinculados al objeto en cuestión, y no implica ningún riesgo de confundir a los usuarios al modificar los metadatos con los que están familiarizados.

Tenga en cuenta que para las alternativas 1 y 2, la modificación puede ser tan simple como agregar un pequeño pre-/post-fijo al nombre, para minimizar el riesgo de confusión.

Alternativa 3¶

Un tercer enfoque, más complejo, consiste en modificar el archivo .json para reutilizar los metadatos existentes. Por ejemplo, en los casos en que ya existe un conjunto de opciones para un determinado concepto (por ejemplo, «sexo»), dicho conjunto de opciones podría eliminarse del archivo .json y todas las referencias a su UID reemplazarse por el conjunto de opciones correspondiente que ya existe en la base de datos. La gran ventaja de este método (que no se limita a los casos en que hay un conflicto de importación directo) es evitar la creación de metadatos duplicados en la base de datos. Hay algunas consideraciones clave a tener en cuenta al realizar este tipo de modificación:

requiere conocimiento especializado de la estructura detallada de metadatos de DHIS2
el enfoque no funciona para todos los tipos de objetos. En particular, ciertos tipos de objetos tienen dependencias que son complicadas de resolver de esta manera, por ejemplo en lo que respecta a las desagregaciones.
las futuras actualizaciones del paquete de configuración serán complicadas.

Configuración¶

Una vez que todos los metadatos se han importado exitosamente, es necesario realizar algunos pasos antes de que el módulo sea funcional.

En primer lugar, deberá utilizar la funcionalidad de Compartir de DHIS2 para configurar qué usuarios (grupos de usuarios) deben ver los metadatos y datos asociados al programa, así como quién puede registrar/ingresar datos en el programa. Por defecto, el compartir se ha configurado para lo siguiente:

Tableros
Visualizaciones, mapas, informes de eventos y tablas de informes
Sets de datos
Opciones de categoría

Consulte la documentación DHIS2 para obtener más información sobre compartir.

Los paquetes incluyen tres grupos de usuarios principales:

IMM_BCU - Access (view metadata/view data)
IMM_BCU - Admin (view and edit metadata/no access to data)
IMM_BCU - Data Capture - (view metadata/capture and view data)

Los usuarios se asignan al grupo de usuarios apropiado según su rol dentro del sistema. El compartir de otros objetos en el paquete puede ajustarse dependiendo de la configuración. Consulte la documentación de DHIS2 sobre compartir para más información.

Roles de usuario¶

Los usuarios necesitarán roles de usuario para poder interactuar con las diversas aplicaciones dentro de DHIS2. Se recomiendan los siguientes roles mínimos:

Análisis de datos Tracker: Puede ver análisis de eventos y acceder a tableros, informes de eventos, visualizador de eventos, visualizador de datos, tablas dinámicas, informes y mapas.
Captura de datos Tracker: Puede agregar valores de datos, actualizar entidades rastreadas, buscar entidades rastreadas en las unidades organizativas y acceder a la aplicación de captura Tracker.

Consulte la Documentación de DHIS2 para obtener más información sobre la configuración de roles de usuario.

Asignación de unidades organizativas{ #organisation-unit-assignment }¶

The data sets must be assigned to organisation units within existing hierarchy in order to be accessible via capture app.

Mapeo de indicadores¶

When implementing the dashboard package only, the indicator numerators and denominators have to be configured using the metadata objects in the existing instance. Configuration information is available in the documentation and the description of numerators and denominators in the metadata file.

Metadatos duplicados¶

NOTA

Esta sección solo aplica si está importando en una base de datos DHIS2 en la que ya existen metadatos. Si está trabajando con una nueva instancia de DHIS2, omita esta sección y vaya a Adaptar el programa Tracker. Si está utilizando aplicaciones de terceros que dependen de los metadatos actuales, tenga en cuenta que esta actualización podría afectarlas.

Incluso cuando los metadatos se han importado exitosamente sin ningún conflicto de importación, puede haber duplicados en los metadatos: elementos de datos, atributos de entidades rastreadas o conjuntos de opciones que ya existen. Como se mencionó en la sección anterior sobre la resolución de conflictos, un aspecto importante a tener en cuenta es que las decisiones sobre la modificación de metadatos en DHIS2 también deben considerar otros documentos y recursos que están asociados de diferentes maneras tanto a los metadatos existentes como a los metadatos importados a través del paquete de configuración. La resolución de duplicados no consiste únicamente en «limpiar la base de datos», sino también en asegurarse de que esto se haga sin, por ejemplo, romper la integración potencial con otros sistemas, la posibilidad de utilizar material de capacitación, la ruptura de los POE, etc. Esto depende en gran medida del contexto.

Es importante tener en cuenta que DHIS2 dispone de herramientas que pueden ocultar algunas de las complejidades de las duplicaciones potenciales en los metadatos. Por ejemplo, cuando existen conjuntos de opciones duplicados, estos pueden ocultarse para grupos de usuarios a través de Compartir.

Adaptar el programa¶

Una vez importado el programa, es posible que desee realizar ciertas modificaciones. Algunos ejemplos de adaptaciones locales que podrían realizarse incluyen:

Añadir variables adicionales al formulario.
Adaptar los nombres de los elementos de datos/opciones según las convenciones nacionales.
Añadir traducciones a las variables y/o al formulario de entrada de datos.
Modificación de indicadores basados en definiciones de casos locales

Sin embargo, se recomienda encarecidamente tener mucha precaución si decide modificar o eliminar cualquiera de los formularios/metadatos incluidos. Existe el riesgo de que las modificaciones rompan funcionalidades, por ejemplo las reglas de programa y los indicadores de programa.

Eliminar metadatos¶

In order to keep your instance clean and avoid errors, it is recommended that you remove the unnecessary metadata from your instance. Removing unnecessary metadata requires advanced knowledge of DHIS2 and various dependencies.