|
|
Zeile 63: |
Zeile 63: |
| <td></td> | | <td></td> |
| </tr> | | </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>Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.</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>Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung.</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level3">statusDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">0..1</td>
| |
− | <td>Änderungszeitpunkt des 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>Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von 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>Der Code zu einem Begriff bzw. Konzepts</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level4">isPreferred</td>
| |
− | <td>Boolean</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Gibt an, ob es sich um einen Vorzugsbegriff handelt</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level4">term</td>
| |
− | <td>String</td>
| |
− | <td>65535</td>
| |
− | <td id="cardinality_cell">0..1</td>
| |
− | <td>Der Begriff selbst</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level4">termAbbrevation</td>
| |
− | <td>String</td>
| |
− | <td>50</td>
| |
− | <td id="cardinality_cell">0..1</td>
| |
− | <td>Abkürzung des Begriffs</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>Übersetzung eines Begriffs.</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level5">languageId</td>
| |
− | <td>Long</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)
| |
− | Alle Konzepte dieser Anfrage werden in diese Sprache übersetzt, falls die Übersetzung vorhanden ist.</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level5">term</td>
| |
− | <td>String</td>
| |
− | <td>65535</td>
| |
− | <td id="cardinality_cell">0..1</td>
| |
− | <td>Übersetzter Begriff</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level5">termAbbrevation</td>
| |
− | <td>String</td>
| |
− | <td>50</td>
| |
− | <td id="cardinality_cell">0..1</td>
| |
− | <td>Abkürzung des übersetzten Begriffs</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>Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her.</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level3">isAxis</td>
| |
− | <td>Boolean</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>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level3">isMainClass</td>
| |
− | <td>Boolean</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>
| |
− | </tr>
| |
− | <tr id="row_object">
| |
− | <td id="param_level1">SearchType</td>
| |
− | <td>SearchType</td>
| |
− | <td></td> <td id="cardinality_cell">0..1</td>
| |
− | <td>Spezifiziert die Ergebnismenge von Suchergebnissen.</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level2">caseSensitive</td>
| |
− | <td>Boolean</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>true, wenn zwischen Groß- und Kleinschreibung unterschieden werden soll</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level2">startsWith</td>
| |
− | <td>Boolean</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>true, wenn das Ergebniswort mit dem Suchbegriff beginnen soll</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level2">traverseConceptsToRoot</td>
| |
− | <td>Boolean</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>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level2">wholeWords</td>
| |
− | <td>Boolean</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>true, wenn der Suchbegriff einem Ergebebniswort komplett übereinstimmen soll</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>Spezifiziert die Ergebnismenge von Suchergebnissen.</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level2">allEntries</td>
| |
− | <td>Boolean</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>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level2">pageIndex</td>
| |
− | <td>Integer</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>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level2">pageSize</td>
| |
− | <td>Integer</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>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level1">lookForward</td>
| |
− | <td>Boolean</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>
| |
− | </tr>
| |
− | </table>
| |
− | ==Response==
| |
− | <table border="1" cellpadding="1" class="ws_table">
| |
− | <tr class="ws_table_head">
| |
− | <th>Parameter</th>
| |
− | <th>Typ</th>
| |
− | <th>Länge</th>
| |
− | <th id="cardinality_cell">Kardinalitä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>Enthält Informationen über die Antwort.</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level2">count</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Anzahl der Ergebnisse</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level2">message</td>
| |
− | <td>String</td>
| |
− | <td></td>
| |
− | <td id="cardinality_cell">1..1</td>
| |
− | <td>Status- oder Fehlermeldung</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>Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level2">currentVersionId</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Die aktuelle ID der 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>Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung.</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level3">codeSystemEntityId</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Fremdschlüssel auf die ID des Entities</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level3">effectiveDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Zeitpunkt der letzten Änderung</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level3">insertTimestamp</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Zeitstempel, wann der Eintrag eingefügt worden ist</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level3">isLeaf</td>
| |
− | <td>Boolean</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>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level3">majorRevision</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level3">minorRevision</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level3">status</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level3">statusDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Änderungszeitpunkt des Status</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level3">versionId</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Versions-ID der 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>Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von 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>Der Code zu einem Begriff bzw. Konzepts</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">isPreferred</td>
| |
− | <td>Boolean</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Gibt an, ob es sich um einen Vorzugsbegriff handelt</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level4">term</td>
| |
− | <td>String</td>
| |
− | <td>65535</td>
| |
− | <td id="cardinality_cell">1..1</td>
| |
− | <td>Der Begriff selbst</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level4">termAbbrevation</td>
| |
− | <td>String</td>
| |
− | <td>50</td>
| |
− | <td id="cardinality_cell">1..1</td>
| |
− | <td>Abkürzung des Begriffs</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>Übersetzung eines Begriffs.
| |
− | Gibt eine Übersetzung zurück, falls die Sprache angegeben wurde und die Übersetzung existiert.</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">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>Sprache der Übersetzung. Der Wert kommt von Domain-Value mit der 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>Übersetzter Begriff</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level5">termAbbrevation</td>
| |
− | <td>String</td>
| |
− | <td>50</td>
| |
− | <td id="cardinality_cell">1..1</td>
| |
− | <td>Abkürzung des übersetzten Begriffs</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>Setzt 2 Entity-Versionen miteinander in Beziehung.</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level4">associationKind</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>1 = ontologisch,
| |
− | 2 = taxonomisch,
| |
− | 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>Gibt den Typ der Beziehung an (z.B. 'gehört zu')</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level4">codeSystemEntityVersionId1</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Eine Entity der Beziehung</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level4">codeSystemEntityVersionId2</td>
| |
− | <td>Long</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Eine Entity der Beziehung</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>Zeitpunkt, wann die Beziehung eingefügt worden ist.</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level4">leftId</td>
| |
− | <td>Long</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>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level4">status</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level4">statusDate</td>
| |
− | <td>java.util.Date</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Änderungszeitpunkt des 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>Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her.</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level3">isAxis</td>
| |
− | <td>Boolean</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>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level3">isMainClass</td>
| |
− | <td>Boolean</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>
| |
− | </tr>
| |
− | <tr id="row_object">
| |
− | <td id="param_level1">PagingResultType</td>
| |
− | <td>PagingResultType</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>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level2">maxPageSize</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Systembeschränkung für maximale Einträge pro Seite</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level2">pageIndex</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>aktuelle Seite</td>
| |
− | </tr>
| |
− | <tr>
| |
− | <td id="param_level2">pageSize</td>
| |
− | <td>Integer</td>
| |
− | <td></td> <td id="cardinality_cell">1..1</td>
| |
− | <td>Anzahl an Treffern pro Seite</td>
| |
− | </tr>
| |
− | </table>
| |
| | | |
| =Anmerkungen= | | =Anmerkungen= |
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.