WS-Beschreibung - Terminologieserver Administration ImportCodeSystem

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→Besonderheiten)
(→Request/Response)
Zeile 37: Zeile 37:
 
<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-Informationen</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 46:
 
   <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>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>
 
<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>Import-Metadaten</td>
Zeile 86: Zeile 65:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Das Format des Dateiinhalts.
 
   <td>Das Format des Dateiinhalts.
−
 
 
ClaML: 193
 
ClaML: 193
−
 
 
CSV: 194
 
CSV: 194
−
 
 
LOINC: 200
 
LOINC: 200
−
 
+
LOINC Beziehungen: 201
−
LOINC Beziehungen: 201</td>
+
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 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>
 
<tr>
 
<tr>
Zeile 113: Zeile 83:
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td>Beschreibung des anzulegenden Codesystems</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>
 
<tr>
 
<tr>
Zeile 135: Zeile 93:
 
<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>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>
 
<tr>
 
<tr>
Zeile 157: Zeile 109:
 
<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>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>
 
<tr>
 
<tr>
Zeile 184: Zeile 130:
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td>Offizielle OID</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>
 
<tr>
 
<tr>
Zeile 209: Zeile 143:
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td>Herausgeber der Codesystem-Version</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>
 
<tr>
 
<tr>
Zeile 227: Zeile 149:
 
<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, 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>
 
<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>Arten von Lizenztypen</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 260: Zeile 164:
 
</tr>
 
</tr>
 
</table>
 
</table>
−
 
 
==Response==
 
==Response==
 
<table border="1" cellpadding="1" class="ws_table">
 
<table border="1" cellpadding="1" class="ws_table">
Zeile 272: Zeile 175:
 
<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>Enthält Informationen über die Antwort.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 303: Zeile 206:
 
<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 eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.</td>
Zeile 312: Zeile 215:
 
<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>Die neue ID der hinzugefügten Codesystem-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 325: Zeile 221:
 
<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>Die neue ID des hinzugefügten Codesystems</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>Die Version des angelegtem 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 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>

Version vom 7. Februar 2013, 09:05 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 LoginType 1..1 Login-Informationen
sessionID String 1..1 Die Session-ID des Benutzers
ImportType 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 LOINC: 200 LOINC Beziehungen: 201

KBV Keytab: 234
code_system code_system 1..1 Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.
description String 65535 0..1 Beschreibung des anzulegenden Codesystems
name String 100 1..1 Name des anzulegenden Codesystems
code_system_version code_system_version - Die Version des anzulegenden Codesystems
description String 65535 0..1 Beschreibung des Codesystems
expirationDate java.util.Date 0..1 Datum, bis wann die Version gültig 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
releaseDate java.util.Date 0..1 Datum, ab wann die Version gültig ist
source String 65535 0..1 Herausgeber der Codesystem-Version
underLicence Boolean 1..1 true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar)
licence_type licence_type 0..N Arten von Lizenztypen
typeTxt String 65535 1..1 Typ der Lizenz

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType ReturnType 1..1 Enthält 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 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
id Long 1..1 Die neue ID des hinzugefügten Codesystems
code_system_version code_system_version 1..1 Die Version des angelegtem Codesystems
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 ;
    • Strings können, falls Sie Sonderzeichen oder Trennzeichen enthalten, mit " " angegeben werden
    • 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
      • description
      • is_axis (1/0 oder true/false, Standard: 0)
      • is_mainclass (1/0 oder true/false, Standard: 0)
      • is_preferred (1/0 oder true/false, Standard: 1)
      • 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)
      • translation_XX (XX steht für eine ID einer Sprache, welche über die Domains bestimmt werden kann)
      • metadata_XX (XX steht für einen Metadaten-Namen, welcher automatisch angelegt wird)

*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

Dateien

Die folgende Datei zeigt ein Beispiel eines CSV-Imports mit einem kleinen Vokabular inklusive Beziehungen: CSV-Import_Beispiel

Eine Beispieldatei (CSV) mit verschiedenen Übersetzungen ist hier zu finden: Geschlechtercodes CSV

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>
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