Guide d'installation du package d'agrégats COVID-19

Aperçu

Ce document est destiné à guider les administrateurs dans le processus d'installation du package de configuration standard COVID-19 pour DHIS2 pour la déclaration des données agrégées. Il est donc nécessaire d'avoir une bonne compréhension de DHIS2.

Les packages de configuration pour DHIS2 consistent en un fichier de métadonnées au format JSON qui peut être importé dans une instance de DHIS2, ainsi que la documentation associée. Le package fournit un contenu prédéfini et standard selon les recommandations de l'OMS. Ce document couvre des packages complets qui comprennent des configurations de collecte de données (ensembles de données, éléments de données, règles de validation) ainsi que des analyses et des tableaux de bord (graphiques, cartes et tableaux croisés dynamiques favoris). Il est destiné à être utilisé lorsqu'aucune collecte de données n'est configurée dans DHIS2, ou en cas de remplacement ou de révision du contenu existant pour l'aligner sur les recommandations de l'OMS.

Les packages de configuration se composent de 4 éléments principaux :

Ces composantes sont toutes liées, c'est-à-dire que les indicateurs sont basés sur les éléments de données inclus, les résultats analytiques sont basés sur les indicateurs inclus, et les tableaux de bord sont constitués des résultats analytiques inclus.

Installation

L'installation du module se fait en deux étapes :

  1. Préparer le fichier de métadonnées avec les métadonnées de DHIS2.
  2. Importer le fichier de métadonnées dans DHIS2.
  3. Configurer les métadonnées importées.
  4. Effectuer des modifications spécifiques au package.

Cette section traite des deux premières étapes que sont la préparation et l'importation du fichier de métadonnées dans DHIS2, tandis que la procédure de configuration est abordée dans la section suivante. Il est recommandé de lire les deux sections avant de commencer le processus d'installation et de configuration dans DHIS2. Outre les étapes générales décrites ici, certains des packages de configuration comportent des annexes au guide d'installation, qui décrivent des points particuliers. Ces annexes sont énumérées dans la section appropriée [ici] (https://who.dhis2.org/documentation#configuration-packages).

La procédure décrite dans ce document doit être testée dans un environnement de test et de simulation avant d'être répétée ou transférée à une instance de production du DHIS2.

Packages à configuration multiple

Certains packages de configuration ont des métadonnées qui se chevauchent, par exemple les indicateurs. Cela signifie que dans certaines situations, les modifications apportées aux métadonnées des packages de configuration importés précédemment peuvent être écrasées lors de l'importation d'un package différent. Cela peut être évitée en important des métadonnées "nouvelles seulement" plutôt que "nouvelles et mises à jour", mais notez que dans les deux cas, des modifications manuelles seront nécessaires. Vous devez au moins vous assurer que les métadonnées utilisées par plusieurs programmes sont [partagées] (https://who.dhis2.org/documentation/access-and-sharing) avec les groupes d'utilisateurs appropriés pour les deux programmes.

Conditions requises

Pour installer le package de configuration, un compte d'utilisateur administrateur dans DHIS2 est nécessaire, avec les autorisations permettant d'ajouter/de modifier les objets de métadonnées (publiques), y compris (mais sans s'y limiter) :

La liste complète des objets inclus dans le package (pour lesquels l'administrateur a besoin d'autorisation avant de les gérer) se trouve dans le Document de référence des métadonnées pour le package de configuration en question.

Si des modifications du fichier de métadonnées .json du package de configuration doivent être apportées (voir ci-dessous), il convient d'utiliser un éditeur de texte. Ces modifications ne doivent pas être effectuées avec un logiciel de traitement de textes tel que Microsoft Word.

Le package de configuration peut être installé dans le DHIS2 par l'intermédiaire de l'application DHIS2 Health, ou manuellement par le biais d'un fichier .json contenant les métadonnées du DHIS2 en utilisant l'application Importer/Exporter du DHIS2. La procédure décrite dans le reste de cette section s'applique au processus d'importation manuelle des métadonnées.

La section [Configuration] (https://who.dhis2.org/documentation/installation_guide_complete.html#configuration) s'applique aux deux méthodes.

Préparation du fichier de métadonnées

N.B. : Si vous installez le package sur une nouvelle instance de DHIS2, vous pouvez alors ignorer la section "Préparation du fichier de métadonnées" et passer immédiatement à la section "Importer un fichier de métadonnées dans DHIS2".

Bien que ce ne soit pas toujours nécessaire, il peut souvent être avantageux d'apporter certaines modifications au fichier de métadonnées avant son importation dans DHIS2.

Dimension de données par défaut

Dans les premières versions de DHIS2, l'UID de la dimension des données par défaut était généré automatiquement. Ainsi, alors que toutes les instances du DHIS2 ont une option de catégorie par défaut, une catégorie d'élément de données, une combinaison de catégories et une combinaison d'options de catégories, les UID de ces valeurs par défaut peuvent être différents. Les versions plus récentes de DHIS2 ont des UID codés en dur pour la dimension par défaut, et ce sont ces UID qui sont utilisés dans les packages de configuration.

Pour éviter les conflits lors de l'importation des métadonnées, il est conseillé de rechercher et de remplacer l'ensemble du fichier .json pour toutes les occurrences de ces objets par défaut, en remplaçant les UID du fichier .json par les UID de la base de données dans laquelle le fichier sera importé. Le tableau 1 indique les UID qui doivent être remplacés, ainsi que les point d'extrémité de l'API pour l'identification des UID existants.

Objet UID Point d'extrémité de l'AP
Catégorie GLevLNI9wkl ../api/categories.json?filter=name:eq:default
Option de catégorie xYerKDKCefk ../api/categoryOptions.json?filter=name:eq:default
Combinaison de catégories bjDvmb4bfuf ../api/categoryCombos.json?filter=name:eq:default
Combinaison d'options de catégories HllvX50cXC0 ../api/categoryOptionCombos.json?filter=name:eq:default

Par exemple, si vous importez un package de configuration dans https://play.dhis2.org/demo, l'UID de la combinaison d'options de catégorie par défaut peut être identifié via https://play.dhis2.org/demo/api/categoryOptionCombos.json?filter=name:eq:default comme bRowv6yZOF2. Vous pouvez alors rechercher et remplacer toutes les occurrences de HllvX50cXC0 par bRowv6yZOF2 dans le fichier .json. Notez que cette opération de recherche et de remplacement doit être effectuée avec un éditeur de texte brut, et non avec un logiciel de traitement de textes comme Microsoft Word.

Types d'indicateurs

Le type d'indicateur est un autre type d'objet pouvant créer un conflit d'importation puisque certains noms sont utilisés dans différentes bases de données de DHIS2 ("Pourcentage", par exemple). Étant donné que les types d'indicateurs sont définis simplement par leur facteur et par le fait qu'il s'agisse ou non de simples nombres sans dénominateur, ils sont sans aucune ambiguïté et peuvent être remplacés par une recherche et un remplacement des UID. Cela permet d'éviter d'éventuels conflits d'importation et de ne pas créer de types d'indicateurs dupliqués. Le tableau 2 montre les UID qui pourraient être remplacés, ainsi que les points d'extrémité de l'API pour identifier les UID existants

Objet UID Point d'extrémité de l'AP
Numérateur uniquement (nombre) kHy61PbChXr ../api/indicatorTypes.json?filter=number:eq:true&filter=factor:eq:1
Pourcentage hmSnCXmLYwt ../api/indicatorTypes.json?filter=number:eq:false&filter=factor:eq:100

N.B. 1 : en remplaçant les UID comme décrit et en important le fichier .json, le nom (y compris les traductions éventuelles) des types d'indicateurs en question sera mis à jour pour correspondre à ceux inclus dans les packages de configuration.

Note 2 : Une alternative à la réutilisation des types d'indicateurs existants consiste à importer les types qui sont inclus dans le package de configuration, puis à supprimer ceux qui se chevauchent. Pour ce faire, il faut mettre à jour tous les indicateurs utilisant les types déjà présents avec les ceux nouvellement importés, et ensuite supprimer les types d'indicateurs qui existaient alors.

Importation de métadonnées dans DHIS2

Le fichier de métadonnées .json est importé via l'application Importer/Exporter de DHIS2. Il est conseillé d'utiliser la fonction "test" pour identifier les problèmes avant d'essayer d'importer les métadonnées. Si la fonction "test" signale des problèmes ou des conflits, consultez la section [importer des conflits] (https://who.dhis2.org/documentation/installation_guide_complete.html#handling-import-conflicts) ci-dessous.

Si l'importation "d'essai"/"de validation fonctionne sans erreur, essayez d'importer les métadonnées. Si l'importation réussit sans aucune erreur, vous pouvez alors passer à la configuration du module. Dans certains cas, les conflits ou les problèmes d'importation ne sont pas affichés pendant le "test", mais apparaissent lorsque l'on tente l'importation proprement dite. Dans ce cas, le résumé de l'importation énumère les erreurs à résoudre.

Gestion des conflits d'importation

N.B. : Si vous importez dans une nouvelle instance DHIS2, vous n'aurez pas à vous soucier des conflits d'importation, car il n'y a rien dans la base de données que vous importez qui puisse entrer en conflit avec celle-ci. Suivez les instructions pour importer les métadonnées, puis passez à la section "Configuration supplémentaire".

Plusieurs de conflits peuvent survenir, mais le plus courant est le fait qu'il y ait des objets de métadonnées dans le package de configuration avec un nom, un nom abrégé et/ou un code qui existe déjà dans la base de données cible. Il existe plusieurs solutions alternatives à ces problèmes, avec de différents avantages et inconvénients. La solution la plus appropriée dépendra, par exemple, du type d'objet pour lequel un conflit survient.

Option 1

Renommez l'objet de votre base de données DHIS2 pour lequel il y a un conflit. L'avantage de cette approche est que vous n'avez pas besoin de modifier le fichier .json, puisque les modifications sont effectuées par l'interface utilisateur de DHIS2. Cette méthode est probablement moins susceptible d'entraîner des erreurs. Cela signifie également que le package de configuration est laissé tel quel, ce qui peut être un avantage, par exemple, lorsque du matériel de formation et de la documentation basés sur le package de configuration seront utilisés.

Option 2

Renommez l'objet pour lequel il y a un conflit dans le fichier .json. L'avantage de cette approche est que les métadonnées DHIS2 existantes sont laissées telles quelles. Cela peut être un facteur lorsqu'il y a du matériel de formation ou de la documentation, comme les procédure normale d'exploitation des dictionnaires de données liés à l'objet en question, et cela n'implique aucun risque de confusion pour les utilisateurs lors de la modification des métadonnées qui leur sont familières. Au même moment, la modification de l'objet du fichier .json signifie que l'utilisation de la documentation et du matériel de formation associés pourrait devenir plus compliquée.

Notez que pour les deux options 1 et 2, la modification peut être aussi simple que l'ajout d'un petit pré/post-fixe au nom, pour minimiser le risque de confusion.

Option 3

Une troisième approche, plus complexe, consiste à modifier le fichier .json pour réutiliser les métadonnées existantes. Par exemple, dans les cas où un indicateur existe déjà pour un certain concept (par exemple "Couverture de CPN 1"), cet indicateur pourrait être supprimé du fichier .json et toutes les références à son UID remplacées par l'indicateur correspondant existant déjà dans la base de données. Le grand avantage de cette méthode (qui n'est pas limitée aux seuls cas où il y a un conflit d'importation direct) est d'éviter de créer des métadonnées en double dans la base de données. Cependant, elle n'est généralement pas recommandée pour plusieurs raisons :

Configuration supplémentaire

Une fois que toutes les métadonnées ont été importées avec succès, le module devrait être utilisable avec seulement quelques ajustements mineurs supplémentaires. En outre, en fonction de l'instance DHIS2 dans laquelle le module a été importé, une configuration et des modifications supplémentaires peuvent être nécessaires ou avantageuses. Cette section passera d'abord en revue les étapes de configuration nécessaires, puis mentionnera certains des autres types de modifications ou de configuration qui pourraient être utiles.

Configuration requise

Avant que les packages de configuration puissent être utilisés pour la collecte de données, deux étapes sont nécessaires.

Les ensembles de données doivent être attribués aux unités d'organisation (établissements) qui sont censées faire rapport sur cet ensemble de données particulier.

Les ensembles de données et les options de catégories doivent également être partagés avec le ou les groupe(s) d'utilisateurs concernés du personnel chargé de la saisie des données pour ces ensembles de données.

Partage

Tout d'abord, vous devrez utiliser la fonctionnalité Partage de DHIS2 pour configurer quels utilisateurs (groupes d'utilisateurs) doivent voir les métadonnées et les données associées au programme ainsi que qui peut enregistrer/saisir des données dans le programme. La fonctionnalité Partage doit être configurée pour ce qui suit :

Trois groupes d'utilisateurs sont inclus dans le package :

Nous recommandons l'accès suivant

Objet Groupe d'utilisateurs
COVID19 Accès COVID19 Administrateur COVID19 Saisie de données
Eléments de données/Groupe d'éléments de données Métadonnées : peut visualiser

Données : peut visualiser

Métadonnées : peut modifier et visualiser

Données : peut visualiser

Métadonnées : peut visualiser

Données : peut visualiser

Indicateurs/Groupe d'indicateurs Métadonnées : peut visualiser

Données : peut visualiser

Métadonnées : peut modifier et visualiser

Données : peut visualiser

Métadonnées : peut visualiser

Données : peut visualiser

Ensembles de données Métadonnées : peut visualiser

Données : peut visualiser

Métadonnées : peut modifier et visualiser

Données : peut visualiser

Métadonnées : peut visualiser

Données : peut saisir et visualiser

Tableaux de bord Métadonnées : peut visualiser

Données : peut visualiser

Métadonnées : peut modifier et visualiser

Données : peut visualiser

Métadonnées : peut visualiser

Données : peut visualiser

Métadonnées dupliquées

Même lorsque les métadonnées sont importées avec succès sans aucun conflit d'importation, il peut y avoir des doublons dans les métadonnées - qu'il s'agisse d'un graphique, d'un indicateur, d'un élément de données ou d'une catégorie d'éléments de données qui existe déjà. Comme indiqué dans la section ci-dessus sur la résolution des conflits, il est important de garder à l'esprit que les décisions relatives à la modification des métadonnées dans DHIS2 doivent également tenir compte d'autres documents et ressources associés de différentes manières aux métadonnées existantes et aux métadonnées importées par le biais du package de configuration. La résolution des doublons ne consiste donc pas seulement à "nettoyer la base de données", mais aussi à s'assurer que cela est fait sans, par exemple, casser le potentiel d'intégration avec d'autres systèmes, la possibilité d'utiliser du matériel de formation, la violation des procédures, etc. Cela dépend beaucoup du contexte.

Une chose importante à garder à l'esprit est que le DHIS2 dispose d'outils pouvant dissimuler certaines des complexités des duplications potentielles dans les métadonnées. Par exemple, lorsqu'il existe des catégories d'éléments de données double, ces doublons peuvent être masqués aux utilisateurs finaux grâce à des ensembles de groupes d'options de catégories, ou certains objets de métadonnées peuvent être masqués pour des groupes d'utilisateurs à travers l'option de partage.

Il est recommandé de ne pas supprimer ou remplacer les indicateurs inclus dans les packages de configuration même si le même indicateur existe déjà, afin de pouvoir conserver les résultats analytiques (qui, eux, reposent exclusivement sur des indicateurs). Cela permettra de réutiliser le matériel de formation basé sur les packages de configuration.

Exemples d'autres modifications

Outre la configuration requise, il existe plusieurs autres modifications et configurations qui peuvent s'avérer utiles, en fonction de la situation spécifique. Il ne sera pas possible de fournir des orientations et des recommandations couvrant tous les différents scénarios, mais nous présentons ici une brève discussion de certains problèmes courants.

Les traductions

Des traductions supplémentaires pourraient être ajoutées, si d'autres langues que celles incluses sont nécessaires.

Ajout de variables supplémentaires

Les packages de configuration comprennent les principaux éléments de données et indicateurs recommandés. Toutefois, il peut être nécessaire dans certains cas d'ajouter des variables supplémentaires pour répondre aux besoins d'information spécifiques à chaque pays. Ces variables peuvent être ajoutées aux ensembles de données inclus.

Mise à jour de la présentation des formulaires de déclaration

Pour faciliter le travail du personnel chargé de la saisie des données dans DHIS2, il est parfois souhaitable d'ajouter un formulaire de saisie personnalisé qui correspond au format des formulaires papier utilisés au premier niveau.

Maintenance

Aucune maintenance particulière n'est requise pour les packages de configuration, puisqu'ils sont constitués de métadonnées standard de DHIS2. Toutefois, avant de passer aux nouvelles versions de DHIS2, il est important de tester toutes les fonctionnalités du système en général sur un serveur de test ou de préproduction avant la mise à niveau des instances de production du système.