Vorlage:AttDesc/doc

Dokumentation AttDesc

Diese Vorlage dient zur Beschreibung von HL7-Klassenattributen

Der Aufruf ist wie folgt:

{{AttDesc
| ae = 
| rim = 
| name =
| desc = 
| dt = 
| card = 
| conf =
}}

mit folgenden Parametern:

Parameter	Bedeutung
ae	Angabe, ob es ein XML-Element oder -Attribut ist. Zugelassen sind hier att für Attribute elm für Elemente
rim	Angabe, um welche RIM-Klasse es sich handelt (wegen der Farbe). Zugelassen sind hier act für Acts ent für Entites role für Roles part für Participations oth für andere Klassen
name	Bezeichner des Elements/Attributs
desc	Bedeutung des Elements/Attributs
dt	Datentyp des Elements/Attributs
card	Kardinalität des Elements/Attributs. für Elemente wird hier typischerweise n..m angegeben, bei Attributen ist die Angabe "optional" oder "required" möglich
conf	Angaben zur Conformance des Elements/Attributs O R M X NP

Beispiel 1

{{AttDesc
| ae = att
| rim = act
| name = encoding
| desc = Kodierung
| dt = CS
| card = required
| conf = M
}}

ergibt

	@	Attribut	DT	Card	Conf	Beschreibung
		encoding	CS	required	M	Kodierung

Beispiel 2

{{AttDesc
| ae = elm
| rim = role
| name = code
| desc = Kodierung
| dt = CE CWE
| card = 1..1
| conf = M
}}

ergibt

	<	Element	DT	Card	Conf	Beschreibung
		code	CE CWE	1..1	M	Kodierung

Beispiel 3

{{AttDesc
| ae = elm
| rim = ent
| name = reference
| desc = Verweis
| dt = TEL
| card = 0..1
}}

ergibt

	<	Element	DT	Card	Conf	Beschreibung
		reference	TEL	0..1		Verweis