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