CTS2-LE SVS API: Update - Versionsgeschichte

Krebs am 5. April 2018 um 07:54 Uhr

2018-04-05T07:54:03Z

2017-11-27T09:04:30Z

2017-08-09T06:52:19Z

2017-08-09T06:52:03Z

2017-07-31T10:22:40Z

‎Using SVS to represent Codesystems and Value Sets

2017-07-27T14:04:22Z

‎Input Specification by Example

2017-07-27T14:01:35Z

‎Input Specification by Example

2017-07-27T12:16:06Z

2017-07-27T12:04:35Z

2017-07-27T11:16:31Z

‎Input Specification by Example

@@ Zeile 41: / Zeile 41: @@
 Note that the pair <<b>versionOf, versionId</b>> as well as the <code>resourceId</code> uniquely identify a resource within CTS2-LE.
-== Example Request ==
+== Example Request: creating/updating a code system ==
 <b>POST</b> /WebCts2LE/service/crud/svs/update?groupName=EXA&defaultLanguage=en<br>
 <b>with body:</b>
 <syntaxhighlight lang="xml" line="GESHI_NORMAL_LINE_NUMBERS">
 <?xml version="1.0" encoding="UTF-8"?>
 <valueSet id="http://test/stu3/cs" version="2017-07" verantw_Org="fhg ehealth" description="... descr ..." name="code-system-stu3-88">

@@ Zeile 9: / Zeile 9: @@
 ;Parameters
 :<b>groupName</b> (type: <code>string</code>, occurence: <code>mandatory</code>) determines the group to which the resource will belong; this is essential for displaying the resource in the navigator
 :<b>defaultLanguage</b> (type: <code>string</code>, occurence: <code>mandatory</code>) the default language of the resource
 :<b>isDefaultVersion</b> (type: <code>boolean</code>, occurence: <code>optional</code>, default is <code>true</code>)  label the resource as the default version
@@ Zeile 38: / Zeile 39: @@
 The XML input is transformed to an CTS2 resource R. The versionOf of R within CTS2-LE is the XML input item <code>/valueSet/@id</code> whereas the versionId is given by the item <code>/valueSet/@version</code> in both cases. <br>
-Note that the pair <<b>versionOf, versionId</b>> uniquely defines a value set within CTS2-LE.
+Note that the pair <<b>versionOf, versionId</b>> as well as the <code>resourceId</code> uniquely identify a resource within CTS2-LE.
 == Example Request ==

@@ Zeile 11: / Zeile 11: @@
 :<b>defaultLanguage</b> (type: <code>string</code>, occurence: <code>mandatory</code>) the default language of the resource
 :<b>isDefaultVersion</b> (type: <code>boolean</code>, occurence: <code>optional</code>, default is <code>true</code>)  label the resource as the default version
 ;Responses
 :<code>application/xml</code>
 :<code>200</code> no errors

@@ Zeile 12: / Zeile 12: @@
 :<b>isDefaultVersion</b> (type: <code>boolean</code>, occurence: <code>optional</code>, default is <code>true</code>)  label the resource as the default version
 ;Responses
 :<code>application/xml</code>
 :<code>200</code> no errors

@@ Zeile 36: / Zeile 36: @@
 Case B applies if each <code>//concept/@codeSystem</code> value is different from <code>/valueSet/@id</code>.
-The XML input is transformed to an CTS2 resource R. The versionOf of R within CTS2-LE is the XML input item <code>/valueSet/@id</code> in both cases. <br>
+The XML input is transformed to an CTS2 resource R. The versionOf of R within CTS2-LE is the XML input item <code>/valueSet/@id</code> whereas the versionId is given by the item <code>/valueSet/@version</code> in both cases. <br>
-Note that the pair <<b>versionOf, versionId</b>> uniquely defines a value set within CTS2-LE. The versionId is given by the item <code>/valueSet/@version</code> in both cases.<br>
+Note that the pair <<b>versionOf, versionId</b>> uniquely defines a value set within CTS2-LE.
 == Example Request ==

@@ Zeile 24: / Zeile 24: @@
      <conceptList>
          <concept code='1' codeSystem='1.2.40.0.34.99.1212' displayName='display name for first concept' level='0' type='L' concept_beschreibung='a description'
-deutsch='a german designation' hinweise='concept notes' relationships='some associations'/>
+        deutsch='a german designation' hinweise='concept notes' relationships='some associations'/>
          <concept code='2' codeSystem='1.2.40.0.34.99.1212' displayName='display name for second concept' level='0' type='L' concept_beschreibung='another description'
-deutsch='a german designation' hinweise='notes for second concept' relationships='association for second concept'/>
+        deutsch='a german designation' hinweise='notes for second concept' relationships='association for second concept'/>
      </conceptList>
 </valueSet>

@@ Zeile 28: / Zeile 28: @@
 </syntaxhighlight>
-=== Using SVS to represent Codesystems and Value Sets ===
+== Using SVS to represent Codesystems and Value Sets ==
 The XML input can be a code system (case A) or a value set definition (case B).
 Case A applies if each <code>//concept/@codeSystem</code> value is equal to <code>/valueSet/@id</code>.
@@ Zeile 35: / Zeile 35: @@
 The XML input is transformed to an CTS2 resource R. The versionOf of R within CTS2-LE is the XML input item <code>/valueSet/@id</code> in both cases. <br>
 Note that the pair <<b>versionOf, versionId</b>> uniquely defines a value set within CTS2-LE. The versionId is given by the item <code>/valueSet/@version</code> in both cases.<br>
-=== Example Request ===