WS-Beschreibung - Terminologieserver Search ListCodeSystemConcepts

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→Funktionalität)
(→SOAP-Nachrichten)
 
(20 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
<table border="0">
+
=Functionality=
−
  <tr>
+
Lists all concepts of the given code system version. Concepts can be filtered by certain properties (see request section).
−
    <td width="100px" style="font-weight: bold;">System</td>
+
−
    <td>Terminologieserver</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">Webservice</td>
+
−
    <td>Search</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">WSDL</td>
+
−
    <td>http://www.term.mi.fh-dortmund.de:8080/Terminologieserver/Search?wsdl</td>
+
−
  </tr>
+
−
  <tr>
+
−
    <td style="font-weight: bold;">Methode</td>
+
−
    <td>ListCodeSystemConcepts</td>
+
−
  </tr>
+
−
</table><br>
+
−
=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=
+
=Prerequisites=
  
 
=Request/Response=
 
=Request/Response=
 +
==Request==
 +
<table border="1" cellpadding="1" class="ws_table">
 +
  <tr class="ws_table_head">
 +
    <th>Parameter</th>
 +
    <th>Typ</th>
 +
    <th>L&auml;nge</th>
 +
    <th id="cardinality_cell">Kardinalit&auml;t</th>
 +
    <th>Beschreibung</th>
 +
  </tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">LoginType</td>
 +
  <td>LoginType</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Login information</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">sessionID</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Session-ID from user (given by system)</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">code_system</td>
 +
  <td>code_system</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Name of codesystem. Each codesystem requires at least one version.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_version</td>
 +
  <td>code_system_version</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Version of a Code System</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">code_system_entity</td>
 +
  <td>code_system_entity</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_entity_version</td>
 +
  <td>code_system_entity_version</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Point of time of the last change of the status.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level3">code_system_concept</td>
 +
  <td>code_system_concept</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Displays a concept or term. Specialization of code_system_entity_version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">code</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Code of a concept or term.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">isPreferred</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Specifies, if a term or concept is preferred or not.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">term</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>The term itself</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">termAbbrevation</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>The abbrevation of the term.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level4">code_system_concept_translation</td>
 +
  <td>code_system_concept_translation</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Translation of a term</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">languageId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes)
 +
All concepts of this query are translated into this language, if the translation exists.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">term</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Translated term</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">termAbbrevation</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Abbreviation of the translated term.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_version_entity_membership</td>
 +
  <td>code_system_version_entity_membership</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Connects the version of a Code System to the entities.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">isAxis</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>true, if the belonging entity of the entry is an axis of the code system</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">isMainClass</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>true, if the belonging entity of the entry is a root element of the code system.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">SearchType</td>
 +
  <td>SearchType</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Information about the search</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">caseSensitive</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>true if case sensitivity should be considered</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">startsWith</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>true if matching words should start with the search term</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">traverseConceptsToRoot</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>true if all associations should be returned to a concept. Because of a longer duration you should use page size to reduce your results.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">wholeWords</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>true if the search term must match exactily</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">PagingType</td>
 +
  <td>PagingType</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Specifies the result amount for searching results.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">allEntries</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>true, if all entries should be returned independent of the system limit. You have to be logged in to use this attribute.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">pageIndex</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Sets the page index (zero based).
 +
When you have a page size of 20 and page index 2, the results 40-59 will be returned.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">pageSize</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Sets the desired page size. If the value is bigger than the system value it will be reduced.
 +
When you have a page size of 20 and page index 2, the results 40-59 will be returned.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">SortingType</td>
 +
  <td>SortingType</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Determines the assortment. If not given, the concepts are sorted asscending according to the code.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">sortBy</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>possible values: CODE, TERM
 +
 +
default value: CODE</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">sortDirection</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>possible values: ASCENDING, DESCENDING
 +
 +
default value: ASCENDING</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">sortType</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>possible values: ALPHABETICALLY, ORDER_NR
 +
 +
default value: ALPHABETICALLY</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level1">lookForward</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Returns whether information about every concept relationships should be loaded. If the parametre is "true", "traverseConceptsToRoot" cannot be used.</td>
 +
</tr>
 +
</table>
 +
==Response==
 +
<table border="1" cellpadding="1" class="ws_table">
 +
  <tr class="ws_table_head">
 +
    <th>Parameter</th>
 +
    <th>Typ</th>
 +
    <th>L&auml;nge</th>
 +
    <th id="cardinality_cell">Kardinalit&auml;t</th>
 +
    <th>Beschreibung</th>
 +
  </tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">ReturnType</td>
 +
  <td>ReturnType</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Return information</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">count</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>number of results</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">message</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>an additional message</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">overallErrorCategory</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>INFO, WARN, ERROR</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">status</td>
 +
  <td></td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>OK, FAILURE</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">code_system_entity</td>
 +
  <td>code_system_entity</td>
 +
<td></td>  <td id="cardinality_cell">0..N</td>
 +
  <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Current ID of code_system_entity_version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_entity_version</td>
 +
  <td>code_system_entity_version</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">codeSystemEntityId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Foreign key to code system entities ID</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">effectiveDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point in time of the last change.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point in time, when entry was inserted.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">isLeaf</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only. </td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">majorRevision</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">minorRevision</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Status of the current entry. Can be taken from a domain.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point of time of the last change of the status.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Version-ID of Entity-Version</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level3">code_system_concept</td>
 +
  <td>code_system_concept</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Displays a concept or term. Specialization of code_system_entity_version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">code</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Code of a concept or term.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">codeSystemEntityVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">description</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Description of a term or concept</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">isPreferred</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Specifies, if a term or concept is preferred or not.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">term</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>The term itself</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">termAbbrevation</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>The abbrevation of the term.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level4">code_system_concept_translation</td>
 +
  <td>code_system_concept_translation</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Translation of a term
 +
Returns a translation, if the language was given and the translation exists.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">codeSystemEntityVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">description</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Description of the translated term.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">languageId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes)</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">term</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Translated term</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">termAbbrevation</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Abbreviation of the translated term.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level3">code_system_entity_version_association</td>
 +
  <td>code_system_entity_version_association</td>
 +
<td></td>  <td id="cardinality_cell">0..N</td>
 +
  <td>Associates two entity versions with each other.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">associationKind</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>1 = ontological,
 +
2 = taxonomic,
 +
3 = cross mapping,
 +
4 = link</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">associationTypeId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Specifies the Type of the association (e.g. 'belongs to')</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">codeSystemEntityVersionId1</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Points to the first entity of the association</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">codeSystemEntityVersionId2</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Points to the second entity of the association</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point of time, when the association was inserted.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">leftId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Specifies the reading direction of the association, if ID 1 or ID 2 is on the left side. E.g.  ID 1 = 12, Id 2 = 14:  12 belongs to 14, or  14 belongs to 12.
 +
If the direction should be ID2 -> ID1, forwardName and reverseName have to be reverted as well. </td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Status of the current entry. Can be taken from a domain. </td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level4">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point of time of the last change of the status.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level2">code_system_version_entity_membership</td>
 +
  <td>code_system_version_entity_membership</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Connects the version of a Code System to the entities.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">isAxis</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>true, if the belonging entity of the entry is an axis of the code system</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level3">isMainClass</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>true, if the belonging entity of the entry is a root element of the code system.</td>
 +
</tr>
 +
<tr id="row_object">
 +
  <td id="param_level1">PagingResultType</td>
 +
  <td>PagingResultType</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Will be returned automatically if result set is bigger than the limiting system value. Results will be cut to the limit size.</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">maxPageSize</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>system limit for maximum number of entries per page</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">pageIndex</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>current page (starts with 0)</td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level2">pageSize</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>number of results per page</td>
 +
</tr>
 +
</table>
  
−
=Anmerkungen=
+
=Annotations=
−
==Besonderheiten==
+
==Noteworthiness==
 
===Filter===
 
===Filter===
−
Filter dienen dazu die Suche einzuschränken. Welche Filter genutzt werden können ist der Request-Tabelle zu entnehmen.
+
Can be used to search for concepts with certain properties.
  
−
===Such-Parameter===
+
===Search 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.
+
*'''pageSize and pageIndex:''' ''pageSize'' and ''pageIndex'' limit the size of the result set to limit resource usage. ''pageSize'' specifies, how many hits shall be displayed. ''pageIndex'' specifies the range of hits shall be displayed. If ''pageSize'' is five and ''pageIndex'' is two, the hits 11-15 will be displayed.
  
−
*'''traverseConceptsToRoot:''' Bewirkt, dass zu jedem gefundenem Konzept die übergeordneten Konzepte bis zur Wurzel mit angegeben werden.
+
*'''traverseConceptsToRoot:''' Returns all superior concepts up to the root as well.
  
−
*'''caseSensitive:''' Groß-/Kleinschreibung wird beachtet.
+
*'''caseSensitive:''' Consider case sensitivity.
  
−
*'''startsWith:''' Konzept beginnt mit dem angegebenen Term.
+
*'''startsWith:''' Concepts starts with the given term.
  
−
*'''wholeWords:''' Nur nach ganzen Wörtern suchen.
+
*'''wholeWords:''' Search for whole words only.
  
 
==Hinweise==
 
==Hinweise==
 +
Result sets can be very hugh (ICD-10 ~ 28,000), therefore it is not recommended to use searches without filters.
  
−
=Beispiele=
+
=Examples=
 
==SOAP-Nachrichten==
 
==SOAP-Nachrichten==
−
===Einfache Suche ohne Filter===
+
===Simple Search without filter===
 
<source lang="xml">
 
<source lang="xml">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
Zeile 64: Zeile 596:
 
</source>
 
</source>
  
−
===Suche nach Konzepten die einen bestimmten Term enthalten===
+
=== Search for concepts that are main classes (Retreive all root elements) ===
 +
<source lang="xml">
 +
<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>30</versionId>
 +
          </codeSystemVersions>
 +
          <id>1</id>
 +
        </codeSystem>
 +
        <codeSystemEntity>
 +
          <codeSystemVersionEntityMemberships>
 +
            <isMainClass>true</isMainClass>
 +
          </codeSystemVersionEntityMemberships>
 +
        </codeSystemEntity>
 +
      </parameter>
 +
    </sear:ListCodeSystemConcepts>
 +
  </soapenv:Body>
 +
</soapenv:Envelope>
 +
</source>
 +
 
 +
===Search for concepts given a specific term===
 
<source lang="xml">
 
<source lang="xml">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
Zeile 93: Zeile 649:
 
</source>
 
</source>
  
−
===Suche mit Filter- und Such-Kriterien===
+
===Search with filters===
 
<source lang="xml">
 
<source lang="xml">
 
<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:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/" xmlns:de="de.fhdo.termserver.types">
Zeile 106: Zeile 662:
 
           <id>1</id>
 
           <id>1</id>
 
         </codeSystem>
 
         </codeSystem>
 +
 
         <codeSystemEntity>
 
         <codeSystemEntity>
 
           <codeSystemEntityVersions>
 
           <codeSystemEntityVersions>
Zeile 114: Zeile 671:
 
           </codeSystemEntityVersions>
 
           </codeSystemEntityVersions>
 
         </codeSystemEntity>
 
         </codeSystemEntity>
 +
 
         <searchParameter>
 
         <searchParameter>
 
           <pageSize>5</pageSize>
 
           <pageSize>5</pageSize>
Zeile 119: Zeile 677:
 
           <traverseConceptsToRoot>true</traverseConceptsToRoot>
 
           <traverseConceptsToRoot>true</traverseConceptsToRoot>
 
         </searchParameter>
 
         </searchParameter>
 +
 +
        <sortingParameter>
 +
          <sortBy>CODE</sortBy>
 +
          <sortType>ALPHABETICALLY</sortType>
 +
        </sortingParameter>
 
       </parameter>
 
       </parameter>
 
     </sear:ListCodeSystemConcepts>
 
     </sear:ListCodeSystemConcepts>
Zeile 125: Zeile 688:
 
</source>
 
</source>
  
−
==Code-Beispiele==
+
==Code example==
 
===Java===
 
===Java===
 
<source lang="java">
 
<source lang="java">
  
 
</source>
 
</source>

Aktuelle Version vom 4. April 2014, 06:39 Uhr

Inhaltsverzeichnis

Functionality

Lists all concepts of the given code system version. Concepts can be filtered by certain properties (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 1..1 Name of codesystem. Each codesystem requires at least one version.
code_system_version code_system_version 1..1 Version of a Code System
versionId Long 1..1
code_system_entity code_system_entity 0..1 Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version.
code_system_entity_version code_system_entity_version 0..1 code_system_entity_version is the superclass of every Concept and Association.
statusDate java.util.Date 0..1 Point of time of the last change of the status.
code_system_concept code_system_concept 0..1 Displays a concept or term. Specialization of code_system_entity_version.
code String 100 0..1 Code of a concept or term.
isPreferred Boolean 1..1 Specifies, if a term or concept is preferred or not.
term String 65535 0..1 The term itself
termAbbrevation String 50 0..1 The abbrevation of the term.
code_system_concept_translation code_system_concept_translation 0..1 Translation of a term
languageId Long 0..1 Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes) All concepts of this query are translated into this language, if the translation exists.
term String 65535 0..1 Translated term
termAbbrevation String 50 0..1 Abbreviation of the translated term.
code_system_version_entity_membership code_system_version_entity_membership 0..1 Connects the version of a Code System to the entities.
isAxis Boolean 0..1 true, if the belonging entity of the entry is an axis of the code system
isMainClass Boolean 0..1 true, if the belonging entity of the entry is a root element of the code system.
SearchType SearchType 0..1 Information about the search
caseSensitive Boolean 1..1 true if case sensitivity should be considered
startsWith Boolean 1..1 true if matching words should start with the search term
traverseConceptsToRoot Boolean 1..1 true if all associations should be returned to a concept. Because of a longer duration you should use page size to reduce your results.
wholeWords Boolean 1..1 true if the search term must match exactily
PagingType PagingType 0..1 Specifies the result amount for searching results.
allEntries Boolean 0..1 true, if all entries should be returned independent of the system limit. You have to be logged in to use this attribute.
pageIndex Integer 1..1 Sets the page index (zero based). When you have a page size of 20 and page index 2, the results 40-59 will be returned.
pageSize Integer 1..1 Sets the desired page size. If the value is bigger than the system value it will be reduced. When you have a page size of 20 and page index 2, the results 40-59 will be returned.
SortingType SortingType 0..1 Determines the assortment. If not given, the concepts are sorted asscending according to the code.
sortBy String 0..1 possible values: CODE, TERM default value: CODE
sortDirection String 0..1 possible values: ASCENDING, DESCENDING default value: ASCENDING
sortType String 0..1 possible values: ALPHABETICALLY, ORDER_NR default value: ALPHABETICALLY
lookForward Boolean 0..1 Returns whether information about every concept relationships should be loaded. If the parametre is "true", "traverseConceptsToRoot" cannot be used.

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_entity code_system_entity 0..N Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version.
currentVersionId Long 1..1 Current ID of code_system_entity_version.
id Long 1..1
code_system_entity_version code_system_entity_version 1..1 code_system_entity_version is the superclass of every Concept and Association.
codeSystemEntityId Long 1..1 Foreign key to code system entities ID
effectiveDate java.util.Date 1..1 Point in time of the last change.
insertTimestamp java.util.Date 1..1 Point in time, when entry was inserted.
isLeaf Boolean 1..1 Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only.
majorRevision Integer 1..1 Major revision of this entry (composition of major and minor version e.g. 1.3).
minorRevision Integer 1..1 Minor revision of this entry (composition of major and minor version e.g. 1.3)
status Integer 1..1 Status of the current entry. Can be taken from a domain.
statusDate java.util.Date 1..1 Point of time of the last change of the status.
versionId Long 1..1 Version-ID of Entity-Version
code_system_concept code_system_concept 1..1 Displays a concept or term. Specialization of code_system_entity_version.
code String 100 1..1 Code of a concept or term.
codeSystemEntityVersionId Long 1..1
description String 1..1 Description of a term or concept
isPreferred Boolean 1..1 Specifies, if a term or concept is preferred or not.
term String 65535 1..1 The term itself
termAbbrevation String 50 1..1 The abbrevation of the term.
code_system_concept_translation code_system_concept_translation 0..1 Translation of a term Returns a translation, if the language was given and the translation exists.
codeSystemEntityVersionId Long 1..1
description String 1..1 Description of the translated term.
id Long 1..1
languageId Long 1..1 Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes)
term String 65535 1..1 Translated term
termAbbrevation String 50 1..1 Abbreviation of the translated term.
code_system_entity_version_association code_system_entity_version_association 0..N Associates two entity versions with each other.
associationKind Integer 1..1 1 = ontological,

2 = taxonomic, 3 = cross mapping,

4 = link
associationTypeId Long 1..1 Specifies the Type of the association (e.g. 'belongs to')
codeSystemEntityVersionId1 Long 1..1 Points to the first entity of the association
codeSystemEntityVersionId2 Long 1..1 Points to the second entity of the association
id Long 1..1
insertTimestamp java.util.Date 1..1 Point of time, when the association was inserted.
leftId Long 1..1 Specifies the reading direction of the association, if ID 1 or ID 2 is on the left side. E.g. ID 1 = 12, Id 2 = 14: 12 belongs to 14, or 14 belongs to 12. If the direction should be ID2 -> ID1, forwardName and reverseName have to be reverted as well.
status Integer 1..1 Status of the current entry. Can be taken from a domain.
statusDate java.util.Date 1..1 Point of time of the last change of the status.
code_system_version_entity_membership code_system_version_entity_membership 1..1 Connects the version of a Code System to the entities.
isAxis Boolean 1..1 true, if the belonging entity of the entry is an axis of the code system
isMainClass Boolean 1..1 true, if the belonging entity of the entry is a root element of the code system.
PagingResultType PagingResultType 0..1 Will be returned automatically if result set is bigger than the limiting system value. Results will be cut to the limit size.
maxPageSize Integer 1..1 system limit for maximum number of entries per page
pageIndex Integer 1..1 current page (starts with 0)
pageSize Integer 1..1 number of results per page

Annotations

Noteworthiness

Filter

Can be used to search for concepts with certain properties.

Search parameter

Hinweise

Result sets can be very hugh (ICD-10 ~ 28,000), therefore it is not recommended to use searches without filters.

Examples

SOAP-Nachrichten

Simple Search without 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>

Search for concepts that are main classes (Retreive all root elements) 

<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>30</versionId>
          </codeSystemVersions>
          <id>1</id>
        </codeSystem>
        <codeSystemEntity>
          <codeSystemVersionEntityMemberships>
            <isMainClass>true</isMainClass>
          </codeSystemVersionEntityMemberships>
        </codeSystemEntity>
      </parameter>
    </sear:ListCodeSystemConcepts>
  </soapenv:Body>
</soapenv:Envelope>

Search for concepts given a specific term

<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>

Search with filters

<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 example

Java

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