WS-Beschreibung - Terminologieserver Search ListCodeSystemConcepts
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(→Request/Response) |
(→SOAP-Nachrichten) |
||
(10 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
− | + | =Functionality= | |
− | + | Lists all concepts of the given code system version. Concepts can be filtered by certain properties (see request section). | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | = | + | =Prerequisites= |
=Request/Response= | =Request/Response= | ||
Zeile 36: | Zeile 18: | ||
<td>LoginType</td> | <td>LoginType</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td>Login | + | <td>Login information</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 43: | Zeile 25: | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Session-ID from user (given by system)</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 49: | Zeile 31: | ||
<td>code_system</td> | <td>code_system</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td>Name | + | <td>Name of codesystem. Each codesystem requires at least one version.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 55: | Zeile 37: | ||
<td>code_system_version</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 | + | <td>Version of a Code System</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 67: | Zeile 49: | ||
<td>code_system_entity</td> | <td>code_system_entity</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 73: | Zeile 55: | ||
<td>code_system_entity_version</td> | <td>code_system_entity_version</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>code_system_entity_version is the superclass of every Concept and Association. </td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 79: | Zeile 61: | ||
<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> | + | <td>Point of time of the last change of the status.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 85: | Zeile 67: | ||
<td>code_system_concept</td> | <td>code_system_concept</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Displays a concept or term. Specialization of code_system_entity_version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 92: | Zeile 74: | ||
<td>100</td> | <td>100</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Code of a concept or term.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 98: | Zeile 80: | ||
<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> | + | <td>Specifies, if a term or concept is preferred or not.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 105: | Zeile 87: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>The term itself</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 112: | Zeile 94: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>The abbrevation of the term.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 118: | Zeile 100: | ||
<td>code_system_concept_translation</td> | <td>code_system_concept_translation</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Translation of a term</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 124: | Zeile 106: | ||
<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> | + | <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> | ||
<tr> | <tr> | ||
Zeile 132: | Zeile 114: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Translated term</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 139: | Zeile 121: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Abbreviation of the translated term.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 145: | Zeile 127: | ||
<td>code_system_version_entity_membership</td> | <td>code_system_version_entity_membership</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Connects the version of a Code System to the entities.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 151: | Zeile 133: | ||
<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, | + | <td>true, if the belonging entity of the entry is an axis of the code system</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 157: | Zeile 139: | ||
<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, | + | <td>true, if the belonging entity of the entry is a root element of the code system.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 163: | Zeile 145: | ||
<td>SearchType</td> | <td>SearchType</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Information about the search</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 169: | Zeile 151: | ||
<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 | + | <td>true if case sensitivity should be considered</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 175: | Zeile 157: | ||
<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 | + | <td>true if matching words should start with the search term</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 181: | Zeile 163: | ||
<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 | + | <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> | ||
<tr> | <tr> | ||
Zeile 187: | Zeile 169: | ||
<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 | + | <td>true if the search term must match exactily</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 193: | Zeile 175: | ||
<td>PagingType</td> | <td>PagingType</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Specifies the result amount for searching results.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 199: | Zeile 181: | ||
<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, | + | <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> | ||
<tr> | <tr> | ||
Zeile 205: | Zeile 187: | ||
<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> | + | <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> | ||
<tr> | <tr> | ||
Zeile 211: | Zeile 194: | ||
<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> | + | <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> | ||
<tr> | <tr> | ||
Zeile 217: | Zeile 234: | ||
<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> | + | <td>Returns whether information about every concept relationships should be loaded. If the parametre is "true", "traverseConceptsToRoot" cannot be used.</td> |
</tr> | </tr> | ||
</table> | </table> | ||
Zeile 233: | Zeile 250: | ||
<td>ReturnType</td> | <td>ReturnType</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Return information</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 239: | Zeile 256: | ||
<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> | + | <td>number of results</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 246: | Zeile 263: | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>an additional message</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 264: | Zeile 281: | ||
<td>code_system_entity</td> | <td>code_system_entity</td> | ||
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
− | <td> | + | <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 270: | Zeile 287: | ||
<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>Current ID of code_system_entity_version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 282: | Zeile 299: | ||
<td>code_system_entity_version</td> | <td>code_system_entity_version</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>code_system_entity_version is the superclass of every Concept and Association. </td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 288: | Zeile 305: | ||
<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>Foreign key to code system entities ID</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 294: | Zeile 311: | ||
<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> | + | <td>Point in time of the last change.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 300: | Zeile 317: | ||
<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> | + | <td>Point in time, when entry was inserted.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 306: | Zeile 323: | ||
<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> | + | <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> | ||
<tr> | <tr> | ||
Zeile 312: | Zeile 329: | ||
<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> | + | <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 318: | Zeile 335: | ||
<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> | + | <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 324: | Zeile 341: | ||
<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> | + | <td>Status of the current entry. Can be taken from a domain.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 330: | Zeile 347: | ||
<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> | + | <td>Point of time of the last change of the status.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 336: | Zeile 353: | ||
<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>Version-ID of Entity-Version</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 342: | Zeile 359: | ||
<td>code_system_concept</td> | <td>code_system_concept</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Displays a concept or term. Specialization of code_system_entity_version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 349: | Zeile 366: | ||
<td>100</td> | <td>100</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Code of a concept or term.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 356: | Zeile 373: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td></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> | ||
<tr> | <tr> | ||
Zeile 361: | Zeile 385: | ||
<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> | + | <td>Specifies, if a term or concept is preferred or not.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 368: | Zeile 392: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>The term itself</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 375: | Zeile 399: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>The abbrevation of the term.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 381: | Zeile 405: | ||
<td>code_system_concept_translation</td> | <td>code_system_concept_translation</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <td> | + | <td>Translation of a term |
− | + | Returns a translation, if the language was given and the translation exists.</td> | |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 389: | Zeile 413: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td></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> | ||
<tr> | <tr> | ||
Zeile 400: | Zeile 431: | ||
<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>Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes)</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 407: | Zeile 438: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Translated term</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 414: | Zeile 445: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Abbreviation of the translated term.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 420: | Zeile 451: | ||
<td>code_system_entity_version_association</td> | <td>code_system_entity_version_association</td> | ||
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
− | <td> | + | <td>Associates two entity versions with each other.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 426: | Zeile 457: | ||
<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>1 = | + | <td>1 = ontological, |
− | 2 = | + | 2 = taxonomic, |
3 = cross mapping, | 3 = cross mapping, | ||
4 = link</td> | 4 = link</td> | ||
Zeile 435: | Zeile 466: | ||
<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>Specifies the Type of the association (e.g. 'belongs to')</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 441: | Zeile 472: | ||
<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>Points to the first entity of the association</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 447: | Zeile 478: | ||
<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>Points to the second entity of the association</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 459: | Zeile 490: | ||
<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> | + | <td>Point of time, when the association was inserted.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 465: | Zeile 496: | ||
<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>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> | ||
<tr> | <tr> | ||
Zeile 471: | Zeile 503: | ||
<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> | + | <td>Status of the current entry. Can be taken from a domain. </td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 477: | Zeile 509: | ||
<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> | + | <td>Point of time of the last change of the status.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 483: | Zeile 515: | ||
<td>code_system_version_entity_membership</td> | <td>code_system_version_entity_membership</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Connects the version of a Code System to the entities.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 489: | Zeile 521: | ||
<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, | + | <td>true, if the belonging entity of the entry is an axis of the code system</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 495: | Zeile 527: | ||
<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, | + | <td>true, if the belonging entity of the entry is a root element of the code system.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 501: | Zeile 533: | ||
<td>PagingResultType</td> | <td>PagingResultType</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
− | <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> | ||
<tr> | <tr> | ||
Zeile 507: | Zeile 539: | ||
<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> | + | <td>system limit for maximum number of entries per page</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 513: | Zeile 545: | ||
<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> | + | <td>current page (starts with 0)</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 519: | Zeile 551: | ||
<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> | + | <td>number of results per page</td> |
</tr> | </tr> | ||
</table> | </table> | ||
− | = | + | =Annotations= |
− | == | + | ==Noteworthiness== |
===Filter=== | ===Filter=== | ||
− | + | Can be used to search for concepts with certain properties. | |
− | === | + | ===Search parameter=== |
− | *'''pageSize | + | *'''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:''' | + | *'''traverseConceptsToRoot:''' Returns all superior concepts up to the root as well. |
− | *'''caseSensitive:''' | + | *'''caseSensitive:''' Consider case sensitivity. |
− | *'''startsWith:''' | + | *'''startsWith:''' Concepts starts with the given term. |
− | *'''wholeWords:''' | + | *'''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. | |
− | = | + | =Examples= |
==SOAP-Nachrichten== | ==SOAP-Nachrichten== | ||
− | === | + | ===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 564: | Zeile 596: | ||
</source> | </source> | ||
− | === | + | === 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 593: | Zeile 649: | ||
</source> | </source> | ||
− | === | + | ===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 606: | Zeile 662: | ||
<id>1</id> | <id>1</id> | ||
</codeSystem> | </codeSystem> | ||
+ | |||
<codeSystemEntity> | <codeSystemEntity> | ||
<codeSystemEntityVersions> | <codeSystemEntityVersions> | ||
Zeile 614: | Zeile 671: | ||
</codeSystemEntityVersions> | </codeSystemEntityVersions> | ||
</codeSystemEntity> | </codeSystemEntity> | ||
+ | |||
<searchParameter> | <searchParameter> | ||
<pageSize>5</pageSize> | <pageSize>5</pageSize> | ||
Zeile 619: | 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 625: | Zeile 688: | ||
</source> | </source> | ||
− | ==Code | + | ==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
- 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: Returns all superior concepts up to the root as well.
- caseSensitive: Consider case sensitivity.
- startsWith: Concepts starts with the given term.
- wholeWords: Search for whole words only.
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>