CTS2-LE SVS API: Retrieve Codesystem or Value Set

Aus CTS2-LE
Zur Navigation springen Zur Suche springen

Retrieve Codesystem

Operation Syntax

GET /WebCts2LE/service/crud/svs/retrieveCodeSystem

Exports a code system in XML format (strongly aligned to IHE Sharing Value Sets format).
Parameters
versionOf (type: string, occurence: mandatory) the versionOf (usually an OID) of the requested code system
versionId (type: string, occurence: mandatory) the versionId of the requested code system
Responses
application/xml
200 no errors
409 errors specified in XML

Example Response

GET /WebCts2LE/service/crud/svs/retrieveCodeSystem?versionOf=http://test/stu3/cs&versionId=2017-01

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <valueSet id="http://test/stu3/cs" version="2017-01" verantw_Org="fhg ehealth" description="... descr ..." name="code-system-stu3-88">
 3     <conceptList>
 4         <concept codeSystem="http://test/stu3/cs" code="1" displayName="designation-1" level="0" type="S" />
 5         <concept codeSystem="http://test/stu3/cs" code="1.1" displayName="designation-11" level="1" type="S" />
 6         <concept codeSystem="http://test/stu3/cs" code="1.1.1" displayName="1.1.1" level="2" type="L" />
 7         <concept codeSystem="http://test/stu3/cs" code="2" displayName="designation-2" level="0" type="L" />
 8         <concept codeSystem="http://test/stu3/cs" code="3" displayName="3" level="0" type="L" prop="val2; val1" />
 9     </conceptList>
10 </valueSet>

Retrieve Value Set

Operation Syntax

GET /WebCts2LE/service/crud/svs/retrieveValueSet

Exports a code system in XML format (strongly aligned to IHE Sharing Value Sets format).
Parameters
versionOf (type: string, occurence: mandatory) the versionOf (usually an OID) of the requested value set
versionId (type: string, occurence: mandatory) the versionId of the requested value set
Responses
application/xml
200 no errors
409 errors specified in XML

Example Response

GET /WebCts2LE/service/crud/svs/retrieveCodeSystem?versionOf=http://test/stu3/vs&versionId=2017-01

1 <?xml version="1.0" encoding="UTF-8"?>
2 <valueSet id="http://test/stu3/vs" version="2017-01" verantw_Org="fhg ehealth" description="... descr ..." name="value-set-stu3-99">
3        <conceptList>
4            <concept codeSystem="example:terminology" code="a01" displayName="this is a VS specific display" level="0" type="L"/>
5            <concept codeSystem="example:terminology" code="b01" level="0" type="L"/>
6        </conceptList>
7 </valueSet>