CTS2-LE REST API: Resolve Value Set: Unterschied zwischen den Versionen

Aus CTS2-LE
Zur Navigation springen Zur Suche springen
K
Zeile 1: Zeile 1:
−
== xxx ==
+
== Operation Signature ==
  
−
----
+
<h5><span style='font-family:"Segoe UI","sans-serif"'><span
 +
style='color:black;text-decoration:none'>Response</span> <span
 +
style='color:black;text-decoration:none'>webCts2Le</span>.<span
 +
style='color:black;text-decoration:none'>rest</span>.<span
 +
style='color:black;text-decoration:none'>FhirValueSets</span>.resolveValueSet(</span><span
 +
style='font-family:"Segoe UI","sans-serif";font-weight:normal'>@<span
 +
style='color:black;text-decoration:none'>Context</span> </span><span
 +
style='font-family:"Segoe UI","sans-serif"'><span
 +
style='color:black;text-decoration:none'>HttpServletRequest</span> request,
 +
</span><span style='font-family:"Segoe UI","sans-serif";
 +
font-weight:normal'>@<span
 +
style='color:black;text-decoration:none'>QueryParam</span>(<span
 +
style='color:black;text-decoration:none'>value</span>=&quot;_query&quot;) </span><span
 +
style='font-family:"Segoe UI","sans-serif"'><span
 +
style='color:black;text-decoration:none'>String</span> query, </span><span
 +
style='font-family:"Segoe UI","sans-serif";font-weight:normal'>@<span
 +
style='color:black;text-decoration:none'>QueryParam</span>(<span
 +
style='color:black;text-decoration:none'>value</span>=&quot;identifier&quot;)
 +
</span><span style='font-family:"Segoe UI","sans-serif"'><span
 +
style='color:black;text-decoration:none'>String</span> identifier, </span><span
 +
style='font-family:"Segoe UI","sans-serif";font-weight:normal'>@<span
 +
style='color:black;text-decoration:none'>QueryParam</span>(<span
 +
style='color:black;text-decoration:none'>value</span>=&quot;codeSystemUri&quot;)
 +
</span><span style='font-family:"Segoe UI","sans-serif"'><span
 +
style='color:black;text-decoration:none'>String</span> codeSystemUri, </span><span
 +
style='font-family:"Segoe UI","sans-serif";font-weight:normal'>@<span
 +
style='color:black;text-decoration:none'>QueryParam</span>(<span
 +
style='color:black;text-decoration:none'>value</span>=&quot;code&quot;) </span><span
 +
style='font-family:"Segoe UI","sans-serif"'><span
 +
style='color:black;text-decoration:none'>String</span> code, </span><span
 +
style='font-family:"Segoe UI","sans-serif";font-weight:normal'>@<span
 +
style='color:black;text-decoration:none'>QueryParam</span>(<span
 +
style='color:black;text-decoration:none'>value</span>=&quot;stylesheet&quot;)
 +
</span><span style='font-family:"Segoe UI","sans-serif"'><span
 +
style='color:black;text-decoration:none'>String</span> stylesheet)</span></h5>
  
−
<p class=MsoNormal style='margin-bottom:0cm;margin-bottom:.0001pt;line-height:
+
<p class=MsoNormal style='margin-bottom:0cm;margin-bottom:.0001pt'><span
−
normal'><b><span style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";
+
style='line-height:115%;font-family:"Segoe UI","sans-serif"'>&nbsp;</span></p>
−
color:black'>Response
 
−
webCts2Le.rest.FhirValueSets.resolveValueSet(</span></b><span
 
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'>@Context
 
−
<b>HttpServletRequest
 
−
request, </b>@QueryParam(value=&quot;_query&quot;)
 
−
<b>String
 
−
query, </b>@QueryParam(value=&quot;identifier&quot;)
 
−
<b>String
 
−
identifier, </b>@QueryParam(value=&quot;codeSystemUri&quot;)
 
−
<b>String
 
−
codeSystemUri, </b>@QueryParam(value=&quot;code&quot;)
 
−
<b>String
 
−
code, </b>@QueryParam(value=&quot;stylesheet&quot;)
 
−
<b>String
 
−
stylesheet)</b></span></p>
 
  
−
<p class=MsoNormal style='margin-bottom:0cm;margin-bottom:.0001pt;line-height:
+
<p class=MsoNormal style='margin-bottom:0cm;margin-bottom:.0001pt'><span
−
normal'><span style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";
+
style='line-height:115%;font-family:"Segoe UI","sans-serif"'>@GET<br>
−
color:black'>&nbsp;</span></p>
 
−
 
 
−
<p class=MsoNormal style='margin-bottom:3.75pt;line-height:normal'><span
 
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'>@GET<br>
 
 
@Produces(value={&quot;application/xml&quot;})</span></p>
 
@Produces(value={&quot;application/xml&quot;})</span></p>
  
−
<p class=MsoNormal style='margin-top:12.0pt;margin-right:0cm;margin-bottom:
+
<p><span style='font-family:"Segoe UI","sans-serif"'>Value set
−
12.0pt;margin-left:0cm;line-height:normal'><span style='font-size:9.0pt;
+
resolution. This REST function is a multi-modal function to retrieve value set
−
font-family:"Segoe UI","sans-serif";color:black'>Value set resolution. This
+
resolutions.</span></p>
−
REST function is a multi-modal function to retrieve value set resolutions.<br>
 
−
(A) If </span><span style='font-size:10.0pt;font-family:"Courier New";
 
−
color:black'>_query == 'expand'</span><span style='font-size:9.0pt;font-family:
 
−
"Segoe UI","sans-serif";color:black'> then </span><span style='font-size:10.0pt;
 
−
font-family:"Courier New";color:black'>identifier</span><span style='font-size:
 
−
9.0pt;font-family:"Segoe UI","sans-serif";color:black'> 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, </span><span style='font-size:10.0pt;
 
−
font-family:"Courier New";color:black'>codeSystemUri</span><span
 
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'> and </span><span
 
−
style='font-size:10.0pt;font-family:"Courier New";color:black'>code</span><span
 
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'> have
 
−
to be set accordingly.<br>
 
−
(B) If </span><span style='font-size:10.0pt;font-family:"Courier New";
 
−
color:black'>_query == 'expandDefinedCodeSystem'</span><span style='font-size:
 
−
9.0pt;font-family:"Segoe UI","sans-serif";color:black'> then </span><span
 
−
style='font-size:10.0pt;font-family:"Courier New";color:black'>identifier</span><span
 
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'> has no
 
−
meaning and </span><span style='font-size:10.0pt;font-family:"Courier New";
 
−
color:black'>codeSystemUri</span><span style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";
 
−
color:black'> must be set. To restrict the expansion to a code, </span><span
 
−
style='font-size:10.0pt;font-family:"Courier New";color:black'>code</span><span
 
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'> has to
 
−
be set accordingly.<br>
 
−
(C) If </span><span style='font-size:10.0pt;font-family:"Courier New";
 
−
color:black'>_query == 'expandResource'</span><span style='font-size:9.0pt;
 
−
font-family:"Segoe UI","sans-serif";color:black'> then </span><span
 
−
style='font-size:10.0pt;font-family:"Courier New";color:black'>identifier</span><span
 
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'> 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 </span><span style='font-size:10.0pt;font-family:"Courier New";
 
−
color:black'>codeSystemUri=identifier</span><span style='font-size:9.0pt;
 
−
font-family:"Segoe UI","sans-serif";color:black'>.</span></p>
 
  
−
<p class=MsoNormal style='margin-bottom:0cm;margin-bottom:.0001pt;line-height:
+
<p class=MsoNormal style='margin-bottom:0cm;margin-bottom:.0001pt'><b><span
−
normal'><b><span style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";
+
style='line-height:115%;font-family:"Segoe UI","sans-serif"'>Parameters:</span></b></p>
−
color:black'>Parameters:</span></b></p>
 
  
 
<p class=MsoNormal style='margin-top:0cm;margin-right:0cm;margin-bottom:0cm;
 
<p class=MsoNormal style='margin-top:0cm;margin-right:0cm;margin-bottom:0cm;
−
margin-left:42.0pt;margin-bottom:.0001pt;line-height:normal'><b><span
+
margin-left:36.0pt;margin-bottom:.0001pt'><b><span style='
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'>request</span></b><span
+
line-height:115%;font-family:"Segoe UI","sans-serif"'>request</span></b><span
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'> HTTP
+
style='line-height:115%;font-family:"Segoe UI","sans-serif"'>
−
request.</span></p>
+
HTTP request.</span></p>
  
 
<p class=MsoNormal style='margin-top:0cm;margin-right:0cm;margin-bottom:0cm;
 
<p class=MsoNormal style='margin-top:0cm;margin-right:0cm;margin-bottom:0cm;
−
margin-left:42.0pt;margin-bottom:.0001pt;line-height:normal'><b><span
+
margin-left:36.0pt;margin-bottom:.0001pt'><b><span style='
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'>query</span></b><span
+
line-height:115%;font-family:"Segoe UI","sans-serif"'>query</span></b><span
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'> Query
+
style='line-height:115%;font-family:"Segoe UI","sans-serif"'>
−
refinement. </span><span style='font-size:10.0pt;font-family:"Courier New";
+
Query refinement. </span><code><span style='font-size:10.0pt;line-height:115%'>_query</span></code><span
−
color:black'>_query</span><span style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";
+
style='line-height:115%;font-family:"Segoe UI","sans-serif"'>
−
color:black'> must match </span><span style='font-size:10.0pt;font-family:"Courier New";
+
must match </span><code><span style='font-size:10.0pt;line-height:115%'>'(expand|expandDefinedCodeSystem|expandResource)'</span></code><span
−
color:black'>'(expand|expandDefinedCodeSystem|expandResource)'</span><span
+
style='line-height:115%;font-family:"Segoe UI","sans-serif"'>.</span></p>
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'>.</span></p>
 
  
 
<p class=MsoNormal style='margin-top:0cm;margin-right:0cm;margin-bottom:0cm;
 
<p class=MsoNormal style='margin-top:0cm;margin-right:0cm;margin-bottom:0cm;
−
margin-left:42.0pt;margin-bottom:.0001pt;line-height:normal'><b><span
+
margin-left:36.0pt;margin-bottom:.0001pt'><b><span style='
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'>identifier</span></b><span
+
line-height:115%;font-family:"Segoe UI","sans-serif"'>identifier</span></b><span
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'>
+
style='line-height:115%;font-family:"Segoe UI","sans-serif"'>
 
Identifier of a resource.</span></p>
 
Identifier of a resource.</span></p>
  
 
<p class=MsoNormal style='margin-top:0cm;margin-right:0cm;margin-bottom:0cm;
 
<p class=MsoNormal style='margin-top:0cm;margin-right:0cm;margin-bottom:0cm;
−
margin-left:42.0pt;margin-bottom:.0001pt;line-height:normal'><b><span
+
margin-left:36.0pt;margin-bottom:.0001pt'><b><span style='
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'>codeSystemUri</span></b><span
+
line-height:115%;font-family:"Segoe UI","sans-serif"'>codeSystemUri</span></b><span
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'> Code
+
style='line-height:115%;font-family:"Segoe UI","sans-serif"'>
−
system URI.</span></p>
+
Code system URI.</span></p>
  
 
<p class=MsoNormal style='margin-top:0cm;margin-right:0cm;margin-bottom:0cm;
 
<p class=MsoNormal style='margin-top:0cm;margin-right:0cm;margin-bottom:0cm;
−
margin-left:42.0pt;margin-bottom:.0001pt;line-height:normal'><b><span
+
margin-left:36.0pt;margin-bottom:.0001pt'><b><span style='
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'>code</span></b><span
+
line-height:115%;font-family:"Segoe UI","sans-serif"'>code</span></b><span
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'> Code.</span></p>
+
style='line-height:115%;font-family:"Segoe UI","sans-serif"'>
 +
Code.</span></p>
  
 
<p class=MsoNormal style='margin-top:0cm;margin-right:0cm;margin-bottom:0cm;
 
<p class=MsoNormal style='margin-top:0cm;margin-right:0cm;margin-bottom:0cm;
−
margin-left:42.0pt;margin-bottom:.0001pt;line-height:normal'><b><span
+
margin-left:36.0pt;margin-bottom:.0001pt'><b><span style='
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'>stylesheet</span></b><span
+
line-height:115%;font-family:"Segoe UI","sans-serif"'>stylesheet</span></b><span
−
style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";color:black'> the
+
style='line-height:115%;font-family:"Segoe UI","sans-serif"'>
−
stylesheet that will be referenced within the XML response.</span></p>
+
the stylesheet that will be referenced within the XML response.</span></p>
  
−
<p class=MsoNormal style='margin-bottom:0cm;margin-bottom:.0001pt;line-height:
+
<p class=MsoNormal style='margin-bottom:0cm;margin-bottom:.0001pt'><b><span
−
normal'><b><span style='font-size:9.0pt;font-family:"Segoe UI","sans-serif";
+
style='line-height:115%;font-family:"Segoe UI","sans-serif"'>Returns:</span></b></p>
−
color:black'>Returns:</span></b></p>
 
  
−
<p class=MsoNormal style='margin-top:0cm;margin-right:0cm;margin-bottom:3.0pt;
+
<p class=MsoNormal style='margin-top:0cm;margin-right:0cm;margin-bottom:0cm;
−
margin-left:42.0pt;line-height:normal'><span style='font-size:9.0pt;font-family:
+
margin-left:36.0pt;margin-bottom:.0001pt'><span style='
−
"Segoe UI","sans-serif";color:black'>FHIR expansion according to <a
+
line-height:115%;font-family:"Segoe UI","sans-serif"'>FHIR expansion according
−
href="http://hl7.org/fhir/2015Jan/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>
−
----
 
  
−
xxx
+
== xx ==

Version vom 9. Juni 2015, 13:53 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

xx

Abgerufen von „https://websites.fraunhofer.de/CTS2-LE/index.php?title=CTS2-LE_REST_API:_Resolve_Value_Set&oldid=94“