Leitfaden erstellen

Aus HL7 Austria MediaWiki
Wechseln zu: Navigation, Suche
[unmarkierte Version][unmarkierte Version]
(Eingebettete Unterseite wird nicht angezeigt)
(Neue Seite in einem Namespace anlegen/verschieben)
(5 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 3: Zeile 3:
  
 
=Workflow=
 
=Workflow=
Die Einbindung eines neuen Leitfadens folgt einen vorgegebenen Prozess, dieser ist hier ersichtlich: [[Hilfe:Flagged_Revisions#Benutzung_von_Flagged_Revisions|Workflow]]
+
Die Einbindung eines neuen Leitfadens folgt einem vorgegebenen Prozess, dieser ist ersichtlich unter
 +
[[Hilfe:Flagged_Revisions#Benutzung_von_Flagged_Revisions|Workflow]].
  
 
=Wiki-Hilfe=
 
=Wiki-Hilfe=
Die Wiki Hilfe bietet eine Einführung, wie grundsätzlich mit einem Wiki gearbeitet wird und welche Markups zur Verfügung stehen: [[Hilfe:Wiki|How-to-Wiki]]
+
Die Wiki Hilfe bietet eine Einführung, wie grundsätzlich mit einem Wiki gearbeitet wird und welche Markups zur Verfügung stehen: [[Hilfe:Wiki|How-to-Wiki]].
  
 
=Leitfaden im Wiki erstellen=
 
=Leitfaden im Wiki erstellen=
 
==Neue Seite anlegen==
 
==Neue Seite anlegen==
 
Von einer bestehenden Seite aus kann mit folgender Syntax eine neue Seite angelegt werden: <pre>[[NeueSeite]]</pre><br/>
 
Von einer bestehenden Seite aus kann mit folgender Syntax eine neue Seite angelegt werden: <pre>[[NeueSeite]]</pre><br/>
Sollen sich der Text des Links und der Seitenname unterscheiden muss folgender Code benutzt werden: <pre>[[NeueSeite | Sichtbarer Text]]</pre>
+
Sollen sich der Text des Links und der Seitenname unterscheiden, muss folgender Code benutzt werden: <pre>[[NeueSeite | Sichtbarer Text]]</pre>
  
 
===Neue Seite in einem Namespace anlegen/verschieben===
 
===Neue Seite in einem Namespace anlegen/verschieben===
Wenn die Seite bereits erstellt wurde, kann die Seite unter dem Reiter "Mehr" mit "Verschieben" in den gewünscht Namespace verschoben werden. Einfach statt (Artikel) den gewünschten Namespace auswählen und bestätigen.
+
Wenn die Seite bereits erstellt wurde, kann die Seite unter dem Reiter "Mehr" mit "Verschieben" in den gewünscht Namespace verschoben werden. Einfach (statt Artikel) den gewünschten Namespace auswählen und bestätigen.
  
 
Wenn die Seite noch nicht angelegt wurde, kann von einer bestehenden Seite aus mit folgender Syntax eine Seite in einem Namespace angelegt werden:
 
Wenn die Seite noch nicht angelegt wurde, kann von einer bestehenden Seite aus mit folgender Syntax eine Seite in einem Namespace angelegt werden:

Version vom 7. November 2019, 10:15 Uhr

Mit dem Wiki Portal von HL7 Austria wird das Ziel verfolgt, alle Implementierungsleitfäden und dazugehörigen Dokumente, Terminologien, Templates und sonstiges im Wiki verfügbar zu machen. Um einen Leitfaden zu veröffentlichen, ist eine Reihe von Schritten durchzuführen. Die Leifäden bzw. die zugehörigen Teildokumente müssen nach bestimmten Kriterien erstellt werden, um als Leitfäden oder als Teil davon erkannt zu werden und die Extraktionsmöglichkeit als PDF-Dokument zu ermöglichen.

Workflow

Die Einbindung eines neuen Leitfadens folgt einem vorgegebenen Prozess, dieser ist ersichtlich unter Workflow.

Wiki-Hilfe

Die Wiki Hilfe bietet eine Einführung, wie grundsätzlich mit einem Wiki gearbeitet wird und welche Markups zur Verfügung stehen: How-to-Wiki.

Leitfaden im Wiki erstellen

Neue Seite anlegen

Von einer bestehenden Seite aus kann mit folgender Syntax eine neue Seite angelegt werden:
[[NeueSeite]]

Sollen sich der Text des Links und der Seitenname unterscheiden, muss folgender Code benutzt werden:
[[NeueSeite | Sichtbarer Text]]

Neue Seite in einem Namespace anlegen/verschieben

Wenn die Seite bereits erstellt wurde, kann die Seite unter dem Reiter "Mehr" mit "Verschieben" in den gewünscht Namespace verschoben werden. Einfach (statt Artikel) den gewünschten Namespace auswählen und bestätigen.

Wenn die Seite noch nicht angelegt wurde, kann von einer bestehenden Seite aus mit folgender Syntax eine Seite in einem Namespace angelegt werden:

//Neue Seite wird im Namespace ILF angelegt
[[ILF:NeueSeite]]

Konfiguration

Alle Seiten des Wiki unterliegen dem Flagged Revisions Verfahren, das es ermöglicht, Seitenversionen zu markieren sowie eine stabile (Reiter "Lesen") und current Seitenversion (Reiter "Revision") festzulegen (https://www.mediawiki.org/wiki/Extension:FlaggedRevs). Die Seiten werden abschließend von so genannten Sichtern freigegeben.

Aufbau eines Implementierungsleitfadens

Ein Implementierungsleitfaden teilt sich in einen technischen und einen textlichen Teil auf. Der technische ist für den Leser nicht sichtbar und beinhaltet folgende Angaben:

Optional stehen folgende Funktion bereit:

Der textliche Teil eines Wiki Leitfadens, beinhaltet den eigentlichen Inhalt(/Beschreibung) eines Implementierungsleitfaden. Implementierungsleitfäden sind sehr lange Dokumente und umfassen meist eine Seitenanzahl von über 200 A4 Seiten. Deshalb ist es sinnvoll das Hauptdokument in Teildokumente zu unterteilen. Die Summe der Teildokumente ergibt somit einen Leitfaden.

Typische Gliederung eines Dokuments

Ein Leitfaden wird typischerweise in folgende Abschnitte gliedert:

  • Informationen über dieses Dokument
    • Allgemeines
    • Sprachliche Gleichbehandlung
    • Verbindlichkeit
    • Zielgruppe
    • Hinweis auf verwendete Grundlagen
    • Danksagung
    • Hinweise zur Nutzung des Leitfadens
    • Revisionsliste
    • Weitere unterstützende Materialien
    • Bedienungshinweise
    • Impressum
  • Harmonisierung
  • Einleitung
    • Ausgangssituation
    • Zweck
    • Hierarchie der Implementierungsleitfäden
  • Anwendungsfälle
  • Administrative Daten (CDA Header)
  • Fachlicher Inhalt (CDA Body)
  • Technische Konformitätsprüfung
    • Schema-Prüfung
    • Schematron-Prüfung
    • Online-Validation von CDA-Dokumenten
  • Anhang
    • Referenzen
    • Revisionsliste

Hauptdokument

Das Hauptdokument bildet den eigentlichen Leitfaden im Wiki ab und ist in verschiedene Abschnitte eingeteilt. Diese Abschnitte sind im Wiki sogenannten Teildokumente die in Summe den gesamten Leitfaden abbilden. Um die Teildokumente in das richtige Hauptdokument zu transkludieren, müssen diese einen gewissen Namensbereich zugeordnet sein. Teildokumente werden im Wiki folgendermaßen eingebunden:

elga-cdaalf-2.06.2:Harmonisierung

Teildokument

Die Teildokumente enthalten den eigentlichen Text und müssen einem Namensbereich zugeordnet. Diese Namensbereiche werden im Vorhinein definiert und leiten sich aus den Titel des Leitfadens und der Versionierung ab. Folgende Namensräume sind derzeit in Gebrauch:

  • Allgemeiner Leitfaden: Elga-cdaalf-2.06.2
  • XDS Metadaten: Elga-cdaxds-2.06.2
  • Entlassungsbrief (Ärztlich): Elga-cdaea-2.06.2
  • Entlassungsbrief (Pflege): Elga-cdaep-2.06.2
  • Pflegesituationsbericht: Elga-cdapsb-2.06.2
  • E-Medikation: Elga-cdaem-2.06.2
  • Laborbefund: Elga-cdalab-2.06.2
  • Laborbefund Version 2.06.03: Elga-cdalab-2.06.3
  • Befund Bildgebende Diagnostik: Elga-cdabgd-2.06.2
  • Patient Summary: Elga-cdaps-2.06.2

Vollständiges Beispiel eines Implementierungsleitfadens

Beispiel:

{{#seo:
|title=Entlassungsbrief (Ärztlich)
|titlemode=append
|keywords= Entlassungsbrief,Entlassungsbrief Ärztlich,Ärztlicher Entlassungsbrief,CDA, Leitfaden, Leitfäden, Spezielle Leitfäden, Arzt, Krankenhaus, Informationsausstausch, Gesundheitsdienstleitster, GDA, Medizin, Patienten
|description=Ein Entlassungsdokument enthält die medizinisch relevanten Teile der Geschichte eines Patienten und ist für den Informationsaustausch zwischen Gesundheitsdienstleistern bestimmt. 
}}
{{#customtitle:Entlassungsbrief (Ärztlich)}}

{{Underconstruction}}
 <!--

         Implementierungsleitfaden "Entlassungsbrief (Ärztlich)"
 >

{{#css:
@media screen{
.orange{
   border: thin black solid;
   background-color:#F4C789;
   padding: 5px 5px 5px 5px;
   margin-left:6px;
   width:70%;
}
.violet{
   border: thin black solid;
   background-color:#E5D0EE;
   padding: 5px 5px 5px 5px;
   margin-left:6px;
   width:70%;
}
.toc{
    width: 20%;
    float: right !important;
    margin: 10px 0px 10px 30px !important;
    border: 1px solid #AAA;
    background-color: #F9F9F9;
    display: table;
    padding: 7px !important;
}
}
}}

{{Infobox Dokument
|Group     = ELGA CDA<br/>Implementierungsleitfäden
|Title     = HL7 Implementation Guide for CDA<sup>®</sup> R2:<br/>Entlassungsbrief (Ärztlich)
|Subtitle  = Zur Anwendung im österreichischen<br/>Gesundheitswesen [1.2.40.0.34.7.1.6.2]
|Short     = Entlassungsbrief (Ärztlich) 
|Namespace = elga-cdaea-2.06.2
|Type      = Implementierungsleitfaden
|Version   = 2.06.2
|Submitted = HL7 Austria
|Date      = 20. März 2017
|Copyright = 2017-2021
|Status    = Entwurf
|Period    = n.a.
|OID       = n.n.
|Realm     = Österreich
}}

 <!--
{{Infobox Contributors Begin}}
{{Contributor | Logo = Logo.jpg | Name = Abc | Location = Hürth }}
{{Infobox Contributors End}}
 >

=Informationen über dieses Dokument=
{{ILF:Allgemeines}}
{{ILF:Verbindlichkeit}}
{{ILF:Zielgruppe}}
{{ILF:Hinweis auf verwendete Grundlagen}}
{{ILF:Danksagung}}
{{ILF:Hinweise zur Nutzung des Leitfadens}}
.
.
.

Benutzerdefinierter Titel

Ermöglicht das Ändern des Seitentitels mittels:

{{#customtitle:Neuer Titel}}

SEO

SEO ist eine Maßnahme, um das Ranking in Suchmaschinen zu optimieren.
Code:

{{#seo:
|title=LOINC
|titlemode=append
|keywords= Leitfaden, Leitfäden, LOINC, ELGA, Arzt, Krankenhaus, Informationsausstausch, Gesundheitsdienstleitster, GDA, Medizin, Patienten
|description=Dieser Leitfaden erklärt das Vorgehen beim „Mapping“, der korrekten Zuordnung von lokalen Laborcodes zu den standardisierten Codes für ELGA
}}

in Bearbeitung/UnderConstruction

Um den Leser darauf hinzuweisen, dass dieser Leitfaden noch in Bearbeitung ist, muss die Vorlage „Underconstruction“ verwendet werden. Damit wird die Wiki-Seite visuell als „In Bearbeitung“ gekennzeichnet:

{{Underconstruction}}

Formatierungen

Damit das Inhaltsverzeichnis rechts aufscheint und die Strukturbeispiele richtig formatiert sind, muss folgender Code eingefügt werden:

{{#css:
@media screen{
.orange{
   border: thin black solid;
   background-color:#F4C789;
   padding: 5px 5px 5px 5px;
   margin-left:6px;
   width:70%;
}
.violet{
   border: thin black solid;
   background-color:#E5D0EE;
   padding: 5px 5px 5px 5px;
   margin-left:6px;
   width:70%;
}
.toc{
    width: 20%;
    float: right !important;
    margin: 10px 0px 10px 30px !important;
    border: 1px solid #AAA;
    background-color: #F9F9F9;
    display: table;
    padding: 7px !important;
}
}
}}

Infobox

Jeder Leitfaden hat eine Infobox, die alle zur Erstellung der Druckversion im PDF Format notwendigen Informationen enthält. Sie ist in der Online-Version nicht sichtbar.

{{Infobox Dokument
|Group     = ELGA GmbH<br/>Leitfaden zur Verwendung von LOINC<sup>®</sup>
|Title     = im ELGA CDA<sup>®</sup> R2 Laborbefund
|Subtitle  = Zur Anwendung im österreichischen<br/>Gesundheitswesen [1.2.40.0.34.10.1]
|Short     = Leitfaden zur Verwendung von LOINC 
|Namespace = elga-loinc-1.03
|Type      = Implementierungsleitfaden
|Version   = 1.03
|Submitted = HL7 Austria
|Date      = 07. Februar 2017
|Copyright = 2017-2021
|Status    = Gültig
|Period    = n.a.
|OID       = n.n.
|Realm     = Österreich
}}

Für die Erstellung des PDF-Dokuments werden die Werte für Group, Title, Subtitle, Date, Version und Status übernommen. Die anderen Felder werden zurzeit nicht genutzt.

Namespace/Namensraum

Jeder Leitfaden gehört zu einem Namespace, z.B. elga-cdaps-2.06.2 für das Patient Summary. Darüberhinaus gibt es auch den allgemeinen Namespace ILF (Implementierungsleitfäden), der alle Leitfäden vereint. Wenn eine Seite in eine Hauptseite eingebunden werden soll, muss die Unterseite einem Namensraum zugehören.

Weitere Namespaces müssen im LocalSettings.php angelegt werden.

Der Namespace Name darf keine Bindestriche enthalten, der Titel aber schon!

// Define constants for additional namespaces.
define("NS_ILF", 3000); // This MUST be even.
define("NS_ILF_DISKUSSION", 3001); // This MUST be the following odd integer.
define("NS_elga_cdaps2062", 3002); // This MUST be even.
define("NS_elga_cdaps2062_DISKUSSION", 3003); // This MUST be the following odd integer.
// Add namespaces.
$wgExtraNamespaces[NS_ILF] = "ILF";
$wgExtraNamespaces[NS_ILF_DISKUSSION] = "ILF_Diskussion";
$wgExtraNamespaces[NS_ elga_cdaps2062] = " elga-cdaps-2.06.2";
$wgExtraNamespaces[NS_ elga_cdaps2062_DISKUSSION] = " elga-cdaps-2.06.2_Diskussion";

Im Generellen ist die Struktur der Namensräume folgendermaßen aufgebaut:

elga-cda | Abkürzung des Titels des Leitfadens | Version

Jeder Leitfaden gehört zu seinem eigenen Namespace und zum Namespace ILF. z.B. der Leitfaden für das Patient Summary gehört auch zu elga-cdaps-2.06.2 und ILF

Alle Seiten zu allgemeinen Kapiteln, die für alle Leitfäden gleich sind, gehören zum Namespace ILF.

Alle Seiten zu spezifischen Kapiteln, die nur für diesen Leitfaden gelten, gehören zum Namespace des spezifischen Leitfadens z.B. elga-cdaps-2.06.2.

Werden Seiten zu Kapitel aus anderen Leitfäden übernommen, so gehören sie zum Namespace des anderen Leitfadens.

Neuen Namespace anlegen

Um weitere Namensräume anzulegen, müssen diese in den LocalSettings.php definiert und eingefügt werden.

// Define constants for additional namespaces.
define("NS_ILF", 3000); // This MUST be even.
define("NS_ILF_DISKUSSION", 3001); // This MUST be the following odd integer.
odd integer.
// Add namespaces.
$wgExtraNamespaces[NS_ILF] = "ILF";
$wgExtraNamespaces[NS_ILF_DISKUSSION] = "ILF_Diskussion";

Der neue Namensraum muss in der FlaggedRevs.php (Verzeichnis: extensions/FlaggedRevs/FlaggedRevs.php) eingefügt werden, ansonsten kann man Seiten, die diesem Namensraum angehören, nicht flaggen. Hierfür die FlaggedRevs.php öffnen und die Zahl, die für den Namespace vergeben wurde, nach an letzter Stelle des Arrays einfügen:

# Allowed namespaces of reviewable pages
$wgFlaggedRevsNamespaces = [ NS_MAIN, NS_FILE, NS_TEMPLATE, 3000, 3002, 3004, 3006, 3008, 3010, 3012, 3014, 3016, 3018, 3020, 3030, 3032, 3034, 3036, 3038, 3040, 3042, 3044, 3046, 3048, 3050];

Versionierung

Die Versionierung der Leitfäden erfolgt über den Namespace und Flagged Revision.

Beispiel:
elga-cdaalf-2.06.2 … Allgemeiner Leitfaden V2.06.2
elga-cdaalf-2.07 … Allgemeiner Leitfaden V2.07

Wird eine neue Version eines Leitfadens erarbeitet, so muss

  • die alte Version im Wiki vor Änderungen gesperrt werden
  • der neue Namespace für diese Version angelegt werden
  • die Seiten der alten Version, die unverändert bleiben, können so inkludiert werden
  • die Seiten, die geändert werden müssen, müssen neu angelegt werden

Art-Decor Templates einbinden

Die Templates für den Leitfaden werden in ArtDecor modelliert (http://art-decor.org/art-decor/decor-project--elga-) und mittels eines Bots ins Wiki übertragen und in den Leitfaden transkludiert. Die Identifizierung der Templates erfolgt über ihre OID, über die sie auch als Wikiseite aufgerufen werden können.

Für die Transklusion gibt es zwei Möglichkeiten:
1. Einbinden eines Art-Decor Templates dynamisch
Die dynamische Möglichkeit stellt sicher, dass immer das Template der letzten Version eingebunden ist. Somit werden Änderungen im Art-Decor im Wiki Leitfaden automatisch mittels eines Bots nachgezogen. Eingebunden können Templates bei dynamischer Verwendung durch folgenden Code:

{{:OID-NR/dynamic}}
Beispiel Rehabilitationsziele:
{{:1.2.40.0.34.11.2.2.26/dynamic}}

2. Einbinden eines Art-Decor Templates statisch (Zeitstempel): Die statische Möglichkeit sieht vor eine bestimmten Version des Templates anhand des Zeitstempels einzubinden. Der Code hierfür lautet:

{{:OID-NR/static-Datum-Zeit}}
Beispiel eMedikationRezept:
{{:1.2.40.0.10.1.4.3.4.1.1.1/static-2013-12-16T000000}}

Jedes Template besteht also sozusagen aus verschiedenen Versionen (Static Versionen) und über einen redirect (dynamic) wird auf die aktuellste Version des Templates verwiesen.

PDF Generierung

Für die Generierung eines PDF-Dokuments aus einer Wikiseite wird das Tool

PRINCE 11 , free for non-commercial use (https://www.princexml.com/download/)

verwendet. Die Version wird lokal auf dem Benutzerrechner gespeichert und das EXE-File aus dem Filesystem heraus aufgerufen.

Die Quelle für das Dokument ist immer das Wiki.

Es kommen drei Stylesheets zur Anwendung:

= Stylesheet für das Aussehen des MediaWikis am Bildschirm
= elgaspezifisches Stylesheet

Häufige Probleme

Die Änderungen der Unterseite werden nicht auf der Hauptseite angezeigt

Dazu gehen Sie auf der Hauptseite auf den Reiter "Bearbeiten" und speichern den Beitrag gleich wieder mit dem Klick auf "Änderungen speichern". Jetzt werden die Änderungen von der Unterseite in die Hauptseite gezogen und sollten aufscheinen.

Anlegen neuer Namespaces/Namensräume

Siehe hierzu Punkt Neuen Namespace anlegen

Eingebettete Unterseite wird nicht angezeigt

Wenn eine Unterseite mit folgendem Code eingebettet wird

{{Unterseite}}

und nicht angezeigt wird, dann liegt es daran, dass die Unterseite nicht einem Namensraum zugeordnet ist. Lesen Sie bitte dazu den Schritt: Seite einem Namensraum zuordnen