WS-Beschreibung - Terminologieserver Administration ImportCodeSystem

Aus Termserver-CTS2
Wechseln zu: Navigation, Suche

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:

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