CTS2-LE REST API: Resolve Value Set: Unterschied zwischen den Versionen
Billig (Diskussion | Beiträge) |
Billig (Diskussion | Beiträge) K |
||
| Zeile 98: | Zeile 98: | ||
to <a href="http://www.hl7.org/fhir/valueset.html">FHIR</a>, or an error XML</span></p> | to <a href="http://www.hl7.org/fhir/valueset.html">FHIR</a>, or an error XML</span></p> | ||
| − | == | + | == Additional Info == |
| + | |||
| + | (A) If <code>_query == 'expand'</code> then <code>identifier</code> 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, <code>codeSystemUri</code> and | ||
| + | <code>code</code> have to be set accordingly.<br> | ||
| + | (B) If <code>_query == 'expandDefinedCodeSystem'</code> then <code>identifier</code> | ||
| + | has no meaning and <code>codeSystemUri</code> must be set. To restrict the | ||
| + | expansion to a code, <code>code</code> has to be set accordingly.<br> | ||
| + | (C) If <code>_query == 'expandResource'</code> then <code>identifier</code> 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 <code>codeSystemUri=identifier</code>. | ||
Version vom 9. Juni 2015, 13:56 Uhr
Operation Signature
Response webCts2Le.rest.FhirValueSets.resolveValueSet(@Context HttpServletRequest request, @QueryParam(value="_query") String query, @QueryParam(value="identifier") String identifier, @QueryParam(value="codeSystemUri") String codeSystemUri, @QueryParam(value="code") String code, @QueryParam(value="stylesheet") String stylesheet)
@GET
@Produces(value={"application/xml"})
Value set resolution. This REST function is a multi-modal function to retrieve value set resolutions.
Parameters:
request HTTP request.
query
Query refinement. _query
must match '(expand|expandDefinedCodeSystem|expandResource)'.
identifier Identifier of a resource.
codeSystemUri Code system URI.
code Code.
stylesheet the stylesheet that will be referenced within the XML response.
Returns:
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.