WS-Beschreibung - Terminologieserver Administration ImportCodeSystem
Aus Termserver-CTS2
Version vom 3. Mai 2012, 08:16 Uhr von Muetzner (Diskussion | Beiträge)
| 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, zu erhalten von Login | |
| 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)
- erlaubte Werte
*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
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>
