Terminologieserver - Search - ListGloballySearchedConcepts

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(2 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=
 +
Search for codes in all codesystems and valuesets.<br>
 
=Request/Response=
 
=Request/Response=
 
==Request==
 
==Request==
Zeile 12: Zeile 14:
 
     <th>Beschreibung</th>
 
     <th>Beschreibung</th>
 
   </tr>
 
   </tr>
 +
<tr>
 +
  <td id="cardinality_cell">1</td>
 +
  <td id="param_level1">loginToken</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td>Login-Token that ensures the user is logged in.</td>
 +
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
Zeile 92: Zeile 102:
 
<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 166: Zeile 176:
 
   <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>Point in time of the last change.</td>
+
   <td>Last change date of the entity version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 173: Zeile 183:
 
   <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>Point in time, when entry was inserted.</td>
+
   <td>Point in time when entry was inserted.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 180: Zeile 190:
 
   <td>Boolean</td>
 
   <td>Boolean</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only. </td>
+
   <td>Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 198: Zeile 208:
 
<tr>
 
<tr>
 
   <td id="cardinality_cell">3</td>
 
   <td id="cardinality_cell">3</td>
−
   <td id="param_level3">status</td>
+
   <td id="param_level3">previousVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Refers to the prior version, if there are more than one version.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDeactivated</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Defines the state. Default value is 0 (=visible). Look for available values in the according domain.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDeactivatedDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Date when statusDeactivated changed</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusVisibility</td>
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
Zeile 205: Zeile 236:
 
<tr>
 
<tr>
 
   <td id="cardinality_cell">3</td>
 
   <td id="cardinality_cell">3</td>
−
   <td id="param_level3">statusDate</td>
+
   <td id="param_level3">statusVisibilityDate</td>
 
   <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>Point of time of the last change of the status.</td>
 
   <td>Point of time of the last change of the status.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusWorkflow</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>A workflow status, can be unique for each codesystem.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusWorkflowDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>Date when statusWorkflow changed</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 215: Zeile 260:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td>Version-ID of Entity-Version</td>
+
   <td>The ID of this entry.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 276: Zeile 321:
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
   <td>Connects a valueset to an entity.</td>
 
   <td>Connects a valueset to an entity.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">hints</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">isStructureEntry</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">meaning</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">orderNr</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 318: Zeile 401:
 
   <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></td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">5</td>
 +
  <td id="param_level5">name</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">5</td>
 +
  <td id="param_level5">oid</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
Zeile 324: Zeile 423:
 
   <td id="param_level5">preferredLanguageCd</td>
 
   <td id="param_level5">preferredLanguageCd</td>
 
   <td>String</td>
 
   <td>String</td>
−
   <td>19</td>
+
   <td>30</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>The preferred langue of the code system. (The ID has to be taken from the domain 'ISO_639_1_Language_Codes' - ID 1)</td>
+
   <td>Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 361: Zeile 460:
 
   <td>Long</td>
 
   <td>Long</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
−
   <td></td>
+
   <td>Validity range (German: Gültigkeitsbereich)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 404: Zeile 503:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>true, if the belonging entity of the entry is a root element of the code system.</td>
 
   <td>true, if the belonging entity of the entry is a root element of the code system.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">orderNr</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">1..1</td>
 +
  <td>If used, concepts are ordered by the given numbers.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>

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

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

Search for codes in all codesystems and valuesets.

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 codeSystemConcept code_system_concept 1..1 Displays a concept or term. Specialization of code_system_entity_version.
2 code String 100 0..1 Code of a concept or term.
2 isPreferred Boolean 0..1 Specifies, if a term or concept is preferred or not.
2 term String 65535 0..1 The term itself
2 termAbbrevation String 50 0..1 The abbrevation of the term.


Response

Level Parameter Typ Länge Kardinalität Beschreibung
1 pagingInfos PagingResultType 0..1 Will be returned automatically if result set is bigger than the limiting system value. Results will be cut to the limit size.
2 maxPageSize Integer 1..1 system limit for maximum number of entries per page
2 pageIndex Integer 1..1 current page (starts with 0)
2 pageSize Integer 1..1 number of results per page
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 codeSystemEntity code_system_entity 0..N Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version.
2 currentVersionId Long 1..1 Current ID of code_system_entity_version.
2 id Long 1..1
2 codeSystemEntityVersion code_system_entity_version 1..1 code_system_entity_version is the superclass of every Concept and Association.
3 codeSystemEntityId Long 1..1 Foreign key to code system entities ID
3 effectiveDate java.util.Date 1..1 Last change date of the entity version.
3 insertTimestamp java.util.Date 1..1 Point in time when entry was inserted.
3 isLeaf Boolean 1..1 Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only.
3 majorRevision Integer 1..1 Major revision of this entry (composition of major and minor version e.g. 1.3).
3 minorRevision Integer 1..1 Minor revision of this entry (composition of major and minor version e.g. 1.3)
3 previousVersionId Long 1..1 Refers to the prior version, if there are more than one version.
3 statusDeactivated Integer 1..1 Defines the state. Default value is 0 (=visible). Look for available values in the according domain.
3 statusDeactivatedDate java.util.Date 1..1 Date when statusDeactivated changed
3 statusVisibility Integer 1..1 Status of the current entry. Can be taken from a domain.
3 statusVisibilityDate java.util.Date 1..1 Point of time of the last change of the status.
3 statusWorkflow Integer 1..1 A workflow status, can be unique for each codesystem.
3 statusWorkflowDate java.util.Date 1..1 Date when statusWorkflow changed
3 versionId Long 1..1 The ID of this entry.
3 codeSystemConcept code_system_concept 1..1 Displays a concept or term. Specialization of code_system_entity_version.
4 code String 100 1..1 Code of a concept or term.
4 codeSystemEntityVersionId Long 1..1
4 description String 1..1 Description of a term or concept
4 isPreferred Boolean 1..1 Specifies, if a term or concept is preferred or not.
4 term String 65535 1..1 The term itself
4 termAbbrevation String 50 1..1 The abbrevation of the term.
3 conceptValueSetMembership concept_value_set_membership 0..N Connects a valueset to an entity.
4 description String 65535 1..1
4 hints String 65535 1..1
4 isStructureEntry Boolean 1..1
4 meaning String 65535 1..1
4 orderNr Long 1..1
4 status Integer 1..1
4 statusDate java.util.Date 1..1
4 valueOverride String 100 1..1 If stated this value overrides the 'code' from code_system_concept of the belonging entity.
4 valueSetVersion value_set_version 1..1 Represents the version of an valueset.
5 insertTimestamp java.util.Date 1..1 Timestamp of the insertion of the valueset version.
5 lastChangeDate java.util.Date 1..1
5 name String 1..1
5 oid String 1..1
5 preferredLanguageCd String 30 1..1 Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
5 previousVersionId Long 1..1 Points to the previous version.
5 releaseDate java.util.Date 1..1 Start date for the validity of the valueset version.
5 status Integer 1..1 The status of the current entry. Can be found in a domain.
5 statusDate java.util.Date 1..1 Alteration time of the status.
5 validityRange Long 1..1 Validity range (German: Gültigkeitsbereich)
5 valueSetId Long 1..1 Foreign key to the ID of the valueset.
5 versionId Long 1..1 Version ID of the value set
2 codeSystemVersionEntityMembership code_system_version_entity_membership 1..1 Connects the version of a Code System to the entities.
3 codeSystemVersionId Long 1..1
3 isAxis Boolean 1..1 true, if the belonging entity of the entry is an axis of the code system
3 isMainClass Boolean 1..1 true, if the belonging entity of the entry is a root element of the code system.
3 orderNr Long 1..1 If used, concepts are ordered by the given numbers.

Beispiele

SOAP

List concepts globally by term and code

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <sear:ListGloballySearchedConcepts>
         <parameter>
            <codeSystemConcept>
               <term>Blut</term>
               <code>A0</code>
            </codeSystemConcept>
         </parameter>
      </sear:ListGloballySearchedConcepts>
   </soapenv:Body>
</soapenv:Envelope>



zurück zur Webservice-Übersicht

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