WS-Beschreibung - Terminologieserver Search ReturnConceptDetails
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(→Request/Response) |
Becker (Diskussion | Beiträge) (→Request/Response) |
||
| (2 dazwischenliegende Versionen von einem Benutzer werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
| − | + | =Functionality= | |
| − | + | Lists all details of the given concept. See response section for more details about the informations returned. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | = | + | =Prerequisites= |
=Request/Response= | =Request/Response= | ||
| Zeile 34: | Zeile 16: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">LoginType</td> | <td id="param_level1">LoginType</td> | ||
| − | <td></td> | + | <td>LoginType</td> |
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
| − | <td>Login | + | <td>Login information</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 57: | Zeile 25: | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <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</td> | <td id="param_level1">code_system_entity</td> | ||
| − | <td></td> | + | <td>code_system_entity</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <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"> | ||
<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></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>code_system_entity_version is the superclass of every Concept and Association. </td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 148: | Zeile 43: | ||
<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></td> | + | <td>Version-ID of Entity-Version</td> |
</tr> | </tr> | ||
</table> | </table> | ||
| Zeile 162: | Zeile 57: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">ReturnType</td> | <td id="param_level1">ReturnType</td> | ||
| − | <td></td> | + | <td>ReturnType</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Return information</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 177: | Zeile 66: | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>an additional message</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 193: | Zeile 82: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level1">code_system_entity</td> | <td id="param_level1">code_system_entity</td> | ||
| − | <td></td> | + | <td>code_system_entity</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <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 201: | Zeile 90: | ||
<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> | + | <td>Current ID of code_system_entity_version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 211: | Zeile 100: | ||
<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..N</td> | <td></td> <td id="cardinality_cell">1..N</td> | ||
| − | <td> | + | <td>code_system_entity_version is the superclass of every Concept and Association. </td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 225: | Zeile 108: | ||
<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> | + | <td>Point in time of the last change.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 231: | Zeile 114: | ||
<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> | + | <td>Point in time, when entry was inserted.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 237: | Zeile 120: | ||
<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> | + | <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 243: | Zeile 126: | ||
<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> | + | <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 249: | Zeile 132: | ||
<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> | + | <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 255: | Zeile 138: | ||
<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> | + | <td>Refers to the prior version, if there are more than one version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 261: | Zeile 144: | ||
<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> | + | <td>Status of the current entry. Can be taken from a domain.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 267: | Zeile 150: | ||
<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> | + | <td>Point of time of the last change of the status.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 273: | Zeile 156: | ||
<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></td> | + | <td>Version-ID of Entity-Version</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></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Displays a concept or term. Specialization of code_system_entity_version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 286: | Zeile 169: | ||
<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"> | + | <td id="param_level4">description</td> |
| − | <td> | + | <td>String</td> |
| − | + | ||
<td></td> | <td></td> | ||
| + | <td id="cardinality_cell">1..1</td> | ||
| + | <td>Description of a term or concept</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 298: | Zeile 182: | ||
<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></td> | + | <td>Specifies, if a term or concept is preferred or not.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 305: | Zeile 189: | ||
<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> | ||
| Zeile 312: | Zeile 196: | ||
<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> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level4">code_system_concept_translation</td> | <td id="param_level4">code_system_concept_translation</td> | ||
| − | <td></td> | + | <td>code_system_concept_translation</td> |
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
| − | <td> | + | <td>Translation of a term</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 325: | Zeile 209: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td></td> | <td></td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td id="param_level5">description</td> | ||
| + | <td>String</td> | ||
| + | <td></td> | ||
| + | <td id="cardinality_cell">1..1</td> | ||
| + | <td>Description of the translated term.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 336: | Zeile 227: | ||
<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></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 343: | Zeile 234: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Translated term</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 350: | Zeile 241: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td></td> | + | <td>Abbreviation of the translated term.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level3">code_system_metadata_value</td> | <td id="param_level3">code_system_metadata_value</td> | ||
| − | <td></td> | + | <td>code_system_metadata_value</td> |
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
| − | <td> | + | <td>Values of metadata</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 369: | Zeile 254: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td></td> | <td></td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 381: | Zeile 260: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Values of metadata.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level4">metadata_parameter</td> | <td id="param_level4">metadata_parameter</td> | ||
| − | <td></td> | + | <td>metadata_parameter</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Contains an accumulation of meta data. (List of the available descriptions)</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 394: | Zeile 273: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td></td> | <td></td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td id="param_level5">metadataParameterType</td> | ||
| + | <td>String</td> | ||
| + | <td>30</td> | ||
| + | <td id="cardinality_cell">1..1</td> | ||
| + | <td>Type of the meta data. A possible list of values is contained in the domain table.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 400: | Zeile 286: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Data type of the value in code_system_metadata_value.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 407: | Zeile 293: | ||
<td>65535</td> | <td>65535</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Description of meta data (e.g. measurement unit)</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level3">property</td> | <td id="param_level3">property</td> | ||
| − | <td></td> | + | <td>property</td> |
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
<td></td> | <td></td> | ||
| Zeile 427: | Zeile 313: | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
| − | <tr | + | <tr> |
<td id="param_level4">name</td> | <td id="param_level4">name</td> | ||
<td>String</td> | <td>String</td> | ||
<td>65535</td> | <td>65535</td> | ||
| − | <td id="cardinality_cell"> | + | <td id="cardinality_cell">1..1</td> |
<td></td> | <td></td> | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level4">property_version</td> | <td id="param_level4">property_version</td> | ||
| − | <td></td> | + | <td>property_version</td> |
<td></td> <td id="cardinality_cell">1..N</td> | <td></td> <td id="cardinality_cell">1..N</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
| Zeile 502: | Zeile 382: | ||
<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></td> | <td></td> | ||
</tr> | </tr> | ||
| Zeile 536: | Zeile 410: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">code_system_version_entity_membership</td> | <td id="param_level2">code_system_version_entity_membership</td> | ||
| − | <td></td> | + | <td>code_system_version_entity_membership</td> |
<td></td> <td id="cardinality_cell">1..N</td> | <td></td> <td id="cardinality_cell">1..N</td> | ||
| − | <td> | + | <td>Connects the version of a Code System to the entities.</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 556: | Zeile 424: | ||
<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, | + | <td>true, if the belonging entity of the entry is an axis of the code system</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 562: | Zeile 430: | ||
<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, | + | <td>true, if the belonging entity of the entry is a root element of the code system.</td> |
</tr> | </tr> | ||
</table> | </table> | ||
| − | = | + | =Annotations= |
| − | == | + | ==Noteworthiness== |
| − | + | ==Hints== | |
| − | == | + | The result set is small. |
| − | + | ||
| − | = | + | =Examples= |
| − | ==SOAP | + | ==SOAP messages== |
<source lang="xml"> | <source lang="xml"> | ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> | ||
| Zeile 592: | Zeile 459: | ||
</source> | </source> | ||
| − | ==Code | + | ==Code examples== |
===Java=== | ===Java=== | ||
<source lang="java"> | <source lang="java"> | ||
</source> | </source> | ||
Aktuelle Version vom 9. August 2013, 09:30 Uhr
Inhaltsverzeichnis |
Functionality
Lists all details of the given concept. See response section for more details about the informations returned.
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_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. | |
| versionId | Long | 1..1 | Version-ID of Entity-Version |
Response
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| ReturnType | ReturnType | 1..1 | Return information | |
| message | String | 1..1 | an additional message | |
| overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| status | 1..1 | OK, FAILURE | ||
| 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. | |
| 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 | |
| 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. |
| description | String | 1..1 | Description of a term or concept | |
| 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..N | Translation of a term | |
| codeSystemEntityVersionId | Long | 1..1 | ||
| description | String | 1..1 | Description of the translated term. | |
| 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_metadata_value | code_system_metadata_value | 0..N | Values of metadata | |
| id | Long | 1..1 | ||
| parameterValue | String | 65535 | 1..1 | Values of metadata. |
| metadata_parameter | metadata_parameter | 1..1 | Contains an accumulation of meta data. (List of the available descriptions) | |
| id | Long | 1..1 | ||
| metadataParameterType | String | 30 | 1..1 | Type of the meta data. A possible list of values is contained in the domain table. |
| paramDatatype | String | 65535 | 1..1 | Data type of the value in code_system_metadata_value. |
| paramName | String | 65535 | 1..1 | Description of meta data (e.g. measurement unit) |
| property | property | 0..N | ||
| currentVersionId | Long | 1..1 | ||
| id | Long | 1..1 | ||
| name | String | 65535 | 1..1 | |
| property_version | property_version | 1..N | ||
| content | byte[] | 1..1 | ||
| contentMimetype | String | 50 | 1..1 | |
| contentName | String | 255 | 1..1 | |
| contentSize | Integer | 1..1 | ||
| description | String | 65535 | 1..1 | |
| insertTimestamp | java.util.Date | 1..1 | ||
| languageId | Long | 1..1 | ||
| name | String | 65535 | 1..1 | |
| previousVersionId | Long | 1..1 | ||
| propertyKindId | Long | 1..1 | ||
| status | Integer | 1..1 | ||
| statusDate | java.util.Date | 1..1 | ||
| versionId | Long | 1..1 | ||
| code_system_version_entity_membership | code_system_version_entity_membership | 1..N | Connects the version of a Code System to the entities. | |
| codeSystemVersionId | Long | 1..1 | ||
| 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. |
Annotations
Noteworthiness
Hints
The result set is small.
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:ReturnConceptDetails> <parameter> <codeSystemEntity> <id>2114</id> <codeSystemEntityVersions> <versionId>2114</versionId> </codeSystemEntityVersions> </codeSystemEntity> </parameter> </sear:ReturnConceptDetails> </soapenv:Body> </soapenv:Envelope>
