WS-Beschreibung - Terminologieserver Search ListValueSetContents
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Becker (Diskussion | Beiträge) (→Funktionalität) |
(→Specifics) |
||
| (7 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
| − | + | =Functionality= | |
| − | + | Lists all concepts that are linked to the given value set version. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | = | + | =Preconditions= |
=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">value_set</td> | <td id="param_level1">value_set</td> | ||
| − | <td></td> | + | <td>value_set</td> |
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>A subset of terms.Every valueset has at least one valueset-version.</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="param_level2">value_set_version</td> | <td id="param_level2">value_set_version</td> | ||
| − | <td></td> | + | <td>value_set_version</td> |
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
| − | <td> | + | <td>Represents the version of an valueset.</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 138: | Zeile 43: | ||
<td>java.util.Date</td> | <td>java.util.Date</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
| − | <td> | + | <td>Start date for the validity of the valueset version.</td> |
</tr> | </tr> | ||
| − | <tr | + | <tr> |
| − | <td id="param_level3"> | + | <td id="param_level3">versionId</td> |
| − | <td> | + | <td>Long</td> |
| − | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">1..1</td> |
| − | <td> | + | <td>Version ID of the value set</td> |
</tr> | </tr> | ||
| − | <tr id=" | + | <tr id="row_object"> |
| − | <td id=" | + | <td id="param_level1">SortingType</td> |
| − | <td> | + | <td>SortingType</td> |
| − | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">0..1</td> |
| − | <td> | + | <td>Determines the assortment. If not given, the concepts are sorted asscending according to the code.</td> |
</tr> | </tr> | ||
| − | <tr | + | <tr> |
| − | <td id=" | + | <td id="param_level2">sortBy</td> |
| − | <td> | + | <td>String</td> |
| − | + | ||
<td></td> | <td></td> | ||
| + | <td id="cardinality_cell">0..1</td> | ||
| + | <td>possible values: CODE, TERM | ||
| + | |||
| + | default value: CODE</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td id=" | + | <td id="param_level2">sortDirection</td> |
| − | <td> | + | <td>String</td> |
| − | + | ||
<td></td> | <td></td> | ||
| + | <td id="cardinality_cell">0..1</td> | ||
| + | <td>possible values: ASCENDING, DESCENDING | ||
| + | |||
| + | default value: ASCENDING</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td id="param_level2">sortType</td> | ||
| + | <td>String</td> | ||
| + | <td></td> | ||
| + | <td id="cardinality_cell">0..1</td> | ||
| + | <td>possible values: ALPHABETICALLY, ORDER_NR | ||
| + | |||
| + | default value: ALPHABETICALLY</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
| Zeile 176: | Zeile 96: | ||
<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 184: | Zeile 104: | ||
<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>number of results</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 191: | Zeile 111: | ||
<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 207: | Zeile 127: | ||
<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">0..N</td> | <td></td> <td id="cardinality_cell">0..N</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 215: | Zeile 135: | ||
<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 225: | Zeile 145: | ||
<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 239: | Zeile 153: | ||
<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 245: | Zeile 159: | ||
<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 251: | Zeile 165: | ||
<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 257: | Zeile 171: | ||
<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 263: | Zeile 177: | ||
<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 269: | Zeile 183: | ||
<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 275: | Zeile 189: | ||
<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 281: | Zeile 195: | ||
<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 287: | Zeile 201: | ||
<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">association_type</td> | <td id="param_level3">association_type</td> | ||
| − | <td></td> | + | <td>association_type</td> |
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
| − | <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> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 306: | Zeile 214: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td>Name | + | <td>Name of association in normal reading direction (ID 1->2)</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 313: | Zeile 221: | ||
<td>50</td> | <td>50</td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td>Name | + | <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_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">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
| − | <td> | + | <td>Displays a concept or term. Specialization of code_system_entity_version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 326: | Zeile 234: | ||
<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 338: | Zeile 247: | ||
<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 345: | Zeile 254: | ||
<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 352: | Zeile 261: | ||
<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 366: | Zeile 275: | ||
<td></td> | <td></td> | ||
</tr> | </tr> | ||
| − | <tr id=" | + | <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> | ||
<td id="param_level5">id</td> | <td id="param_level5">id</td> | ||
<td>Long</td> | <td>Long</td> | ||
| − | <td></td> <td id="cardinality_cell"> | + | <td></td> <td id="cardinality_cell">1..1</td> |
<td></td> | <td></td> | ||
</tr> | </tr> | ||
| Zeile 376: | Zeile 292: | ||
<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 383: | Zeile 299: | ||
<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 390: | Zeile 306: | ||
<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">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 408: | Zeile 324: | ||
<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> | ||
<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 485: | Zeile 388: | ||
<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 519: | Zeile 416: | ||
<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..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Connects the version of a Code System to the entities.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 539: | Zeile 436: | ||
<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 545: | Zeile 442: | ||
<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= |
| − | == | + | ==Specifics== |
| + | Use the statusDate from "conceptValueSetMemberships" to obtain all inserted or changed values since the given date. Use it for synchronize with your own system. Please see the SOAP messages for an example. | ||
| − | == | + | ==Hints== |
| − | = | + | =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 572: | Zeile 470: | ||
</soapenv:Body> | </soapenv:Body> | ||
</soapenv:Envelope> | </soapenv:Envelope> | ||
| + | </source> | ||
| + | ===with search date=== | ||
| + | The given statusDate represents a start date. All inserted or changed concepts after this date will be returned. | ||
| + | <source lang="xml"> | ||
| + | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> | ||
| + | <soapenv:Header/> | ||
| + | <soapenv:Body> | ||
| + | <sear:ListValueSetContents> | ||
| + | <parameter> | ||
| + | <valueSet> | ||
| + | <valueSetVersions> | ||
| + | <versionId>4</versionId> | ||
| + | <conceptValueSetMemberships> | ||
| + | <statusDate>2013-01-01T00:00:00+01:00</statusDate> | ||
| + | </conceptValueSetMemberships> | ||
| + | </valueSetVersions> | ||
| + | </valueSet> | ||
| + | <readMetadataLevel>true</readMetadataLevel> | ||
| + | </parameter> | ||
| + | </sear:ListValueSetContents> | ||
| + | </soapenv:Body> | ||
| + | </soapenv:Envelope> | ||
</source> | </source> | ||
| − | ==Code | + | ==Code examples== |
===Java=== | ===Java=== | ||
<source lang="java"> | <source lang="java"> | ||
</source> | </source> | ||
Aktuelle Version vom 2. Dezember 2013, 08:09 Uhr
Inhaltsverzeichnis |
Functionality
Lists all concepts that are linked to the given value set version.
Preconditions
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) | |
| value_set | value_set | 1..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| value_set_version | value_set_version | 0..1 | Represents the version of an valueset. | |
| releaseDate | java.util.Date | 0..1 | Start date for the validity of the valueset version. | |
| versionId | Long | 1..1 | Version ID of the value set | |
| SortingType | SortingType | 0..1 | Determines the assortment. If not given, the concepts are sorted asscending according to the code. | |
| sortBy | String | 0..1 | possible values: CODE, TERM default value: CODE | |
| sortDirection | String | 0..1 | possible values: ASCENDING, DESCENDING default value: ASCENDING | |
| sortType | String | 0..1 | possible values: ALPHABETICALLY, ORDER_NR default value: ALPHABETICALLY |
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 | 0..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) |
| code_system_concept | code_system_concept | 0..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. |
| property | property | 0..N | ||
| currentVersionId | Long | 1..1 | ||
| id | Long | 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..1 | Connects the version of a Code System to the entities. | |
| codeSystemEntityId | Long | 1..1 | ||
| 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
Specifics
Use the statusDate from "conceptValueSetMemberships" to obtain all inserted or changed values since the given date. Use it for synchronize with your own system. Please see the SOAP messages for an example.
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:ListValueSetContents> <parameter> <valueSet> <id>1</id> <valueSetVersions> <versionId>1</versionId> </valueSetVersions> </valueSet> </parameter> </sear:ListValueSetContents> </soapenv:Body> </soapenv:Envelope>
with search date
The given statusDate represents a start date. All inserted or changed concepts after this date will be returned.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ListValueSetContents> <parameter> <valueSet> <valueSetVersions> <versionId>4</versionId> <conceptValueSetMemberships> <statusDate>2013-01-01T00:00:00+01:00</statusDate> </conceptValueSetMemberships> </valueSetVersions> </valueSet> <readMetadataLevel>true</readMetadataLevel> </parameter> </sear:ListValueSetContents> </soapenv:Body> </soapenv:Envelope>
