WS-Beschreibung - Terminologieserver Administration ImportValueSet
Aus Termserver-CTS2
Version vom 17. Januar 2013, 08:04 Uhr von Muetzner (Diskussion | Beiträge)
| 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)
- concept_id (entweder code oder conecpt_id verpflichtend)
- codesystem_version_id (muss angegeben werden, wenn der code angegeben ist)
- erlaubte Werte
*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
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>
