CodeManager: verschil tussen versies
(→Korte beschrijving) |
(→CodeManager gebruikersinterface) |
||
(17 tussenliggende versies door dezelfde gebruiker niet weergegeven) | |||
Regel 11: | Regel 11: | ||
Het programma CodeManager kent de volgende besturingselementen:<br> | Het programma CodeManager kent de volgende besturingselementen:<br> | ||
{| | {| | ||
− | |[[Bestand: | + | |[[Bestand:CodeManagementUI.png]] |
|- | |- | ||
|align= "center"| Figuur 1: CodeManager gebruikersinterface | |align= "center"| Figuur 1: CodeManager gebruikersinterface | ||
Regel 29: | Regel 29: | ||
<li><span style="font-variant: small-caps;">Maak backup bij opslaan</span>: Vinkvak: Indien aangevinkt wordt voor het opslaan van de wijzigingen eerst een backup gemaakt.<sup>1</sup><br> | <li><span style="font-variant: small-caps;">Maak backup bij opslaan</span>: Vinkvak: Indien aangevinkt wordt voor het opslaan van de wijzigingen eerst een backup gemaakt.<sup>1</sup><br> | ||
</li> | </li> | ||
− | <li><span style="font-variant: small-caps;">Initieel data inlezen</span>: Geeft het bestandsselectie veld vrij voor initieel laden van de codestelsels.<br> | + | <li><span style="font-variant: small-caps;">Initieel data inlezen</span>: Vinkvak: Geeft het bestandsselectie veld vrij voor initieel laden van de codestelsels.<br> |
</li> | </li> | ||
<li><span style="font-variant: small-caps;">Export Wiki pagina</span>: Maakt een wiki pagina aan met een overzicht van de codestelsels.<br> | <li><span style="font-variant: small-caps;">Export Wiki pagina</span>: Maakt een wiki pagina aan met een overzicht van de codestelsels.<br> | ||
Regel 62: | Regel 62: | ||
<li>'''Actieknoppen'''<br> | <li>'''Actieknoppen'''<br> | ||
<span style="font-variant: small-caps;">Annuleren</span>: Wijzigingen niet doorvoeren, c.q. aanmaken nieuw item afbreken<br> | <span style="font-variant: small-caps;">Annuleren</span>: Wijzigingen niet doorvoeren, c.q. aanmaken nieuw item afbreken<br> | ||
− | <span style="font-variant: small-caps;">Wijzigen</span>: Doorvoeren wijzigingen. Indien een naam gewijzigd is, zal een nieuwe versie van de naam aangemaakt worden en de oude op deprecated gezet worden.<br> | + | <span style="font-variant: small-caps;">toevoegen/Wijzigen</span>: Doorvoeren wijzigingen. Indien een naam gewijzigd is, zal een nieuwe versie van de naam aangemaakt worden en de oude op deprecated gezet worden.<br> |
− | <span style="font-variant: small-caps;">Nieuw</span>: Aanmaken nieuw item (groep/codestelsel/code). | + | <span style="font-variant: small-caps;">Nieuw</span>: Aanmaken nieuw item (groep/codestelsel/code). De naam van de middelste knop vanandert van 'Wijzigen' naar 'Toevoegen'. |
</li> | </li> | ||
<li>'''Statusbalk'''<br> | <li>'''Statusbalk'''<br> | ||
Regel 72: | Regel 72: | ||
==Gebruik== | ==Gebruik== | ||
− | ====Aanmaken nieuw | + | ====Aanmaken nieuw item==== |
− | + | Selecteer in de boom een item op het niveau waar het nieuwe item toegevoegd moet worden.<br> | |
− | Druk op de knop 'Nieuw'. | + | Selecteer dus voor het toevoegen van een groep een codestelselgroep, voor een codestelsel een codestelsel binnen de groep waarin dit codestelsel toegevoegd moet worden en voor een code een code uit het betreffende codestelsel.<br> |
− | + | Druk op de knop 'Nieuw'. Voor groepen en codestelsels zal automatisch een OID aangemaakt worden. Deze kan niet gewijzigd worden.<br> | |
− | Voer de Nederlandse en Engelse | + | Bij een nieuwe code moet het code veld gevuld worden. Codes moeten binnen het codestelsel uniek zijn.<br> |
− | + | Voer de Nederlandse en Engelse naam voor het item in in het 'Naam NL' resp. 'Naam EN veld. Minimaal één naam moet gevuld zijn.<br> | |
Druk, als de teksten naar tevredenheid ingevoerd zijn, op de knop 'Toevoegen'<br> | Druk, als de teksten naar tevredenheid ingevoerd zijn, op de knop 'Toevoegen'<br> | ||
− | + | [[Bestand:Warning-icon.png]] Aan de groep 'Algemeen' mogen geen codestelsels meer toegevoegd worden en aan het codestelsel 'NL-CM-VS' geen codes. Dit codestelsel is een overblijfsel uit het verleden. | |
+ | De invoer kan op ieder moment gestopt worden door op 'Annuleren' te drukken. | ||
− | ====Wijzigen van een | + | ====Wijzigen van de naam van een item==== |
− | + | Selecteer in de boom het item waarvan de naam of namen gewijzigd moet worden. Hiervoor kan het noodzakelijk zijn om de boom uit te klappen<br> | |
− | In de ' | + | In de 'Concept' velden verschijnt de code of de OID en de Nederlandse en Engelse naam.<br> |
− | Pas de | + | De code of de OID kan niet gewijigd worden. Pas de namen naar behoeve aan. Als één van de namen gewijzigd wordt, wordt de knop 'Wijzigen' vrij gegeven<br> |
− | |||
Druk, als de teksten naar tevredenheid gewijzigd zijn, op de knop 'Wijzigen'<br> | Druk, als de teksten naar tevredenheid gewijzigd zijn, op de knop 'Wijzigen'<br> | ||
− | + | [[Bestand:Warning-icon.png]] Het wijzigen van de naam van in gebruik zijnde codes moet vermeden worden. | |
+ | Gebruik deze optie in dat geval alleen voor het herstel van typ- of taalfouten of om bv. een ontbrekende Engelse naam toe te voegen. | ||
+ | Bij het wijzigen van een naam zal in code bestand bij de betreffende code een nieuwe naam entry gemaakt worden en de oude op deprecated gezet worden.<br> | ||
+ | Hiermee blijft de geschiedenis bewaard. De oude naam herstellen kan niet via deze applicatie, maar handmatig kan evt. de xml file aangepast worden. | ||
− | ==== | + | ====Item op 'Deprecated' zetten==== |
− | + | Als een groep, codestelsel of code niet langer geldig is kan de status van het item op 'Deprecated' gezet worden.<br> | |
− | Druk op de | + | Het item blijft in de applicatie zichtbaar maar is uitgegrijsd en kan niet meer gewijzigd worden.<br> |
− | + | Om dit te doen, wordt het item geselecteerd zoals beschreven onder 'Wijzigen' en wordt het concept blok het vinkje 'Actief' verwijderd.<br> | |
+ | Druk daarna op 'Wijzigen'.<br> | ||
+ | Deze actie is éénmalig. Vanuit de gebruikersinterface kan dit niet teruggedraaid worden. | ||
+ | |||
+ | ====Publiceren van de codestelsels op de wiki==== | ||
+ | De codestelsels worden op de zibs wiki gepubliceerd. De publicatiecyclus hiervan staat los van de publicatiecyclus van de zibs.<br> | ||
+ | De publicatie bestaat uit twee delen (op twee verschillende wiki pagina's): een [[Zib_Codestelsels#Overzicht codestelsels voor waardenlijsten | overzicht van alle codestelsels]] en de [[ZibCodeSystems |codestelsels incl. alle codes]].<br> | ||
+ | De twee delen komen overeen met de menu opties 'Export Wiki pagina' en 'Publiceer codestelsels'<br> | ||
+ | De eerste optie is alleen zinvol als er een nieuwe groep of nieuw codestelsel bijgekomen is. In dat geval moet ook de tweede optie uitgevoerd worden.<br> | ||
+ | Indien codes gewijzigd of toegevoegd zijn, kan het zinvol zijn om opnieuw te publiceren.<br> | ||
+ | Bij publicatie wordt een keuzescherm getoond waarin aangegeven kan worden of de wijzigingen een major of minor versie ophoging vereisen. De criteria doorvoor vallen buiten de scope van de helppagina.<br> | ||
+ | {| | ||
+ | |[[Bestand:CodeManagement-Publish.png]] | ||
+ | |- | ||
+ | |align= "center"| Figuur 2: CodeManager publicatie | ||
+ | |} | ||
+ | Tijdens de publicatie zal voor ieder codestelsel gecontroleerd worden of er wijzigingen zijn die een latere datum hebben dan de publicatiedatum van dat codestelsel.<br> | ||
+ | Indien dat zo is wordt het versienummer van dat codestelsel conform de eerder genoemde keuze opgehoogd.<br> | ||
+ | Gezien dit mechanisme is het aan te bevelen om na iedere grotere wijziging van een codestelsel een publicatie te doen en slechts wijzigingen in verschillende codestelsels te combineren in een publicatie als de major/minor vraag voor deze wijgingen gelijk is.<br> Een publicatie heeft geen impact op versienummers van niet gewijzigde codestelsels.<br> | ||
+ | Bij deze export wordt een directory structuur aangemaakt conform de eisen van het programma ZibExtractor en met de naam CodeManagement.<br> | ||
+ | De export wiki secties worden hierin geplaatst en kunnen vervolgens met ZibExtractor ge-upload worden. | ||
====Afsluiten van de applicatie==== | ====Afsluiten van de applicatie==== | ||
De applicatie kan gesloten worden met de menu knoppen en op de gebruikelijke Windows manieren (rode kruis, alt F4 etc.)<br> | De applicatie kan gesloten worden met de menu knoppen en op de gebruikelijke Windows manieren (rode kruis, alt F4 etc.)<br> | ||
− | [[Bestand:Warning-icon.png]] De | + | [[Bestand:Warning-icon.png]] De knop 'Wijzigen' wijzigt alleen de namen en evt code in het geheugen, niet in het code bestand. |
Daarom moeten na wijzigingen altijd ook nog het menu item 'Opslaan' geselecteerd worden. Hiermee worden de wijzigingen ook in het bestand opgeslagen. | Daarom moeten na wijzigingen altijd ook nog het menu item 'Opslaan' geselecteerd worden. Hiermee worden de wijzigingen ook in het bestand opgeslagen. | ||
+ | Hiervan kan echter ook gebruik worden gemaakt: als een invoerfout geconstateerd wordt na het wijzigen maar voor het opslaan, kan het programma beëindigd worden zonder op te slaan. | ||
+ | De foutieve wijzigingen worden dan niet geëffectueerd. Echter gaan ook alle andere wijzigingen verloren. | ||
Als er wijzigingen aangebracht zijn en de applicatie op een of andere wijze afgesloten wordt zonder dat de wijzigingen opgeslagen zijn,<br> | Als er wijzigingen aangebracht zijn en de applicatie op een of andere wijze afgesloten wordt zonder dat de wijzigingen opgeslagen zijn,<br> | ||
wordt een dialoog getoond worden met de vraag of de wijzigingen alsnog opgeslagen moeten worden. | wordt een dialoog getoond worden met de vraag of de wijzigingen alsnog opgeslagen moeten worden. | ||
− | |||
− | |||
− | |||
==Configureerbare gegevens== | ==Configureerbare gegevens== | ||
Regel 117: | Regel 139: | ||
|De basis url van deze wiki | |De basis url van deze wiki | ||
|Hiermee wordt de url van deze pagina aangemaakt. | |Hiermee wordt de url van deze pagina aangemaakt. | ||
− | |<span | + | |<span>ZibAppsStart.cfg </span> |
|<nowiki>https://zibs.nl/wiki</nowiki> | |<nowiki>https://zibs.nl/wiki</nowiki> | ||
|Nee | |Nee | ||
|- | |- | ||
− | | | + | |CodeSystemCodesLocation |
− | |Locatie | + | |Locatie van het bestand met codestelsels |
− | | | + | |Kernbestand van deze applicatie. |
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span> | |<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span> | ||
− | | | + | |..\ZIB centrum - Documenten\9. Overig\9.5. Software\Config |
||Nee | ||Nee | ||
|- | |- | ||
− | | | + | |CodeSystemCodesFilename |
− | | | + | |Naam van het bestand met codestelsels. |
− | | | + | |Kernbestand van deze applicatie. |
− | |<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction"> | + | |<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg</span> |
− | | | + | |Codes.xml |
− | || | + | ||Nee |
|} | |} | ||
Huidige versie van 4 nov 2023 om 21:54
Inhoud
Manual pagina's
- Enterprise Architect plug-in voor zib's
- Publicatie van zibs
- ZibExtraction user interface
- Configuratie user interface
- Controleren SNOMED CT en LOINC codes
- Beheer wikipage labels
- Beheer publicaties en groepen
- Beheer codestelsels en codes
- Beheer zib identifiers
Korte beschrijving
Bepaalde types concepten en waardelijsten van concepten in sommige bouwstenen bevatten elementen waarvoor geen SNOMED CT (of ander codestelsel) concept bestaat en waarvoor ook geen code aangemaakt gaat worden.
In deze gevallen wordt een 'eigen' codestelsel aangemaakt, zodat de waarden die deze zib concepten aan kunnen nemen toch gecodeerd kunnen worden vastgelegd en uitgewisseld.
Het aanmaken en beheren van deze codestelsels en codes gebeurt met deze applicatie. De gegevens van deze codestelsels staan in een centraal beheerd bestand dat met deze applicatie bewerkt kan worden.
Het biedt de mogelijkheid nieuwe codestelsels en codes aan te maken, de namen van bestaande codes te wijzigen en codes of hele codestelsels op 'deprecated' te zetten, als b.v. er toch een code uit een bestaand codestelsel toegepast kan worden.
Aan codes kan een Nederlandse en een Engelse naam gegeven worden. Indien beide beschikbaar zijn, zal bij publicatie met ZibExtractor op de NL en EN wiki pagina de bijbehorende naam getoond worden.
CodeManager gebruikersinterface
Het programma CodeManager kent de volgende besturingselementen:
![]() |
Figuur 1: CodeManager gebruikersinterface |
- Menubalk
Bestand: Heeft drie submenu items:- Opslaan: Opslaan van de wijzigingen zonder de applicatie te sluiten
- Sluiten: Afsluiten van de applicatie. Als er wijzigingen zijn gedaan, wordt gevraagd of deze opgeslagen moeten worden.
- Exit: In deze versie dezelfde functie als Sluiten. Voorheen was dit sluiten zonder wijzigingen op te slaan.
Akties: Heeft vijf submenu items:
- Maak backup bij opslaan: Vinkvak: Indien aangevinkt wordt voor het opslaan van de wijzigingen eerst een backup gemaakt.1
- Initieel data inlezen: Vinkvak: Geeft het bestandsselectie veld vrij voor initieel laden van de codestelsels.
- Export Wiki pagina: Maakt een wiki pagina aan met een overzicht van de codestelsels.
- Publiceer codestelsels: Publiceert de codestelsels : verhoogd indien nodig het versienummer en maakt een wiki pagina met alle codestelsels incl. inhoud.
- Export codestelsel als CSV: Biedt de mogelijkheid om een specifiek codestelsel als CSV bestand te exporteren (alleen aktief bij selectie van een codestelsel).
Help: Heeft twee submenu items:
- Over: Informatie over de applicatie
- Help pagina: Gebruiksaanwijzing van de applicatie (deze pagina)
- Opslaan: Opslaan van de wijzigingen zonder de applicatie te sluiten
- Alle codestelselgroepen
Uitklapbare selectieboom met de namen van alle codesteselgroepen. Met de + wordt een groep uitgeklapt en worden alle stelsels in de groep getoond.
Als vervolgens het stelsel met de + uitgeklapt wordt, worden alle codes van het stelsel getoond in de boom.
Het selecteren van een item in de boom resulteert in het tonen van alle item's van het geselecteerde niveau in de tekstbox 'Deel van het codestelsel'. - Deel van codestelsel
Alle codestelsels van een groep of codes van een codestelsel van het in de boom geselecteerde item.
Door in dit venster een item te selecteren kunnen de gegevens van dat item gewijzigd worden of kan een item op dat niveau toegevoegd worden.
Dit geldt zowel voor groepen, codestelsels als codes. - Concept
Naast de code van het geselecteerde item worden ook de Nederlandse en Engelse naam getoond.
De namen zijn wijzigbaar, de code niet voor bestaande items. Voor nieuwe item kan deze ingevoerd worden.
Tenslotte is er het keuzeveld 'Naam type' en de checkbox 'Actief'. Het naam type is vooralsnog altijd 'Pref' (preferent).
Door checkbox te deselecteren wordt de groep/code op 'deprecated' gezet. - Actieknoppen
Annuleren: Wijzigingen niet doorvoeren, c.q. aanmaken nieuw item afbreken
toevoegen/Wijzigen: Doorvoeren wijzigingen. Indien een naam gewijzigd is, zal een nieuwe versie van de naam aangemaakt worden en de oude op deprecated gezet worden.
Nieuw: Aanmaken nieuw item (groep/codestelsel/code). De naam van de middelste knop vanandert van 'Wijzigen' naar 'Toevoegen'. - Statusbalk
Geeft de locatie aan waar de codestelsel file is opgeslagen.
1 De naam van de backupfile is Codes_v.[version]_Backup_[yyyyMMddHHmmss].xml. Het terugzetten van een backup dient handmatig gedaan te worden door de gewenste backup te hernoemen naar Codes.xml
Gebruik
Aanmaken nieuw item
Selecteer in de boom een item op het niveau waar het nieuwe item toegevoegd moet worden.
Selecteer dus voor het toevoegen van een groep een codestelselgroep, voor een codestelsel een codestelsel binnen de groep waarin dit codestelsel toegevoegd moet worden en voor een code een code uit het betreffende codestelsel.
Druk op de knop 'Nieuw'. Voor groepen en codestelsels zal automatisch een OID aangemaakt worden. Deze kan niet gewijzigd worden.
Bij een nieuwe code moet het code veld gevuld worden. Codes moeten binnen het codestelsel uniek zijn.
Voer de Nederlandse en Engelse naam voor het item in in het 'Naam NL' resp. 'Naam EN veld. Minimaal één naam moet gevuld zijn.
Druk, als de teksten naar tevredenheid ingevoerd zijn, op de knop 'Toevoegen'
Aan de groep 'Algemeen' mogen geen codestelsels meer toegevoegd worden en aan het codestelsel 'NL-CM-VS' geen codes. Dit codestelsel is een overblijfsel uit het verleden.
De invoer kan op ieder moment gestopt worden door op 'Annuleren' te drukken.
Wijzigen van de naam van een item
Selecteer in de boom het item waarvan de naam of namen gewijzigd moet worden. Hiervoor kan het noodzakelijk zijn om de boom uit te klappen
In de 'Concept' velden verschijnt de code of de OID en de Nederlandse en Engelse naam.
De code of de OID kan niet gewijigd worden. Pas de namen naar behoeve aan. Als één van de namen gewijzigd wordt, wordt de knop 'Wijzigen' vrij gegeven
Druk, als de teksten naar tevredenheid gewijzigd zijn, op de knop 'Wijzigen'
Het wijzigen van de naam van in gebruik zijnde codes moet vermeden worden. Gebruik deze optie in dat geval alleen voor het herstel van typ- of taalfouten of om bv. een ontbrekende Engelse naam toe te voegen.
Bij het wijzigen van een naam zal in code bestand bij de betreffende code een nieuwe naam entry gemaakt worden en de oude op deprecated gezet worden.
Hiermee blijft de geschiedenis bewaard. De oude naam herstellen kan niet via deze applicatie, maar handmatig kan evt. de xml file aangepast worden.
Item op 'Deprecated' zetten
Als een groep, codestelsel of code niet langer geldig is kan de status van het item op 'Deprecated' gezet worden.
Het item blijft in de applicatie zichtbaar maar is uitgegrijsd en kan niet meer gewijzigd worden.
Om dit te doen, wordt het item geselecteerd zoals beschreven onder 'Wijzigen' en wordt het concept blok het vinkje 'Actief' verwijderd.
Druk daarna op 'Wijzigen'.
Deze actie is éénmalig. Vanuit de gebruikersinterface kan dit niet teruggedraaid worden.
Publiceren van de codestelsels op de wiki
De codestelsels worden op de zibs wiki gepubliceerd. De publicatiecyclus hiervan staat los van de publicatiecyclus van de zibs.
De publicatie bestaat uit twee delen (op twee verschillende wiki pagina's): een overzicht van alle codestelsels en de codestelsels incl. alle codes.
De twee delen komen overeen met de menu opties 'Export Wiki pagina' en 'Publiceer codestelsels'
De eerste optie is alleen zinvol als er een nieuwe groep of nieuw codestelsel bijgekomen is. In dat geval moet ook de tweede optie uitgevoerd worden.
Indien codes gewijzigd of toegevoegd zijn, kan het zinvol zijn om opnieuw te publiceren.
Bij publicatie wordt een keuzescherm getoond waarin aangegeven kan worden of de wijzigingen een major of minor versie ophoging vereisen. De criteria doorvoor vallen buiten de scope van de helppagina.
![]() |
Figuur 2: CodeManager publicatie |
Tijdens de publicatie zal voor ieder codestelsel gecontroleerd worden of er wijzigingen zijn die een latere datum hebben dan de publicatiedatum van dat codestelsel.
Indien dat zo is wordt het versienummer van dat codestelsel conform de eerder genoemde keuze opgehoogd.
Gezien dit mechanisme is het aan te bevelen om na iedere grotere wijziging van een codestelsel een publicatie te doen en slechts wijzigingen in verschillende codestelsels te combineren in een publicatie als de major/minor vraag voor deze wijgingen gelijk is.
Een publicatie heeft geen impact op versienummers van niet gewijzigde codestelsels.
Bij deze export wordt een directory structuur aangemaakt conform de eisen van het programma ZibExtractor en met de naam CodeManagement.
De export wiki secties worden hierin geplaatst en kunnen vervolgens met ZibExtractor ge-upload worden.
Afsluiten van de applicatie
De applicatie kan gesloten worden met de menu knoppen en op de gebruikelijke Windows manieren (rode kruis, alt F4 etc.)
De knop 'Wijzigen' wijzigt alleen de namen en evt code in het geheugen, niet in het code bestand. Daarom moeten na wijzigingen altijd ook nog het menu item 'Opslaan' geselecteerd worden. Hiermee worden de wijzigingen ook in het bestand opgeslagen. Hiervan kan echter ook gebruik worden gemaakt: als een invoerfout geconstateerd wordt na het wijzigen maar voor het opslaan, kan het programma beëindigd worden zonder op te slaan. De foutieve wijzigingen worden dan niet geëffectueerd. Echter gaan ook alle andere wijzigingen verloren.
Als er wijzigingen aangebracht zijn en de applicatie op een of andere wijze afgesloten wordt zonder dat de wijzigingen opgeslagen zijn,
wordt een dialoog getoond worden met de vraag of de wijzigingen alsnog opgeslagen moeten worden.
Configureerbare gegevens
Naam | Beschrijving | Gebruik | Locatie | Huidige waarde | Wijzigbaar via UI |
---|---|---|---|---|---|
WikiBase | De basis url van deze wiki | Hiermee wordt de url van deze pagina aangemaakt. | ZibAppsStart.cfg | https://zibs.nl/wiki | Nee |
CodeSystemCodesLocation | Locatie van het bestand met codestelsels | Kernbestand van deze applicatie. | ZibAppsStart.cfg | ..\ZIB centrum - Documenten\9. Overig\9.5. Software\Config | Nee |
CodeSystemCodesFilename | Naam van het bestand met codestelsels. | Kernbestand van deze applicatie. | ZibAppsStart.cfg | Codes.xml | Nee |
Vaste gegevens
Naam | Beschrijving | Gebruik | Vaste locatie |
---|---|---|---|
ZibAppsStart.cfg | Basis configuratie bestand | Bevat opstartconfiguratiedata voor Zib app's | C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction |