Terminologieserver - Search - ListConceptAssociationTypes
Aus Termserver-CTS2
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Lists all association types. There are general associations available for all code systems, but also associations available in specific code systems only.
Request/Response
Request
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | loginToken | String | 0..1 | Login-Token that ensures the user is logged in. | |
| 1 | codeSystem | code_system | 0..1 | If a code system is listed, the information is used as a filter | |
| 2 | codeSystemVersion | code_system_version | 0..1 | Version of a Code System | |
| 3 | versionId | Long | 1..1 |
Response
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | returnInfos | ReturnType | 1..1 | Return information | |
| 2 | count | Integer | 1..1 | number of results | |
| 2 | message | String | 1..1 | an additional message | |
| 2 | overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| 2 | status | 1..1 | OK, FAILURE | ||
| 1 | codeSystemEntity | code_system_entity | 0..N | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
| 2 | currentVersionId | Long | 1..1 | Current ID of code_system_entity_version. | |
| 2 | id | Long | 1..1 | ||
| 2 | codeSystemEntityVersion | code_system_entity_version | 1..N | code_system_entity_version is the superclass of every Concept and Association. | |
| 3 | effectiveDate | java.util.Date | 1..1 | Last change date of the entity version. | |
| 3 | insertTimestamp | java.util.Date | 1..1 | Point in time when entry was inserted. | |
| 3 | isLeaf | Boolean | 1..1 | Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only. | |
| 3 | majorRevision | Integer | 1..1 | Major revision of this entry (composition of major and minor version e.g. 1.3). | |
| 3 | minorRevision | Integer | 1..1 | Minor revision of this entry (composition of major and minor version e.g. 1.3) | |
| 3 | previousVersionId | Long | 1..1 | Refers to the prior version, if there are more than one version. | |
| 3 | statusDeactivated | Integer | 1..1 | Defines the state. Default value is 0 (=visible). Look for available values in the according domain. | |
| 3 | statusDeactivatedDate | java.util.Date | 1..1 | Date when statusDeactivated changed | |
| 3 | statusVisibility | Integer | 1..1 | Status of the current entry. Can be taken from a domain. | |
| 3 | statusVisibilityDate | java.util.Date | 1..1 | Point of time of the last change of the status. | |
| 3 | statusWorkflow | Integer | 1..1 | A workflow status, can be unique for each codesystem. | |
| 3 | statusWorkflowDate | java.util.Date | 1..1 | Date when statusWorkflow changed | |
| 3 | versionId | Long | 1..1 | The ID of this entry. | |
| 3 | associationType | association_type | 1..1 | Name of an association. Specialization of code_system_entity_version. The codeSystemEntityVersionId is the same as the versionId of code_system_entity_version | |
| 4 | codeSystemEntityVersionId | Long | 1..1 | Match to the versionId of code_system_entity_version | |
| 4 | forwardName | String | 50 | 1..1 | Name of association in normal reading direction (ID 1->2) |
| 4 | reverseName | String | 50 | 1..1 | Name of association in reversed reading direction (ID 2->1) |
Beispiele
SOAP
List all association types
<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>
