Terminologieserver - Search - ListCodeSystemsInTaxonomy
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
||
Zeile 16: | Zeile 16: | ||
<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">0..1</td> | ||
+ | <td>Login-Token that ensures the user is logged in.</td> | ||
+ | </tr> | ||
</table> | </table> | ||
<br> | <br> | ||
Zeile 28: | Zeile 36: | ||
<th>Beschreibung</th> | <th>Beschreibung</th> | ||
</tr> | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="cardinality_cell">1</td> | ||
+ | <td id="param_level1">domainValue</td> | ||
+ | <td>domain_value</td> | ||
+ | <td></td> <td id="cardinality_cell">0..N</td> | ||
+ | <td>Value from a domain.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">attribut1Classname</td> | ||
+ | <td>String</td> | ||
+ | <td>50</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Additonal information</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">attribut1Value</td> | ||
+ | <td>String</td> | ||
+ | <td>50</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Additonal information</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">domainCode</td> | ||
+ | <td>String</td> | ||
+ | <td>50</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Code of the value. It is used as foreign key.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">domainDisplay</td> | ||
+ | <td>String</td> | ||
+ | <td>100</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Displayed name of the value.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">domainId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">domainValueId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">imageFile</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Filename of an image saved on the file system.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">orderNo</td> | ||
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Manual order of the values. The 'displayOrder' of the domain in the table 'domain' with 186 (to Order-Number) has to be used.</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">codeSystem</td> | ||
+ | <td>code_system</td> | ||
+ | <td></td> <td id="cardinality_cell">0..N</td> | ||
+ | <td>Name of codesystem. Each codesystem requires at least one version.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">codeSystemType</td> | ||
+ | <td>String</td> | ||
+ | <td>30</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Type of Code System (Taxonomy, Ontology). A possible value set is available in domain table</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">currentVersionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Version of the Code System</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">description</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Narrative description of Code System</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">id</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Internal ID = Primary Key of Code System</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">insertTimestamp</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Timestamp, wenn the Code System was inserted</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">name</td> | ||
+ | <td>String</td> | ||
+ | <td>100</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Name of the Code System. The precise name should be specified in the Code System Version.</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">codeSystemVersion</td> | ||
+ | <td>code_system_version</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Version of a Code System</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">description</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Description of the Code System</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">expirationDate</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Point of time the Code System looses its validity.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">insertTimestamp</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Point of time when the Code System Version was inserted.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">licenceHolder</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Owner of the licence.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">name</td> | ||
+ | <td>String</td> | ||
+ | <td>100</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Complete Name of the Code System.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">oid</td> | ||
+ | <td>String</td> | ||
+ | <td>100</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Official OID</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">preferredLanguageCd</td> | ||
+ | <td>String</td> | ||
+ | <td>30</td> | ||
+ | <td id="cardinality_cell">1..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> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">previousVersionID</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Refers to the prior version, if there are more than one.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">releaseDate</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Point of time, when this version starts to be valid.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">source</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Source of the Code System Version</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">status</td> | ||
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Status of the current entry. Can be taken from a domain.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">statusDate</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Point of time of the last change of the status</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">underLicence</td> | ||
+ | <td>Boolean</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> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">validityRange</td> | ||
+ | <td>String</td> | ||
+ | <td>30</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Validity range, Values from domain list "codesystem_validityrange". | ||
+ | Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">versionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="cardinality_cell">1</td> | ||
+ | <td id="param_level1">returnInfos</td> | ||
+ | <td>ReturnType</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Return information</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">count</td> | ||
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>number of results</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">message</td> | ||
+ | <td>String</td> | ||
+ | <td></td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>an additional message</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">overallErrorCategory</td> | ||
+ | <td></td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>INFO, WARN, ERROR</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">2</td> | ||
+ | <td id="param_level2">status</td> | ||
+ | <td></td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>OK, FAILURE</td> | ||
+ | </tr> | ||
</table> | </table> | ||
=Beispiele= | =Beispiele= |
Version vom 22. Juli 2014, 08:54 Uhr
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Lists all codesystem in a defined taxonomy in a hierarchical structure. The taxonomy defines diagnoses, procedures, ...
This method is used in the TermBrowser, for example.
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. |
Response
Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|---|
1 | domainValue | domain_value | 0..N | Value from a domain. | |
2 | attribut1Classname | String | 50 | 1..1 | Additonal information |
2 | attribut1Value | String | 50 | 1..1 | Additonal information |
2 | domainCode | String | 50 | 1..1 | Code of the value. It is used as foreign key. |
2 | domainDisplay | String | 100 | 1..1 | Displayed name of the value. |
2 | domainId | Long | 1..1 | ||
2 | domainValueId | Long | 1..1 | ||
2 | imageFile | String | 65535 | 1..1 | Filename of an image saved on the file system. |
2 | orderNo | Integer | 1..1 | Manual order of the values. The 'displayOrder' of the domain in the table 'domain' with 186 (to Order-Number) has to be used. | |
2 | codeSystem | code_system | 0..N | Name of codesystem. Each codesystem requires at least one version. | |
3 | codeSystemType | String | 30 | 1..1 | Type of Code System (Taxonomy, Ontology). A possible value set is available in domain table |
3 | currentVersionId | Long | 1..1 | Version of the Code System | |
3 | description | String | 65535 | 1..1 | Narrative description of Code System |
3 | id | Long | 1..1 | Internal ID = Primary Key of Code System | |
3 | insertTimestamp | java.util.Date | 1..1 | Timestamp, wenn the Code System was inserted | |
3 | name | String | 100 | 1..1 | Name of the Code System. The precise name should be specified in the Code System Version. |
3 | codeSystemVersion | code_system_version | 1..1 | Version of a Code System | |
4 | description | String | 65535 | 1..1 | Description of the Code System |
4 | expirationDate | java.util.Date | 1..1 | Point of time the Code System looses its validity. | |
4 | insertTimestamp | java.util.Date | 1..1 | Point of time when the Code System Version was inserted. | |
4 | licenceHolder | String | 65535 | 1..1 | Owner of the licence. |
4 | name | String | 100 | 1..1 | Complete Name of the Code System. |
4 | oid | String | 100 | 1..1 | Official OID |
4 | preferredLanguageCd | String | 30 | 1..1 | Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...) |
4 | previousVersionID | Long | 1..1 | Refers to the prior version, if there are more than one. | |
4 | releaseDate | java.util.Date | 1..1 | Point of time, when this version starts to be valid. | |
4 | source | String | 65535 | 1..1 | Source of the Code System Version |
4 | status | Integer | 1..1 | Status of the current entry. Can be taken from a domain. | |
4 | statusDate | java.util.Date | 1..1 | Point of time of the last change of the status | |
4 | underLicence | Boolean | 1..1 | true, if Code System is under license (Code System will be invisible for all users without proper license) | |
4 | validityRange | String | 30 | 1..1 | Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional) |
4 | versionId | Long | 1..1 | ||
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 |
Beispiele
SOAP
List all codesystems in a taxonomy
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ListCodeSystemsInTaxonomy> <parameter> </parameter> </sear:ListCodeSystemsInTaxonomy> </soapenv:Body> </soapenv:Envelope>