WS-Beschreibung - Terminologieserver Search ListCodeSystems

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→Request/Response)
 
Zeile 16: Zeile 16:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">LoginType</td>
 
   <td id="param_level1">LoginType</td>
−
   <td></td>
+
   <td>LoginType</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Login-Informationen</td>
+
   <td>Login information</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">ip</td>
+
−
  <td>String</td>
+
−
  <td></td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Die IP-Adresse des Benutzers (wird intern vergeben)</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">password</td>
+
−
  <td>String</td>
+
−
  <td></td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Passwort des Benutzers (als MD5-Wert)</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 39: Zeile 25:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</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="gray">
+
−
  <td id="param_level2">username</td>
+
−
  <td>String</td>
+
−
  <td></td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Benutzername</td>
+
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">code_system</td>
 
   <td id="param_level1">code_system</td>
−
   <td></td>
+
   <td>code_system</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Ist ein Codesystemangegeben, werden die Angaben als Filter verwendet</td>
+
   <td>If a code system is listed, the information is used as a filter</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">currentVersionId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Die aktuelle Versions-ID</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 65: Zeile 38:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Beschreibung eines Codesystems</td>
+
   <td>Narrative description of Code System</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">id</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td></td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 77: Zeile 44:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Zeitstempel, wann das Codesystem eingefügt worden ist</td>
+
   <td>Timestamp, wenn the Code System was inserted</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 84: Zeile 51:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Name des Codesystems. Der genau Name sollte in der Version angegeben werden</td>
+
   <td>Name of the Code System. The precise name should be specified in the Code System Version.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level2">code_system_version</td>
 
   <td id="param_level2">code_system_version</td>
−
   <td></td>
+
   <td>code_system_version</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Version eines Codesystems</td>
+
   <td>Version of a Code System</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">codeSystemId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td></td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 103: Zeile 64:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Beschreibung des Codesystems</td>
+
   <td>Description of the Code System</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 109: Zeile 70:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">0..1</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>
 
<tr>
 
<tr>
Zeile 115: Zeile 76:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Zeitstempel, wann die Codesystem-Version eingefügt worden ist</td>
+
   <td>Point of time when the Code System Version was inserted.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 122: Zeile 83:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Besitzer der Lizenz</td>
+
   <td>Owner of the licence.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 129: Zeile 90:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Vollständiger Name des Codesystems</td>
+
   <td>Complete Name of the Code System.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 136: Zeile 97:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Offizielle OID</td>
+
   <td>Official OID</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 142: Zeile 103:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">0..1</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>
+
   <td>Preferred language of the  Code System ( ID has to be taken from domain 'ISO_639_1_Language_Codes' with ID 1)</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">previousVersionID</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 154: Zeile 109:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">0..1</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>
 
<tr>
 
<tr>
Zeile 161: Zeile 116:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Herausgeber der Codesystem-Version</td>
+
   <td>Source of the Code System Version</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 167: Zeile 122:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
   <td>Status of the current entry. Can be taken from a domain.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 173: Zeile 128:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Änderungszeitpunkt des Status</td>
+
   <td>Point of time of the last change of the status</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 179: Zeile 134:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..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>
−
<tr id="gray">
+
<tr>
−
   <td id="param_level3">versionId</td>
+
   <td id="param_level3">validityRange</td>
−
   <td>Long</td>
+
   <td>String</td>
−
<td></td> <td id="cardinality_cell">-</td>
+
  <td>30</td>
−
   <td></td>
+
  <td id="cardinality_cell">0..1</td>
 +
   <td>Validity range, Values from domain list "codesystem_validityrange".
 +
Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Zeile 199: Zeile 156:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">ReturnType</td>
 
   <td id="param_level1">ReturnType</td>
−
   <td></td>
+
   <td>ReturnType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Entählt Informationen über die Antwort.</td>
+
   <td>Return information</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 207: Zeile 164:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Anzahl der Ergebnisse</td>
+
   <td>number of results</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 214: Zeile 171:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Status- oder Fehlermeldung</td>
+
   <td>an additional message</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 230: Zeile 187:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">code_system</td>
 
   <td id="param_level1">code_system</td>
−
   <td></td>
+
   <td>code_system</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</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>
 
<tr>
 
<tr>
Zeile 238: Zeile 195:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Die aktuelle Versions-ID</td>
+
   <td>Version of the Code System</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level2">description</td>
+
−
  <td>String</td>
+
−
  <td>65535</td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Beschreibung eines Codesystems</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 251: Zeile 201:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td></td>
+
   <td>Internal ID = Primary Key of Code System</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 257: Zeile 207:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Zeitstempel, wann das Codesystem eingefügt worden ist</td>
+
   <td>Timestamp, wenn the Code System was inserted</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 264: Zeile 214:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Name des Codesystems. Der genau Name sollte in der Version angegeben werden</td>
+
   <td>Name of the Code System. The precise name should be specified in the Code System Version.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level2">code_system_version</td>
 
   <td id="param_level2">code_system_version</td>
−
   <td></td>
+
   <td>code_system_version</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Version eines Codesystems</td>
+
   <td>Version of a Code System</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">codeSystemId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td></td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">description</td>
+
−
  <td>String</td>
+
−
  <td>65535</td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Beschreibung des Codesystems</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">expirationDate</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Datum, bis wann die Version gültig ist</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 295: Zeile 226:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Zeitstempel, wann die Codesystem-Version eingefügt worden ist</td>
+
   <td>Point of time when the Code System Version was inserted.</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">licenceHolder</td>
+
−
  <td>String</td>
+
−
  <td>65535</td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Besitzer der Lizenz</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 309: Zeile 233:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Vollständiger Name des Codesystems</td>
+
   <td>Complete Name of the Code System.</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">oid</td>
+
−
  <td>String</td>
+
−
  <td>100</td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Offizielle OID</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">preferredLanguageId</td>
+
−
  <td>Long</td>
+
−
<td></td>  <td id="cardinality_cell">-</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>
 
<tr>
 
<tr>
Zeile 328: Zeile 239:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.</td>
+
   <td>Refers to the prior version, if there are more than one.</td>
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">releaseDate</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Datum, ab wann die Version gültig ist</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">source</td>
+
−
  <td>String</td>
+
−
  <td>65535</td>
+
−
  <td id="cardinality_cell">-</td>
+
−
  <td>Herausgeber der Codesystem-Version</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">status</td>
+
−
  <td>Integer</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
−
</tr>
+
−
<tr id="gray">
+
−
  <td id="param_level3">statusDate</td>
+
−
  <td>java.util.Date</td>
+
−
<td></td>  <td id="cardinality_cell">-</td>
+
−
  <td>Änderungszeitpunkt des Status</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 359: Zeile 245:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">1..1</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>
 +
  <td id="param_level3">validityRange</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Validity range, Values from domain list "codesystem_validityrange".
 +
Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>

Aktuelle Version vom 9. August 2013, 09:26 Uhr

Inhaltsverzeichnis

Functionality

Lists all code systems and their versions that match the given criteria. For details about criteria see request section.

Prerequisites

Request/Response

Request

Parameter Typ Länge Kardinalität Beschreibung
LoginType LoginType 0..1 Login information
sessionID String 1..1 Session-ID from user (given by system)
code_system code_system 0..1 If a code system is listed, the information is used as a filter
description String 65535 0..1 Narrative description of Code System
insertTimestamp java.util.Date 0..1 Timestamp, wenn the Code System was inserted
name String 100 0..1 Name of the Code System. The precise name should be specified in the Code System Version.
code_system_version code_system_version 0..1 Version of a Code System
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.
insertTimestamp java.util.Date 0..1 Point of time when the Code System Version was inserted.
licenceHolder String 65535 0..1 Owner of the licence.
name String 100 0..1 Complete Name of the Code System.
oid String 100 0..1 Official OID
preferredLanguageId Long 0..1 Preferred language of the Code System ( ID has to be taken from domain 'ISO_639_1_Language_Codes' with ID 1)
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
status Integer 0..1 Status of the current entry. Can be taken from a domain.
statusDate java.util.Date 0..1 Point of time of the last change of the status
underLicence Boolean 0..1 true, if Code System is under license (Code System will be invisible for all users without proper license)
validityRange String 30 0..1 Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)

Response

Parameter Typ Länge 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 0..N Name of codesystem. Each codesystem requires at least one version.
currentVersionId Long 1..1 Version of the Code System
id Long 1..1 Internal ID = Primary Key of Code System
insertTimestamp java.util.Date 1..1 Timestamp, wenn the Code System was inserted
name String 100 1..1 Name of the Code System. The precise name should be specified in the Code System Version.
code_system_version code_system_version 1..1 Version of a Code System
insertTimestamp java.util.Date 1..1 Point of time when the Code System Version was inserted.
name String 100 1..1 Complete Name of the Code System.
previousVersionID Long 1..1 Refers to the prior version, if there are more than one.
underLicence Boolean 1..1 true, if Code System is under license (Code System will be invisible for all users without proper license)
validityRange String 30 1..1 Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)
versionId Long 1..1

Annotations

Noteworthiness

Hints

Examples

SOAP messages

Simple Search w/o filters

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <sear:ListCodeSystems>
         </sear:ListCodeSystems>
   </soapenv:Body>
</soapenv:Envelope>

Search for code systems with specific properties (here: code system versions name has to contain ICD)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <sear:ListCodeSystems>
         <parameter>
            <codeSystem>
               <codeSystemVersions>
                  <name>ICD</name>
               </codeSystemVersions>
            </codeSystem>
         </parameter>
      </sear:ListCodeSystems>
   </soapenv:Body>
</soapenv:Envelope>

Code example

Java

 
Von „http://www.wiki.mi.fh-dortmund.de/cts2/index.php?title=WS-Beschreibung_-_Terminologieserver_Search_ListCodeSystems“
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge