Hilfe:Implementierungsleitfaden

Wie übertrage bzw. erstelle ich einen Implementierungsleitfaden im HL7 Wiki

Einleitung

HL7 Deutschland hat sich zum Ziel gesetzt, alle Implementierungsleitfäden und dazugehörige Dokumente, Terminologien, Templates und sonstiges im Wiki verfügbar zu machen. Um einen Leitfaden hier zu veröffentlichen, sind eine Reihe von Voraussetzungen zu erfüllen und die Leifäden bzw. die zugehörigen Teildokumente müssen nach bestimmten Kriterien erstellt werden, um als Leitfäden oder Teilen davon erkannt zu werden und um die Extraktionsmöglichkeit als PDF-Dokument zu ermöglichen.

Wiki-Hilfe

Das Wiki bietet selbst eine Einführung, wie grundsätzlich mit einem Wiki gearbeitet wird und welche Markups zur Verfügung stehen: http://de.wikipedia.org/wiki/Hilfe:Textgestaltung

Grundsätzliches und Gute Praxis der Wiki-Leitfäden

Leitfäden sind meist lange Dokumente. Es ist deshalb sinnvoll, diese in Teildokumente zu unterteilen, die dann zu einem einzigen Leitfaden zusammengefügt werden.

Hauptdokument

Das Hauptdokument enthält folgende verpflichtend anzugebenden Teile:

• eine Infobox Dokument (auszufüllende Vorlage)
• bei Bedarf eine Infobox Ballot (als Begin und End Vorlage) mit den bisherigen Stufen des Dokuments im Abstimmungsprozess
• bei Bedarf eine Liste von Kontributoren dieses Leitfadens, also "vorgelegt von", "mit Beiträgen von", etc.
• die trankludierten separat angelegten Abschnitte, eingefügt mit der Vorlage HL7transclude
• ein abschließendes <references/> Tag zum Aufführen aller in Haupt- und Nebendokumenten erwähnten Referenzen.

aus werden die einzelnen Teildokumente transkludiert.

Beispiel

<!--

    Implementierungsleitfaden "Digitaler Mutterpass auf der Basis von CDA R2"

-->
{{Infobox Dokument
|Title     = Digitaler Mutterpass auf Basis der<br/>HL7 Clinical Document Architecture Release 2<br/>für das deutsche Gesundheitswesen
|Short     = Digitaler Mutterpass auf der Basis von CDA R2
|Namespace = cdaemp
|Type      = Implementierungsleitfaden
|Version   = 1.20
|Date      = 15. Februar 2011
|Copyright = 2010-2011
|Status    = Final Draft
|Period    = Abstimmung
|OID       = n.n.
|Realm     = Deutschland
}}
<!--

-->
{{Infobox Ballot Begin}}
{{Ballot | Version = 1.00 | Date = 18.09.2010 | Status = Entwurf | Realm = Deutschland}}
{{Ballot | Version = 1.10 | Date = 15.02.2011 | Status = Abstimmung | Realm = Deutschland}}
{{Ballot | Version = 1.20 | Date = 15.06.2011 | Status = Kommentarauflösung | Realm = Deutschland}}
{{Infobox Ballot End}}

{{HL7transclude| cdaemp:Einleitung}}
{{HL7transclude| cdaemp:Grundlagen}}
{{HL7transclude| cdaemp:ImplementierungCDA}}
{{HL7transclude| cdaemp:Anhang}}
{{HL7transclude| cdaemp:Abkürzungsverzeichnis}}
{{HL7transclude| cdaemp:Literaturverzeichnis}}

= Referenzen =
<references/>

Teildokumente

Jedes Teildokument enthält neben dem eigentlichen Text ganz oben an als ersten Text die Vorlage DocumentPart um deutlich zu machen, dass dieses Dokument Teil eines Leitfadens ist. Diese Vorlage sorgt automatisch auch dafür, dass das Dokument zur zum Teildokumenten-Namespace gleichnamigen Kategorie hingefügt wird.

Zu beachten ist, dass Teildokumente in einem eigenen Namespace pro Leitfaden (Teildokumenten-Namespace) unterzubringen sind.

Beispiel: Inhalt des Dokuments cdaemp:Einleitung

{{DocumentPart}}
= Einleitung =
== Motivation und Ziel ==

Seit der Einführung des... (Text)

Voraussetzungen

Namespaces

Jeder Implementierungsleitfaden ist ein eigenständiges Wiki-Dokument, dass im Wiki-Namespace IG: anzulegen und zu pflegen ist.

Beispiel: Das Hauptdokument des Leitfadens Digitaler Mutterpass auf der Basis von CDA R2 ist angelegt als

IG:HL7_CDA_Mutterpass

Es ist zu beachten, dass die Leitfäden keine Versionsnummern oder dergleichen enthalten.

Alle zugehörigen Dokumente sind in einem eigenen Wiki-Namespace unterzubringen.

Beispiel:

cdaemp:

ist der ausgezeichneten Wiki-Namespace für alle Dokumente zum Leitfaden Digitaler Mutterpass auf der Basis von CDA R2. Alle zu diesem Leitfaden gehörenden Dokumente sind mit diesem Namespace-Präfix zu versehen. Das Hauptdokument des Leitfadens selbst ist im Namespace IG: angelegt.

Aufteilen der Dokumente

Der gesamte Leitfaden sollte in kleinere Abschnitte unterteilt werden. Sehr sinnvoll ist hier zum Beispiel das teilen in Kapitel oder in logische Abschnitte.

Beispiele: Der Leitfaden Digitaler Mutterpass auf der Basis von CDA R2 ist in seine Kapitel aufgeteilt. Bei Leitfaden Datentypen ist die ebenso der Fall, zusätzlich sind hier die Beschreibungen der einzelnen Datentypen auch noch als kleine Teildokumente vorhanden, damit man ihren Text in anderen Dokumenten transkludieren oder referenzieren kann.

Erstellen / Umsetzen der Spezifikation

Grundsätzlich können die üblichen Mediawiki-Möglichkeiten genutzt werden. Im Zuge der Vereinheitlichung von Leitfäden, ihrem Layout und ihrer möglichen Wiedergabe als PDF sind einige Vorschläge und Regeln zu beachten.

Verwendung von Hinweisboxen mit Symbolen

Es können die folgenden mit Symbolen versehenen Hinweisboxen im laufenden Text gesetzt werden.

Siehe dazu die folgenden Vorlagen:

• Vorlage:EMBox
• Vorlage:NoteBox
• Vorlage:OIBox
• Vorlage:FAQBox
• Vorlage:AlertBox
• Vorlage:ConstraintBox
• Vorlage:HL7deBox
• Vorlage:HL7intBox

XML-Darstellung

Soll XML eingebunden werden, ist dies mit dem Tag syntaxhighlight wie folgt anzugeben.

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>

     oder (als default)

<?xml version="1.0"?>
</syntaxhighlight>

und erscheint dann zum Beispiel als:

<?xml version="1.0" encoding="utf-8"?>

     oder (als default)

<?xml version="1.0"?>

Mehr dazu findet sich in der Hilfe zu Hilfe:Syntaxhervorhebung.

Angaben zu HL7 V3 Klassen-Attributen

Klassen-Attribute in HL7 V3 werden grundsätzlich über die Vorlage AttDesc in die Spezifikationen eingebunden.

Wiki-Text:

{ {AttDesc
| ae = elm
| rim = act, ent, role, part
| name = id
| desc = Id des Dokuments
| dt = II
| card = 1..1
| conf = M
}}

Beispiel:

	<	Element	DT	Card	Conf	Beschreibung
		id	II	1..1	M	Id des Dokuments

Im Falle einer Einschränkung auf ein Attribut kann dieses separat oder direkt beim Attribut niedergelegt werden.

Wiki-Text:

{{AttDesc
| ae = elm
| rim = act, ent, role, part
| name = id
| desc = Id des Dokuments
{{ ConstraintBox|Mindestens eine id MUSS als @root 2.1.3.4.5.6 PatientenNummerDeutschland enthalten. }}
| dt = II
| card = 1..1
| conf = M
}}

Beispiel:

	<	Element	DT	Card	Conf	Beschreibung
		id	II	1..1	M	Id des Dokuments