Aus Termserver-CTS2
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 |
|
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>
Code-Beispiele
Java