WS-Beschreibung - Terminologieserver Search ListCodeSystemConcepts
Aus Termserver-CTS2
Version vom 17. Juni 2013, 12:21 Uhr von Muetzner (Diskussion | Beiträge)
| System | Terminologieserver |
| Webservice | Search |
| WSDL | http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/Search?wsdl |
| Methode | ListCodeSystemConcepts |
Inhaltsverzeichnis |
Funktionalität
Listet alle Konzepte des angegebenen Vokabulars bzw. einer Vokabularversion an. Es können Filter benutzt werden um nach bestimmten Konzepten zu suchen. Welche Filter genutzt werden können ist der Eingabe-Tabelle zu entnehmen.
Vorbedingungen
Request/Response
Request
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| LoginType | LoginType | 0..1 | Login-Informationen | |
| sessionID | String | 1..1 | Die Session-ID des Benutzers | |
| code_system | code_system | 1..1 | Name eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen. | |
| code_system_version | code_system_version | 1..1 | Version eines Codesystems | |
| versionId | Long | 1..1 | ||
| code_system_entity | code_system_entity | 0..1 | Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen. | |
| code_system_entity_version | code_system_entity_version | 0..1 | Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung. | |
| statusDate | java.util.Date | 0..1 | Änderungszeitpunkt des Status | |
| code_system_concept | code_system_concept | 0..1 | Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von code_system_entity_version. | |
| code | String | 100 | 0..1 | Der Code zu einem Begriff bzw. Konzepts |
| isPreferred | Boolean | 1..1 | Gibt an, ob es sich um einen Vorzugsbegriff handelt | |
| term | String | 65535 | 0..1 | Der Begriff selbst |
| termAbbrevation | String | 50 | 0..1 | Abkürzung des Begriffs |
| code_system_concept_translation | code_system_concept_translation | 0..1 | Übersetzung eines Begriffs. | |
| languageId | Long | 0..1 | Sprache der Übersetzung. Der Wert kommt von Domain-Value mit der Domain-ID 1 (ISO_639_1_Language_Codes) Alle Konzepte dieser Anfrage werden in diese Sprache übersetzt, falls die Übersetzung vorhanden ist. | |
| term | String | 65535 | 0..1 | Übersetzter Begriff |
| termAbbrevation | String | 50 | 0..1 | Abkürzung des übersetzten Begriffs |
| code_system_version_entity_membership | code_system_version_entity_membership | 0..1 | Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her. | |
| isAxis | Boolean | 0..1 | true, wenn die zugehörige Entity des Eintrags eine Achse des Codesystems ist | |
| isMainClass | Boolean | 0..1 | true, wenn die zugehörige Entity des Eintrags eine Hauptklasse (root-Element) des Codesystems ist | |
| SearchType | SearchType | 0..1 | Spezifiziert die Ergebnismenge von Suchergebnissen. | |
| caseSensitive | Boolean | 1..1 | true, wenn zwischen Groß- und Kleinschreibung unterschieden werden soll | |
| startsWith | Boolean | 1..1 | true, wenn das Ergebniswort mit dem Suchbegriff beginnen soll | |
| traverseConceptsToRoot | Boolean | 1..1 | true, wenn (bei hierarchischen Codesystemen) zu einem Begriff alle Begriffe bis zur Wurzel abgerufen werden sollen. Die Suche dauert anhand der Traversierungen dementstprechend länger, deshalb sollte eine kleine pageSize gewählt werden | |
| wholeWords | Boolean | 1..1 | true, wenn der Suchbegriff einem Ergebebniswort komplett übereinstimmen soll | |
| PagingType | PagingType | 0..1 | Spezifiziert die Ergebnismenge von Suchergebnissen. | |
| allEntries | Boolean | 0..1 | true, wenn alle Einträge unabhängig von der pageSize zurückgegeben werden sollen. Dieses Attribut benötigt Berechtigungen, so dass man sich vorher einloggen muss. | |
| pageIndex | Integer | 1..1 | Gibt die Seite an, für welche die Ergebnisse zurückgegeben werden sollen. Ist z.B. pageSize mit 20 und pageIndex mit 2 angegeben, so werden die Einträge 40-59 zurückgegeben. | |
| pageSize | Integer | 1..1 | Gibt die gewünschte Anzahl an Treffern an, welche auf einer Seite dargestellt werden. Überschreitet der Wert die maximale Systemgröße, wird dieser automatisch verkleinert. | |
| lookForward | Boolean | 0..1 | Gibt an, ob Informationen über Beziehungen zu jedem Begriff geladen werden sollen. Falls der Parameter "true" ist, kann "traverseConceptsToRoot" nicht verwendet werden. |
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_entity | code_system_entity | 0..N | Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen. | |
| currentVersionId | Long | 1..1 | Die aktuelle ID der code_system_entity_version | |
| id | Long | 1..1 | ||
| code_system_entity_version | code_system_entity_version | 1..1 | Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung. | |
| codeSystemEntityId | Long | 1..1 | Fremdschlüssel auf die ID des Entities | |
| effectiveDate | java.util.Date | 1..1 | Zeitpunkt der letzten Änderung | |
| insertTimestamp | java.util.Date | 1..1 | Zeitstempel, wann der Eintrag eingefügt worden ist | |
| isLeaf | Boolean | 1..1 | Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden. | |
| majorRevision | Integer | 1..1 | Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) | |
| minorRevision | Integer | 1..1 | Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3) | |
| status | Integer | 1..1 | Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. | |
| statusDate | java.util.Date | 1..1 | Änderungszeitpunkt des Status | |
| versionId | Long | 1..1 | Versions-ID der Entity-Version | |
| code_system_concept | code_system_concept | 1..1 | Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von code_system_entity_version. | |
| code | String | 100 | 1..1 | Der Code zu einem Begriff bzw. Konzepts |
| codeSystemEntityVersionId | Long | 1..1 | ||
| isPreferred | Boolean | 1..1 | Gibt an, ob es sich um einen Vorzugsbegriff handelt | |
| term | String | 65535 | 1..1 | Der Begriff selbst |
| termAbbrevation | String | 50 | 1..1 | Abkürzung des Begriffs |
| code_system_concept_translation | code_system_concept_translation | 0..1 | Übersetzung eines Begriffs. Gibt eine Übersetzung zurück, falls die Sprache angegeben wurde und die Übersetzung existiert. | |
| codeSystemEntityVersionId | Long | 1..1 | ||
| id | Long | 1..1 | ||
| languageId | Long | 1..1 | Sprache der Übersetzung. Der Wert kommt von Domain-Value mit der Domain-ID 1 (ISO_639_1_Language_Codes) | |
| term | String | 65535 | 1..1 | Übersetzter Begriff |
| termAbbrevation | String | 50 | 1..1 | Abkürzung des übersetzten Begriffs |
| code_system_entity_version_association | code_system_entity_version_association | 0..N | Setzt 2 Entity-Versionen miteinander in Beziehung. | |
| associationKind | Integer | 1..1 | 1 = ontologisch,
2 = taxonomisch, 3 = cross mapping, 4 = link |
|
| associationTypeId | Long | 1..1 | Gibt den Typ der Beziehung an (z.B. 'gehört zu') | |
| codeSystemEntityVersionId1 | Long | 1..1 | Eine Entity der Beziehung | |
| codeSystemEntityVersionId2 | Long | 1..1 | Eine Entity der Beziehung | |
| id | Long | 1..1 | ||
| insertTimestamp | java.util.Date | 1..1 | Zeitpunkt, wann die Beziehung eingefügt worden ist. | |
| leftId | Long | 1..1 | Gibt an, wie die Leserichtung von ID 1 und ID 2 ist. Ist entweder gleich der codeSystemEntityVersionId1 oder codeSystemEntityVersionId2. Sollte die Leserichtung von ID2 -> ID1 gerichtet sein, müssen ebenfalls die Beziehungsnamen (forwardName und reverseName) umgedreht werden. | |
| status | Integer | 1..1 | Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden. | |
| statusDate | java.util.Date | 1..1 | Änderungszeitpunkt des Status | |
| code_system_version_entity_membership | code_system_version_entity_membership | 1..1 | Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her. | |
| isAxis | Boolean | 1..1 | true, wenn die zugehörige Entity des Eintrags eine Achse des Codesystems ist | |
| isMainClass | Boolean | 1..1 | true, wenn die zugehörige Entity des Eintrags eine Hauptklasse (root-Element) des Codesystems ist | |
| PagingResultType | PagingResultType | 0..1 | Wird automatisch zurückgegeben, wenn die Treffermenge größer der maximalen Systembegrenzung ist. Die Treffermenge wird dabei automatisch verkleinert. Ist z.B. pageSize mit 20 und pageIndex mit 2 angegeben, so werden die Einträge 40-59 zurückgegeben. | |
| maxPageSize | Integer | 1..1 | Systembeschränkung für maximale Einträge pro Seite | |
| pageIndex | Integer | 1..1 | aktuelle Seite | |
| pageSize | Integer | 1..1 | Anzahl an Treffern pro Seite |
Anmerkungen
Besonderheiten
Filter
Filter dienen dazu die Suche einzuschränken.
Such-Parameter
- pageSize und pageIndex: pageSize und pageIndex begrenzen die Menge an zurückgelieferten Treffern, damit die Suchanfragen nicht so viele Resourcen verbrauchen. pageSize gibt dabei an, wieviele Treffer angezeigt werden sollen. pageIndex gibt an, welche Treffer angezeigt werden sollen. Stellt man pageSize auf 5 und pageIndex auf 0, würden die Treffer 1-5 angezeigt werden. Stellt man pageIndex auf 2, die Treffer 11-15.
- traverseConceptsToRoot: Bewirkt, dass zu jedem gefundenem Konzept die übergeordneten Konzepte bis zur Wurzel mit angegeben werden.
- caseSensitive: Groß-/Kleinschreibung wird beachtet.
- startsWith: Konzept beginnt mit dem angegebenen Term.
- wholeWords: Nur nach ganzen Wörtern suchen.
Hinweise
Die Ergebnismenge kann sehr groß werden (ICD-10 ca. 28.000). Daher sollten Suchen ohne Filter vermieden werden.
Beispiele
SOAP-Nachrichten
Einfache Suche ohne Filter
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ListCodeSystemConcepts> <parameter> <codeSystem> <codeSystemVersions> <versionId>1</versionId> </codeSystemVersions> <id>1</id> </codeSystem> </parameter> </sear:ListCodeSystemConcepts> </soapenv:Body> </soapenv:Envelope>
Suche nach Konzepten die einen bestimmten Term enthalten
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ListCodeSystemConcepts> <parameter> <codeSystem> <codeSystemVersions> <versionId>4</versionId> </codeSystemVersions> <id>1</id> </codeSystem> <codeSystemEntity> <codeSystemVersionEntityMemberships> <isAxis>false</isAxis> </codeSystemVersionEntityMemberships> <codeSystemEntityVersions> <codeSystemConcepts> <term>Zungen</term> </codeSystemConcepts> </codeSystemEntityVersions> </codeSystemEntity> </parameter> </sear:ListCodeSystemConcepts> </soapenv:Body> </soapenv:Envelope>
Suche mit Filter- und Such-Kriterien
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/" xmlns:de="de.fhdo.termserver.types"> <soapenv:Header/> <soapenv:Body> <sear:ListCodeSystemConcepts> <parameter> <codeSystem> <codeSystemVersions> <versionId>4</versionId> </codeSystemVersions> <id>1</id> </codeSystem> <codeSystemEntity> <codeSystemEntityVersions> <codeSystemConcepts> <term>Zunge</term> <isPreferred>true</isPreferred> </codeSystemConcepts> </codeSystemEntityVersions> </codeSystemEntity> <searchParameter> <pageSize>5</pageSize> <pageIndex>0</pageIndex> <traverseConceptsToRoot>true</traverseConceptsToRoot> </searchParameter> <sortingParameter> <sortBy>CODE</sortBy> <sortType>ALPHABETICALLY</sortType> </sortingParameter> </parameter> </sear:ListCodeSystemConcepts> </soapenv:Body> </soapenv:Envelope>
