Covid-19 Electronic Immunization Registry - Tracker Installation Guide¶

Tento dokument obsahuje instalační příručku pro aktualizovaný balíček trasování elektronického imunizačního registru COVAC a doplňkový agregační modul pro denní hlášení na základě údajů z trasování.

Výchozí jazyk systému: angličtina

Dostupné překlady: francouzština, španělština, portugalština

Instalace¶

Instalace modulu se skládá z několika kroků:

1. Příprava souboru metadat s metadaty DHIS2.
2. Import souboru metadat do DHIS2.
3. Konfigurace importovaných metadat.
4. Přizpůsobení programu po importu

Před zahájením procesu instalace a konfigurace v DHIS2 se doporučuje nejprve přečíst každou část instalační příručky. Identifikujte příslušné sekce v závislosti na typu vašeho importu:

1. importovat do prázdné instance DHIS2
2. importovat do instance DHIS2 s existujícími metadaty.

Kroky popsané v tomto dokumentu by měly být otestovány v testovací instanci DHIS2 a teprve poté aplikovány na produkční prostředí.

Požadavky¶

Pro instalaci modulu je vyžadován uživatelský účet správce na DHIS2.

Velkou péči je třeba věnovat tomu, aby byl server samotný i aplikace DHIS2 dobře zabezpečeny, měla by být definována přístupová práva ke shromážděným datům. Podrobnosti o zabezpečení systému DHIS2 jsou mimo rozsah tohoto dokumentu a odkazujeme na dokumentaci DHIS2.

Metadata files¶

I když to není vždy nutné, může být často výhodné provést určité úpravy souboru metadat před jeho importem do DHIS2.

Balíček sledování elektronického registru imunizace Covid-19 obsahuje tři soubory metadat. Obsah a účel každého jednotlivého souboru jsou popsány níže:

Note

The package is not an out-of-the-box tool for tracker-to-aggregate data transfer. The structure of the metadata package and the suggested mapping of metadata allow the implementer to set up the transfer of data based on existing tools and guidance. More information is available in the Tracker to aggregate data Transfer Document.

Příprava souboru metadat¶

Mapping guide for data transfer¶

13 programových indikátorů, které lze použít pro přenos dat z trasovače do agregovaného, je mapováno na odpovídající datové prvky a kombinace možností kategorií souhrnné datové sady.

Příklad

Indikátor programu Počet lidí, kteří dostanou první dávku (ženy 0-59) RJ6pdxga9Odje mapován na kombinaci možností kategorie Žena, 0-59 let FsZSFGKirY0 datového prvku COVAC - Lidé s 1. dávkou RjT7dmzunF4

Mapování je založeno na kódech objektů metadat.

Vlastní atribut Datový prvek pro export souhrnných dat vudyDP7jUy5 obsahuje referenční kód prvků agregovaných dat, např. CVC_EIR_AGG_PPL_1ST_DOSE

Pole Kombinace možností kategorie pro agregovaný export obsahuje referenční kódy kombinací možností kategorií, např. CVC_EIR_0059Y_F

Navrhovaný přenos hodnot z trasovače na agregát je založen na následujících požadavcích GET a POST API:

1. Zdrojový požadavek: ../api/analytics/dataValueSet.json?dimension=dx: "{program indicator uid/s}" &dimension=pe: "{relative period/s}" &dimension=ou: {organisation unit level} &outputIdScheme=ATTRIBUTE: {"custom attribute:vudyDP7jUy5"}
2. Cílový požadavek: ..api/dataValueSets?dataElementIdScheme=CODE&categoryOptionComboIdScheme=CODE&importStrategy=CREATE_AND_UPDATE&mergeMode=REPLACE&dryRun=false

Indikátory programu¶

Programové indikátory potřebné pro agregaci hodnot dat jsou zahrnuty ve skupině programových indikátorů COVAC - Trasovač na souhrn NXBR4r6MwAO

Tyto programové indikátory jsou součástí původního balíčku, ale musí být aktualizovány kvůli přidanému mapování.

Note

If the original program indicators in your system were modified as part of local adaptation process, be aware that all changes will be overwritten once you import the updated set of program indicators. If any of your modified program indicators have the same UID as the program indicators listed in the table above, make sure to duplicate the modified program indicators before import.

Výchozí dimenze dat¶

V dřívějších verzích DHIS2 byla UID výchozích datových dimenzí automaticky generována. I když tedy všechny instance DHIS2 mají výchozí volbu kategorie, kategorii datových prvků, kombinaci kategorií a kombinaci možností kategorie, UID těchto výchozích hodnot se mohou lišit. Novější verze DHIS2 mají pevně zakódovaná UID pro výchozí dimenzi a tato UID se používají v konfiguračních balíčcích.

Aby se předešlo konfliktům při importu metadat, je vhodné vyhledat a nahradit celý soubor .json pro všechny výskyty těchto výchozích objektů a nahradit UID souboru .json UID z instance, do které bude soubor importován. Tabulka 1 ukazuje UID, která by měla být nahrazena, a také koncové body API pro identifikaci stávajících UID

Identifikujte UID výchozích dimenzí ve vaší instanci pomocí uvedených požadavků API a nahraďte UID v souboru json UID z instance.

POZNÁMKA

Pamatujte, že tato operace hledání a nahrazování musí být provedena pomocí editoru prostého textu, nikoli textového procesoru, jako je Microsoft Word.

Typy indikátorů¶

Typ indikátoru je dalším typem objektu, který může způsobit konflikt importu, protože určitá jména se používají v různých databázích DHIS2 (např. "Procento"). Vzhledem k tomu, že typy indikátorů jsou definovány svým faktorem (včetně 1 pro indikátory „pouze čitatel“), jsou jednoznačné a lze je nahradit vyhledáváním a nahrazováním UID. Tato metoda pomáhá vyhnout se potenciálním konfliktům při importu a zabraňuje implementátoru ve vytváření duplicitních typů indikátorů. Níže uvedená tabulka obsahuje UID, která lze nahradit, a také koncové body API pro identifikaci stávajících UID:

TrackedEntityType¶

Stejně jako typy indikátorů můžete mít ve své databázi DHIS2 již existující typy trasovaných entit. Odkazy na typ trasované entity by se měly změnit tak, aby odrážely to, co je ve vašem systému, abyste nevytvářeli duplikáty. Níže uvedená tabulka obsahuje UID, která lze nahradit, a také koncové body API pro identifikaci stávajících UID:

Visualizations using Root Organisation Unit UID¶

Vizualizace, sestavy událostí, tabulky sestav a mapy, které jsou přiřazeny konkrétní úrovni organizační jednotky nebo skupině organizačních jednotek, mají odkaz na kořenovou organizační jednotku (úroveň 1). Takové objekty, pokud jsou v souboru metadat přítomny, obsahují zástupný symbol <OU_ROOT_UID>. Použijte funkci vyhledávání v editoru souborů .json k případné identifikaci tohoto zástupného symbolu a jeho nahrazení UID organizační jednotky úrovně 1 v cílové instanci.

Option codes¶

According to the DHIS2 naming conventions, the metadata codes use capital letters, underscores and no spaces. Some exceptions that may occur are specified in the corresponding package documentation. All codes included in the metadata objects in the current version of the package were adjusted to match the naming conventions. It may occur that the codes used in the earlier versions of the package used lower case characters. If data values in the existing implementations contain lower case codes, it is important to update those values directly in the database.

Níže uvedená tabulka obsahuje všechny sady možností, kde byly kódy v balíčku metadat změněny na velká písmena. Před importem metadat do instance zkontrolujte, zda se sady možností ve stávajícím systému shodují se sadami v balíčku .json a použijte stejné kódy možností velkými písmeny.

Níže uvedená tabulka obsahuje prvky metadat, které používají ovlivněnou sadu možností:

Important

During the import, the existing option codes will be overwritten with the updated upper case codes. In order to update the data values for existing data in the database, it is necessary to update the values stored in the database using database commands. Make sure to map existing old option codes and new option codes before replacing the values. Use staging instance first, before making adjustments on the production server.

Pro hodnoty datových prvků použijte:

```SQL
UPDATE programstageinstance
SET eventdatavalues = jsonb_set(eventdatavalues, '{"<affected data element uid>","value"}', '"<new value>"')
WHERE eventdatavalues @> '{"<affected data element uid>":{"value": "<old value>"}}'::jsonb
AND programstageid=<database_programsatgeid>;
```

Pro hodnoty atributu trasované entity použijte:

```SQL
UPDATE trackedentityattributevalue
SET value = <new value>
WHERE trackedentityattributeid=<affected trackedentityattribute database_id> AND value=<old value>;
```

Příklad

Chcete-li nahradit kód možnosti 'yes' za 'YES' pro existující datové hodnoty (datový prvek COVAC - Dříve infikovaný COVID LOU9t0aR0z7) v programové fázi s id=1510410385 (příklad id), bude příkaz nakonfigurován následovně :

UPDATE programstageinstance
SET eventdatavalues = jsonb_set(eventdatavalues, '{"LOU9t0aR0z7","value"}', '"YES"')
WHERE eventdatavalues @> '{"LOU9t0aR0z7":{"value": "yes"}}'::jsonb
AND programstageid=1510410385;

Kódy voleb se také používají ve výrazech programových pravidel, programových indikátorech atd. Pokud aktualizujete volby kódu ve vašem systému, ujistěte se, že aktualizujete kódy ve všech dotčených objektech metadat.

Sort order for options¶

Zkontrolujte, zda pořadí řazení sortOrder možností ve vašem systému odpovídá pořadí řazení možností obsažených v balíčku metadat. To platí pouze v případě, že soubor json a cílová instance obsahují volby a sady voleb se stejným UID.

Po importu se ujistěte, že pořadí řazení možností v sadě možností začíná na 1. V hodnotách pořadí řazení by neměly být žádné mezery (např. 1,2,3,5,6).

Pořadí řazení lze upravit v aplikaci Údržba.

1. Přejděte na příslušnou sadu možností
2. Otevřete sekci „Možnosti“.
3. Použijte alternativy "ŘADIT PODLE JMÉNA", "ŘADIT PODLE KÓDU/HODNOTY" nebo "ŘADIT RUČNĚ".

Import metadat¶

K importu balíčků metadat použijte aplikaci Import/Export DHIS2. Před pokusem o skutečný import metadat je vhodné použít funkci „suchého běhu“ k identifikaci problémů. Pokud "suchý běh" nahlásí nějaké problémy nebo konflikty, podívejte se do sekce konflikty importu níže. Pokud import „suché spuštění“/„ověření“ funguje bez chyby, pokuste se importovat metadata. Pokud import proběhne bez chyb, můžete přistoupit ke konfiguraci modulu. V některých případech se konflikty nebo problémy při importu nezobrazí během „suchého běhu“, ale objeví se při pokusu o vlastní import. V tomto případě budou v souhrnu importu uvedeny všechny chyby, které je třeba vyřešit.

Řešení konfliktů importu¶

POZNÁMKA

Pokud importujete balíček do nové instance DHIS2, nezaznamenáte konflikty importu, protože v cílové databázi nejsou žádná metadata. Po importu metadat přejděte k části „Konfigurace“.

Může dojít k řadě různých konfliktů, i když nejběžnějším je, že v konfiguračním balíčku jsou objekty metadat s názvem, zkratkou a/nebo kódem, které již v cílové databázi existují. Existuje několik alternativních řešení těchto problémů s různými výhodami a nevýhodami. Který z nich je vhodnější, bude záviset například na typu objektu, u kterého ke konfliktu dojde.

Alternativa 1¶

Přejmenujte existující objekt v databázi DHIS2, u kterého existuje konflikt. Výhodou tohoto přístupu je, že není potřeba upravovat soubor .json, protože změny se místo toho provádějí prostřednictvím uživatelského rozhraní DHIS2. To bude pravděpodobně méně náchylné k chybám. To také znamená, že konfigurační balíček zůstane tak, jak je, což může být výhodou například při vydání aktualizací balíčku. Na původní objekty balíčku se také často odkazuje ve školicích materiálech a dokumentaci.

Alternativa 2¶

Přejmenujte objekt, u kterého došlo ke konfliktu v souboru .json. Výhodou tohoto přístupu je, že stávající metadata DHIS2 jsou ponechána tak, jak jsou. To může být faktor, když existuje školicí materiál nebo dokumentace, jako jsou SOP datových slovníků propojených s daným objektem, a to nezahrnuje žádné riziko záměny uživatelů úpravou metadat, se kterými jsou obeznámeni.

Všimněte si, že pro alternativu 1 i 2 může být modifikace stejně jednoduchá jako přidání malého pre / post-fix k názvu, aby se minimalizovalo riziko záměny.

Alternativa 3¶

Třetím a komplikovanějším přístupem je úprava souboru .json pro opětovné použití existujících metadat. Například v případech, kdy pro určitý koncept již existuje sada možností (např. „Pohlaví“), by tato sada možností mohla být odstraněna ze souboru .json a všechny odkazy na jeho UID nahrazeny odpovídající sadou možností již v databázi. Velkou výhodou tohoto (která se neomezuje na případy přímého konfliktu importu) je vyhnout se vytváření duplicitních metadat v databázi. Při provádění tohoto typu modifikace je třeba provést několik klíčových úvah:

• vyžaduje odborné znalosti podrobné struktury metadat DHIS2
• přístup nefunguje u všech typů objektů. Zejména určité typy objektů mají závislosti, které se tímto způsobem komplikovaně řeší, například v souvislosti s rozčleněními.
• budoucí aktualizace konfiguračního balíčku budou komplikované.

Konfigurace¶

Po úspěšném importu všech metadat existuje několik kroků, které je třeba provést, než bude modul funkční.

Sdílení¶

First, you will have to use the Sharing functionality of DHIS2 to configure which users (user groups) should see the metadata and data associated with the program as well as who can register/enter data into the program. By default, sharing has been configured for the following:

• Typ trasované entity
• Program
• Fáze programu
• Ovládací panely
• Vizualizace, mapy, zprávy o událostech a tabulky zpráv
• Datové sady
• Možnosti kategorie

Další informace o sdílení naleznete v dokumentaci DHIS2.

Balíček obsahuje čtyři základní skupiny uživatelů:

• COVAC - Analýza dat imunizace COVID-19
• COVAC – Správa údajů o imunizaci COVID-19
• COVAC – Zadání údajů o imunizaci COVID-19
• COVAC – Správa metadat imunizace COVID-19

Ve výchozím nastavení jsou těmto skupinám uživatelů přiřazena následující oprávnění:

Uživatelé jsou přiřazeni do příslušné skupiny uživatelů na základě jejich role v systému. Sdílení pro další objekty v balíčku může být upraveno v závislosti na nastavení. Další informace naleznete v dokumentaci DHIS2 o sdílení.

User roles¶

Uživatelé budou potřebovat uživatelské role, aby mohli pracovat s různými aplikacemi v rámci DHIS2. Doporučují se následující minimální role:

1. Analýza dat trasovače: Může zobrazit analytiku událostí a přistupovat k ovládacím panelům, zprávám o událostech, vizualizátorům událostí, vizualizátorům dat, kontingenčním tabulkám, zprávám a mapám.
2. Zachycování dat Trasovače: Může přidávat datové hodnoty, aktualizovat trasované entity, prohledávat trasované entity napříč organizačními jednotkami a přistupovat k zachycení trasovačů

Další informace o konfiguraci rolí uživatelů najdete v dokumentaci DHIS2.

Organisation units¶

Program a datové sady musí být přiřazeny organizačním jednotkám v rámci stávající hierarchie, aby byly přístupné prostřednictvím aplikací pro sledování / zachycování.

Duplikovaná metadata¶

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. If you are using any third party applications that rely on the current metadata, please take into account that this update could break them.

I když byla metadata úspěšně importována bez jakýchkoli konfliktů při importu, v metadatech mohou existovat duplikáty - datové prvky, trasované atributy entit nebo sady voleb, které již existují. Jak bylo uvedeno v části výše o řešení konfliktů, je třeba mít na paměti důležitý problém, že rozhodnutí o provádění změn metadat v DHIS2 musí také zohledňovat další dokumenty a zdroje, které jsou různými způsoby spojeny s existujícími metadaty a metadata, která byla importována prostřednictvím konfiguračního balíčku. Vyřešení duplikátů tedy není jen otázkou „vyčištění databáze“, ale také zajištěním toho, aby se tak dělo například bez narušení potenciálu integrace s jinými systémy, možnosti použít školicí materiál, rozbití SOP atd. To bude velmi záviset na kontextu.

Jedna důležitá věc, kterou je třeba mít na paměti, je, že DHIS2 má nástroje, které mohou skrýt některé složitosti potenciálních duplikací v metadatech. Například tam, kde existují duplicitní sady možností, mohou být skryty pro skupiny uživatelů pomocí sharing.

Adapting the program¶

Once the program has been imported, you might want to make certain modifications to the program. Examples of local adaptations that could be made include:

• Přidání dalších proměnných do formuláře.
• Přizpůsobení názvů datových prvků / možností podle národních konvencí.
• Přidávání překladů do proměnných nebo do formuláře pro zadávání údajů.
• Úprava indikátorů programu na základě místních definic případů

Důrazně se však doporučuje věnovat velkou pozornost, pokud se rozhodnete změnit nebo odebrat některý ze zahrnutých formulářů / metadat. Existuje nebezpečí, že by úpravy mohly narušit funkčnost, například pravidla programu a indikátory programu.

Removing metadata¶

Aby byla vaše instance čistá a předešlo se chybám, doporučuje se z instance odstranit nepotřebná metadata.

Původní ovládací panel COVAC - registr vakcín COVID-19 YYtAbckt77l byl z aktualizovaného balíčku odstraněn a nahrazen novým ovládacím panelem: COVAC - Daily monitoring iBWlFCvvtkH

Chcete-li odstranit starý ovládací panel ze systému, musíte:

1. Poznamenat si názvy / UID všech objektů obsažených na ovládacím panelu.
2. Odstranit všechny položky z ovládacího panelu a uložit to.
3. Smazat ovládací panel.
4. Odstranit všechny vizualizace, mapy, zprávy o událostech a tabulky zpráv obsažené v původním ovládacím panelu.

POZNÁMKA

Přímo z databáze pomocí SQL příkazů je možné smazat ovládací panel, jeho položky a všechny relevantní vizualizace, mapy a sestavy.