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

Aus CTS2-LE
Zur Navigation springen Zur Suche springen
 
Zeile 1: Zeile 1:
 +
Because of [[CTS2-LE_REST_API:_Resolve_Value_Set]] is a multi modal operation, the
 +
operation can be used to retrieve single codes in detail.
  
[[https://publicwiki-01.fraunhofer.de/CTS2-LE/index.php/CTS2-LE_REST_API:_Resolve_Value_Set]]
+
For instance, the call
  
[[CTS2-LE_REST_API:_Resolve_Value_Set]]
+
<pre>
 +
http://<host>/WebCts2LE/rest/fhir/ValueSet?_query=expand
 +
&identifier=http://hl7.org/fhir/vs/administrative-gender
 +
&codeSystemUri=http://hl7.org/fhir/v3/AdministrativeGender&code=M
 +
</pre>
 +
 
 +
retrieves only the male code
 +
 
 +
<pre>
 +
...
 +
<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>
 +
...
 +
</pre>
 +
 
 +
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:
 +
 
 +
<pre>
 +
...
 +
<expansion>
 +
  <timestamp />
 +
</expansion>
 +
...
 +
</pre>

Version vom 9. Juni 2015, 15:54 Uhr

Because of CTS2-LE_REST_API:_Resolve_Value_Set is a multi modal operation, the operation can be used to retrieve single codes in detail.

For instance, the call

http://<host>/WebCts2LE/rest/fhir/ValueSet?_query=expand
	&identifier=http://hl7.org/fhir/vs/administrative-gender
	&codeSystemUri=http://hl7.org/fhir/v3/AdministrativeGender&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>
...