WS-Beschreibung - Terminologieserver Administration ImportValueSet

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→Besonderheiten)
(→Request/Response)
Zeile 26: Zeile 26:
  
 
=Request/Response=
 
=Request/Response=
 +
==Request==
 +
<table border="1" cellpadding="1" class="ws_table">
 +
  <tr class="ws_table_head">
 +
    <th>Parameter</th>
 +
    <th>Typ</th>
 +
    <th>L&auml;nge</th>
 +
    <th id="cardinality_cell">Kardinalit&auml;t</th>
 +
    <th>Beschreibung</th>
 +
  </tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">importInfos</td>
 +
  <td>ImportType</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 id="row_object">
 +
  <td id="param_level1">LoginType</td>
 +
  <td>LoginType</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Login-Informationen</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="row_object">
 +
  <td id="param_level1">value_set</td>
 +
  <td>value_set</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Stellt eine Untermenge von Begriffen dar. Jedes Valueset hat mindestens eine Valueset-Version.</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 Valuesets
 +
Dieses Feld wird nur benötigt, wenn Sie ein neues Value Set anlegen.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>ID des Valuesets
 +
Sie müssen entweder die ID eines Value Sets angeben oder einen Namen angeben, falls Sie ein neues Value Set erstellen möchten.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">name</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Name des Valuesets
 +
Sie müssen entweder die ID eines Value Sets angeben oder einen Namen angeben, falls Sie ein neues Value Set erstellen möchten.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">value_set_version</td>
 +
  <td>value_set_version</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Stellt die Version eines Valuesets dar.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">preferredLanguageId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">0..1</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>
 +
  <td id="param_level3">releaseDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Datum, ab dem die Valueset-Version gültig ist</td>
 +
</tr>
 +
</table>
 +
==Response==
 +
<table border="1" cellpadding="1" class="ws_table">
 +
  <tr class="ws_table_head">
 +
    <th>Parameter</th>
 +
    <th>Typ</th>
 +
    <th>L&auml;nge</th>
 +
    <th id="cardinality_cell">Kardinalit&auml;t</th>
 +
    <th>Beschreibung</th>
 +
  </tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">ReturnType</td>
 +
  <td>ReturnType</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Enthält Informationen über die Antwort.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">count</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Anzahl der Ergebnisse</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">message</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Status- oder Fehlermeldung</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">overallErrorCategory</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>INFO, WARN, ERROR</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">status</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>OK, FAILURE</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">value_set</td>
 +
  <td>value_set</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Stellt eine Untermenge von Begriffen dar. Jedes Valueset hat mindestens eine Valueset-Version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>ID des Valuesets</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">value_set_version</td>
 +
  <td>value_set_version</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Stellt die Version eines Valuesets dar.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Versions-ID des Valuesets</td>
 +
</tr>
 +
</table>
  
 
=Anmerkungen=
 
=Anmerkungen=

Version vom 17. Januar 2013, 07:38 Uhr

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

Inhaltsverzeichnis

Funktionalität

Mit ImportValueSet können Value Set-Inhalte in den Terminologieserver importiert werden. Dabei müssen die Daten im CSV-Format vorliegen.

Vorbedingungen

Erfordert Login.

Request/Response

Request

Parameter Typ Länge Kardinalität Beschreibung
importInfos ImportType 1..1 Import-Metadaten
filecontent byte[] 1..1 Der Dateiinhalt. CSV-Dateien müssen mit ISO-8859-1 kodiert werden.
LoginType LoginType 1..1 Login-Informationen
sessionID String 1..1 Die Session-ID des Benutzers
value_set value_set 1..1 Stellt eine Untermenge von Begriffen dar. Jedes Valueset hat mindestens eine Valueset-Version.
description String 65535 0..1 Beschreibung des Valuesets Dieses Feld wird nur benötigt, wenn Sie ein neues Value Set anlegen.
id Long 0..1 ID des Valuesets Sie müssen entweder die ID eines Value Sets angeben oder einen Namen angeben, falls Sie ein neues Value Set erstellen möchten.
name String 50 0..1 Name des Valuesets Sie müssen entweder die ID eines Value Sets angeben oder einen Namen angeben, falls Sie ein neues Value Set erstellen möchten.
value_set_version value_set_version 0..1 Stellt die Version eines Valuesets dar.
preferredLanguageId Long 0..1 Bevorzugte Sprache des Codesystems (ID ist aus der Domäne 'ISO_639_1_Language_Codes' mit der ID 1 zu entnehmen)
releaseDate java.util.Date 0..1 Datum, ab dem die Valueset-Version gültig ist

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
value_set value_set 0..1 Stellt eine Untermenge von Begriffen dar. Jedes Valueset hat mindestens eine Valueset-Version.
id Long 1..1 ID des Valuesets
value_set_version value_set_version 1..1 Stellt die Version eines Valuesets dar.
versionId Long 1..1 Versions-ID des Valuesets

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 conecpt_id verpflichtend)
      • conecpt_id (entweder code oder conecpt_id verpflichtend)

*Kursive Einträge sind optional

Ist keine Konzept-ID angegeben, wird die Code-Bezeichnung verwendet, um die Konzept-ID zu lesen (schlechtere Performance).

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_ImportValueSet“
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge