WS-Beschreibung - Terminologieserver Administration ImportCodeSystem

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→SOAP-Nachrichten)
(→Request/Response)
Zeile 26: Zeile 26:
  
 
=Request/Response=
 
=Request/Response=
−
==Eingabewerte==
+
==Request==
−
 
+
<table border="1" cellpadding="1" class="ws_table">
−
===importInfos===
+
   <tr class="ws_table_head">
−
<table border="1">
+
−
   <tr>
+
 
     <th>Parameter</th>
 
     <th>Parameter</th>
 
     <th>Typ</th>
 
     <th>Typ</th>
−
     <th>Optional</th>
+
     <th>L&auml;nge</th>
 +
    <th id="cardinality_cell">Kardinalit&auml;t</th>
 
     <th>Beschreibung</th>
 
     <th>Beschreibung</th>
 
   </tr>
 
   </tr>
−
   <tr>
+
<tr id="row_object">
−
    <td>formatId</td>
+
   <td id="param_level1">LoginType</td>
−
    <td>Long</td>
+
  <td></td>
−
    <td></td>
+
<td></td>  <td id="cardinality_cell">1..1</td>
−
    <td>Das Format des Dateiinhalts.<br>'''ClaML:''' 193<br>'''CSV:''' 194</td>
+
  <td>Login-Informationen</td>
−
   </tr>
+
</tr>
−
   <tr>
+
<tr id="gray">
−
    <td>filecontent</td>
+
  <td id="param_level2">ip</td>
−
    <td><nowiki>byte[]</nowiki></td>
+
  <td>String</td>
−
    <td></td>
+
  <td></td>
−
    <td>Der Dateiinhalt. CSV-Dateien müssen mit ISO-8859-1 kodiert werden.</td>
+
  <td id="cardinality_cell">-</td>
−
   </tr>
+
  <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>
 +
   <td id="param_level2">sessionID</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Die Session-ID des Benutzers</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 id="row_object">
 +
  <td id="param_level1">ImportType</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Import-Metadaten</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">filecontent</td>
 +
  <td>byte[]</td>
 +
<td></td> <td id="cardinality_cell">1..1</td>
 +
  <td>Der Dateiinhalt. CSV-Dateien müssen mit ISO-8859-1 kodiert werden.</td>
 +
</tr>
 +
<tr>
 +
   <td id="param_level2">formatId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Das Format des Dateiinhalts.
 +
ClaML: 193
 +
CSV: 194</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">code_system</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.</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>
 +
  <td id="param_level2">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Beschreibung des anzulegenden Codesystems</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>
 +
  <td id="param_level2">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Name des anzulegenden Codesystems</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_version</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Die Version des anzulegenden Codesystems</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>
 +
  <td id="param_level3">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Beschreibung des Codesystems</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">expirationDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">0..1</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>
 +
  <td id="param_level3">licenceHolder</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Besitzer der Lizenz</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Der Name der anzulegenden Codesystem-Version</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">oid</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">0..1</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>
 +
  <td id="param_level3">releaseDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Datum, ab wann die Version gültig ist</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">source</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</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>
 +
  <td id="param_level3">underLicence</td>
 +
  <td>Boolean</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>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">licence_type</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">0..N</td>
 +
  <td>Arten von Lizenztypen</td>
 +
</tr>
 +
<tr>
 +
  <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>
 +
  <td id="param_level3">typeTxt</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Typ der Lizenz</td>
 +
</tr>
 
</table>
 
</table>
−
 
+
==Response==
−
===codeSystem===
+
<table border="1" cellpadding="1" class="ws_table">
−
<table border="1">
+
   <tr class="ws_table_head">
−
   <tr>
+
 
     <th>Parameter</th>
 
     <th>Parameter</th>
 
     <th>Typ</th>
 
     <th>Typ</th>
−
     <th>Optional</th>
+
     <th>L&auml;nge</th>
 +
    <th id="cardinality_cell">Kardinalit&auml;t</th>
 
     <th>Beschreibung</th>
 
     <th>Beschreibung</th>
 
   </tr>
 
   </tr>
−
  <tr>
+
<tr id="row_object">
−
    <td>name</td>
+
  <td id="param_level1">ReturnType</td>
−
    <td>String</td>
+
  <td></td>
−
    <td></td>
+
<td></td> <td id="cardinality_cell">1..1</td>
−
    <td>Name des anzulegenden Codesystems</td>
+
   <td>Entählt Informationen über die Antwort.</td>
−
   </tr>
+
</tr>
−
  <tr>
+
<tr>
−
    <td>description</td>
+
  <td id="param_level2">count</td>
−
    <td>String</td>
+
  <td>Integer</td>
−
    <td>x</td>
+
<td></td> <td id="cardinality_cell">1..1</td>
−
    <td>Beschreibung des anzulegenden Codesystems</td>
+
   <td>Anzahl der Ergebnisse</td>
−
   </tr>
+
</tr>
−
  <tr style="background-color:#CCCCCC">
+
<tr>
−
    <td >codeSystemVersion</td>
+
  <td id="param_level2">message</td>
−
    <td>CodeSystemVersion</td>
+
  <td>String</td>
−
    <td></td>
+
  <td></td>
−
    <td>Die Version des anzulegenden Codesystems</td>
+
  <td id="cardinality_cell">1..1</td>
−
  </tr>
+
  <td>Status- oder Fehlermeldung</td>
−
  <tr>
+
</tr>
−
    <td>name</td>
+
<tr>
−
    <td>String</td>
+
  <td id="param_level2">overallErrorCategory</td>
−
    <td></td>
+
  <td></td>
−
    <td>Der Name der anzulegenden Codesystem-Version</td>
+
<td></td> <td id="cardinality_cell">1..1</td>
−
   </tr>
+
   <td>INFO, WARN, ERROR</td>
−
  <tr>
+
</tr>
−
    <td>releaseDate</td>
+
<tr>
−
    <td>java.util.Date</td>
+
  <td id="param_level2">status</td>
−
    <td>x</td>
+
  <td></td>
−
    <td></td>
+
<td></td> <td id="cardinality_cell">1..1</td>
−
   </tr>
+
   <td>OK, FAILURE</td>
−
  <tr>
+
</tr>
−
    <td>expirationDate</td>
+
<tr id="row_object">
−
    <td>java.util.Date</td>
+
  <td id="param_level1">code_system</td>
−
    <td>x</td>
+
  <td></td>
−
    <td></td>
+
<td></td> <td id="cardinality_cell">1..1</td>
−
   </tr>
+
   <td>Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.</td>
−
  <tr>
+
</tr>
−
    <td>source</td>
+
<tr>
−
    <td>String</td>
+
  <td id="param_level2">currentVersionId</td>
−
    <td>x</td>
+
  <td>Long</td>
−
    <td></td>
+
<td></td> <td id="cardinality_cell">1..1</td>
−
   </tr>
+
   <td>Die neue ID der hinzugefügten Codesystem-Version</td>
−
  <tr>
+
</tr>
−
    <td>description</td>
+
<tr id="gray">
−
    <td>String</td>
+
  <td id="param_level2">description</td>
−
    <td>x</td>
+
  <td>String</td>
−
    <td></td>
+
  <td>65535</td>
−
   </tr>
+
  <td id="cardinality_cell">-</td>
−
  <tr>
+
   <td>Beschreibung eines Codesystems</td>
−
    <td>oid</td>
+
</tr>
−
    <td>String (Länge: 100)</td>
+
<tr>
−
    <td>x</td>
+
  <td id="param_level2">id</td>
−
    <td></td>
+
  <td>Long</td>
−
   </tr>
+
<td></td> <td id="cardinality_cell">1..1</td>
−
  <tr>
+
   <td>Die neue ID des hinzugefügten Codesystems</td>
−
    <td>licenceHolder</td>
+
</tr>
−
    <td>String</td>
+
<tr id="gray">
−
    <td>x</td>
+
  <td id="param_level2">insertTimestamp</td>
−
    <td></td>
+
  <td>java.util.Date</td>
−
   </tr>
+
<td></td> <td id="cardinality_cell">-</td>
−
  <tr>
+
   <td>Zeitstempel, wann das Codesystem eingefügt worden ist</td>
−
    <td>underLicence</td>
+
</tr>
−
    <td>boolean</td>
+
<tr id="gray">
−
    <td></td>
+
  <td id="param_level2">name</td>
−
    <td>Gibt an, ob die Codesystem-Version unter einer Lizenz steht oder nicht.</td>
+
  <td>String</td>
−
   </tr>
+
  <td>100</td>
−
  <tr style="background-color:#CCCCCC">
+
  <td id="cardinality_cell">-</td>
−
    <td>licenceType</td>
+
   <td>Name des Codesystems. Der genau Name sollte in der Version angegeben werden</td>
−
    <td><nowiki>List<LicenceType></nowiki></td>
+
</tr>
−
    <td>x</td>
+
<tr id="row_object">
−
    <td></td>
+
  <td id="param_level2">code_system_version</td>
−
   </tr>
+
  <td></td>
−
   <tr>
+
<td></td> <td id="cardinality_cell">1..1</td>
−
    <td>typeTxt</td>
+
  <td>Die Version des angelegtem Codesystems</td>
−
    <td>String</td>
+
</tr>
−
    <td></td>
+
<tr id="gray">
−
    <td>Typ der Lizenz</td>
+
  <td id="param_level3">codeSystemId</td>
−
   </tr>
+
   <td>Long</td>
−
</table>
+
<td></td>  <td id="cardinality_cell">-</td>
−
 
+
   <td></td>
−
===login===
+
</tr>
−
<table border="1">
+
<tr id="gray">
−
   <tr>
+
  <td id="param_level3">description</td>
−
    <th>Parameter</th>
+
  <td>String</td>
−
    <th>Typ</th>
+
  <td>65535</td>
−
    <th>Optional</th>
+
  <td id="cardinality_cell">-</td>
−
    <th>Beschreibung</th>
+
   <td>Beschreibung des Codesystems</td>
−
   </tr>
+
</tr>
−
  <tr>
+
<tr id="gray">
−
    <td>sessionID</td>
+
  <td id="param_level3">expirationDate</td>
−
    <td>String</td>
+
  <td>java.util.Date</td>
−
    <td></td>
+
<td></td>  <td id="cardinality_cell">-</td>
−
    <td>Die Session-ID, welche nach den erfolgreichen Login übergeben wurde.</td>
+
   <td>Datum, bis wann die Version gültig ist</td>
−
   </tr>
+
</tr>
−
</table>
+
<tr id="gray">
−
 
+
  <td id="param_level3">insertTimestamp</td>
−
==Rückgabewerte==
+
  <td>java.util.Date</td>
−
===returnInfos===
+
<td></td> <td id="cardinality_cell">-</td>
−
<table border="1">
+
   <td>Zeitstempel, wann die Codesystem-Version eingefügt worden ist</td>
−
   <tr>
+
</tr>
−
    <th>Parameter</th>
+
<tr id="gray">
−
    <th>Typ</th>
+
  <td id="param_level3">licenceHolder</td>
−
    <th>Optional</th>
+
  <td>String</td>
−
    <th>Beschreibung</th>
+
  <td>65535</td>
−
  </tr>
+
  <td id="cardinality_cell">-</td>
−
  <tr>
+
   <td>Besitzer der Lizenz</td>
−
    <td>overallErrorCategory</td>
+
</tr>
−
    <td>Enum</td>
+
<tr id="gray">
−
    <td></td>
+
   <td id="param_level3">name</td>
−
    <td>INFO, WARN oder ERROR</td>
+
  <td>String</td>
−
   </tr>
+
  <td>100</td>
−
  <tr>
+
  <td id="cardinality_cell">-</td>
−
    <td>status</td>
+
  <td>Vollständiger Name des Codesystems</td>
−
    <td>Enum</td>
+
</tr>
−
    <td></td>
+
<tr id="gray">
−
    <td>OK oder FAILURE</td>
+
  <td id="param_level3">oid</td>
−
   </tr>
+
  <td>String</td>
−
  <tr>
+
  <td>100</td>
−
    <td>message</td>
+
  <td id="cardinality_cell">-</td>
−
    <td>String</td>
+
   <td>Offizielle OID</td>
−
    <td></td>
+
</tr>
−
    <td>Status-Meldung</td>
+
<tr id="gray">
−
   </tr>
+
  <td id="param_level3">preferredLanguageId</td>
−
</table>
+
  <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>
−
===codeSystem===
+
</tr>
−
<table border="1">
+
<tr id="gray">
−
   <tr>
+
  <td id="param_level3">previousVersionID</td>
−
    <th>Parameter</th>
+
  <td>Long</td>
−
    <th>Typ</th>
+
<td></td> <td id="cardinality_cell">-</td>
−
    <th>Optional</th>
+
   <td>Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.</td>
−
    <th>Beschreibung</th>
+
</tr>
−
   </tr>
+
<tr id="gray">
−
  <tr>
+
  <td id="param_level3">releaseDate</td>
−
    <td>id</td>
+
  <td>java.util.Date</td>
−
    <td>long</td>
+
<td></td>  <td id="cardinality_cell">-</td>
−
    <td></td>
+
   <td>Datum, ab wann die Version gültig ist</td>
−
    <td>Die neue ID des hinzugefügten Codesystems</td>
+
</tr>
−
  </tr>
+
<tr id="gray">
−
  <tr>
+
  <td id="param_level3">source</td>
−
    <td>currentVersionId</td>
+
  <td>String</td>
−
    <td>long</td>
+
  <td>65535</td>
−
    <td></td>
+
  <td id="cardinality_cell">-</td>
−
    <td>Die neue ID der hinzugefügten Codesystem-Version</td>
+
   <td>Herausgeber der Codesystem-Version</td>
−
   </tr>
+
</tr>
−
  <tr style="background-color:#CCCCCC">
+
<tr id="gray">
−
    <td >codeSystemVersion</td>
+
  <td id="param_level3">status</td>
−
    <td>CodeSystemVersion</td>
+
  <td>Integer</td>
−
    <td></td>
+
<td></td>  <td id="cardinality_cell">-</td>
−
    <td>Die Version des anzulegenden Codesystems</td>
+
  <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
−
   </tr>
+
</tr>
−
  <tr>
+
<tr id="gray">
−
    <td>versionId</td>
+
  <td id="param_level3">statusDate</td>
−
    <td>long</td>
+
  <td>java.util.Date</td>
−
    <td></td>
+
<td></td> <td id="cardinality_cell">-</td>
−
    <td>Die neue ID der hinzugefügten Codesystem-Version</td>
+
   <td>Änderungszeitpunkt des Status</td>
−
  </tr>
+
</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>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Die neue ID der hinzugefügten Codesystem-Version</td>
 +
</tr>
 
</table>
 
</table>
  

Version vom 26. März 2012, 09:17 Uhr

System Terminologieserver
Webservice Administration
WSDL http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/Administration?wsdl
Methode ImportCodeSystem

Inhaltsverzeichnis

Funktionalität

Mit ImportCodeSystem können Sie komplette CodeSysteme importieren. Dabei stehen 2 Formate zur Wahl: ClaML oder CSV.
Sie müssen bei jedem Import ein Codesystem angeben, welches durch den Import erstellt wird. Alle neuen Konzepte werden in dieses Codesystem eingeordnet.

Vorbedingungen

Erfordert Login.

Request/Response

Request

Parameter Typ Länge Kardinalität Beschreibung
LoginType 1..1 Login-Informationen
ip String - Die IP-Adresse des Benutzers (wird intern vergeben)
password String - Passwort des Benutzers (als MD5-Wert)
sessionID String 1..1 Die Session-ID des Benutzers
username String - Benutzername
ImportType 1..1 Import-Metadaten
filecontent byte[] 1..1 Der Dateiinhalt. CSV-Dateien müssen mit ISO-8859-1 kodiert werden.
formatId Long 1..1 Das Format des Dateiinhalts.

ClaML: 193

CSV: 194
code_system 1..1 Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.
currentVersionId Long - Die aktuelle Versions-ID
description String 65535 0..1 Beschreibung des anzulegenden Codesystems
id Long -
insertTimestamp java.util.Date - Zeitstempel, wann das Codesystem eingefügt worden ist
name String 100 1..1 Name des anzulegenden Codesystems
code_system_version - Die Version des anzulegenden Codesystems
codeSystemId Long -
description String 65535 0..1 Beschreibung des Codesystems
expirationDate java.util.Date 0..1 Datum, bis wann die Version gültig ist
insertTimestamp java.util.Date - Zeitstempel, wann die Codesystem-Version eingefügt worden ist
licenceHolder String 65535 0..1 Besitzer der Lizenz
name String 100 1..1 Der Name der anzulegenden Codesystem-Version
oid String 100 0..1 Offizielle OID
preferredLanguageId Long - Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen)
previousVersionID Long - Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.
releaseDate java.util.Date 0..1 Datum, ab wann die Version gültig ist
source String 65535 0..1 Herausgeber der Codesystem-Version
status Integer - Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.
statusDate java.util.Date - Änderungszeitpunkt des Status
underLicence Boolean 1..1 true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar)
versionId Long -
licence_type 0..N Arten von Lizenztypen
codeSystemVersionId Long --..--
id Long -
typeTxt String 65535 1..1 Typ der Lizenz

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType 1..1 Entählt Informationen über die Antwort.
count Integer 1..1 Anzahl der Ergebnisse
message String 1..1 Status- oder Fehlermeldung
overallErrorCategory 1..1 INFO, WARN, ERROR
status 1..1 OK, FAILURE
code_system 1..1 Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.
currentVersionId Long 1..1 Die neue ID der hinzugefügten Codesystem-Version
description String 65535 - Beschreibung eines Codesystems
id Long 1..1 Die neue ID des hinzugefügten Codesystems
insertTimestamp java.util.Date - Zeitstempel, wann das Codesystem eingefügt worden ist
name String 100 - Name des Codesystems. Der genau Name sollte in der Version angegeben werden
code_system_version 1..1 Die Version des angelegtem Codesystems
codeSystemId Long -
description String 65535 - Beschreibung des Codesystems
expirationDate java.util.Date - Datum, bis wann die Version gültig ist
insertTimestamp java.util.Date - Zeitstempel, wann die Codesystem-Version eingefügt worden ist
licenceHolder String 65535 - Besitzer der Lizenz
name String 100 - Vollständiger Name des Codesystems
oid String 100 - Offizielle OID
preferredLanguageId Long - Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen)
previousVersionID Long - Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.
releaseDate java.util.Date - Datum, ab wann die Version gültig ist
source String 65535 - Herausgeber der Codesystem-Version
status Integer - Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.
statusDate java.util.Date - Änderungszeitpunkt des Status
underLicence Boolean - true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar)
versionId Long 1..1 Die neue ID der hinzugefügten Codesystem-Version

Anmerkungen

Besonderheiten

CSV-Import
Die kommagetrennte Datei muss folgendermaßen aufgebaut sein:

  • Syntax
    • Codierung: ISO-8859-1
    • Felder getrennt mit einem Semikolon ;
    • 1. Zeile enthält Informationen über die Spalten
  • Felder
    • erlaubte Werte
      • code (entweder code oder term verpflichtend)
      • term (entweder code oder term verpflichtend)
      • term_abbrevation
      • is_axis (1/0 oder true/false, Standard: 0)
      • is_mainclass (1/0 oder true/false, Standard: 0)
      • relation (Code, zu dem eine Beziehung aufgebaut wird)
        • association_kind (1=ontologisch, 2=taxonomisch, 3=cross mapping; Standard: 2)
        • association_type (Assoziationsbeschreibung, String, z.B. 'ist Unterklasse von', verpflichtend, wenn 'relation' angegeben ist)
        • association_type_reverse (Assoziationsbeschreibung rückwärts, String, z.B. 'ist Oberklasse von', verpflichtend, wenn 'relation' angegeben ist)

*Kursive Einträge sind optional

Ist kein Code angegeben, wird die Term-Bezeichnung dafür verwendet (wird gekürzt auf eine max. Länge von 100 Zeichen)

Hinweise

Beispiele

SOAP-Nachrichten

 <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>  <!-- kann man in Soap-UI direkt importieren (Kontextmenü) -->
               <formatId>194</formatId>
            </importInfos>
            <login>
               <sessionID>71a4f756-dc1a-41a6-941d-0e4fb0145f7f</sessionID>  <!-- Session-ID vom Login einfügen -->
            </login>
         </parameter>
      </adm:ImportCodeSystem>
   </soapenv:Body>
 </soapenv:Envelope>

Code-Beispiele

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