Terminologieserver - Search - ListCodeSystemConcepts

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
Zeile 42: Zeile 42:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</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 id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">codeSystemType</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Type of Code System (Taxonomy, Ontology). Possible values are available in domain table with id 6</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Version of the Code System</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Narrative description of Code System</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Internal ID = Primary Key of Code System</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Timestamp, when the Code System was inserted</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Name of the Code System. The precise name should be specified in the Code System Version.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 49: Zeile 94:
 
<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 id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Description of the Code System</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">expirationDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Point of time the Code System looses its validity.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Point of time when the Code System Version was inserted.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">licenceHolder</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Owner of the licence.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Complete Name of the Code System.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">oid</td>
 +
  <td>String</td>
 +
  <td>100</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Official OID</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">preferredLanguageCd</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">previousVersionID</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Refers to the prior version, if there are more than one.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">releaseDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Point of time, when this version starts to be valid.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">source</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Source of the Code System Version</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Status of the current entry. Can be taken from a domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Point of time of the last change of the status</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">underLicence</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>true, if Code System is under license (Code System will be invisible for all users without proper license)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">validityRange</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Validity range, Values from domain list "codesystem_validityrange".
 +
Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 63: Zeile 221:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
 
   <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Current ID of code_system_entity_version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 70: Zeile 242:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
 
   <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemEntityId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Foreign key to code system entities ID</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">effectiveDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Last change date of the entity version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Point in time when entry was inserted.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">isLeaf</td>
 +
  <td>Boolean</td>
 +
<td></td>  <td id="cardinality_cell">-</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 id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">majorRevision</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">minorRevision</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">previousVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Refers to the prior version, if there are more than one version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDeactivated</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Defines the state. Default value is 0 (=visible). Look for available values in the according domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDeactivatedDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Date when statusDeactivated changed</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusVisibility</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Status of the current entry. Can be taken from a domain.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 78: Zeile 320:
 
   <td>Point of time of the last change of the status.
 
   <td>Point of time of the last change of the status.
 
Used for synchronization at this point. All concepts after the given date will be returned.</td>
 
Used for synchronization at this point. All concepts after the given date will be returned.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusWorkflow</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>A workflow status, can be unique for each codesystem.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusWorkflowDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Date when statusWorkflow changed</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">versionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>The ID of this entry.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 93: Zeile 356:
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td>Code of a concept or term.</td>
 
   <td>Code of a concept or term.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">codeSystemEntityVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">4</td>
 +
  <td id="param_level4">description</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Description of a term or concept</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 123: Zeile 401:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Translation of a term</td>
 
   <td>Translation of a term</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">5</td>
 +
  <td id="param_level5">codeSystemEntityVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">5</td>
 +
  <td id="param_level5">description</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Description of the translated term.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">5</td>
 +
  <td id="param_level5">id</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 155: Zeile 455:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Connects the version of a Code System to the entities.</td>
 
   <td>Connects the version of a Code System to the entities.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemEntityId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 169: Zeile 483:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..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 id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">orderNr</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>If used, concepts are ordered by the given numbers.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 640: Zeile 961:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Connects the version of a Code System to the entities.</td>
 
   <td>Connects the version of a Code System to the entities.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemEntityId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">codeSystemVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 766: Zeile 1.101:
 
           </codeSystemEntityVersions>
 
           </codeSystemEntityVersions>
 
         </codeSystemEntity>
 
         </codeSystemEntity>
−
+
       
−
         <searchParameter>
+
         <pagingParameter>
 
           <pageSize>5</pageSize>
 
           <pageSize>5</pageSize>
−
           <pageIndex>0</pageIndex>
+
           <pageIndex>100</pageIndex>
 +
        </pagingParameter>
 +
 
 +
        <searchParameter>
 
           <traverseConceptsToRoot>true</traverseConceptsToRoot>
 
           <traverseConceptsToRoot>true</traverseConceptsToRoot>
 
         </searchParameter>
 
         </searchParameter>

Version vom 30. September 2014, 12:20 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

Lists all concepts from a codesystem version. Use filters to limit the results.

Result sets can be very huge (ICD-10 ~ 28,000), therefore it is not recommended to use search without filters.

Search parameter


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 1..1 Name of codesystem. Each codesystem requires at least one version.
2 codeSystemType String 30 - Type of Code System (Taxonomy, Ontology). Possible values are available in domain table with id 6
2 currentVersionId Long - Version of the Code System
2 description String 65535 - Narrative description of Code System
2 id Long - Internal ID = Primary Key of Code System
2 insertTimestamp java.util.Date - Timestamp, when the Code System was inserted
2 name String 100 - 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 codeSystemId Long -
3 description String 65535 - Description of the Code System
3 expirationDate java.util.Date - Point of time the Code System looses its validity.
3 insertTimestamp java.util.Date - Point of time when the Code System Version was inserted.
3 licenceHolder String 65535 - Owner of the licence.
3 name String 100 - Complete Name of the Code System.
3 oid String 100 - Official OID
3 preferredLanguageCd String 30 - Preferred language for this code system. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
3 previousVersionID Long - Refers to the prior version, if there are more than one.
3 releaseDate java.util.Date - Point of time, when this version starts to be valid.
3 source String 65535 - Source of the Code System Version
3 status Integer - Status of the current entry. Can be taken from a domain.
3 statusDate java.util.Date - Point of time of the last change of the status
3 underLicence Boolean - true, if Code System is under license (Code System will be invisible for all users without proper license)
3 validityRange String 30 - Validity range, Values from domain list "codesystem_validityrange". Standard: 1 (required), 2 (recomended), 3 (limited), 4 (optional)
3 versionId Long 1..1
1 codeSystemEntity code_system_entity 0..1 Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version.
2 currentVersionId Long - Current ID of code_system_entity_version.
2 id Long -
2 codeSystemEntityVersion code_system_entity_version 0..1 code_system_entity_version is the superclass of every Concept and Association.
3 codeSystemEntityId Long - Foreign key to code system entities ID
3 effectiveDate java.util.Date - Last change date of the entity version.
3 insertTimestamp java.util.Date - Point in time when entry was inserted.
3 isLeaf Boolean - Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only.
3 majorRevision Integer - Major revision of this entry (composition of major and minor version e.g. 1.3).
3 minorRevision Integer - Minor revision of this entry (composition of major and minor version e.g. 1.3)
3 previousVersionId Long - Refers to the prior version, if there are more than one version.
3 statusDeactivated Integer - Defines the state. Default value is 0 (=visible). Look for available values in the according domain.
3 statusDeactivatedDate java.util.Date - Date when statusDeactivated changed
3 statusVisibility Integer - Status of the current entry. Can be taken from a domain.
3 statusVisibilityDate java.util.Date 0..1 Point of time of the last change of the status. Used for synchronization at this point. All concepts after the given date will be returned.
3 statusWorkflow Integer - A workflow status, can be unique for each codesystem.
3 statusWorkflowDate java.util.Date - Date when statusWorkflow changed
3 versionId Long - The ID of this entry.
3 codeSystemConcept code_system_concept 0..1 Displays a concept or term. Specialization of code_system_entity_version.
4 code String 100 0..1 Code of a concept or term.
4 codeSystemEntityVersionId Long -
4 description String - 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 0..1 The term itself
4 termAbbrevation String 50 0..1 The abbrevation of the term.
4 codeSystemConceptTranslation code_system_concept_translation 0..1 Translation of a term
5 codeSystemEntityVersionId Long -
5 description String - Description of the translated term.
5 id Long -
5 languageCd String 30 0..1 Language of translation. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...) All concepts of this query are translated into this language, if the translation exists.
5 term String 65535 0..1 Translated term
5 termAbbrevation String 50 0..1 Abbreviation of the translated term.
2 codeSystemVersionEntityMembership code_system_version_entity_membership 0..1 Connects the version of a Code System to the entities.
3 codeSystemEntityId Long -
3 codeSystemVersionId Long -
3 isAxis Boolean 0..1 true, if the belonging entity of the entry is an axis of the code system
3 isMainClass Boolean 0..1 true, if the belonging entity of the entry is a root element of the code system.
3 orderNr Long - If used, concepts are ordered by the given numbers.
1 searchParameter SearchType 0..1 Information about the search
2 caseSensitive Boolean 1..1 true if case sensitivity should be considered
2 startsWith Boolean 1..1 true if matching words should start with the search term
2 traverseConceptsToRoot Boolean 1..1 true if all associations should be returned to a concept. Because of a longer duration you should use page size to reduce your results.
2 wholeWords Boolean 1..1 true if the search term must match exactily
1 pagingParameter PagingType 0..1 Specifies the result amount for searching results.
2 allEntries Boolean 0..1 true, if all entries should be returned independent of the system limit. You have to be logged in to use this attribute.
2 pageIndex Integer 1..1 Sets the page index (zero based). When you have a page size of 20 and page index 2, the results 40-59 will be returned.
2 pageSize Integer 1..1 Sets the desired page size. If the value is bigger than the system value it will be reduced. When you have a page size of 20 and page index 2, the results 40-59 will be returned.
1 sortingParameter SortingType 0..1 Determines the assortment. If not given, the concepts are sorted asscending according to the code.
2 sortBy String 0..1 possible values: CODE, TERM default value: CODE
2 sortDirection String 0..1 possible values: ASCENDING, DESCENDING default value: ASCENDING
2 sortType String 0..1 possible values: ALPHABETICALLY, ORDER_NR default value: ALPHABETICALLY
1 lookForward Boolean 0..1 If lookForward is set, information about related concepts are loaded to each concept. If the parametre is "true", "traverseConceptsToRoot" cannot be used.


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 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.
4 codeSystemConceptTranslation code_system_concept_translation 0..1 Translation of a term Returns a translation, if the language was given and the translation exists.
5 codeSystemEntityVersionId Long 1..1
5 description String 1..1 Description of the translated term.
5 id Long 1..1
5 languageCd String 30 1..1 Language of translation. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
5 term String 65535 1..1 Translated term
5 termAbbrevation String 50 1..1 Abbreviation of the translated term.
3 codeSystemEntityVersionAssociation code_system_entity_version_association 0..N Associates two entity versions with each other.
4 associationKind Integer 1..1 1 = ontological,

2 = taxonomic, 3 = cross mapping,

4 = link
4 associationTypeId Long 1..1 Specifies the Type of the association (e.g. 'belongs to')
4 codeSystemEntityVersionId1 Long 1..1 Points to the first entity of the association
4 codeSystemEntityVersionId2 Long 1..1 Points to the second entity of the association
4 id Long 1..1
4 insertTimestamp java.util.Date 1..1 Point of time, when the association was inserted.
4 leftId Long 1..1 Specifies the reading direction of the association, if ID 1 or ID 2 is on the left side. E.g. ID 1 = 12, Id 2 = 14: 12 belongs to 14, or 14 belongs to 12. If the direction should be ID2 -> ID1, forwardName and reverseName have to be reverted as well.
4 status Integer 1..1 Status of the current entry. Can be taken from a domain.
4 statusDate java.util.Date 1..1 Point of time of the last change of the status.
2 codeSystemVersionEntityMembership code_system_version_entity_membership 1..1 Connects the version of a Code System to the entities.
3 codeSystemEntityId Long -
3 codeSystemVersionId Long -
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.
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

Beispiele

SOAP

Lists all concepts from codesystem with version id 32 which are main classes

<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>32</versionId>
          </codeSystemVersions>
        </codeSystem>
        <codeSystemEntity>
          <codeSystemVersionEntityMemberships>
            <isMainClass>true</isMainClass>
          </codeSystemVersionEntityMemberships>
        </codeSystemEntity>
      </parameter>
    </sear:ListCodeSystemConcepts>
  </soapenv:Body>
</soapenv:Envelope>

Search for concepts given a specific term

<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>4</versionId>
          </codeSystemVersions>
          <id>1</id>
        </codeSystem>
        <codeSystemEntity>
          <codeSystemVersionEntityMemberships>
            <isAxis>false</isAxis>
          </codeSystemVersionEntityMemberships>
          <codeSystemEntityVersions>          
            <codeSystemConcepts>          
              <term>Zungen</term>
            </codeSystemConcepts>
          </codeSystemEntityVersions>
        </codeSystemEntity>
      </parameter>
    </sear:ListCodeSystemConcepts>
  </soapenv:Body>
</soapenv:Envelope>

Search with filters

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/" xmlns:de="de.fhdo.termserver.types">
  <soapenv:Header/>
  <soapenv:Body>
    <sear:ListCodeSystemConcepts>
      <parameter>
        <codeSystem>
          <codeSystemVersions>
            <versionId>4</versionId>
          </codeSystemVersions>
          <id>1</id>
        </codeSystem>
 
        <codeSystemEntity>
          <codeSystemEntityVersions>
            <codeSystemConcepts>
              <term>Zunge</term>
              <isPreferred>true</isPreferred>
            </codeSystemConcepts>
          </codeSystemEntityVersions>
        </codeSystemEntity>
 
        <pagingParameter>
          <pageSize>5</pageSize>
          <pageIndex>100</pageIndex>
        </pagingParameter>
 
        <searchParameter>
          <traverseConceptsToRoot>true</traverseConceptsToRoot>
        </searchParameter>
 
        <sortingParameter>
          <sortBy>CODE</sortBy>
          <sortType>ALPHABETICALLY</sortType>
        </sortingParameter>
      </parameter>
    </sear:ListCodeSystemConcepts>
  </soapenv:Body>
</soapenv:Envelope>
 
[Bearbeiten] Code example



zurück zur Webservice-Übersicht

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