CTS2-LE REST API: Requesting Concept Details

Because of CTS2-LE_REST_API:_Resolve_Value_Set is a multi modal operation, the operation can be used to retrieve single codes with its display name. This functionality requires that an additional parameter code is set.

Operation Syntax

Signature

root: @Path("/fhir/ValueSet")

Response webCts2Le.rest.FhirValueSets.resolveValueSet(

@Context HttpServletRequest request,

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

@QueryParam(value="identifier") String resource-URI,

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

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

@GET

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

REST Call Syntax

http://<host>/WebCts2LE/rest/fhir/ValueSet?_query=expandResource&identifier=<resource-URI>&code=<code>&stylesheet=<stylesheet-path>

Parameters

_query=expandResource

fixed parameter for signaling a query on a (potentially expandable) resource

Cardinality: 1..1

identifier=<resource-URI>

<resource-URI>: URI-encoded identifier of the value set or codesystem that contains the requested code

Cardinality: 1..1

Example: identifier=urn:oid:2.16.840.1.113883.5.1050

Example: identifier=http://hl7.org/fhir/vs/administrative-gender

code=<code>

<code>: code for which all defined display names are requested

Cardinality: 1..1

Example: code=M

Example: code=13

stylesheet=<stylesheet-path>

<stylesheet-path>: stylesheet that will be referenced within the XML response

Cardinality: 0..1

Result

In case of an successful processing of the call, the result will an FHIR Value Set resource as defined in http://www.hl7.org/fhir/valueset.html containing the the codesystem, code and all defined display names of the requested code (Note: if the resource-URI references a value set then only the preferred term for the code is returned; in order to get all designations the details have to be fetched via the corresponding code system URI).

In case of an error an error XML is returned.

Example

For instance, the call

http://<host>/WebCts2LE/rest/fhir/ValueSet?
	_query=expandResource
	&identifier=urn:oid:2.16.840.1.113883.5.1
	&code=M

retrieves only the male code

...
<expansion>
	<timestamp/>
	<contains xmlns="http://hl7.org/fhir">
		<system value="urn:oid:2.16.840.1.113883.5.1"/>
		<code value="M"/>
		<display value="Male"/>
	</contains>
</expansion>
...

The same call can be performed to check wether a (code, code system)-pair is contained in a value set. If this pair is not contained the call yields an atom response with an expansion element that does not has any contains-elements as children:

...
<expansion>
   <timestamp />
</expansion>
...