WS-Beschreibung - Terminologieserver Concept Association ListConceptAssociations
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(→Request) |
Becker (Diskussion | Beiträge) (→Request/Response) |
||
(8 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
− | + | =Functionality= | |
− | + | Lists all associations of the given concept. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | = | + | =Prerequisites= |
=Request/Response= | =Request/Response= | ||
Zeile 32: | Zeile 14: | ||
<th>Beschreibung</th> | <th>Beschreibung</th> | ||
</tr> | </tr> | ||
− | + | <tr> | |
− | <tr | + | <td id="param_level1">reverse</td> |
− | <td id="param_level1"> | + | <td>Boolean</td> |
− | <td></td> | + | <td></td> <td id="cardinality_cell">0..1</td> |
− | + | ||
− | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
− | <tr | + | <tr> |
− | <td id=" | + | <td id="param_level1">directionBoth</td> |
− | <td> | + | <td>Boolean</td> |
− | + | <td></td> <td id="cardinality_cell">0..1</td> | |
− | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
− | <tr | + | <tr> |
− | <td id=" | + | <td id="param_level1">lookForward</td> |
− | <td> | + | <td>Boolean</td> |
− | + | <td></td> <td id="cardinality_cell">0..1</td> | |
− | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
− | |||
− | |||
<tr id="row_object"> | <tr id="row_object"> | ||
− | <td id=" | + | <td id="param_level1">LoginType</td> |
− | <td></td> | + | <td>LoginType</td> |
− | + | <td></td> <td id="cardinality_cell">0..1</td> | |
− | + | <td>Login information</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level2">sessionID</td> |
− | <td> | + | <td>String</td> |
− | + | ||
− | + | ||
<td></td> | <td></td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Session-ID from user (given by system)</td> | ||
</tr> | </tr> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">code_system_entity_version_association</td> | <td id="param_level1">code_system_entity_version_association</td> | ||
− | <td></td> | + | <td>code_system_entity_version_association</td> |
− | + | <td></td> <td id="cardinality_cell">0..1</td> | |
− | + | <td>Associates two entity versions with each other.</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">associationKind</td> | <td id="param_level2">associationKind</td> | ||
− | <td> | + | <td>Integer</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>1 = ontological, | |
− | <td></td> | + | 2 = taxonomic, |
+ | 3 = cross mapping, | ||
+ | 4 = link</td> | ||
</tr> | </tr> | ||
− | <tr id=" | + | <tr id="row_object"> |
− | <td id=" | + | <td id="param_level1">code_system_entity</td> |
− | <td> | + | <td>code_system_entity</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
− | <tr id=" | + | <tr id="row_object"> |
− | <td id="param_level2"> | + | <td id="param_level2">code_system_entity_version</td> |
− | <td> | + | <td>code_system_entity_version</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>code_system_entity_version is the superclass of every Concept and Association. </td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
− | <tr | + | <tr> |
− | <td id=" | + | <td id="param_level3">codeSystemEntityId</td> |
− | <td> | + | <td>Long</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Foreign key to code system entities ID</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level3">effectiveDate</td> |
− | <td> | + | <td>java.util.Date</td> |
− | + | <td></td> <td id="cardinality_cell">0..1</td> | |
− | + | <td>Point in time of the last change.</td> | |
− | <td></td> | + | |
</tr> | </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"> | <tr id="row_object"> | ||
− | <td id="param_level1"> | + | <td id="param_level1">ReturnType</td> |
− | <td></td> | + | <td>ReturnType</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Return information</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
− | <tr | + | <tr> |
− | <td id="param_level2"> | + | <td id="param_level2">count</td> |
− | <td> | + | <td>Integer</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>number of results</td> | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td id="param_level2"> | + | <td id="param_level2">message</td> |
− | <td> | + | <td>String</td> |
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td></td> | + | <td>an additional message</td> |
</tr> | </tr> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level2">overallErrorCategory</td> |
− | + | ||
− | + | ||
− | + | ||
<td></td> | <td></td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>INFO, WARN, ERROR</td> | ||
</tr> | </tr> | ||
− | |||
− | |||
<tr> | <tr> | ||
− | <td id=" | + | <td id="param_level2">status</td> |
− | + | ||
− | + | ||
− | + | ||
<td></td> | <td></td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>OK, FAILURE</td> | ||
</tr> | </tr> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">code_system_entity_version_association</td> | <td id="param_level1">code_system_entity_version_association</td> | ||
− | <td></td> | + | <td>code_system_entity_version_association</td> |
− | + | <td></td> <td id="cardinality_cell">0..N</td> | |
− | + | <td>Associates two entity versions with each other.</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">associationKind</td> | <td id="param_level2">associationKind</td> | ||
− | <td> | + | <td>Integer</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>1 = ontological, | |
− | <td></td> | + | 2 = taxonomic, |
+ | 3 = cross mapping, | ||
+ | 4 = link</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">associationTypeId</td> | <td id="param_level2">associationTypeId</td> | ||
− | <td> | + | <td>Long</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Specifies the Type of the association (e.g. 'belongs to')</td> | |
− | <td> | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">codeSystemEntityVersionId2</td> | <td id="param_level2">codeSystemEntityVersionId2</td> | ||
− | <td> | + | <td>Long</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Points to the second entity of the association</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">id</td> | <td id="param_level2">id</td> | ||
− | <td> | + | <td>Long</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">insertTimestamp</td> | <td id="param_level2">insertTimestamp</td> | ||
− | <td> | + | <td>java.util.Date</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Point of time, when the association was inserted.</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">leftId</td> | <td id="param_level2">leftId</td> | ||
− | <td> | + | <td>Long</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Specifies the reading direction of the association, if ID 1 or ID 2 is on the left side. E.g. ID 1 = 12, Id 2 = 14: 12 belongs to 14, or 14 belongs to 12. | |
− | <td></td> | + | If the direction should be ID2 -> ID1, forwardName and reverseName have to be reverted as well. </td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">status</td> | <td id="param_level2">status</td> | ||
− | <td> | + | <td>Integer</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Status of the current entry. Can be taken from a domain. </td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level2">statusDate</td> | <td id="param_level2">statusDate</td> | ||
− | <td> | + | <td>java.util.Date</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Point of time of the last change of the status.</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
− | |||
− | |||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">association_type</td> | <td id="param_level2">association_type</td> | ||
− | <td></td> | + | <td>association_type</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">codeSystemEntityVersionId</td> | <td id="param_level3">codeSystemEntityVersionId</td> | ||
− | <td> | + | <td>Long</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Equates the versionId of code_system_entity_version</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">forwardName</td> | <td id="param_level3">forwardName</td> | ||
− | <td> | + | <td>String</td> |
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td></td> | + | <td>Name of association in normal reading direction (ID 1->2)</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">reverseName</td> | <td id="param_level3">reverseName</td> | ||
− | <td> | + | <td>String</td> |
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td></td> | + | <td>Name of association in reversed reading direction (ID 2->1)</td> |
</tr> | </tr> | ||
− | |||
− | |||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">code_system_entity_version</td> | <td id="param_level2">code_system_entity_version</td> | ||
− | <td></td> | + | <td>code_system_entity_version</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>code_system_entity_version is the superclass of every Concept and Association. </td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">codeSystemEntityId</td> | <td id="param_level3">codeSystemEntityId</td> | ||
− | <td> | + | <td>Long</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Foreign key to code system entities ID</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">effectiveDate</td> | <td id="param_level3">effectiveDate</td> | ||
− | <td> | + | <td>java.util.Date</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Point in time of the last change.</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">insertTimestamp</td> | <td id="param_level3">insertTimestamp</td> | ||
− | <td> | + | <td>java.util.Date</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Point in time, when entry was inserted.</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">isLeaf</td> | <td id="param_level3">isLeaf</td> | ||
− | <td> | + | <td>Boolean</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only. </td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">majorRevision</td> | <td id="param_level3">majorRevision</td> | ||
− | <td> | + | <td>Integer</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">minorRevision</td> | <td id="param_level3">minorRevision</td> | ||
− | <td> | + | <td>Integer</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">previousVersionId</td> | <td id="param_level3">previousVersionId</td> | ||
− | <td> | + | <td>Long</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Refers to the prior version, if there are more than one version.</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">status</td> | <td id="param_level3">status</td> | ||
− | <td> | + | <td>Integer</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Status of the current entry. Can be taken from a domain.</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">statusDate</td> | <td id="param_level3">statusDate</td> | ||
− | <td> | + | <td>java.util.Date</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Point of time of the last change of the status.</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level3">versionId</td> | <td id="param_level3">versionId</td> | ||
− | <td> | + | <td>Long</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Version-ID of Entity-Version</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
− | |||
− | |||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level3">code_system_concept</td> | <td id="param_level3">code_system_concept</td> | ||
− | <td></td> | + | <td>code_system_concept</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Displays a concept or term. Specialization of code_system_entity_version.</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level4">code</td> | <td id="param_level4">code</td> | ||
− | <td> | + | <td>String</td> |
<td>100</td> | <td>100</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td></td> | + | <td>Code of a concept or term.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level4">codeSystemEntityVersionId</td> | <td id="param_level4">codeSystemEntityVersionId</td> | ||
− | <td> | + | <td>Long</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level4">isPreferred</td> | <td id="param_level4">isPreferred</td> | ||
− | <td> | + | <td>Boolean</td> |
− | + | <td></td> <td id="cardinality_cell">1..1</td> | |
− | + | <td>Specifies, if a term or concept is preferred or not.</td> | |
− | <td></td> | + | |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level4">term</td> | <td id="param_level4">term</td> | ||
− | <td> | + | <td>String</td> |
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td></td> | + | <td>The term itself</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="param_level4">termAbbrevation</td> | <td id="param_level4">termAbbrevation</td> | ||
− | <td> | + | <td>String</td> |
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
− | <td></td> | + | <td>The abbrevation of the term.</td> |
</tr> | </tr> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</table> | </table> | ||
− | = | + | =Annotations= |
− | == | + | ==Noteworthiness== |
− | == | + | ==Hints== |
− | + | A typical result set is rather small. | |
− | = | + | =Examples= |
− | ==SOAP | + | ==SOAP messages== |
+ | ===Search for all associations of a given term=== | ||
<source lang="xml"> | <source lang="xml"> | ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/"> | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/"> | ||
Zeile 563: | Zeile 335: | ||
</codeSystemEntityVersions> | </codeSystemEntityVersions> | ||
</codeSystemEntity> | </codeSystemEntity> | ||
+ | </parameter> | ||
+ | </con:ListConceptAssociations> | ||
+ | </soapenv:Body> | ||
+ | </soapenv:Envelope> | ||
+ | </source> | ||
+ | ===Example search fo Cross-Mappings=== | ||
+ | <source lang="xml"> | ||
+ | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/"> | ||
+ | <soapenv:Header/> | ||
+ | <soapenv:Body> | ||
+ | <con:ListConceptAssociations> | ||
+ | <parameter> | ||
+ | <codeSystemEntity> | ||
+ | <codeSystemEntityVersions> | ||
+ | <status/> | ||
+ | <versionId>29769</versionId> | ||
+ | </codeSystemEntityVersions> | ||
+ | </codeSystemEntity> | ||
+ | <codeSystemEntityVersionAssociation> | ||
+ | <associationKind>3</associationKind> | ||
+ | </codeSystemEntityVersionAssociation> | ||
+ | <directionBoth>true</directionBoth> | ||
</parameter> | </parameter> | ||
</con:ListConceptAssociations> | </con:ListConceptAssociations> | ||
Zeile 569: | Zeile 363: | ||
</source> | </source> | ||
− | ==Code | + | ==Code example== |
===Java=== | ===Java=== | ||
<source lang="java"> | <source lang="java"> | ||
</source> | </source> |
Aktuelle Version vom 9. August 2013, 09:22 Uhr
Inhaltsverzeichnis |
Functionality
Lists all associations of the given concept.
Prerequisites
Request/Response
Request
Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|
reverse | Boolean | 0..1 | ||
directionBoth | Boolean | 0..1 | ||
lookForward | Boolean | 0..1 | ||
LoginType | LoginType | 0..1 | Login information | |
sessionID | String | 1..1 | Session-ID from user (given by system) | |
code_system_entity_version_association | code_system_entity_version_association | 0..1 | Associates two entity versions with each other. | |
associationKind | Integer | 1..1 | 1 = ontological,
2 = taxonomic, 3 = cross mapping, 4 = link |
|
code_system_entity | code_system_entity | 1..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 | 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 | 0..1 | Point in time of the last change. |
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_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') | |
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. | |
association_type | association_type | 1..1 | Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version | |
codeSystemEntityVersionId | Long | 1..1 | Equates the versionId of code_system_entity_version | |
forwardName | String | 50 | 1..1 | Name of association in normal reading direction (ID 1->2) |
reverseName | String | 50 | 1..1 | Name of association in reversed reading direction (ID 2->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) | |
previousVersionId | Long | 1..1 | Refers to the prior version, if there are more than one version. | |
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. |
Annotations
Noteworthiness
Hints
A typical result set is rather small.
Examples
SOAP messages
Search for all associations of a given term
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <con:ListConceptAssociations> <parameter> <codeSystemEntity> <codeSystemEntityVersions> <status/><versionId>17</versionId> </codeSystemEntityVersions> </codeSystemEntity> </parameter> </con:ListConceptAssociations> </soapenv:Body> </soapenv:Envelope>
Example search fo Cross-Mappings
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://conceptAssociation.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <con:ListConceptAssociations> <parameter> <codeSystemEntity> <codeSystemEntityVersions> <status/> <versionId>29769</versionId> </codeSystemEntityVersions> </codeSystemEntity> <codeSystemEntityVersionAssociation> <associationKind>3</associationKind> </codeSystemEntityVersionAssociation> <directionBoth>true</directionBoth> </parameter> </con:ListConceptAssociations> </soapenv:Body> </soapenv:Envelope>