Terminologieserver - Administration - ImportCodeSystem
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
||
| Zeile 1: | Zeile 1: | ||
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br> | [[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br> | ||
| + | =Beschreibung= | ||
| + | Import a codesystem from a blob. Look at the domain with id 4 to get available import formats.<br> | ||
=Request/Response= | =Request/Response= | ||
==Request== | ==Request== | ||
| Zeile 12: | Zeile 14: | ||
<th>Beschreibung</th> | <th>Beschreibung</th> | ||
</tr> | </tr> | ||
| − | <tr | + | <tr> |
<td id="cardinality_cell">1</td> | <td id="cardinality_cell">1</td> | ||
| − | <td id="param_level1"> | + | <td id="param_level1">loginToken</td> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
<td>String</td> | <td>String</td> | ||
<td></td> | <td></td> | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Login-Token that ensures the user is logged in.</td> |
</tr> | </tr> | ||
<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">importInfos</td> |
<td>ImportType</td> | <td>ImportType</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| Zeile 47: | Zeile 42: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td>The content of the file. | <td>The content of the file. | ||
| − | ClaML: | + | ClaML: 1 |
| − | CSV: | + | CSV: 2 |
| − | LOINC: | + | LOINC: 3 |
| − | LOINC relations: | + | LOINC relations: 4 |
| − | KBV keytab: | + | KBV keytab: 5 |
| + | ELGA ICD: 6 | ||
| + | ELGA Leitlinien: 7 | ||
| + | ELGA SVS: 8 | ||
| + | ELGA KAL: 9</td> | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
| Zeile 121: | Zeile 120: | ||
<td id="cardinality_cell">0..1</td> | <td id="cardinality_cell">0..1</td> | ||
<td>Official OID</td> | <td>Official OID</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td id="cardinality_cell">3</td> | ||
| + | <td id="param_level3">preferredLanguageCd</td> | ||
| + | <td>String</td> | ||
| + | <td>30</td> | ||
| + | <td id="cardinality_cell">0..1</td> | ||
| + | <td>Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 143: | Zeile 150: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td>true, if Code System is under license (Code System will be invisible for all users without proper license)</td> | <td>true, if Code System is under license (Code System will be invisible for all users without proper license)</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td id="cardinality_cell">3</td> | ||
| + | <td id="param_level3">validityRange</td> | ||
| + | <td>String</td> | ||
| + | <td>30</td> | ||
| + | <td id="cardinality_cell">0..1</td> | ||
| + | <td>Validity range, Values from domain list "codesystem_validityrange". | ||
| + | Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)</td> | ||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
| Zeile 173: | Zeile 189: | ||
<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> | ||
Version vom 22. Juli 2014, 12:53 Uhr
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Import a codesystem from a blob. Look at the domain with id 4 to get available import formats.
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 contents. CSV files must be encoded with ISO-8859-1. | |
| 2 | formatId | Long | 1..1 | The content of the file.
ClaML: 1 CSV: 2 LOINC: 3 LOINC relations: 4 KBV keytab: 5 ELGA ICD: 6 ELGA Leitlinien: 7 ELGA SVS: 8 ELGA KAL: 9 |
|
| 1 | codeSystem | code_system | 1..1 | Name of codesystem. Each codesystem requires at least one version. | |
| 2 | description | String | 65535 | 0..1 | Description of the code system to be created |
| 2 | name | String | 100 | 1..1 | Name of the code system to be created |
| 2 | codeSystemVersion | code_system_version | - | Version of the code system to be created | |
| 3 | description | String | 65535 | 0..1 | Description of the Code System |
| 3 | expirationDate | java.util.Date | 0..1 | Point of time the Code System looses its validity. | |
| 3 | licenceHolder | String | 65535 | 0..1 | Owner of the licence. |
| 3 | name | String | 100 | 1..1 | Name of the code system version to be created |
| 3 | oid | String | 100 | 0..1 | Official OID |
| 3 | preferredLanguageCd | String | 30 | 0..1 | Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...) |
| 3 | releaseDate | java.util.Date | 0..1 | Point of time, when this version starts to be valid. | |
| 3 | source | String | 65535 | 0..1 | Source of the Code System Version |
| 3 | underLicence | Boolean | 1..1 | true, if Code System is under license (Code System will be invisible for all users without proper license) | |
| 3 | validityRange | String | 30 | 0..1 | Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional) |
| 2 | licenceType | licence_type | 0..N | Sorts of licence types. | |
| 3 | typeTxt | String | 65535 | 1..1 | type of licence |
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 | codeSystem | code_system | 1..1 | Name of codesystem. Each codesystem requires at least one version. | |
| 2 | currentVersionId | Long | 1..1 | The new ID of the added code system version | |
| 2 | id | Long | 1..1 | The new ID of the added code system | |
| 2 | codeSystemVersion | code_system_version | 1..1 | The version of the added code system | |
| 3 | versionId | Long | 1..1 | The new ID of the added code system version |
