Terminologieserver - Administration - ImportValueSet
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
(→Beschreibung) |
||
| (4 dazwischenliegende Versionen von einem Benutzer werden nicht angezeigt) | |||
| Zeile 6: | Zeile 6: | ||
You must specify an existing value set. If a valueset version-id is given, this is used. Specify a version name to create a new valueset version. | You must specify an existing value set. If a valueset version-id is given, this is used. Specify a version name to create a new valueset version. | ||
<br><br> | <br><br> | ||
| − | Valueset-CSV | + | Valueset-CSV fields: |
| − | + | *code (code from given codesystem-version by oid or version-id) | |
| − | + | *codesystem_oid (either oid or version-id must be given) | |
| − | + | *codesystem_version_id (either oid or version-id must be given) | |
| − | + | *<i>value_override</i> | |
| − | + | *<i>hints</i> | |
| − | + | *<i>description</i> | |
| − | + | *<i>meaning</i> | |
<i>italic fields are optional</i> | <i>italic fields are optional</i> | ||
| − | |||
<br> | <br> | ||
| + | |||
=Request/Response= | =Request/Response= | ||
==Request== | ==Request== | ||
| Zeile 29: | Zeile 29: | ||
<th>Beschreibung</th> | <th>Beschreibung</th> | ||
</tr> | </tr> | ||
| + | <tr> | ||
| + | <td id="cardinality_cell">1</td> | ||
| + | <td id="param_level1">loginToken</td> | ||
| + | <td>String</td> | ||
| + | <td></td> | ||
| + | <td id="cardinality_cell">1..1</td> | ||
| + | <td>Login-Token that ensures the user is logged in.</td> | ||
| + | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="cardinality_cell">1</td> | <td id="cardinality_cell">1</td> | ||
| Zeile 42: | Zeile 50: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td>The file content as a blob. CSV files have to be encoded with ISO-8859-1.</td> | <td>The file content as a blob. CSV files have to be encoded with ISO-8859-1.</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td id="cardinality_cell">2</td> | <td id="cardinality_cell">2</td> | ||
| − | <td id="param_level2"> | + | <td id="param_level2">formatId</td> |
| − | <td> | + | <td>Long</td> |
| − | + | <td></td> <td id="cardinality_cell">1..1</td> | |
| − | + | <td>The content of the file. | |
| − | <td> | + | CSV: 1 |
| + | SVS: 2</td> | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
| Zeile 110: | Zeile 112: | ||
<td id="param_level3">preferredLanguageCd</td> | <td id="param_level3">preferredLanguageCd</td> | ||
<td>String</td> | <td>String</td> | ||
| − | <td> | + | <td>30</td> |
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
| − | <td> | + | <td>Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 135: | Zeile 137: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="cardinality_cell">1</td> | <td id="cardinality_cell">1</td> | ||
| − | <td id="param_level1"> | + | <td id="param_level1">returnInfos</td> |
<td>ReturnType</td> | <td>ReturnType</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
Aktuelle Version vom 7. März 2016, 12:32 Uhr
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Imports a value set from existing concepts from code systems.
You must specify an existing value set. If a valueset version-id is given, this is used. Specify a version name to create a new valueset version.
Valueset-CSV fields:
- code (code from given codesystem-version by oid or version-id)
- codesystem_oid (either oid or version-id must be given)
- codesystem_version_id (either oid or version-id must be given)
- value_override
- hints
- description
- meaning
italic fields are optional
Request/Response
Request
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | loginToken | String | 1..1 | Login-Token that ensures the user is logged in. | |
| 1 | importInfos | ImportType | 1..1 | Parameter for import | |
| 2 | filecontent | byte[] | 1..1 | The file content as a blob. CSV files have to be encoded with ISO-8859-1. | |
| 2 | formatId | Long | 1..1 | The content of the file.
CSV: 1 SVS: 2 |
|
| 1 | valueSet | value_set | 1..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| 2 | description | String | 65535 | 0..1 | Description of the valueset. This field is only required if you create a new Value set. |
| 2 | 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. | |
| 2 | 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. |
| 2 | valueSetVersion | value_set_version | 1..1 | Represents the version of an valueset. | |
| 3 | name | String | 0..1 | ||
| 3 | preferredLanguageCd | String | 30 | 0..1 | Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...) |
| 3 | releaseDate | java.util.Date | 0..1 | Start date for the validity of the valueset version. |
Response
| Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|---|
| 1 | returnInfos | ReturnType | 1..1 | Return information | |
| 2 | count | Integer | 1..1 | number of results | |
| 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 | 0..1 | A subset of terms.Every valueset has at least one valueset-version. | |
| 2 | id | Long | 1..1 | ID of the valueset. | |
| 2 | valueSetVersion | value_set_version | 1..1 | Represents the version of an valueset. | |
| 3 | versionId | Long | 1..1 | Version ID of the value set |
