CTS2-LE REST API: Resolve Value Set MM

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

Operation Syntax

Signature

Response webCts2Le.rest.FhirValueSets.resolveValueSet(@Context HttpServletRequest request,

@QueryParam(value="_query") @DefaultValue(value="expandResource") String query,

@QueryParam(value="limit") int limit,

@QueryParam(value="identifier") String identifier,

@QueryParam(value="version") String version,

@QueryParam(value="codeSystemUri") String codeSystemUri,

@QueryParam(value="codeSystemVersion") String codeSystemVersion,

@QueryParam(value="code") String code,

@QueryParam(value="withDesignations") @DefaultValue(value="false") boolean withDesignations,

@QueryParam(value="stylesheet") String stylesheet)

@GET

@Path(value="/rest/fhir/ValueSet")

@Produces(value={"application/xml"})

Parameters

query

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

Cardinality: 0..1

limit

limits the number of codes returned

Cardinality: 0..1

identifier

Identifier of a resource.

Cardinality: 0..1

version

version related to identifier

Cardinality: 0..1

codeSystemUri

Code system URI.

Cardinality: 0..1

codeSystemVersion

Code system version

Cardinality: 0..1

code

Code.

Cardinality: 0..1

withDesignations

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

Cardinality: 0..1

stylesheet

the stylesheet that will be referenced within the XML response.

Cardinality: 0..1

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.

Result

FHIR expansion according to http://www.hl7.org/fhir/valueset.html or an error XML.