CTS2-LE REST API: Requesting Concept Details - Versionsgeschichte

Billig am 25. Oktober 2016 um 17:51 Uhr

2016-10-25T17:51:32Z

Billig: /* Example */

2016-10-25T17:46:04Z

‎Example

Billig am 24. August 2015 um 10:56 Uhr

2015-08-24T10:56:25Z

Billig am 22. August 2015 um 09:50 Uhr

2015-08-22T09:50:51Z

Billig am 22. August 2015 um 09:41 Uhr

2015-08-22T09:41:32Z

Billig am 22. August 2015 um 09:24 Uhr

2015-08-22T09:24:52Z

Caumanns: /* Operation Signature */

2015-06-15T20:44:13Z

‎Operation Signature

Caumanns: /* Operation Signature */

2015-06-15T11:59:16Z

‎Operation Signature

Caumanns: /* Operation Signature */

2015-06-15T11:58:34Z

‎Operation Signature

Caumanns: /* Operation Signature */

2015-06-15T09:38:51Z

‎Operation Signature

← Nächstältere Version		Version vom 25. Oktober 2016, 17:51 Uhr
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=<code>~~</~~code~~>~~'''~~
−	~~::<code><code></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 ==

@@ Zeile 49: / Zeile 49: @@
 	_query=expandResource
 	&identifier=urn:oid:2.16.840.1.113883.5.1
 	&code=M
 </pre>
@@ Zeile 54: / Zeile 55: @@
 retrieves only the male code
-<pre>
+<syntaxhighlight lang="xml">
 ...
 <expansion>
@@ Zeile 65: / Zeile 66: @@
 </expansion>
 ...
-</pre>
+</syntaxhighlight>
 The same call can be performed to check wether a (code, code
@@ Zeile 72: / Zeile 73: @@
 has any contains-elements as children:
-<pre>
+<syntaxhighlight lang="xml">
 ...
 <expansion>
@@ Zeile 78: / Zeile 79: @@
 </expansion>
 ...
-</pre>
+</syntaxhighlight>

@@ 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 with its display name. This functionality requires that an additional parameter
+operation can be used to retrieve single codes with its preferred designation. This functionality requires that an additional parameter
 <code>code</code> is set.
@@ Zeile 30: / Zeile 30: @@
 ::Example: identifier=http://hl7.org/fhir/vs/administrative-gender
 :'''<code>code=&lt;code&gt;</code>'''
-::<code>&lt;code&gt;</code>: code for which all defined display names are requested
+::<code>&lt;code&gt;</code>: code for which the preferred designation names is requested
 ::Cardinality: 1..1
 ::Example: code=M
@@ Zeile 39: / Zeile 39: @@
 ;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 all defined display names of the requested code (Note: if the resource-URI references a value set then only the preferred term for the code is returned; in order to get all designations the details have to be fetched via the corresponding code system URI).
+: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.

@@ Zeile 39: / Zeile 39: @@
 ;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 all defined display names of the requested code.
+: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 all defined display names of the requested code (Note: if the resource-URI references a value set then only the preferred term for the code is returned; in order to get all designations the details have to be fetched via the corresponding code system URI).
 :In case of an error an error XML is returned.

@@ Zeile 9: / Zeile 9: @@
 ::@Context HttpServletRequest request,
 ::@QueryParam(value="_query") String query,
-::@QueryParam(value="identifier") String valueset-URI,
+::@QueryParam(value="identifier") String resource-URI,
 ::@QueryParam(value="code") String code,
 ::@QueryParam(value="stylesheet") String stylesheet-path)
@@ Zeile 18: / Zeile 18: @@
 ;REST Call Syntax
-:<pre>http://<host>/WebCts2LE/rest/fhir/ValueSet?_query=expandResource&identifier=<valueset-URI>&code=<code>&stylesheet=<stylesheet-path></pre>
+:<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) value set resource
+::fixed parameter for signaling a query on a (potentially expandable) resource
 ::Cardinality: 1..1
-:'''<code>identifier=<valueset-URI></code>'''
+:'''<code>identifier=<resource-URI></code>'''
-::<code><valueset-URI></code>: URI-encoded identifier of the value set or codesystem that contains the requested 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
@@ Zeile 40: / Zeile 40: @@
 ;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 all defined display names of the requested code.
-:In case of an error an empty FHIR Value Set resource is returned.
+:In case of an error an error XML is returned.
 == Example ==

@@ Zeile 3: / Zeile 3: @@
 <code>code</code> is set.
-== Operation Signature ==
+== Operation Syntax ==
 ;Signature
 :root: @Path("/fhir/ValueSet")

← Nächstältere Version		Version vom 15. Juni 2015, 11:58 Uhr
Zeile 4:		Zeile 4:

	== Operation Signature ==		== Operation Signature ==
		+	;Signature
		+	:root: @Path("/fhir/ValueSet")
		+	:Response webCts2Le.rest.FhirValueSets.resolveValueSet(
		+	::@Context HttpServletRequest request,
		+	::@QueryParam(value="_query") String query,
		+	::@QueryParam(value="identifier") String valueset-URI,
		+	::@QueryParam(value="code") String code,
		+	::@QueryParam(value="stylesheet") String stylesheet-path)
		+
		+	:@GET
		+	:@Produces(value={"application/xml"})
		+

	;REST Call Syntax		;REST Call Syntax