Electronic Immunization Registry Installation Guide¶
Vous devrez suivre les instructions dans leur intégralité pour chaque package que vous installez.
Installation¶
L'installation du module se fait en plusieurs étapes :
- Préparation du fichier de métadonnées avec les métadonnées de DHIS2.
- Importation du fichier de métadonnées dans le DHIS2.
- Configuration des métadonnées importées.
- Adaptation du programme après son importation
Il est recommandé de lire d'abord chaque section avant de commencer le processus d'installation et de configuration dans le DHIS2. Les sections non applicables ont été identifiées, selon que vous importiez dans une nouvelle instance de DHIS2 ou dans une instance de DHIS2 ayant déjà des métadonnées. La procédure décrite dans le présent document doit être testée dans un environnement de test et de simulation avant d'être répétée ou transférée dans une instance de production du DHIS2.
Conditions requises¶
Pour installer le module, il faut nécessairement un compte d'utilisateur administrateur sur DHIS2. La procédure décrite dans le présent document doit être testée dans un environnement de test et de simulation avant d'être exécutée sur une instance de production du DHIS2.
Il faut veiller à ce que le serveur lui-même et l'application DHIS2 soient bien sécurisés, afin de limiter l'accès aux données collectées. Les détails sur la sécurisation d'un système DHIS2 dépassent le cadre de ce document et nous renvoyons à l'adresse Documentation sur le DHIS2.
Préparation du fichier de métadonnées¶
N.B. : Si vous installez le package sur une nouvelle instance du système DHIS2, vous pouvez ignorer la section « Préparation du fichier de métadonnées » et passer immédiatement à la section « Importation 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.
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.
| Objet | UID | Chemin vers l'API |
|---|---|---|
| Catégorie | GLevLNI9wkl | ../api/categories.json?filter=name:eq:default |
| Option de catégorie | xYerKDKCefk | ../api/categoryOptions.json?filter=name:eq:default |
| La combinaison de catégories | bjDvmb4bfuf | ../api/categoryCombos.json?filter=name:eq:default |
| Combinaison d’options catégorie | HllvX50cXC0 | ../api/categoryOptionCombos.json?filter=name:eq:default |
Par exemple, lors de l’importation d’un package de configuration dans https://play.dhis2.org/demo, l’UID de la combinaison d’options de catégorie par défaut pourrait être identifié comme bRowv6yZOF2 par https://play.dhis2.org/demo/api/categoryOptionCombos.json?filter=name:eq:default.
Vous pouvez alors rechercher et remplacer toutes les occurrences de HllvX50cXC0 par bRowv6yZOF2 dans le fichier .json, car il s’agit de l’ID par défaut du système dans lequel vous effectuez l’importation. Notez que cette opération de recherche et de remplacement doit être effectuée avec un éditeur de texte brut, et non avec un traitement de texte 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 | Chemin vers l'API |
|---|---|---|
| Pourcentage | hmSnCXmLYwt | ../api/indicatorTypes.json?filter=number:eq:false&filter=factor:eq:100 |
TrackedEntityType (Type d'entité suivie)¶
Comme pour les types d'indicateurs, il se peut que vous ayez déjà des types d'entités suivies dans votre base de données DHIS2. Les références au type d'entité suivie doivent être modifiées pour refléter ce qui se trouve dans votre système afin d'éviter la création de doublons. Le tableau 3 indique les UID qui pourraient être remplacés, ainsi que les points point d'extrémité de l'API permettant d'identifier les UID existants.
| Objet | UID | Chemin vers l'API |
|---|---|---|
| Personne | MCPQUTHX1Ze | ../api/trackedEntityTypes.json?filter=name:eq:Person |
Visualisations à l'aide de l’UID de l’unité d’organisation de base¶
Les visualisations, les rapports d’événements, les tableaux de rapports et les cartes affectés à un niveau d’unité d’organisation spécifique ou à un groupe d’unités d’organisation comportent un renvoi à l’unité d’organisation de base (niveau 1). Ces objets, s’ils sont présents dans le fichier de métadonnées, contiennent une balise <OU_ROOT_UID>. Utilisez la fonction de recherche de l’éditeur de fichiers .json pour trouver cette balise et la remplacer par l’UID de l’unité d’organisation de niveau 1 dans l’instance cible.
Importation de métadonnées¶
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¶
Pour obtenir un aperçu des métadonnées génériques (objets de métadonnées identiques utilisés par plusieurs packages), veuillez vous référer à l’annexe d’installation du package individuel.
Gestion des conflits d'importation¶
N.B. : Si vous importez dans une nouvelle instance du DHIS2, vous n'aurez pas à vous soucier des conflits d'importation, car il n'y a pas de conflit dans la base de données que vous importez. Suivez les instructions pour importer les métadonnées puis passez à la section “Additional configuration”.
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 existant 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 de 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 sujette aux 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.
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 ensemble d'options existe déjà pour un certain concept (par exemple "sexe"), cet ensemble d'options pourrait être supprimé du fichier .json et toutes les références à son UID remplacées par l'ensemble d'options 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 directe) est d'éviter de créer des métadonnées dupliquées dans la base de données. Il y a des aspects essentiels à prendre en compte lors de ce type de modification :
- il nécessite une connaissance approfondie de la structure détaillée des métadonnées du DHIS2
- Cette approche ne fonctionne pas pour tous les types d'objets. En particulier, certains types d'objets ont des dépendances compliquées à résoudre de cette manière, par exemple en ce qui concerne les désagrégations.
- il sera compliqué de procéder aux futures mises à jour du package de configuration.
Configuration supplémentaire¶
Une fois que toutes les métadonnées sont importées avec succès, des étapes doivent être mises en oeuvre avant que le module ne soit fonctionnel.
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. Par défaut, le partage a été configuré pour ce qui suit :
- Type d'entité suivie
- Programme
- Étapes du programme
- Tableaux de bord
Un package de métadonnées contient généralement plusieurs groupes d’utilisateurs :
- EIR - Immunization access
- EIR - Immunization admin
- EIR - Immunization data capture
Les éléments suivants sont attribués par défaut à ces groupes d'utilisateurs
| Objet | Groupes d'utilisateurs | ||
|---|---|---|---|
| EIR - Immunization access | EIR - Immunization admin | EIR - Immunization data capture | |
| Type d'entité suivie | Métadonnées : peuvent être visualisées Données : peuvent être visualisées | Métadonnées : peuvent être modifiées et visualisées Données : peuvent être visualisées | Métadonnées : peuvent être visualisées Données : peuvent être capturées et visualisées |
| Programme | Métadonnées : peuvent être visualisées Données : peuvent être visualisées | Métadonnées : peuvent être modifiées et visualisées Données : peuvent être visualisées | Métadonnées : peuvent être visualisées Données : peuvent être capturées et visualisées |
| Étapes du programme | Métadonnées : peuvent être visualisées Données : peuvent être visualisées | Métadonnées : peuvent être modifiées et visualisées Données : peuvent être visualisées | Métadonnées : peuvent être visualisées Données : peuvent être capturées et visualisées |
| Tableaux de bord | Métadonnées : peuvent être visualisées Données : peuvent être visualisées | Métadonnées : peuvent être modifiées et visualisées Données : peuvent être visualisées | Métadonnées : peuvent être visualisées Données : peuvent être visualisées |
Veuillez vous référer à l’annexe de l’installation de chaque package pour en savoir plus sur les groupes d’utilisateurs.
Vous chercherez à affecter vos utilisateurs au groupe d’utilisateurs approprié en fonction de leur rôle dans le système. En fonction de votre configuration, vous pouvez activer le partage pour d’autres objets du package. Consultez le site Documentation sur le DHIS2 pour plus d’informations sur la configuration du partage.
Remarque importante : les versions 2.33 et 2.34 comportent un bogue qui remplace les propriétés de partage d’un objet après son importation, même si MERGE est sélectionné comme paramètre d’importation. Ceci est particulièrement important pour l’objet Type d’entité suivie - Personne (UID : MCPQUTHX1Ze) qui est généralement partagé avec des groupes d’utilisateurs de différents packages.
Si votre objet Type d’entité suivie - Personne correspond déjà à celle du package et que vous voulez conserver les propriétés de partage actuelles de cet objet dans la base de données, vous pouvez suivre les étapes suivantes :
- Supprimez cette TET du fichier du package
- Importez le package
- Mettez à jour les propriétés de partage pour cet objet Type d’entité suivie en utilisant le tableau ci-dessus
Rôles des utilisateurs¶
Les utilisateurs auront besoin de rôles utilisateur pour pouvoir utiliser les différentes applications du DHIS2. Les rôles minimums suivants sont recommandés :
- Analyse des données Tracker : Il peut visualiser des analyses d'événements et accéder à des tableaux de bord, des rapports d'événements, un visualiseur d'événements, un visualiseur de données, des tableaux croisés dynamiques, des rapports et des cartes.
- Saisie de données Tracker : possibilité d'ajouter des valeurs de données, de mettre à jour les entités suivies, de rechercher des entités suivies dans les unités d'organisation et d'accéder à l'application Saisie Tracker
Consultez le site Documentation sur le DHIS2 pour plus d'informations sur la configuration des rôles d'utilisateur.
Unités d’Organisation¶
Vous devez assigner le programme à des unités d'organisation au sein de votre propre hiérarchie afin de pouvoir le visualiser dans Saisie Tracker.
Métadonnées dupliquées¶
N.B. : Cette section ne s’applique que si vous importez dans une base de données DHIS2 ayant déjà des métadonnées. Si vous travaillez avec une nouvelle instance du DHIS2, veuillez ignorer cette section et aller à « Adapter le programme Tracker ».
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 - éléments de données, attributs d'entités suivies ou ensembles d'options qui existent 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 le 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, briser le potentiel d'intégration avec d'autres systèmes, la possibilité d'utiliser du matériel de formation, la rupture des SOP, etc. Cela dépend beaucoup du contexte.
Il est important de garder à l’esprit 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 ensembles d’options en double, ils peuvent être masqués pour des groupes d’utilisateurs par le biais de Partage.
Adapter le programme tracker¶
Une fois le programme importé, il est possible que vous souhaitiez y apporter certaines modifications. Voici quelques exemples d'adaptations locales que vous pourrez effectuer :
- Ajout de variables supplémentaires au formulaire.
- Adaptation des noms des éléments de données/options en fonction des usages au niveau national.
- Ajout des traductions aux variables et/ou au formulaire de saisie des données.
- Modification des indicateurs du programme en fonction des définitions de cas locales
Toutefois, il est fortement recommandé de faire preuve d'une grande prudence si vous décidez de modifier ou de supprimer l'un des formulaires/métadonnées inclus. Il y a donc un risque que des modifications brisent des fonctionnalités, par exemple les règles du programme et les indicateurs du programme.