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

Aus CTS2-LE
Zur Navigation springen Zur Suche springen
K
 
(11 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
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 display name. This functionality requires that parameter
 
<code>code</code> and <code>codeSystemUri</code> is set.
 
  
 +
== Example ==
 
For instance, the call
 
For instance, the call
  
 
<pre>
 
<pre>
 
http://<host>/WebCts2LE/rest/fhir/ValueSet?
 
http://<host>/WebCts2LE/rest/fhir/ValueSet?
_query=expandDefinedCodeSystem
+
_query=expandResource
&codeSystemUri=urn:oid:2.16.840.1.113883.5.1
+
&identifier=urn:oid:2.16.840.1.113883.5.1
 +
        &version=generated:2015
 
&code=M
 
&code=M
 
</pre>
 
</pre>
Zeile 14: Zeile 14:
 
retrieves only the male code
 
retrieves only the male code
  
<pre>
+
<syntaxhighlight lang="xml">
 
...
 
...
 
<expansion>
 
<expansion>
 
<timestamp/>
 
<timestamp/>
<contains xmlns="http://hl7.org/fhir">
+
<contains xmlns="http://hl7.org/fhir">
 
<system value="urn:oid:2.16.840.1.113883.5.1"/>
 
<system value="urn:oid:2.16.840.1.113883.5.1"/>
 
<code value="M"/>
 
<code value="M"/>
Zeile 25: Zeile 25:
 
</expansion>
 
</expansion>
 
...
 
...
</pre>
+
</syntaxhighlight>
  
 
The same call can be performed to check wether a (code, code
 
The same call can be performed to check wether a (code, code
Zeile 32: Zeile 32:
 
has any contains-elements as children:
 
has any contains-elements as children:
  
<pre>
+
<syntaxhighlight lang="xml">
 
...
 
...
 
<expansion>
 
<expansion>
Zeile 38: Zeile 38:
 
</expansion>
 
</expansion>
 
...
 
...
</pre>
+
</syntaxhighlight>

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>
...