Admin at 15:50, 21 May 2016

2016-05-21T15:50:28Z

Ahenket: /* URI logic */

2014-11-18T08:30:39Z

‎URI logic

Mligtvoet: first setup of page

2014-11-17T14:48:54Z

first setup of page

New page

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.

== URI logic ==
{|class="artdecor"
! Item
! Description
|-
| server
| <nowiki>http://art-decor.org/decor/services</nowiki>
|-
| 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 ==
{|class="artdecor"
! 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 [[Image:Conformance.svg|20px]] is implemented at this moment.
Each query parameter marked with N/A is not applicable, not implemented at this moment.

{|class="artdecor" width="100%"
|
! classificationId
! code
! string
! language
|-
! ViewClass
| required [[Image:Conformance.svg|right|20px]]
| required [[Image:Conformance.svg|right|20px]]
| N/A
| N/A
|-
! RetrieveClass
| required [[Image:Conformance.svg|right|20px]]
| required [[Image:Conformance.svg|right|20px]]
| N/A
| N/A
|-
! RetrieveSubClasses
| required [[Image:Conformance.svg|right|20px]]
| required [[Image:Conformance.svg|right|20px]]
| N/A
| N/A
|-
! SearchDescription
| required [[Image:Conformance.svg|right|20px]]
| N/A
| required [[Image:Conformance.svg|right|20px]]
| N/A
|}

== Implementation status of the return formats ==
Each format marked with [[Image:Conformance.svg|20px]] is implemented at this moment.

{|class="artdecor"
!
! ViewClass
! RetrieveClass
! RetrieveSubClasses
! SearchDescription
|-
! XML
| no
| yes [[Image:Conformance.svg|right|20px]]
| yes [[Image:Conformance.svg|right|20px]]
| yes [[Image:Conformance.svg|right|20px]]
|-
! CSV
| no
| no
| no
| no
|-
! HTML
| yes [[Image:Conformance.svg|right|20px]]
| no
| no
| no
|-
! PDF
| no
| no
| no
| no
|}

@@ Line 3: / Line 3: @@
 == URI logic ==
-{|class="artdecor"
+{|class="artdecorwiki"
 ! Item
 ! Description
@@ Line 37: / Line 37: @@
 == Examples ==
-{|class="artdecor"
+{|class="artdecorwiki"
 ! URI
 Description
@@ Line 59: / Line 59: @@
 Each query parameter marked with N/A is not applicable, not implemented at this moment.
-{|class="artdecor" width="100%"
+{|class="artdecorwiki" width="100%"
+|
 ! classificationId
@@ Line 94: / Line 94: @@
 Each format marked with [[Image:Conformance.svg|20px]] is implemented at this moment.
-{|class="artdecor"
+{|class="artdecorwiki"
+!
 ! ViewClass

@@ Line 8: / Line 8: @@
 |-
 | server
-| <nowiki>http://art-decor.org/decor/services</nowiki>
+| <nowiki>http://art-decor.org/terminology/claml</nowiki>
 |-
 | separator

Terminology URIs - Revision history

Admin at 15:50, 21 May 2016

Ahenket: /* URI logic */

Mligtvoet: first setup of page