Difference between revisions of "Terminology URIs"
(first setup of page) |
(→URI logic) |
||
| Line 8: | Line 8: | ||
|- | |- | ||
| server | | server | ||
| − | | <nowiki>http://art-decor.org/ | + | | <nowiki>http://art-decor.org/terminology/claml</nowiki> |
|- | |- | ||
| separator | | separator | ||
Revision as of 08:30, 18 November 2014
Retrieval of terminolgy objects with URI's. Note that the content retrieved is mainly external content, such as ICD-10, ICF, Radlex, ATC. In general: all terminology content that is available in ClaML format is retrievable through the services described here.
Contents
URI logic
| Item | Description |
|---|---|
| server | http://art-decor.org/terminology/claml |
| separator | / |
| action | ViewClass, RetrieveClass, RetrieveSubClasses, SearchDescription |
| query part and query parameters separator | ? |
| Query parameter | Description |
| classificationId | The id of the codeSystem, possibly containing a version label. |
| code | The code of the concept. |
| string | Search string when searching for concepts (URL encoded). |
| Language | Language qualifier, for instance language=en-US. Currently not supported. |
Examples
| URI
Description |
|---|
| https://art-decor.org/terminology/claml/ViewClass?classificationId=WHOICD102010_v2011-January-11&code=B27
Will return a class of concepts (with SubClasses) from ICD-10 US in the return format html |
| https://art-decor.org/terminology/claml/RetrieveClass?classificationId=WHOICD102010_v2011-January-11&code=B27
Will return a class of concepts (with SubClasses) from ICD-10 US in the return format XML |
| https://art-decor.org/terminology/claml/RetrieveSubClasses?classificationId=WHOICD102010_v2011-January-11&code=B27
Will return a only the child SubClasses from a class of concepts from ICD-10 US in the return format XML |
| https://art-decor.org/terminology/claml/SearchDescription?classificationId=WHOICD102010_v2011-January-11&string=inf%20mononu
Will return classes based on a search string from ICD-10 US in the return format XML |
Implementation status of the query parameters
Each query parameter marked with 
is implemented at this moment.
Each query parameter marked with N/A is not applicable, not implemented at this moment.
| classificationId | code | string | language | |
|---|---|---|---|---|
| ViewClass | required |
required |
N/A | N/A |
| RetrieveClass | required |
required |
N/A | N/A |
| RetrieveSubClasses | required |
required |
N/A | N/A |
| SearchDescription | required |
N/A | required |
N/A |
Implementation status of the return formats
Each format marked with is implemented at this moment.
| ViewClass | RetrieveClass | RetrieveSubClasses | SearchDescription | |
|---|---|---|---|---|
| XML | no | yes |
yes |
yes |
| CSV | no | no | no | no |
| HTML | yes |
no | no | no |
| no | no | no | no |
