Retrieve all concepts for a given code system
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(→SOAP) |
(→Request) |
||
| Zeile 9: | Zeile 9: | ||
'''Method:''' ListCodeSystemConcepts | '''Method:''' ListCodeSystemConcepts | ||
==Request== | ==Request== | ||
| − | + | '''versionId:''' Change the versionId to the versionId from your code system you want to get concepts from. | |
| + | '''isMainClass:''' true, if you want to get only the root concepts (if code system is hierarchical) | ||
| + | |||
| + | '''lookForward:''' true, if you want to get the childs from the concepts, if available (if code system is hierarchical) | ||
| + | |||
| + | <source lang="xml"> | ||
| + | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> | ||
| + | <soapenv:Header/> | ||
| + | <soapenv:Body> | ||
| + | <sear:ListCodeSystemConcepts> | ||
| + | <parameter> | ||
| + | <codeSystem> | ||
| + | <codeSystemVersions> | ||
| + | <versionId>6</versionId> | ||
| + | </codeSystemVersions> | ||
| + | </codeSystem> | ||
| + | <codeSystemEntity> | ||
| + | <codeSystemVersionEntityMemberships> | ||
| + | <isMainClass>true</isMainClass> | ||
| + | </codeSystemVersionEntityMemberships> | ||
| + | </codeSystemEntity> | ||
| + | <searchParameter> | ||
| + | </searchParameter> | ||
| + | <lookForward>false</lookForward> | ||
| + | </parameter> | ||
| + | </sear:ListCodeSystemConcepts> | ||
| + | </soapenv:Body> | ||
| + | </soapenv:Envelope> | ||
</source> | </source> | ||
| + | |||
==Response== | ==Response== | ||
A possible response can look like this: | A possible response can look like this: | ||
Version vom 25. November 2014, 08:23 Uhr
Inhaltsverzeichnis |
Description
You can retrieve all concepts for a given code system with the method "ListCodeSystemConcepts" in the "Search" web service.
You have to add the code system version id as a parameter. If you don't know the version id from the code system you want to get concepts from, please take a look to Retrieve available code systems.
SOAP
Web service: Search
Method: ListCodeSystemConcepts
Request
versionId: Change the versionId to the versionId from your code system you want to get concepts from.
isMainClass: true, if you want to get only the root concepts (if code system is hierarchical)
lookForward: true, if you want to get the childs from the concepts, if available (if code system is hierarchical)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ListCodeSystemConcepts> <parameter> <codeSystem> <codeSystemVersions> <versionId>6</versionId> </codeSystemVersions> </codeSystem> <codeSystemEntity> <codeSystemVersionEntityMemberships> <isMainClass>true</isMainClass> </codeSystemVersionEntityMemberships> </codeSystemEntity> <searchParameter> </searchParameter> <lookForward>false</lookForward> </parameter> </sear:ListCodeSystemConcepts> </soapenv:Body> </soapenv:Envelope>
Response
A possible response can look like this:
