Terminologieserver - Search - ReturnCodeSystemDetails
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
||
| Zeile 28: | Zeile 28: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td>Name of codesystem. Each codesystem requires at least one version.</td> | <td>Name of codesystem. Each codesystem requires at least one version.</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 58: | Zeile 35: | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
<td>The ID does not required, if a Codesystem-Version-ID is listed.</td> | <td>The ID does not required, if a Codesystem-Version-ID is listed.</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
| Zeile 80: | Zeile 42: | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
<td>Version of a Code System</td> | <td>Version of a Code System</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 219: | Zeile 68: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td>Return information</td> | <td>Return information</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 255: | Zeile 97: | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
<td>Name of codesystem. Each codesystem requires at least one version.</td> | <td>Name of codesystem. Each codesystem requires at least one version.</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 307: | Zeile 141: | ||
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
<td>Version of a Code System</td> | <td>Version of a Code System</td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
Aktuelle Version vom 30. September 2014, 12:31 Uhr
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
List all details of the given code system or code system 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 | codeSystem | code_system | 1..1 | Name of codesystem. Each codesystem requires at least one version. | |
| 2 | id | Long | 0..1 | The ID does not required, if a Codesystem-Version-ID is listed. | |
| 2 | codeSystemVersion | code_system_version | 0..1 | Version of a Code System | |
| 3 | versionId | Long | 1..1 |
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 | codeSystem | code_system | 0..1 | Name of codesystem. Each codesystem requires at least one version. | |
| 2 | currentVersionId | Long | 1..1 | Version of the Code System | |
| 2 | description | String | 65535 | 1..1 | Narrative description of Code System |
| 2 | id | Long | 1..1 | Internal ID = Primary Key of Code System | |
| 2 | insertTimestamp | java.util.Date | 1..1 | Timestamp, when the Code System was inserted | |
| 2 | name | String | 100 | 1..1 | Name of the Code System. The precise name should be specified in the Code System Version. |
| 2 | codeSystemVersion | code_system_version | 0..N | Version of a Code System | |
| 3 | description | String | 65535 | 1..1 | Description of the Code System |
| 3 | expirationDate | java.util.Date | 1..1 | Point of time the Code System looses its validity. | |
| 3 | insertTimestamp | java.util.Date | 1..1 | Point of time when the Code System Version was inserted. | |
| 3 | licenceHolder | String | 65535 | 1..1 | Owner of the licence. |
| 3 | name | String | 100 | 1..1 | Complete Name of the Code System. |
| 3 | oid | String | 100 | 1..1 | Official OID |
| 3 | preferredLanguageCd | String | 30 | 1..1 | Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...) |
| 3 | previousVersionID | Long | 1..1 | Refers to the prior version, if there are more than one. | |
| 3 | releaseDate | java.util.Date | 1..1 | Point of time, when this version starts to be valid. | |
| 3 | source | String | 65535 | 1..1 | Source of the Code System Version |
| 3 | status | Integer | 1..1 | Status of the current entry. Can be taken from a domain. | |
| 3 | statusDate | java.util.Date | 1..1 | Point of time of the last change of the status | |
| 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 | 1..1 | Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional) |
| 3 | versionId | Long | 1..1 | ||
| 3 | licenceType | licence_type | 0..N | Sorts of licence types. | |
| 4 | codeSystemVersionId | Long | 1..1 | ||
| 4 | id | Long | 1..1 | ||
| 4 | typeTxt | String | 65535 | 1..1 | Name of the licence type. |
| 2 | metadataParameter | metadata_parameter | 0..N | Contains an accumulation of meta data. (List of the available descriptions) | |
| 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) |
Beispiele
SOAP
Codesystem details with codesystem version-id 30
<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> <codeSystemVersions> <versionId>30</versionId> </codeSystemVersions> </codeSystem> </parameter> </sear:ReturnCodeSystemDetails> </soapenv:Body> </soapenv:Envelope>
