CTS2-LE REST API: Resolve Value Set - Versionsgeschichte

Billig am 25. Oktober 2016 um 17:37 Uhr

2016-10-25T17:37:52Z

Billig am 22. August 2015 um 09:00 Uhr

2015-08-22T09:00:10Z

Caumanns: /* Operation Signature */

2015-06-15T11:18:00Z

‎Operation Signature

Caumanns: /* Operation Signature */

2015-06-15T11:02:05Z

‎Operation Signature

Caumanns am 15. Juni 2015 um 09:26 Uhr

2015-06-15T09:26:26Z

Caumanns: /* Operation Signature */

2015-06-15T09:21:32Z

‎Operation Signature

Caumanns: /* Operation Signature */

2015-06-15T09:07:07Z

‎Operation Signature

Caumanns: /* Example */

2015-06-15T09:01:49Z

‎Example

Caumanns: /* Additional Info */

2015-06-15T09:01:15Z

‎Additional Info

Caumanns: /* Operation Signature */

2015-06-15T09:00:41Z

‎Operation Signature

@@ Zeile 1: / Zeile 1: @@
 This REST call fetches the full content of a defined value set or codesystem. In case a value set is requested, this call responds with the '''expanded''' content of the value set, which means that all code references are resolved from their underlying codesystems.
-== Operation Syntax ==
+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>.
 == Example ==
@@ Zeile 54: / Zeile 18: @@
 that will return the following value set expansion
-<pre>
+<syntaxhighlight lang="xml">
 <atom:feed xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://hl7.org/fhir"
     xmlns:at="http://purl.org/atompub/tombstones/1.0" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
@@ Zeile 98: / Zeile 62: @@
     </atom:entry>
 </atom:feed>
-</pre>
+</syntaxhighlight>
 Appropriate XPATH expressions should select the code list. E.g., the XPATH expression

@@ Zeile 7: / Zeile 7: @@
 ::@Context HttpServletRequest request,
 ::@QueryParam(value="_query") String query,
-::@QueryParam(value="identifier") String valueset-URI,
+::@QueryParam(value="identifier") String resource-URI,
 ::@QueryParam(value="stylesheet") String stylesheet-path,
 ::@QueryParam(value="limit") Integer max-count)
@@ Zeile 16: / Zeile 16: @@
 ;REST Call Syntax
-:<pre>http://<host>/WebCts2LE/rest/fhir/ValueSet?_query=expandResource&identifier=<valueset-URI>&stylesheet=<stylesheet-path>&limit=<max-count></pre>
+:<pre>http://<host>/WebCts2LE/rest/fhir/ValueSet?_query=expandResource&identifier=<resource-URI>&stylesheet=<stylesheet-path>&limit=<max-count></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
-::Optionality: mandatory
+::Cardinality: 1..1
-:'''<code>identifier=<valueset-URI></code>'''
+:'''<code>identifier=<resource-URI></code>'''
-::<code><valueset-URI></code>: URI-encoded identifier of the requested value set or codesystem
+::<code><resource-URI></code>: URI-encoded identifier of the requested value set or codesystem
 ::Cardinality: 1..1
 ::Example: identifier=urn:oid:2.16.840.1.113883.5.1050
@@ Zeile 30: / Zeile 29: @@
 :'''<code>stylesheet=<stylesheet-path></code>'''
 ::<code><stylesheet-path></code>: stylesheet that will be referenced within the XML response
 ::Cardinality: 0..1
 :'''<code>limit=<max-count></code>'''
 ::<code><max-count></code>: Maximum number of elements to be included with the result set. If this parameter is omitted, the full content of the requested value set or codesystem will be returned.
 ::Cardinality: 0..1
 ::Example: limit=100
@@ Zeile 40: / Zeile 37: @@
 ;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 contents of the requested value set or codesystem.
-: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 1: / Zeile 1: @@
 This REST call fetches the full content of a defined value set or codesystem. In case a value set is requested, this call responds with the '''expanded''' content of the value set, which means that all code references are resolved from their underlying codesystems.
-== Operation Signature ==
+== Operation Syntax ==
 ;REST Call Syntax
@@ Zeile 7: / Zeile 19: @@
 ;Parameters
 :'''<code>identifier=<valueset-URI></code>'''
 ::<code><valueset-URI></code>: URI-encoded identifier of the requested value set or codesystem

@@ Zeile 4: / Zeile 4: @@
 ;REST Call Syntax
-:<pre>http://<host>/WebCts2LE/rest/fhir/ValueSet?_query=expandResource&identifier=<valueset-URI>&stylesheet=<stylesheet-path></pre>
+:<pre>http://<host>/WebCts2LE/rest/fhir/ValueSet?_query=expandResource&identifier=<valueset-URI>&stylesheet=<stylesheet-path>&limit=<max-count></pre>
 ;Parameters
@@ Zeile 17: / Zeile 17: @@
 ::Optionality: optional
 ::Cardinality: 0..1
 ;Result

← Nächstältere Version		Version vom 15. Juni 2015, 09:26 Uhr
Zeile 1:		Zeile 1:
		+	This REST call fetches the full content of a defined value set or codesystem. In case a value set is requested, this call responds with the '''expanded''' content of the value set, which means that all code references are resolved from their underlying codesystems.
		+
	== Operation Signature ==		== Operation Signature ==

@@ Zeile 23: / Zeile 23: @@
 This identifier has to be part of the http-call
 <pre>
-http://<host>/WebCts2LE/rest/fhir/ValueSet?_query=expand&identifier=http://hl7.org/fhir/vs/administrative-gender
+http://<host>/WebCts2LE/rest/fhir/ValueSet?_query=expandResource&identifier=http://hl7.org/fhir/vs/administrative-gender
 </pre>
 that will return the following value set expansion

@@ Zeile 1: / Zeile 1: @@
 == Operation Signature ==
-root: @Path("/fhir/ValueSet")
+;REST Call Syntax
-<h5><span style='font-family:"Segoe UI","sans-serif"'><span
+;Parameters
-style='color:black;text-decoration:none'>Response</span> <span
+:'''identifier''': URI-encoded identifier of the requested value set or codesystem (mandatory)
-style='color:black;text-decoration:none'>webCts2Le</span>.<span
+:'''stylesheet''': stylesheet that will be referenced within the XML response (optional)
-<p class=MsoNormal style='margin-bottom:0cm;margin-bottom:.0001pt'><span
+;Result
-style='line-height:115%;font-family:"Segoe UI","sans-serif"'>&nbsp;</span></p>
+: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 contents of the requested value set or codesystem.
+:In case of an error an empty FHIT Value Set resource is returned.
 == Additional Info ==