ZibCodeCheck: verschil tussen versies

Uit Zorginformatiebouwstenen
Ga naar: navigatie, zoeken
(Korte beschijving)
 
(43 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 2: Regel 2:
 
{{ZIBS_ManualPages}}
 
{{ZIBS_ManualPages}}
 
==Korte beschijving==
 
==Korte beschijving==
==ZibCodeCheck manual==
+
Met het programma ZibCodeCheck kunnen de zib's uit een .eap of .qea(x) file gecontroleerd worden met betrekking tot de gebruikte codes.<br>
 +
Voor zowel de codes gebruikt in de DCM::DefinitionCode tag als in de waardelijsten wordt gechecked of de codes bestaan en of ze geldig zijn en niet bv. 'deprecated'.<br>
 +
De check kan uitgevoerd worden voor zowel SNOMED CT als voor LOINC.<br>
 +
Het verdient aanbeveling om alle.eap bestanden die de zib's van één publicatie bevatten, gelijkertijd te checken.<br>
 +
De controle wordt uitgevoerd tegen de versies van de codesystemen die gepubliceerd zijn op de [http://terminologie.nictiz.nl Nictiz terminologie server]<br>
 +
<br>
 +
De resultaten worden opgeslagen in de vorm van csv bestanden. Beide bestanden vermelden de versie van het codesysteem waartegen gecheckt is. Daarnaast bevatten de bestanden:
 +
*DCM::DefinitionCode tags:
 +
:Naam: Conceptcodes_<Codesysteem>_<timeStamp>.csv, bv Conceptcodes_SNOMED CT_20181106163011.csv
 +
:Inhoud per code: Codesysteem, Code, CodeNaam in ZIB, Engelse CodeNaam in codesysteem, Nederlandse CodeNaam in codesysteem, Status, Naam concept, Naam bouwsteen
 +
:Indien het betreffende vinkvak geselecteerd is, wordt ook de Nederlandse patientvriendelijke naam getoond.
 +
*Waardelijsten:
 +
:Naam: Valuesetcodes_<Codesysteem>_<timeStamp>.csv bv Valuesetcodes_LOINC_20181106163127.csv
 +
:Inhoud per code: Codesysteem, Code, CodeNaam in waardelijst, Engelse CodeNaam in codesysteem, Nederlandse CodeNaam in codesysteem, Status, Description uit waardelijst, Naam waardelijst, Naam bouwsteen
 +
Bij de codestelsel keuze kan naast SNOMED CT en LOINC gekozen worden voor ' Overige code reports'.<br>
 +
Deze keuze levert een een viertal csv raporten op:
 +
*een controle resultaat voor codes uit zib  'eigen' codestelsels conform de resultaten voor SNOMED CT en LOINC (naam: Valuesetcodes_eigen_<timeStamp>),
 +
*een overzicht van alle gebruikte automatisch gegenereerde codes uit het codestelsel ObservatieScores (naam: Conceptcodes_ScoreObservaties_<timeStamp>),
 +
*een overzicht van alle waardenljsten die een binding 'Deprecated' hebben (naam: Valueset_Deprecated_<timeStamp>),
 +
*een overzicht van alle waardenljsten codes die 'Deprecated' zijn, ongeacht het codestelsel (naam: Valuesetcodes_Deprecated_<timeStamp>).
 +
 
 +
==ZibCodeCheck gebruikersinterface==
 
Het programma ZibCodeCheck kent de volgende besturingselementen:<br>
 
Het programma ZibCodeCheck kent de volgende besturingselementen:<br>
 
{|
 
{|
|[[Bestand:CodeCheck_UI.png]]
+
|[[Bestand:CodeCheckUI.png]]
 
|-
 
|-
 
|align= "center"| Figuur 1: ZibCodeCheck gebruikersinterface
 
|align= "center"| Figuur 1: ZibCodeCheck gebruikersinterface
Regel 11: Regel 32:
 
<ol>
 
<ol>
 
<li>'''Menubalk'''<br>
 
<li>'''Menubalk'''<br>
Exit: Afsluiten van de applicatie<br>
+
<span style="font-variant: small-caps;">Exit</span>: Afsluiten van de applicatie<br>
Help: Gebruiksaanwijzing van de applicatie (deze pagina)<br>
+
<span style="font-variant: small-caps;">Extra</span>: Heeft twee submenu items:
About: Informatie over de applicatie<br>
+
<ul>
 +
<li><span style="font-variant: small-caps;">ScoreObservatie codestelsel publiceren</span>: Vinkvak: Opent na controle een dialog om het codestelsel op de zib wiki te publiceren (alleen bij keuze  'Overige code reports').<br>
 +
</li>
 +
<li><span style="font-variant: small-caps;">Ook patientvriendelijke SNOMED termen teruggeven</span>: Vinkvak: Geeft bij de controle van SNOMED termen ook de patientvriendelijke termen terug, indien beschikbaar.
 +
</li></ul>
 +
<span style="font-variant: small-caps;">Help</span>: Gebruiksaanwijzing van de applicatie (deze pagina)<br>
 +
<span style="font-variant: small-caps;">Over</span>: Informatie over de applicatie<br>
 
</li>
 
</li>
 
<li>'''Invoer EAP bestanden'''<br>
 
<li>'''Invoer EAP bestanden'''<br>
Regel 25: Regel 52:
 
</li>
 
</li>
 
<li>'''Actieknoppen'''<br>
 
<li>'''Actieknoppen'''<br>
Wissen: Wist alle invoervelden<br>
+
<span style="font-variant: small-caps;">Wissen</span>: Wist alle invoervelden<br>
Annuleer: Na het starten van de check wordt deze knop actief en kan de check eventueel gestopt worden<br>
+
<span style="font-variant: small-caps;">Annuleer</span>: Na het starten van de check wordt deze knop actief en kan de check eventueel hiermee gestopt worden<br>
Check: Start het controleren van de codes in de geselecteerde .eap bestanden
+
<span style="font-variant: small-caps;">Check</span>: Start het controleren van de codes in de geselecteerde .eap bestanden
 
</li>
 
</li>
<li>'''Voortgangsindicatoren'''<br>
+
<li>'''Meldingen'''<br>
Bovenste indicator geeft de overall voortgang aan, de onderste de voortgang per stap
+
Informatieve meldingen en foutmeldingen.
 
</li>
 
</li>
 
<li>'''Statusbalk'''<br>
 
<li>'''Statusbalk'''<br>
 
Geeft aan met welke stap het programma bezig is
 
Geeft aan met welke stap het programma bezig is
 
</li>
 
</li>
 +
<li>'''Voortgangsindicatoren'''<br>
 +
Bovenste indicator geeft de overall voortgang aan, de onderste de voortgang per stap
 +
</li>
 +
 
</ol>
 
</ol>
 +
 
==Gebruik==
 
==Gebruik==
 +
Voor het gebruik van de applicatie moeten de volgende stappen doorlopen worden:
 +
*Selecteer alle .eap of .qea(x) bestanden die zibs bevatten van de te controleren publicatie.
 +
*Kies een doelfolder.
 +
*Kies het gewenste codesystem waarvan de codes gecontroleerd worden.
 +
*Druk op 'Check'.
 +
Als gekozen is voor 'Overige code reports' en het vinkvak 'ScoreObservatie codestelsel publiceren' is aangevinkt, wordt een dialoog geopend,<br>
 +
waarin de naam en de datum van de publicatie ingevuld kan worden. Deze moeten gelijk zijn aan de gegevens uit de gecontroleeerde (pre-)publicatie.<br>
 +
Vanaf versie 4.3 zal de naam van de publicatie automatisch vooringevuld worden.<br>
 +
De resultaten van de publicatie  (een wiki pagina) worden wegeschreven in een mappen structuur die leesbaar met ZibExtractor. Hiermee is deze pagina op de zib wiki te plaatsen.
 +
Als de controle klaar is:
 +
*Open de csv bestanden met Excel en formateer de opmaak desgewenst om leesbaarheid te vergroten.
 +
*Controleer of er codes zijn die ongeldig of niet actief zijn en start de nodige acties om dit te verbeteren.
 +
*Controleer of er codes zijn waarvan geen Nederlandse vertaling bestaat en geeft dit evt door aan het terminologie centrum.
 +
 +
==Configureerbare gegevens==
 +
 +
{| class="wikitable"
 +
! scope="column"|Naam
 +
! scope="column"|Beschrijving
 +
! scope="column"|Doel
 +
! scope="column"|Locatie
 +
! scope="column"|Huidige waarde
 +
! scope="column"|Wijzigbaar via UI
 +
|-
 +
|WikiBase
 +
|De basis url van deze wiki
 +
|Hiermee wordt de url van deze pagina aangemaakt.
 +
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
 +
|<nowiki>https://zibs.nl/wiki</nowiki>
 +
|Nee
 +
|-
 +
|Snomed_languageRefsetId_NL
 +
|Id van de gebruikte NL ref set
 +
|Ophalen NL definitie van SNOMED term
 +
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
 +
|31000146106
 +
|Nee
 +
|-
 +
|Snomed_languageRefsetId_EN
 +
|Id van de gebruikte EN ref set
 +
|Ophalen EN definitie van SNOMED term
 +
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
 +
|900000000000509007
 +
|Nee
 +
|-
 +
|TerminologyServiceLink
 +
|Base adres van de terminologie services
 +
|Ophalen van SNOMED en LOINC data
 +
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
 +
|<nowiki>https://terminologie.nictiz.nl/terminology/</nowiki>
 +
|Nee
 +
|}
 +
 +
==Vaste gegevens==
 +
 +
{| class="wikitable"
 +
! scope="column"|Naam
 +
! scope="column"|Beschrijving
 +
! scope="column"|Doel
 +
! scope="column"|Vaste locatie
 +
|-
 +
|ZibAppsStart.cfg
 +
|Basis configuratie bestand
 +
|Bevat opstartconfiguratiedata voor Zib app's
 +
|C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction
 +
|}

Huidige versie van 7 nov 2023 om 15:19

Manual pagina's

Korte beschijving

Met het programma ZibCodeCheck kunnen de zib's uit een .eap of .qea(x) file gecontroleerd worden met betrekking tot de gebruikte codes.
Voor zowel de codes gebruikt in de DCM::DefinitionCode tag als in de waardelijsten wordt gechecked of de codes bestaan en of ze geldig zijn en niet bv. 'deprecated'.
De check kan uitgevoerd worden voor zowel SNOMED CT als voor LOINC.
Het verdient aanbeveling om alle.eap bestanden die de zib's van één publicatie bevatten, gelijkertijd te checken.
De controle wordt uitgevoerd tegen de versies van de codesystemen die gepubliceerd zijn op de Nictiz terminologie server

De resultaten worden opgeslagen in de vorm van csv bestanden. Beide bestanden vermelden de versie van het codesysteem waartegen gecheckt is. Daarnaast bevatten de bestanden:

  • DCM::DefinitionCode tags:
Naam: Conceptcodes_<Codesysteem>_<timeStamp>.csv, bv Conceptcodes_SNOMED CT_20181106163011.csv
Inhoud per code: Codesysteem, Code, CodeNaam in ZIB, Engelse CodeNaam in codesysteem, Nederlandse CodeNaam in codesysteem, Status, Naam concept, Naam bouwsteen
Indien het betreffende vinkvak geselecteerd is, wordt ook de Nederlandse patientvriendelijke naam getoond.
  • Waardelijsten:
Naam: Valuesetcodes_<Codesysteem>_<timeStamp>.csv bv Valuesetcodes_LOINC_20181106163127.csv
Inhoud per code: Codesysteem, Code, CodeNaam in waardelijst, Engelse CodeNaam in codesysteem, Nederlandse CodeNaam in codesysteem, Status, Description uit waardelijst, Naam waardelijst, Naam bouwsteen

Bij de codestelsel keuze kan naast SNOMED CT en LOINC gekozen worden voor ' Overige code reports'.
Deze keuze levert een een viertal csv raporten op:

  • een controle resultaat voor codes uit zib 'eigen' codestelsels conform de resultaten voor SNOMED CT en LOINC (naam: Valuesetcodes_eigen_<timeStamp>),
  • een overzicht van alle gebruikte automatisch gegenereerde codes uit het codestelsel ObservatieScores (naam: Conceptcodes_ScoreObservaties_<timeStamp>),
  • een overzicht van alle waardenljsten die een binding 'Deprecated' hebben (naam: Valueset_Deprecated_<timeStamp>),
  • een overzicht van alle waardenljsten codes die 'Deprecated' zijn, ongeacht het codestelsel (naam: Valuesetcodes_Deprecated_<timeStamp>).

ZibCodeCheck gebruikersinterface

Het programma ZibCodeCheck kent de volgende besturingselementen:

CodeCheckUI.png
Figuur 1: ZibCodeCheck gebruikersinterface
  1. Menubalk
    Exit: Afsluiten van de applicatie
    Extra: Heeft twee submenu items:
    • ScoreObservatie codestelsel publiceren: Vinkvak: Opent na controle een dialog om het codestelsel op de zib wiki te publiceren (alleen bij keuze 'Overige code reports').
    • Ook patientvriendelijke SNOMED termen teruggeven: Vinkvak: Geeft bij de controle van SNOMED termen ook de patientvriendelijke termen terug, indien beschikbaar.

    Help: Gebruiksaanwijzing van de applicatie (deze pagina)
    Over: Informatie over de applicatie

  2. Invoer EAP bestanden
    Tot vier verschillende .eap bestanden kunnen geselecteerd worden
  3. Keuze uitvoerlocatie
    Folder waarin de resultaten geplaatst worden
  4. Keuze codesysteem
    Codesystem waarvan de codes getest worden
  5. Actieknoppen
    Wissen: Wist alle invoervelden
    Annuleer: Na het starten van de check wordt deze knop actief en kan de check eventueel hiermee gestopt worden
    Check: Start het controleren van de codes in de geselecteerde .eap bestanden
  6. Meldingen
    Informatieve meldingen en foutmeldingen.
  7. Statusbalk
    Geeft aan met welke stap het programma bezig is
  8. Voortgangsindicatoren
    Bovenste indicator geeft de overall voortgang aan, de onderste de voortgang per stap

Gebruik

Voor het gebruik van de applicatie moeten de volgende stappen doorlopen worden:

  • Selecteer alle .eap of .qea(x) bestanden die zibs bevatten van de te controleren publicatie.
  • Kies een doelfolder.
  • Kies het gewenste codesystem waarvan de codes gecontroleerd worden.
  • Druk op 'Check'.

Als gekozen is voor 'Overige code reports' en het vinkvak 'ScoreObservatie codestelsel publiceren' is aangevinkt, wordt een dialoog geopend,
waarin de naam en de datum van de publicatie ingevuld kan worden. Deze moeten gelijk zijn aan de gegevens uit de gecontroleeerde (pre-)publicatie.
Vanaf versie 4.3 zal de naam van de publicatie automatisch vooringevuld worden.
De resultaten van de publicatie (een wiki pagina) worden wegeschreven in een mappen structuur die leesbaar met ZibExtractor. Hiermee is deze pagina op de zib wiki te plaatsen. Als de controle klaar is:

  • Open de csv bestanden met Excel en formateer de opmaak desgewenst om leesbaarheid te vergroten.
  • Controleer of er codes zijn die ongeldig of niet actief zijn en start de nodige acties om dit te verbeteren.
  • Controleer of er codes zijn waarvan geen Nederlandse vertaling bestaat en geeft dit evt door aan het terminologie centrum.

Configureerbare gegevens

Naam Beschrijving Doel 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
Snomed_languageRefsetId_NL Id van de gebruikte NL ref set Ophalen NL definitie van SNOMED term ZibAppsStart.cfg 31000146106 Nee
Snomed_languageRefsetId_EN Id van de gebruikte EN ref set Ophalen EN definitie van SNOMED term ZibAppsStart.cfg 900000000000509007 Nee
TerminologyServiceLink Base adres van de terminologie services Ophalen van SNOMED en LOINC data ZibAppsStart.cfg https://terminologie.nictiz.nl/terminology/ Nee

Vaste gegevens

Naam Beschrijving Doel Vaste locatie
ZibAppsStart.cfg Basis configuratie bestand Bevat opstartconfiguratiedata voor Zib app's C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction