Terminologieserver - Search - ReturnValueSetDetails
Aus Termserver-CTS2
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
List all details of the given value set or value set version.
Request/Response
Request
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | loginToken | String | 0..1 | Login-Token that ensures the user is logged in. | |
| 1 | valueSet | value_set | 1..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| 2 | id | Long | 0..1 | ID of the valueset. | |
| 2 | valueSetVersion | value_set_version | 0..1 | Represents the version of an valueset. | |
| 3 | versionId | Long | 1..1 | Version ID of the value set |
Response
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | returnInfos | ReturnType | 1..1 | Return information | |
| 2 | message | String | 1..1 | an additional message | |
| 2 | overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| 2 | status | 1..1 | OK, FAILURE | ||
| 1 | valueSet | value_set | 1..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| 2 | currentVersionId | Long | 1..1 | Points to the current version of the valueset. | |
| 2 | description | String | 65535 | 1..1 | Description of the valueset. |
| 2 | id | Long | 1..1 | ID of the valueset. | |
| 2 | name | String | 50 | 1..1 | Name of the valueset. |
| 2 | status | Integer | 1..1 | Status of the current entry. Can be found in a domain. | |
| 2 | statusDate | java.util.Date | 1..1 | Alteration time of the status. | |
| 2 | metadataParameter | metadata_parameter | 0..N | Contains an accumulation of meta data. (List of the available descriptions) | |
| 3 | codeSystemId | Long | 1..1 | If set, this entry belongs to a code system. | |
| 3 | id | Long | 1..1 | ||
| 3 | languageCd | String | 30 | 1..1 | |
| 3 | metadataParameterType | String | 30 | 1..1 | Type of the meta data. A possible list of values is contained in the domain table. |
| 3 | paramDatatype | String | 65535 | 1..1 | Data type of the value in code_system_metadata_value. |
| 3 | paramName | String | 65535 | 1..1 | Description of meta data (e.g. measurement unit) |
| 3 | valueSetId | Long | 1..1 | If set, this entry belongs to a value set. | |
| 2 | valueSetVersion | value_set_version | 1..N | Represents the version of an valueset. | |
| 3 | insertTimestamp | java.util.Date | 1..1 | Timestamp of the insertion of the valueset version. | |
| 3 | name | String | 1..1 | ||
| 3 | oid | String | 1..1 | ||
| 3 | preferredLanguageCd | String | 30 | 1..1 | Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...) |
| 3 | previousVersionId | Long | 1..1 | Points to the previous version. | |
| 3 | releaseDate | java.util.Date | 1..1 | Start date for the validity of the valueset version. | |
| 3 | status | Integer | 1..1 | The status of the current entry. Can be found in a domain. | |
| 3 | statusDate | java.util.Date | 1..1 | Alteration time of the status. | |
| 3 | validityRange | Long | 1..1 | Validity range (German: Gültigkeitsbereich) | |
| 3 | versionId | Long | 1..1 | Version ID of the value set |
Beispiele
SOAP
Get details for a valueset
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ReturnValueSetDetails> <parameter> <valueSet> <valueSetVersions> <versionId>3</versionId> </valueSetVersions> </valueSet> </parameter> </sear:ReturnValueSetDetails> </soapenv:Body> </soapenv:Envelope>
