WS-Beschreibung - Terminologieserver Search ListCodeSystems
Aus Termserver-CTS2
Version vom 8. August 2013, 11:25 Uhr von Becker (Diskussion | Beiträge)
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 | 0..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 | |
username | String | - | Benutzername | |
code_system | 0..1 | Ist ein Codesystemangegeben, werden die Angaben als Filter verwendet | ||
currentVersionId | Long | - | Die aktuelle Versions-ID | |
description | String | 65535 | 0..1 | Beschreibung eines Codesystems |
id | Long | - | ||
insertTimestamp | java.util.Date | 0..1 | Zeitstempel, wann das Codesystem eingefügt worden ist | |
name | String | 100 | 0..1 | Name des Codesystems. Der genau Name sollte in der Version angegeben werden |
code_system_version | 0..1 | Version eines 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 | 0..1 | Zeitstempel, wann die Codesystem-Version eingefügt worden ist | |
licenceHolder | String | 65535 | 0..1 | Besitzer der Lizenz |
name | String | 100 | 0..1 | Vollständiger Name des Codesystems |
oid | String | 100 | 0..1 | Offizielle OID |
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) | |
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 | 0..1 | Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. | |
statusDate | java.util.Date | 0..1 | Änderungszeitpunkt des Status | |
underLicence | Boolean | 0..1 | true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar) | |
versionId | Long | - |
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 | 0..N | Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen. | ||
currentVersionId | Long | 1..1 | Die aktuelle Versions-ID | |
description | String | 65535 | - | Beschreibung eines Codesystems |
id | Long | 1..1 | ||
insertTimestamp | java.util.Date | 1..1 | Zeitstempel, wann das Codesystem eingefügt worden ist | |
name | String | 100 | 1..1 | Name des Codesystems. Der genau Name sollte in der Version angegeben werden |
code_system_version | 1..1 | Version eines 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 | 1..1 | Zeitstempel, wann die Codesystem-Version eingefügt worden ist | |
licenceHolder | String | 65535 | - | Besitzer der Lizenz |
name | String | 100 | 1..1 | 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 | 1..1 | 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 | 1..1 | true, wenn das Vokabular unter Lizenzen fällt (ist dann für Benutzer ohne entsprechende Rechte nicht sichtbar) | |
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>