Aus Termserver-CTS2

(Unterschied zwischen Versionen)

Wechseln zu: Navigation, Suche

Aktuelle Version vom 9. August 2013, 08:27 Uhr

Inhaltsverzeichnis

1 Functionality
2 Prerequisites
3 Request/Response
- 3.1 Request
- 3.2 Response
4 Examples
- 4.1 SOAP messages
  - 4.1.1 Simple domain
  - 4.1.2 Complex domain
- 4.2 Code example
  - 4.2.1 Java
5 Annotations
- 5.1 Noteworthiness
- 5.2 Hints
6 Examples
- 6.1 Files
- 6.2 SOAP messages

Functionality

Imports a whole code system. There are two import formats available: ClaML and CSV.
You have to specify a code system for each import. All new concepts will be added to that code system.

Prerequisites

Requires Login.

Request/Response

Request

Parameter	Typ	Länge	Kardinalität	Beschreibung
LoginType	LoginType		1..1	Login information
sessionID	String		1..1	Session-ID from user (given by system)
ImportType	ImportType		1..1	Parameter for import
filecontent	byte[]		1..1	The file contents. CSV files must be encoded with ISO-8859-1.
formatId	Long		1..1	The content of the file. ClaML: 193 CSV: 194 LOINC: 200 LOINC relations: 201 KBV keytab: 234
code_system	code_system		1..1	Name of codesystem. Each codesystem requires at least one version.
description	String	65535	0..1	Description of the code system to be created
name	String	100	1..1	Name of the code system to be created
code_system_version	code_system_version		-	Version of the code system to be created
description	String	65535	0..1	Description of the Code System
expirationDate	java.util.Date		0..1	Point of time the Code System looses its validity.
licenceHolder	String	65535	0..1	Owner of the licence.
name	String	100	1..1	Name of the code system version to be created
oid	String	100	0..1	Official OID
releaseDate	java.util.Date		0..1	Point of time, when this version starts to be valid.
source	String	65535	0..1	Source of the Code System Version
underLicence	Boolean		1..1	true, if Code System is under license (Code System will be invisible for all users without proper license)
licence_type	licence_type		0..N	Sorts of licence types.
typeTxt	String	65535	1..1	type of licence

Response

Parameter	Typ	Kardinalität	Beschreibung
ReturnType	ReturnType	1..1	Return information
count	Integer	1..1	number of results
message	String	1..1	an additional message
overallErrorCategory		1..1	INFO, WARN, ERROR
status		1..1	OK, FAILURE
code_system	code_system	1..1	Name of codesystem. Each codesystem requires at least one version.
currentVersionId	Long	1..1	The new ID of the added code system version
id	Long	1..1	The new ID of the added code system
code_system_version	code_system_version	1..1	The version of the added code system
versionId	Long	1..1	The new ID of the added code system version

Examples

SOAP messages

Simple domain

Complex domain

Code example

Java

Annotations

Noteworthiness

CSV-Import
The comma separated file has to be build in this pattern:

Syntax
- Coding: ISO-8859-1
- Fields will be separated by a ";"
- Strings has to be encapsulated with " ", if there are any special or delimiter symbols
- First row contains informations about columns
Fields
- legal values
  - code (either code or term are required)
  - term (either code or term are required)
  - term_abbrevation
  - description
  - is_axis (1/0 or true/false, standard: 0)
  - is_mainclass (1/0 or true/false, standard: 0)
  - is_preferred (1/0 or true/false, standard: 1)
  - relation (Code, a association will be build up to)
    - association_kind (1=ontological, 2=taxonomic, 3=cross mapping; standard: 2)
    - association_type (Association description, string, e.g. 'is subclass of', required if 'relation' is set)
    - association_type_reverse (Association description reversed, string, e.g. 'is upper class of', required if 'relation' is set)
  - translation_XX (XX represents the ID of the language, that can be determined by the domains)
  - metadata_XX (XX represents the names of metadata, that will be created automatically)

*italic Entries are optional If no code is given, term will be used as code (cut to a maximum length of 100 characters)

Hints

Examples

Files

The following file shows a example of a csv import of a small code system with associations:CSV-Import_Beispiel

Example file (CSV) with some translations can be found here: Geschlechtercodes CSV

SOAP messages

 <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>  <!-- can be imported directly in Soap-UI (context menu) -->
               <formatId>194</formatId>
            </importInfos>
            <login>
               <sessionID>71a4f756-dc1a-41a6-941d-0e4fb0145f7f</sessionID>  <!-- insert Session-ID from login -->
            </login>
         </parameter>
      </adm:ImportCodeSystem>
   </soapenv:Body>
 </soapenv:Envelope>

@@ Zeile 21: / Zeile 21: @@
    <td>LoginType</td>
 <td></td>  <td id="cardinality_cell">1..1</td>
-   <td>Login-Informationen</td>
+   <td>Login information</td>
 </tr>
 <tr>
@@ Zeile 28: / Zeile 28: @@
    <td></td>
    <td id="cardinality_cell">1..1</td>
-   <td>Die Session-ID des Benutzers</td>
+   <td>Session-ID from user (given by system)</td>
 </tr>
 <tr id="row_object">
@@ Zeile 34: / Zeile 34: @@
    <td>ImportType</td>
 <td></td>  <td id="cardinality_cell">1..1</td>
-   <td>Import-Metadaten</td>
+   <td>Parameter for import</td>
 </tr>
 <tr>
@@ Zeile 40: / Zeile 40: @@
    <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>
+   <td>The file contents. CSV files must be encoded with ISO-8859-1.</td>
 </tr>
 <tr>
@@ Zeile 46: / Zeile 46: @@
    <td>Long</td>
 <td></td>  <td id="cardinality_cell">1..1</td>
-   <td>Das Format des Dateiinhalts.
+   <td>The content of the file.
 ClaML: 193
 CSV: 194
 LOINC: 200
+LOINC relations: 201
-LOINC Beziehungen: 201
+KBV keytab: 234</td>
-KBV Keytab: 234</td>
 </tr>
 <tr id="row_object">
@@ Zeile 62: / Zeile 57: @@
    <td>code_system</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 of codesystem. Each codesystem requires at least one version.</td>
 </tr>
 <tr>
@@ Zeile 69: / Zeile 64: @@
    <td>65535</td>
    <td id="cardinality_cell">0..1</td>
-   <td>Beschreibung des anzulegenden Codesystems</td>
+   <td>Description of the code system to be created</td>
 </tr>
 <tr>
@@ Zeile 76: / Zeile 71: @@
    <td>100</td>
    <td id="cardinality_cell">1..1</td>
-   <td>Name des anzulegenden Codesystems</td>
+   <td>Name of the code system to be created</td>
 </tr>
 <tr id="row_object">
@@ Zeile 82: / Zeile 77: @@
    <td>code_system_version</td>
 <td></td>  <td id="cardinality_cell">-</td>
-   <td>Die Version des anzulegenden Codesystems</td>
+   <td>Version of the code system to be created</td>
 </tr>
 <tr>
@@ Zeile 89: / Zeile 84: @@
    <td>65535</td>
    <td id="cardinality_cell">0..1</td>
-   <td>Beschreibung des Codesystems</td>
+   <td>Description of the Code System</td>
 </tr>
 <tr>
@@ Zeile 95: / Zeile 90: @@
    <td>java.util.Date</td>
 <td></td>  <td id="cardinality_cell">0..1</td>
-   <td>Datum, bis wann die Version gültig ist</td>
+   <td>Point of time the Code System looses its validity.</td>
 </tr>
 <tr>
@@ Zeile 102: / Zeile 97: @@
    <td>65535</td>
    <td id="cardinality_cell">0..1</td>
-   <td>Besitzer der Lizenz</td>
+   <td>Owner of the licence.</td>
 </tr>
 <tr>
@@ Zeile 109: / Zeile 104: @@
    <td>100</td>
    <td id="cardinality_cell">1..1</td>
-   <td>Der Name der anzulegenden Codesystem-Version</td>
+   <td>Name of the code system version to be created</td>
 </tr>
 <tr>
@@ Zeile 116: / Zeile 111: @@
    <td>100</td>
    <td id="cardinality_cell">0..1</td>
-   <td>Offizielle OID</td>
+   <td>Official OID</td>
 </tr>
 <tr>
@@ Zeile 122: / Zeile 117: @@
    <td>java.util.Date</td>
 <td></td>  <td id="cardinality_cell">0..1</td>
-   <td>Datum, ab wann die Version gültig ist</td>
+   <td>Point of time, when this version starts to be valid.</td>
 </tr>
 <tr>
@@ Zeile 129: / Zeile 124: @@
    <td>65535</td>
    <td id="cardinality_cell">0..1</td>
-   <td>Herausgeber der Codesystem-Version</td>
+   <td>Source of the Code System Version</td>
 </tr>
 <tr>
@@ Zeile 135: / Zeile 130: @@
    <td>Boolean</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, if Code System is under license (Code System will be invisible for all users without proper license)</td>
 </tr>
 <tr id="row_object">
@@ Zeile 141: / Zeile 136: @@
    <td>licence_type</td>
 <td></td>  <td id="cardinality_cell">0..N</td>
-   <td>Arten von Lizenztypen</td>
+   <td>Sorts of licence types.</td>
 </tr>
 <tr>
@@ Zeile 148: / Zeile 143: @@
    <td>65535</td>
    <td id="cardinality_cell">1..1</td>
-   <td>Typ der Lizenz</td>
+   <td>type of licence</td>
 </tr>
 </table>
 ==Response==
 <table border="1" cellpadding="1" class="ws_table">
@@ Zeile 165: / Zeile 159: @@
    <td>ReturnType</td>
 <td></td>  <td id="cardinality_cell">1..1</td>
-   <td>Enthält Informationen über die Antwort.</td>
+   <td>Return information</td>
 </tr>
 <tr>
@@ Zeile 171: / Zeile 165: @@
    <td>Integer</td>
 <td></td>  <td id="cardinality_cell">1..1</td>
-   <td>Anzahl der Ergebnisse</td>
+   <td>number of results</td>
 </tr>
 <tr>
@@ Zeile 178: / Zeile 172: @@
    <td></td>
    <td id="cardinality_cell">1..1</td>
-   <td>Status- oder Fehlermeldung</td>
+   <td>an additional message</td>
 </tr>
 <tr>
@@ Zeile 196: / Zeile 190: @@
    <td>code_system</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 of codesystem. Each codesystem requires at least one version.</td>
 </tr>
 <tr>
@@ Zeile 202: / Zeile 196: @@
    <td>Long</td>
 <td></td>  <td id="cardinality_cell">1..1</td>
-   <td>Die neue ID der hinzugefügten Codesystem-Version</td>
+   <td>The new ID of the added code system version</td>
 </tr>
 <tr>
@@ Zeile 208: / Zeile 202: @@
    <td>Long</td>
 <td></td>  <td id="cardinality_cell">1..1</td>
-   <td>Die neue ID des hinzugefügten Codesystems</td>
+   <td>The new ID of the added code system</td>
 </tr>
 <tr id="row_object">
@@ Zeile 214: / Zeile 208: @@
    <td>code_system_version</td>
 <td></td>  <td id="cardinality_cell">1..1</td>
-   <td>Die Version des angelegtem Codesystems</td>
+   <td>The version of the added code system</td>
 </tr>
 <tr>
@@ Zeile 220: / Zeile 214: @@
    <td>Long</td>
 <td></td>  <td id="cardinality_cell">1..1</td>
-   <td>Die neue ID der hinzugefügten Codesystem-Version</td>
+   <td>The new ID of the added code system version</td>
 </tr>
 </table>

WS-Beschreibung - Terminologieserver Administration ImportCodeSystem

Aktuelle Version vom 9. August 2013, 08:27 Uhr

Inhaltsverzeichnis

Functionality

Prerequisites

Request/Response

Request

Response

Examples

SOAP messages

Simple domain

Complex domain

Code example

Java

Annotations

Noteworthiness

Hints

Examples

Files

SOAP messages

Meine Werkzeuge

Namensräume

Varianten

Ansichten

Aktionen

Suche

Navigation

Werkzeuge