CTS2-LE REST API: Check Value Set Containment

Aus CTS2-LE
Zur Navigation springen Zur Suche springen

The operation can be used to check wether a code (from a code system) is contained in a Value Set. This rest call is a variant of Resolve Value Set (multi-modal) with the minimal required parameter set _query=expand, identifier (URI of the Value Set), code (seeked code).

Example

For instance, the call

http://<host>/WebCts2LE/rest/fhir/ValueSet?
      _query=expand
      &identifier=urn:oid:1.2.3.4
      &codeSystemUri=example:terminology
      &code=a01

retrieves

...
<expansion>
   <timestamp/>
   <contains xmlns="http://hl7.org/fhir">
      <system value="example:terminology"/>
      <version value="1.0"/>
      <code value="a01"/>
      <display value="aPrefTerm"/>
   </contains>
</expansion>
...

If the expansion XML element contains the contains XML element then the check is successful (as in the example above). Otherwise the check was not successfull:

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