CTS2-LE REST API: Requesting Concept Details: Unterschied zwischen den Versionen

Aus CTS2-LE
Zur Navigation springen Zur Suche springen
(→‎Example)
 
Zeile 1: Zeile 1:
−
Because of [[CTS2-LE_REST_API:_Resolve_Value_Set]] is a multi modal operation, the
+
The operation can be used to retrieve single codes with its preferred designation. This rest call is a variant of [[CTS2-LE REST API: Resolve Value Set MM|Resolve Value Set (multi-modal)]] with the minimal required parameter set <b>_query</b>=expandResource, <b>identifier</b>, <b>code</b>.
−
operation can be used to retrieve single codes with its preferred designation. This functionality requires that an additional parameter
 
−
<code>code</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
 
−
:<pre>http://<host>/WebCts2LE/rest/fhir/ValueSet?_query=expandResource&identifier=<resource-URI>&code=<code>&stylesheet=<stylesheet-path></pre>
 
−
 
 
−
;Parameters
 
−
:'''<code>_query=expandResource</code>'''
 
−
::fixed parameter for signaling a query on a (potentially expandable) resource
 
−
::Cardinality: 1..1
 
−
:'''<code>identifier=<resource-URI></code>'''
 
−
::<code><resource-URI></code>: 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=&lt;code&gt;</code>'''
 
−
::<code>&lt;code&gt;</code>: code for which the preferred designation names is requested
 
−
::Cardinality: 1..1
 
−
::Example: code=M
 
−
::Example: code=13
 
−
:'''<code>stylesheet=<stylesheet-path></code>'''
 
−
::<code><stylesheet-path></code>: 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 the preferred designation of the requested code.
 
−
:In case of an error an error XML is returned.
 
  
 
== Example ==
 
== Example ==

Aktuelle Version vom 25. Oktober 2016, 19:51 Uhr

The operation can be used to retrieve single codes with its preferred designation. This rest call is a variant of Resolve Value Set (multi-modal) with the minimal required parameter set _query=expandResource, identifier, code.

Example

For instance, the call 

http://<host>/WebCts2LE/rest/fhir/ValueSet?
	_query=expandResource
	&identifier=urn:oid:2.16.840.1.113883.5.1
        &version=generated:2015
	&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>
...
Abgerufen von „https://websites.fraunhofer.de/CTS2-LE/index.php?title=CTS2-LE_REST_API:_Requesting_Concept_Details&oldid=888“