WS-Beschreibung - Terminologieserver Search ListCodeSystemConcepts

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(→ListCodeSystemConcepts)
Zeile 19: Zeile 19:
 
   <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-Informationen</td>
+
   <td>Login information</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 26: Zeile 26:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Die Session-ID des Benutzers</td>
+
   <td>Session-ID from user (given by system)</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 32: Zeile 32:
 
   <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 eines Codesystems/Vokabulars. Jedes Codesystem muss mindestens 1 Version besitzen.</td>
+
   <td>Name of codesystem. Each codesystem requires at least one version.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 38: Zeile 38:
 
   <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 eines Codesystems</td>
+
   <td>Version of a Code System</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 50: Zeile 50:
 
   <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>Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.</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 56: Zeile 56:
 
   <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>Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung.</td>
+
   <td>code_system_entity_version is the superclass of every Concept and Association. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 62: Zeile 62:
 
   <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>Änderungszeitpunkt des Status</td>
+
   <td>Point of time of the last change of the status.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 68: Zeile 68:
 
   <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>Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von code_system_entity_version.</td>
+
   <td>Displays a concept or term. Specialization of code_system_entity_version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 75: Zeile 75:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Der Code zu einem Begriff bzw. Konzepts</td>
+
   <td>Code of a concept or term.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 81: Zeile 81:
 
   <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>Gibt an, ob es sich um einen Vorzugsbegriff handelt</td>
+
   <td>Specifies, if a term or concept is preferred or not.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 88: Zeile 88:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Der Begriff selbst</td>
+
   <td>The term itself</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 95: Zeile 95:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Abkürzung des Begriffs</td>
+
   <td>The abbrevation of the term.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 101: Zeile 101:
 
   <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>Übersetzung eines Begriffs.</td>
+
   <td>Translation of a term</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 107: Zeile 107:
 
   <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>Sprache der Übersetzung. Der Wert kommt von Domain-Value mit der Domain-ID 1 (ISO_639_1_Language_Codes)
+
   <td>Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes)
−
Alle Konzepte dieser Anfrage werden in diese Sprache übersetzt, falls die Übersetzung vorhanden ist.</td>
+
All concepts of this query are translated into this language, if the translation exists.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 115: Zeile 115:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Übersetzter Begriff</td>
+
   <td>Translated term</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 122: Zeile 122:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Abkürzung des übersetzten Begriffs</td>
+
   <td>Abbreviation of the translated term.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 128: Zeile 128:
 
   <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>Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her.</td>
+
   <td>Connects the version of a Code System to the entities.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 134: Zeile 134:
 
   <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, wenn die zugehörige Entity des Eintrags eine Achse des Codesystems ist</td>
+
   <td>true, if the belonging entity of the entry is an axis of the code system</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 140: Zeile 140:
 
   <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, wenn die zugehörige Entity des Eintrags eine Hauptklasse (root-Element) des Codesystems ist</td>
+
   <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 146: Zeile 146:
 
   <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>Spezifiziert die Ergebnismenge von Suchergebnissen.</td>
+
   <td>Information about the search</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 152: Zeile 152:
 
   <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, wenn zwischen Groß- und Kleinschreibung unterschieden werden soll</td>
+
   <td>true if case sensitivity should be considered</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 158: Zeile 158:
 
   <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, wenn das Ergebniswort mit dem Suchbegriff beginnen soll</td>
+
   <td>true if matching words should start with the search term</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 164: Zeile 164:
 
   <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, 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</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>
 
<tr>
 
<tr>
Zeile 170: Zeile 170:
 
   <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, wenn der Suchbegriff einem Ergebebniswort komplett übereinstimmen soll</td>
+
   <td>true if the search term must match exactily</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 176: Zeile 176:
 
   <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>Spezifiziert die Ergebnismenge von Suchergebnissen.</td>
+
   <td>Specifies the result amount for searching results.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 182: Zeile 182:
 
   <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, 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.</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>
 
<tr>
 
<tr>
Zeile 188: Zeile 188:
 
   <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>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.</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 194: Zeile 195:
 
   <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>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.</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>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 200: Zeile 202:
 
   <td>SortingType</td>
 
   <td>SortingType</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Legt Sortierung fest. Falls nicht angegeben, werden die Konzepte aufsteigend nach dem Code sortiert.</td>
+
   <td>Determines the assortment. If not given, the concepts are sorted asscending according to the code.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 207: Zeile 209:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Mögliche Werte: CODE, TERM
+
   <td>possible values: CODE, TERM
  
−
Standardwert: CODE</td>
+
default value: CODE</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 216: Zeile 218:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Mögliche Werte: ASCENDING, DESCENDING
+
   <td>possible values: ASCENDING, DESCENDING
  
−
Standardwert: ASCENDING</td>
+
default value: ASCENDING</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 225: Zeile 227:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>Mögliche Werte: ALPHABETICALLY, ORDER_NR
+
   <td>possible values: ALPHABETICALLY, ORDER_NR
  
−
Standardwert: ALPHABETICALLY</td>
+
default value: ALPHABETICALLY</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 233: Zeile 235:
 
   <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>Gibt an, ob Informationen über Beziehungen zu jedem Begriff geladen werden sollen. Falls der Parameter "true" ist, kann "traverseConceptsToRoot" nicht verwendet werden.</td>
+
   <td>Gives whether information about every concept relationships should be loaded. If the parametre "true" is, cannot be used "traverseConceptsToRoot".</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Zeile 249: Zeile 251:
 
   <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>Enthält Informationen über die Antwort.</td>
+
   <td>Return information</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 255: Zeile 257:
 
   <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>Anzahl der Ergebnisse</td>
+
   <td>number of results</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 262: Zeile 264:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Status- oder Fehlermeldung</td>
+
   <td>an additional message</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 280: Zeile 282:
 
   <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>Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.</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 286: Zeile 288:
 
   <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>Die aktuelle ID der code_system_entity_version</td>
+
   <td>Current ID of code_system_entity_version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 298: Zeile 300:
 
   <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>Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung.</td>
+
   <td>code_system_entity_version is the superclass of every Concept and Association. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 304: Zeile 306:
 
   <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>Fremdschlüssel auf die ID des Entities</td>
+
   <td>Foreign key to code system entities ID</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 310: Zeile 312:
 
   <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>Zeitpunkt der letzten Änderung</td>
+
   <td>Point in time of the last change.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 316: Zeile 318:
 
   <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>Zeitstempel, wann der Eintrag eingefügt worden ist</td>
+
   <td>Point in time, when entry was inserted.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 322: Zeile 324:
 
   <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>Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden.</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 328: Zeile 330:
 
   <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>Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
+
   <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 334: Zeile 336:
 
   <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>Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
+
   <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 340: Zeile 342:
 
   <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>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
   <td>Status of the current entry. Can be taken from a domain.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 346: Zeile 348:
 
   <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>Änderungszeitpunkt des Status</td>
+
   <td>Point of time of the last change of the status.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 352: Zeile 354:
 
   <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>Versions-ID der Entity-Version</td>
+
   <td>Version-ID of Entity-Version</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 358: Zeile 360:
 
   <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>Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von code_system_entity_version.</td>
+
   <td>Displays a concept or term. Specialization of code_system_entity_version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 365: Zeile 367:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Der Code zu einem Begriff bzw. Konzepts</td>
+
   <td>Code of a concept or term.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 377: Zeile 379:
 
   <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>Gibt an, ob es sich um einen Vorzugsbegriff handelt</td>
+
   <td>Specifies, if a term or concept is preferred or not.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 384: Zeile 386:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Der Begriff selbst</td>
+
   <td>The term itself</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 391: Zeile 393:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Abkürzung des Begriffs</td>
+
   <td>The abbrevation of the term.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 397: Zeile 399:
 
   <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>Übersetzung eines Begriffs.
+
   <td>Translation of a term
−
Gibt eine Übersetzung zurück, falls die Sprache angegeben wurde und die Übersetzung existiert.</td>
+
Returns a translation, if the language was given and the translation exists.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 416: Zeile 418:
 
   <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>Sprache der Übersetzung. Der Wert kommt von Domain-Value mit der Domain-ID 1 (ISO_639_1_Language_Codes)</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 423: Zeile 425:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Übersetzter Begriff</td>
+
   <td>Translated term</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 430: Zeile 432:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>Abkürzung des übersetzten Begriffs</td>
+
   <td>Abbreviation of the translated term.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 436: Zeile 438:
 
   <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>Setzt 2 Entity-Versionen miteinander in Beziehung.</td>
+
   <td>Associates two entity versions with each other.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 442: Zeile 444:
 
   <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 = ontologisch,
+
   <td>1 = ontological,
−
2 = taxonomisch,
+
2 = taxonomic,
 
3 = cross mapping,
 
3 = cross mapping,
 
4 = link</td>
 
4 = link</td>
Zeile 451: Zeile 453:
 
   <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>Gibt den Typ der Beziehung an (z.B. 'gehört zu')</td>
+
   <td>Specifies the Type of the association (e.g. 'belongs to')</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 457: Zeile 459:
 
   <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>Eine Entity der Beziehung</td>
+
   <td>Points to the first entity of the association</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 463: Zeile 465:
 
   <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>Eine Entity der Beziehung</td>
+
   <td>Points to the second entity of the association</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 475: Zeile 477:
 
   <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>Zeitpunkt, wann die Beziehung eingefügt worden ist.</td>
+
   <td>Point of time, when the association was inserted.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 481: Zeile 483:
 
   <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>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.</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 487: Zeile 490:
 
   <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>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
   <td>Status of the current entry. Can be taken from a domain. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 493: Zeile 496:
 
   <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>Änderungszeitpunkt des Status</td>
+
   <td>Point of time of the last change of the status.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 499: Zeile 502:
 
   <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>Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her.</td>
+
   <td>Connects the version of a Code System to the entities.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 505: Zeile 508:
 
   <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, wenn die zugehörige Entity des Eintrags eine Achse des Codesystems ist</td>
+
   <td>true, if the belonging entity of the entry is an axis of the code system</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 511: Zeile 514:
 
   <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, wenn die zugehörige Entity des Eintrags eine Hauptklasse (root-Element) des Codesystems ist</td>
+
   <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 517: Zeile 520:
 
   <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>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.</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 523: Zeile 526:
 
   <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>Systembeschränkung für maximale Einträge pro Seite</td>
+
   <td>system limit for maximum number of entries per page</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 529: Zeile 532:
 
   <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>aktuelle Seite</td>
+
   <td>current page (starts with 0)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 535: Zeile 538:
 
   <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>Anzahl an Treffern pro Seite</td>
+
   <td>number of results per page</td>
 
</tr>
 
</tr>
 
</table>
 
</table>

Version vom 6. August 2013, 07:29 Uhr

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

ListCodeSystemConcepts

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 Gives whether information about every concept relationships should be loaded. If the parametre "true" is, cannot be used "traverseConceptsToRoot".

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

Anmerkungen

Besonderheiten

Filter

Filter dienen dazu die Suche einzuschränken.

Such-Parameter

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

 
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