WS-Beschreibung - Terminologieserver Administration ImportCodeSystem

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→Dateien)
(→Request/Response)
 
(19 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
<div class="commonTable">
+
=Functionality=
−
<table border="0">
+
Imports a whole code system. There are two import formats available: ClaML and CSV.<br>
−
  <tr>
+
You have to specify a code system for each import. All new concepts will be added to that code system.<br>
−
    <td width="100px" style="font-weight: bold;">System</td>
+
<br>
−
    <td>Terminologieserver</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">Webservice</td>
+
−
    <td>Administration</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">WSDL</td>
+
−
    <td>http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/Administration?wsdl</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">Methode</td>
+
−
    <td>ImportCodeSystem</td>
+
−
  </tr>
+
−
</table><br>
+
−
=Funktionalität=
+
−
Mit ImportCodeSystem können Sie komplette CodeSysteme importieren. Dabei stehen 2 Formate zur Wahl: ClaML oder CSV.<br>
+
−
Sie müssen bei jedem Import ein Codesystem angeben, welches durch den Import erstellt wird. Alle neuen Konzepte werden in dieses Codesystem eingeordnet.<br><br>
+
  
−
=Vorbedingungen=
+
=Prerequisites=
−
Erfordert [[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]].
+
Requires [[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]].
  
 
=Request/Response=
 
=Request/Response=
Zeile 37: Zeile 19:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">LoginType</td>
 
   <td id="param_level1">LoginType</td>
−
   <td></td>
+
   <td>LoginType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Login-Informationen</td>
+
   <td>Login information</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">ip</td>
+
−
  <td>String</td>
+
−
  <td></td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Die IP-Adresse des Benutzers (wird intern vergeben)</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">password</td>
+
−
  <td>String</td>
+
−
  <td></td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Passwort des Benutzers (als MD5-Wert)</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 60: Zeile 28:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Die Session-ID des Benutzers, zu erhalten von [[WS-Beschreibung - Terminologieserver_Authorization_Login|Login]]</td>
+
   <td>Session-ID from user (given by system)</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">username</td>
+
−
  <td>String</td>
+
−
  <td></td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Benutzername</td>
+
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">ImportType</td>
 
   <td id="param_level1">ImportType</td>
−
   <td></td>
+
   <td>ImportType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Import-Metadaten</td>
+
   <td>Parameter for import</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 79: Zeile 40:
 
   <td>byte[]</td>
 
   <td>byte[]</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Der Dateiinhalt. CSV-Dateien müssen mit ISO-8859-1 kodiert werden.</td>
+
   <td>The file contents. CSV files must be encoded with ISO-8859-1.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 85: Zeile 46:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Das Format des Dateiinhalts.
+
   <td>The content of the file.
 
ClaML: 193
 
ClaML: 193
−
CSV: 194</td>
+
CSV: 194
 +
LOINC: 200
 +
LOINC relations: 201
 +
KBV keytab: 234</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">code_system</td>
 
   <td id="param_level1">code_system</td>
−
   <td></td>
+
   <td>code_system</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.</td>
+
   <td>Name of codesystem. Each codesystem requires at least one version.</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">currentVersionId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Die aktuelle Versions-ID</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 106: Zeile 64:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Beschreibung des anzulegenden Codesystems</td>
+
   <td>Description of the code system to be created</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">id</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td></td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">insertTimestamp</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Zeitstempel, wann das Codesystem eingefügt worden ist</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 125: Zeile 71:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Name des anzulegenden Codesystems</td>
+
   <td>Name of the code system to be created</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level2">code_system_version</td>
 
   <td id="param_level2">code_system_version</td>
−
   <td></td>
+
   <td>code_system_version</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
<td></td>  <td id="cardinality_cell">-</td>
−
   <td>Die Version des anzulegenden Codesystems</td>
+
   <td>Version of the code system to be created</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">codeSystemId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td></td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 144: Zeile 84:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Beschreibung des Codesystems</td>
+
   <td>Description of the Code System</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 150: Zeile 90:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Datum, bis wann die Version gültig ist</td>
+
   <td>Point of time the Code System looses its validity.</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">insertTimestamp</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Zeitstempel, wann die Codesystem-Version eingefügt worden ist</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 163: Zeile 97:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Besitzer der Lizenz</td>
+
   <td>Owner of the licence.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 170: Zeile 104:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Der Name der anzulegenden Codesystem-Version</td>
+
   <td>Name of the code system version to be created</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 177: Zeile 111:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Offizielle OID</td>
+
   <td>Official OID</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">preferredLanguageId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen)</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">previousVersionID</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 195: Zeile 117:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Datum, ab wann die Version gültig ist</td>
+
   <td>Point of time, when this version starts to be valid.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 202: Zeile 124:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Herausgeber der Codesystem-Version</td>
+
   <td>Source of the Code System Version</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">status</td>
+
−
  <td>Integer</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">statusDate</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Änderungszeitpunkt des Status</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 220: Zeile 130:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar)</td>
+
   <td>true, if Code System is under license (Code System will be invisible for all users without proper license)</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">versionId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td></td>
+
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level2">licence_type</td>
 
   <td id="param_level2">licence_type</td>
−
   <td></td>
+
   <td>licence_type</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
−
   <td>Arten von Lizenztypen</td>
+
   <td>Sorts of licence types.</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">codeSystemVersionId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td></td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">id</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td></td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 251: Zeile 143:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Typ der Lizenz</td>
+
   <td>type of licence</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
 
 
==Response==
 
==Response==
 
<table border="1" cellpadding="1" class="ws_table">
 
<table border="1" cellpadding="1" class="ws_table">
Zeile 266: Zeile 157:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">ReturnType</td>
 
   <td id="param_level1">ReturnType</td>
−
   <td></td>
+
   <td>ReturnType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Entählt Informationen über die Antwort.</td>
+
   <td>Return information</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 274: Zeile 165:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Anzahl der Ergebnisse</td>
+
   <td>number of results</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 281: Zeile 172:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Status- oder Fehlermeldung</td>
+
   <td>an additional message</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 297: Zeile 188:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">code_system</td>
 
   <td id="param_level1">code_system</td>
−
   <td></td>
+
   <td>code_system</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.</td>
+
   <td>Name of codesystem. Each codesystem requires at least one version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 305: Zeile 196:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Die neue ID der hinzugefügten Codesystem-Version</td>
+
   <td>The new ID of the added code system version</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">description</td>
+
−
  <td>String</td>
+
−
  <td>65535</td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Beschreibung eines Codesystems</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 318: Zeile 202:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Die neue ID des hinzugefügten Codesystems</td>
+
   <td>The new ID of the added code system</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">insertTimestamp</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Zeitstempel, wann das Codesystem eingefügt worden ist</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">name</td>
+
−
  <td>String</td>
+
−
  <td>100</td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Name des Codesystems. Der genau Name sollte in der Version angegeben werden</td>
+
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level2">code_system_version</td>
 
   <td id="param_level2">code_system_version</td>
−
   <td></td>
+
   <td>code_system_version</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Die Version des angelegtem Codesystems</td>
+
   <td>The version of the added code system</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">codeSystemId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td></td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">description</td>
+
−
  <td>String</td>
+
−
  <td>65535</td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Beschreibung des Codesystems</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">expirationDate</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Datum, bis wann die Version gültig ist</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">insertTimestamp</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Zeitstempel, wann die Codesystem-Version eingefügt worden ist</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">licenceHolder</td>
+
−
  <td>String</td>
+
−
  <td>65535</td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Besitzer der Lizenz</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">name</td>
+
−
  <td>String</td>
+
−
  <td>100</td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Vollständiger Name des Codesystems</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">oid</td>
+
−
  <td>String</td>
+
−
  <td>100</td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Offizielle OID</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">preferredLanguageId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen)</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">previousVersionID</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">releaseDate</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Datum, ab wann die Version gültig ist</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">source</td>
+
−
  <td>String</td>
+
−
  <td>65535</td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Herausgeber der Codesystem-Version</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">status</td>
+
−
  <td>Integer</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">statusDate</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Änderungszeitpunkt des Status</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">underLicence</td>
+
−
  <td>Boolean</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar)</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 432: Zeile 214:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Die neue ID der hinzugefügten Codesystem-Version</td>
+
   <td>The new ID of the added code system version</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
−
=Anmerkungen=
+
=Examples=
−
==Besonderheiten==
+
==SOAP messages==
 +
===Simple domain===
 +
<source lang="xml">
 +
 
 +
</source>
 +
 
 +
===Complex domain===
 +
<source lang="xml">
 +
 
 +
</source>
 +
 
 +
==Code example==
 +
===Java===
 +
<source lang="java">
 +
 
 +
</source>
 +
 
 +
=Annotations=
 +
==Noteworthiness==
 
'''CSV-Import'''<br>
 
'''CSV-Import'''<br>
−
Die kommagetrennte Datei muss folgendermaßen aufgebaut sein:<br>
+
The comma separated file has to be build in this pattern:<br>
 
*Syntax
 
*Syntax
−
**Codierung: ISO-8859-1
+
**Coding: ISO-8859-1
−
**Felder getrennt mit einem Semikolon ;
+
**Fields will be separated by a ";"
−
**1. Zeile enthält Informationen über die Spalten
+
**Strings has to be encapsulated with " ", if there are any special or delimiter symbols
−
*Felder
+
**First row contains informations about columns
−
**erlaubte Werte
+
*Fields
−
***code (entweder code oder term verpflichtend)
+
**legal values
−
***term (entweder code oder term verpflichtend)
+
***code (either code or term are required)
 +
***term (either code or term are required)
 
***''term_abbrevation''
 
***''term_abbrevation''
−
***''is_axis'' (1/0 oder true/false, Standard: 0)
+
***''description''
−
***''is_mainclass'' (1/0 oder true/false, Standard: 0)
+
***''is_axis'' (1/0 or true/false, standard: 0)
−
***''relation'' (Code, zu dem eine Beziehung aufgebaut wird)
+
***''is_mainclass'' (1/0 or true/false, standard: 0)
−
****''association_kind'' (1=ontologisch, 2=taxonomisch, 3=cross mapping; Standard: 2)
+
***''is_preferred'' (1/0 or true/false, standard: 1)
−
****association_type (Assoziationsbeschreibung, String, z.B. 'ist Unterklasse von', verpflichtend, wenn 'relation' angegeben ist)
+
***''relation'' (Code, a association will be build up to)
−
****association_type_reverse (Assoziationsbeschreibung rückwärts, String, z.B. 'ist Oberklasse von', verpflichtend, wenn 'relation' angegeben ist)
+
****''association_kind'' (1=ontological, 2=taxonomic, 3=cross mapping; standard: 2)
 +
****association_type (Association description, string, e.g. 'is subclass of', required if 'relation' is set)
 +
****association_type_reverse (Association description reversed, string, e.g. 'is upper class of', required if 'relation' is set)
 +
***''translation_XX'' (XX represents the ID of the language, that can be determined by the domains)
 +
***''metadata_XX'' (XX represents the names of metadata, that will be created automatically)
  
−
<nowiki>*</nowiki>''Kursive'' Einträge sind optional
+
<nowiki>*</nowiki>''italic'' Entries are optional
 +
If no code is given, term will be used as code (cut to a maximum length of 100 characters)
  
−
Ist kein Code angegeben, wird die Term-Bezeichnung dafür verwendet (wird gekürzt auf eine max. Länge von 100 Zeichen)
+
==Hints==
  
−
==Hinweise==
+
=Examples=
 +
==Files==
 +
The following file shows a example of a csv import of a small code system with associations:[[:File:CSV-Import_Beispiel.csv|CSV-Import_Beispiel]]
  
−
=Beispiele=
+
Example file (CSV) with some translations can be found here: [[:File:ISO_IEC_5218 Geschlechtercodes.csv|Geschlechtercodes CSV]]
−
==Dateien==
+
−
[[Datei:CSV-Import_Beispiel]]
+
  
−
==SOAP-Nachrichten==
+
==SOAP messages==
 
  <source lang="xml">
 
  <source lang="xml">
 
  <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/">
 
  <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/">
Zeile 481: Zeile 287:
 
             </codeSystem>
 
             </codeSystem>
 
             <importInfos>
 
             <importInfos>
−
             <filecontent>BASE64-CONTENT</filecontent>  <!-- kann man in Soap-UI direkt importieren (Kontextmenü) -->
+
             <filecontent>BASE64-CONTENT</filecontent>  <!-- can be imported directly in Soap-UI (context menu) -->
 
               <formatId>194</formatId>
 
               <formatId>194</formatId>
 
             </importInfos>
 
             </importInfos>
 
             <login>
 
             <login>
−
               <sessionID>71a4f756-dc1a-41a6-941d-0e4fb0145f7f</sessionID>  <!-- Session-ID vom Login einfügen -->
+
               <sessionID>71a4f756-dc1a-41a6-941d-0e4fb0145f7f</sessionID>  <!-- insert Session-ID from login -->
 
             </login>
 
             </login>
 
         </parameter>
 
         </parameter>

Aktuelle Version vom 9. August 2013, 08:27 Uhr

Inhaltsverzeichnis

Functionality

Imports a whole code system. There are two import formats available: ClaML and CSV.
You have to specify a code system for each import. All new concepts will be added to that code system.

Prerequisites

Requires Login.

Request/Response

Request

Parameter Typ Länge Kardinalität Beschreibung
LoginType LoginType 1..1 Login information
sessionID String 1..1 Session-ID from user (given by system)
ImportType ImportType 1..1 Parameter for import
filecontent byte[] 1..1 The file contents. CSV files must be encoded with ISO-8859-1.
formatId Long 1..1 The content of the file.

ClaML: 193 CSV: 194 LOINC: 200 LOINC relations: 201

KBV keytab: 234
code_system code_system 1..1 Name of codesystem. Each codesystem requires at least one version.
description String 65535 0..1 Description of the code system to be created
name String 100 1..1 Name of the code system to be created
code_system_version code_system_version - Version of the code system to be created
description String 65535 0..1 Description of the Code System
expirationDate java.util.Date 0..1 Point of time the Code System looses its validity.
licenceHolder String 65535 0..1 Owner of the licence.
name String 100 1..1 Name of the code system version to be created
oid String 100 0..1 Official OID
releaseDate java.util.Date 0..1 Point of time, when this version starts to be valid.
source String 65535 0..1 Source of the Code System Version
underLicence Boolean 1..1 true, if Code System is under license (Code System will be invisible for all users without proper license)
licence_type licence_type 0..N Sorts of licence types.
typeTxt String 65535 1..1 type of licence

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType ReturnType 1..1 Return information
count Integer 1..1 number of results
message String 1..1 an additional message
overallErrorCategory 1..1 INFO, WARN, ERROR
status 1..1 OK, FAILURE
code_system code_system 1..1 Name of codesystem. Each codesystem requires at least one version.
currentVersionId Long 1..1 The new ID of the added code system version
id Long 1..1 The new ID of the added code system
code_system_version code_system_version 1..1 The version of the added code system
versionId Long 1..1 The new ID of the added code system version

Examples

SOAP messages

Simple domain

 

Complex domain

 

Code example

Java

 

Annotations

Noteworthiness

CSV-Import
The comma separated file has to be build in this pattern:

*italic Entries are optional If no code is given, term will be used as code (cut to a maximum length of 100 characters)

Hints

Examples

Files

The following file shows a example of a csv import of a small code system with associations:CSV-Import_Beispiel

Example file (CSV) with some translations can be found here: Geschlechtercodes CSV

SOAP messages

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <adm:ImportCodeSystem>
         <parameter>
            <codeSystem>
               <codeSystemVersions>
                  <name>Administrative sex (HL7)</name>
                  <underLicence>0</underLicence>
               </codeSystemVersions>
               <name>Administrative sex (HL7)</name>
            </codeSystem>
            <importInfos>
            <filecontent>BASE64-CONTENT</filecontent>  <!-- can be imported directly in Soap-UI (context menu) -->
               <formatId>194</formatId>
            </importInfos>
            <login>
               <sessionID>71a4f756-dc1a-41a6-941d-0e4fb0145f7f</sessionID>  <!-- insert Session-ID from login -->
            </login>
         </parameter>
      </adm:ImportCodeSystem>
   </soapenv:Body>
 </soapenv:Envelope>
Von „http://www.wiki.mi.fh-dortmund.de/cts2/index.php?title=WS-Beschreibung_-_Terminologieserver_Administration_ImportCodeSystem“
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge