WS-Beschreibung - Terminologieserver Search ReturnCodeSystemDetails
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Lists all details of the given code system or code system version. See request/response section for properties that will be 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 | code_system | 1..1 | Name of codesystem. Each codesystem requires at least one version. | |
| id | Long | 0..1 | The ID does not required, if a Codesystem-Version-ID is listed. | |
| code_system_version | code_system_version | 0..1 | Version of a Code System | |
| versionId | Long | 1..1 |
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 | code_system | 0..1 | Name of codesystem. Each codesystem requires at least one version. | |
| currentVersionId | Long | 1..1 | Version of the Code System | |
| description | String | 65535 | 1..1 | Narrative description of Code System |
| id | Long | 1..1 | Internal ID = Primary Key of Code System | |
| insertTimestamp | java.util.Date | 1..1 | Timestamp, wenn the Code System was inserted | |
| name | String | 100 | 1..1 | Name of the Code System. The precise name should be specified in the Code System Version. |
| code_system_version | code_system_version | 0..N | Version of a Code System | |
| description | String | 65535 | 1..1 | Description of the Code System |
| expirationDate | java.util.Date | 1..1 | Point of time the Code System looses its validity. | |
| insertTimestamp | java.util.Date | 1..1 | Point of time when the Code System Version was inserted. | |
| licenceHolder | String | 65535 | 1..1 | Owner of the licence. |
| name | String | 100 | 1..1 | Complete Name of the Code System. |
| oid | String | 100 | 1..1 | Official OID |
| preferredLanguageId | Long | 1..1 | Preferred language of the Code System ( ID has to be taken from domain 'ISO_639_1_Language_Codes' with ID 1) | |
| previousVersionID | Long | 1..1 | Refers to the prior version, if there are more than one. | |
| releaseDate | java.util.Date | 1..1 | Point of time, when this version starts to be valid. | |
| source | String | 65535 | 1..1 | Source of the Code System 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 | |
| underLicence | Boolean | 1..1 | true, if Code System is under license (Code System will be invisible for all users without proper license) | |
| validityRange | String | 30 | 1..1 | Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional) |
| versionId | Long | 1..1 | ||
| licence_type | licence_type | 0..N | Sorts of licence types. | |
| codeSystemVersionId | Long | 1..1 | ||
| id | Long | 1..1 | ||
| typeTxt | String | 65535 | 1..1 | Name of the licence type. |
| metadata_parameter | metadata_parameter | 0..N | 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) |
Annotations
Noteworthiness
Hints
The result set is typically 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:ReturnCodeSystemDetails> <parameter> <codeSystem> <id>1</id> <codeSystemVersions> <versionId>4</versionId> </codeSystemVersions> </codeSystem> </parameter> </sear:ReturnCodeSystemDetails> </soapenv:Body> </soapenv:Envelope>
