Terminologieserver - Search - ListCodeSystems
Aus Termserver-CTS2
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Lists all code systems including versions that matches the given criteria.
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 | 0..1 | If a code system is listed, the information is used as a filter | |
| 2 | description | String | 65535 | 0..1 | Narrative description of Code System |
| 2 | insertTimestamp | java.util.Date | 0..1 | Timestamp, when the Code System was inserted | |
| 2 | name | String | 100 | 0..1 | Name of the Code System. The precise name should be specified in the Code System Version. |
| 2 | codeSystemVersion | code_system_version | 0..1 | Version of a Code System | |
| 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 | insertTimestamp | java.util.Date | 0..1 | Point of time when the Code System Version was inserted. | |
| 3 | licenceHolder | String | 65535 | 0..1 | Owner of the licence. |
| 3 | name | String | 100 | 0..1 | Complete Name of the Code System. |
| 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 | status | Integer | 0..1 | Status of the current entry. Can be taken from a domain. | |
| 3 | statusDate | java.util.Date | 0..1 | Point of time of the last change of the status | |
| 3 | underLicence | Boolean | 0..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) |
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 | 0..N | Name of codesystem. Each codesystem requires at least one version. | |
| 2 | codeSystemType | String | 30 | 1..1 | Type of Code System (Taxonomy, Ontology). Possible values are available in domain table with id 6 |
| 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 | 1..1 | 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 |
Beispiele
SOAP
List all codesystems
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ListCodeSystems> <parameter> </parameter> </sear:ListCodeSystems> </soapenv:Body> </soapenv:Envelope>
Search for code systems by name
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ListCodeSystems> <parameter> <codeSystem> <codeSystemVersions> <name>ICD</name> </codeSystemVersions> </codeSystem> </parameter> </sear:ListCodeSystems> </soapenv:Body> </soapenv:Envelope>
