WS-Beschreibung - Terminologieserver Administration ImportValueSet
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Import value sets from a file in CSV format.
Prerequisites
Requires Login.
Request/Response
Request
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| importInfos | ImportType | 1..1 | Parameter for import | |
| filecontent | byte[] | 1..1 | The file content as a blob. CSV files have to be encoded with ISO-8859-1. | |
| LoginType | LoginType | 1..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. | |
| description | String | 65535 | 0..1 | Description of the valueset. This field is only required if you create a new Value set. |
| id | Long | 0..1 | ID of the valueset. They must list either the ID of a Value set, or list a name, if you liked to create a new Value set. | |
| name | String | 50 | 0..1 | Name of the valueset. They must list either the ID of a Value set, or list a name, if you liked to create a new Value set. |
| value_set_version | value_set_version | 0..1 | Represents the version of an valueset. | |
| preferredLanguageId | Long | 0..1 | The preferred langue of the code system. (The ID has to be taken from the domain 'ISO_639_1_Language_Codes' - ID 1) | |
| releaseDate | java.util.Date | 0..1 | Start date for the validity of the valueset version. |
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 | ||
| value_set | value_set | 0..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| id | Long | 1..1 | ID of the valueset. | |
| value_set_version | value_set_version | 1..1 | Represents the version of an valueset. | |
| versionId | Long | 1..1 | Version ID of the value set |
Annotations
Noteworthiness
CSV-Import
The comma separated file has to be build in this pattern:
- Syntax
- Coding: ISO-8859-1
- Fields will be separated by a ";"
- Strings has to be encapsulated with " ", if there are any special or delimiter symbols
- First row contains informations about columns
- Fields
- legal values
- code (either code or term are required)
- concept_id (either code or conecpt_id required)
- codesystem_version_id (required if code angegeben is set)
- legal values
*Italic Entries are optional
If no concept id is given, the code denotation will be used to read concept id (lower performance)
Hints
Examples
Files
SOAP messages
Insert a new value set
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <adm:ImportValueSet> <parameter> <valueSet> <name>NEUER VALUESET NAME</name> </valueSet> <importInfos> <filecontent>BASE64-CONTENT</filecontent> <!-- can be imported directly in soap-Ui via context menu --> </importInfos> <login> <sessionID>b8857f39-fc81-47a1-bec7-1b7935814199</sessionID> <!-- insert Session-ID from login --> </login> </parameter> </adm:ImportValueSet> </soapenv:Body> </soapenv:Envelope>
Insert into a existing value set
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <adm:ImportValueSet> <parameter> <valueSet> <id>10</id> <valueSetVersions> <versionId>11</versionId> </valueSetVersions> </valueSet> <importInfos> <filecontent>BASE64-CONTENT</filecontent> <!-- can be imported directly in soap-Ui via context menu --> </importInfos> <login> <sessionID>b8857f39-fc81-47a1-bec7-1b7935814199</sessionID> <!-- insert Session-ID from login --> </login> </parameter> </adm:ImportValueSet> </soapenv:Body> </soapenv:Envelope>
