Terminologieserver - Search - ListCodeSystems

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(3 dazwischenliegende Versionen von einem Benutzer werden nicht angezeigt)
Zeile 1: Zeile 1:
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br>
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br>
  
 +
=Beschreibung=
 +
Lists all code systems including versions that matches the given criteria.<br>
 
=Request/Response=
 
=Request/Response=
 
==Request==
 
==Request==
Zeile 12: Zeile 14:
 
     <th>Beschreibung</th>
 
     <th>Beschreibung</th>
 
   </tr>
 
   </tr>
−
<tr id="row_object">
+
<tr>
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">LoginType</td>
+
   <td id="param_level1">loginToken</td>
−
  <td>LoginType</td>
+
−
<td></td>  <td id="cardinality_cell">0..1</td>
+
−
  <td>Login information</td>
+
−
</tr>
+
−
<tr>
+
−
  <td id="cardinality_cell">2</td>
+
−
  <td id="param_level2">sessionID</td>
+
 
   <td>String</td>
 
   <td>String</td>
 
   <td></td>
 
   <td></td>
−
   <td id="cardinality_cell">1..1</td>
+
   <td id="cardinality_cell">0..1</td>
−
   <td>Session-ID from user (given by system)</td>
+
   <td>Login-Token that ensures the user is logged in.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 47: Zeile 42:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
−
   <td>Timestamp, wenn the Code System was inserted</td>
+
   <td>Timestamp, when the Code System was inserted</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 112: Zeile 107:
 
<tr>
 
<tr>
 
   <td id="cardinality_cell">3</td>
 
   <td id="cardinality_cell">3</td>
−
   <td id="param_level3">preferredLanguageId</td>
+
   <td id="param_level3">preferredLanguageCd</td>
−
   <td>Long</td>
+
   <td>String</td>
−
<td></td> <td id="cardinality_cell">0..1</td>
+
  <td>30</td>
−
   <td>Preferred language of the Code System ( ID has to be taken from domain 'ISO_639_1_Language_Codes' with ID 1)</td>
+
  <td id="cardinality_cell">0..1</td>
 +
   <td>Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 176: Zeile 172:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">ReturnType</td>
+
   <td id="param_level1">returnInfos</td>
 
   <td>ReturnType</td>
 
   <td>ReturnType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
Zeile 216: Zeile 212:
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
   <td>Name of codesystem. Each codesystem requires at least one version.</td>
 
   <td>Name of codesystem. Each codesystem requires at least one version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">codeSystemType</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Type of Code System (Taxonomy, Ontology). Possible values are available in domain table with id 6</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 223: Zeile 227:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Version of the Code System</td>
 
   <td>Version of the Code System</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Narrative description of Code System</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 236: Zeile 248:
 
   <td>java.util.Date</td>
 
   <td>java.util.Date</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Timestamp, wenn the Code System was inserted</td>
+
   <td>Timestamp, when the Code System was inserted</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 252: Zeile 264:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Version of a Code System</td>
 
   <td>Version of a Code System</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Description of the Code System</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">expirationDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point of time the Code System looses its validity.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 259: Zeile 286:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Point of time when the Code System Version was inserted.</td>
 
   <td>Point of time when the Code System Version was inserted.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">licenceHolder</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Owner of the licence.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 267: Zeile 302:
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td>Complete Name of the Code System.</td>
 
   <td>Complete Name of the Code System.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">oid</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Official OID</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">preferredLanguageCd</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 274: Zeile 325:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Refers to the prior version, if there are more than one.</td>
 
   <td>Refers to the prior version, if there are more than one.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">releaseDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point of time, when this version starts to be valid.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">source</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Source of the Code System Version</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Status of the current entry. Can be taken from a domain.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Point of time of the last change of the status</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 308: Zeile 388:
 
       <sear:ListCodeSystems>
 
       <sear:ListCodeSystems>
 
         <parameter>
 
         <parameter>
 +
        </parameter>
 +
      </sear:ListCodeSystems>
 +
  </soapenv:Body>
 +
</soapenv:Envelope>
 +
</source>
 +
===Search for code systems by name===
 +
<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:ListCodeSystems>
 +
        <parameter>
 +
            <codeSystem>
 +
              <codeSystemVersions>
 +
                  <name>ICD</name>
 +
              </codeSystemVersions>
 +
            </codeSystem>
 
         </parameter>
 
         </parameter>
 
       </sear:ListCodeSystems>
 
       </sear:ListCodeSystems>

Aktuelle Version vom 30. September 2014, 12:31 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

Lists all code systems including versions that matches the given criteria.

Request/Response

Request

Level Parameter Typ Länge Kardinalität Beschreibung
1 loginToken String 0..1 Login-Token that ensures the user is logged in.
1 codeSystem code_system 0..1 If a code system is listed, the information is used as a filter
2 description String 65535 0..1 Narrative description of Code System
2 insertTimestamp java.util.Date 0..1 Timestamp, when the Code System was inserted
2 name String 100 0..1 Name of the Code System. The precise name should be specified in the Code System Version.
2 codeSystemVersion code_system_version 0..1 Version of a Code System
3 description String 65535 0..1 Description of the Code System
3 expirationDate java.util.Date 0..1 Point of time the Code System looses its validity.
3 insertTimestamp java.util.Date 0..1 Point of time when the Code System Version was inserted.
3 licenceHolder String 65535 0..1 Owner of the licence.
3 name String 100 0..1 Complete Name of the Code System.
3 oid String 100 0..1 Official OID
3 preferredLanguageCd String 30 0..1 Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
3 releaseDate java.util.Date 0..1 Point of time, when this version starts to be valid.
3 source String 65535 0..1 Source of the Code System Version
3 status Integer 0..1 Status of the current entry. Can be taken from a domain.
3 statusDate java.util.Date 0..1 Point of time of the last change of the status
3 underLicence Boolean 0..1 true, if Code System is under license (Code System will be invisible for all users without proper license)
3 validityRange String 30 0..1 Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)


Response

Level Parameter Typ Länge Kardinalität Beschreibung
1 returnInfos ReturnType 1..1 Return information
2 count Integer 1..1 number of results
2 message String 1..1 an additional message
2 overallErrorCategory 1..1 INFO, WARN, ERROR
2 status 1..1 OK, FAILURE
1 codeSystem code_system 0..N Name of codesystem. Each codesystem requires at least one version.
2 codeSystemType String 30 1..1 Type of Code System (Taxonomy, Ontology). Possible values are available in domain table with id 6
2 currentVersionId Long 1..1 Version of the Code System
2 description String 65535 1..1 Narrative description of Code System
2 id Long 1..1 Internal ID = Primary Key of Code System
2 insertTimestamp java.util.Date 1..1 Timestamp, when the Code System was inserted
2 name String 100 1..1 Name of the Code System. The precise name should be specified in the Code System Version.
2 codeSystemVersion code_system_version 1..1 Version of a Code System
3 description String 65535 1..1 Description of the Code System
3 expirationDate java.util.Date 1..1 Point of time the Code System looses its validity.
3 insertTimestamp java.util.Date 1..1 Point of time when the Code System Version was inserted.
3 licenceHolder String 65535 1..1 Owner of the licence.
3 name String 100 1..1 Complete Name of the Code System.
3 oid String 100 1..1 Official OID
3 preferredLanguageCd String 30 1..1 Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
3 previousVersionID Long 1..1 Refers to the prior version, if there are more than one.
3 releaseDate java.util.Date 1..1 Point of time, when this version starts to be valid.
3 source String 65535 1..1 Source of the Code System Version
3 status Integer 1..1 Status of the current entry. Can be taken from a domain.
3 statusDate java.util.Date 1..1 Point of time of the last change of the status
3 underLicence Boolean 1..1 true, if Code System is under license (Code System will be invisible for all users without proper license)
3 validityRange String 30 1..1 Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)
3 versionId Long 1..1

Beispiele

SOAP

List all codesystems

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <sear:ListCodeSystems>
         <parameter>
         </parameter>
      </sear:ListCodeSystems>
   </soapenv:Body>
</soapenv:Envelope>

Search for code systems by name

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <sear:ListCodeSystems>
         <parameter>
            <codeSystem>
               <codeSystemVersions>
                  <name>ICD</name>
               </codeSystemVersions>
            </codeSystem>
         </parameter>
      </sear:ListCodeSystems>
   </soapenv:Body>
</soapenv:Envelope>



zurück zur Webservice-Übersicht

Von „http://www.wiki.mi.fh-dortmund.de/cts2/index.php?title=Terminologieserver_-_Search_-_ListCodeSystems“
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge