WS-Beschreibung - Terminologieserver Search ListValueSetContents
Aus Termserver-CTS2
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>
