Aus Termserver-CTS2
Functionality
Lists all association types. There are general associations available for all code systems, but also associations available in specific code systems only. To get those specific ones, the proper code system has to specified.
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 |
| 0..1 |
If a code system is listed, the information is used as a filter |
| id |
Long |
| 1..1 |
Internal ID = Primary Key of Code System |
| code_system_version |
code_system_version |
| 0..1 |
Version of a Code System |
| versionId |
Long |
| 1..1 |
|
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..N |
code_system_entity_version is the superclass of every Concept and Association. |
| 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 |
| 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 |
| 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) |
Annotations
Noteworthiness
Hints
Examples
SOAP messages
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
<soapenv:Header/>
<soapenv:Body>
<sear:ListConceptAssociationTypes>
<parameter>
</parameter>
</sear:ListConceptAssociationTypes>
</soapenv:Body>
</soapenv:Envelope> Code examples
Java
