CTS2-LE REST API: Resolve Value Set MM

Operation Syntax

GET /rest/fhir/ValueSet

Value set resolution. This REST function is a multi-modal function to retrieve value set resolutions

Request Body

-

Parameters

_query (type: string, occurrence: optional, default: expandResource)

Query refinement. _query must match '(expand|expandDefinedCodeSystem|expandResource)'

limit (type: integer, occurrence: optional)

limits the number of codes returned

identifier (type: string, occurrence: optional)

Identifier of a resource

version (type: string, occurrence: optional)

version related to identifier; if ommited then the CTS2-LE default version is used

codeSystemUri (type: string, occurrence: optional)

Code system URI

codeSystemVersion (type: string, occurrence: optional)

Code system version; if ommited then the CTS2-LE default version is used

code (type: string, occurrence: optional)

Code

withDesignations (type: boolean, occurrence: optional, default: false)

with original (non-schema-conform) concept designations (preferred) for special usage

stylesheet (type: string, occurrence: optional)

the stylesheet that will be referenced within the XML response

withContextPath (type: boolean, occurrence: optional, default: false)

<tbd>

Responses

application/xml

200 FHIR expansion according to <a href= "http://www.hl7.org/fhir/valueset.html" >FHIR</a>, or an error XML

Additional Info

(A) If _query == 'expand' then identifier must be an URI of a value set and the response is the corresponding FHIR expansion. To restrict the expansion to code systems or codes, codeSystemUri and code have to be set accordingly.
(B) If _query == 'expandDefinedCodeSystem' then identifier has no meaning and codeSystemUri must be set. To restrict the expansion to a code, code has to be set accordingly.
(C) If _query == 'expandResource' then identifier must be an URI of a (1) CTS2 value set OR a (2) code system. In case of (1) processing (A) will be performed. In case of (2) processing (B) will be performed where codeSystemUri=identifier.