WS-Beschreibung - Terminologieserver Search ReturnConceptDetails

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(Request/Response)
 
Zeile 16: Zeile 16:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">LoginType</td>
 
   <td id="param_level1">LoginType</td>
   <td></td>
+
   <td>LoginType</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
   <td>Login-Informationen</td>
+
   <td>Login information</td>
</tr>
+
<tr id="gray">
+
  <td id="param_level2">ip</td>
+
  <td>String</td>
+
  <td></td>
+
  <td id="cardinality_cell">-</td>
+
  <td>Die IP-Adresse des Benutzers (wird intern vergeben)</td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level2">password</td>
+
  <td>String</td>
+
  <td></td>
+
  <td id="cardinality_cell">-</td>
+
  <td>Passwort des Benutzers (als MD5-Wert)</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 39: Zeile 25:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td>Die Session-ID des Benutzers</td>
+
   <td>Session-ID from user (given by system)</td>
</tr>
+
<tr id="gray">
+
  <td id="param_level2">username</td>
+
  <td>String</td>
+
  <td></td>
+
  <td id="cardinality_cell">-</td>
+
  <td>Benutzername</td>
+
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">code_system_entity</td>
 
   <td id="param_level1">code_system_entity</td>
   <td></td>
+
   <td>code_system_entity</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.</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="param_level2">currentVersionId</td>
+
  <td>Long</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Die aktuelle ID der code_system_entity_version</td>
+
</tr>
+
<tr id="gray">
+
  <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">
 
   <td id="param_level2">code_system_entity_version</td>
 
   <td id="param_level2">code_system_entity_version</td>
   <td></td>
+
   <td>code_system_entity_version</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung.</td>
+
   <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
</tr>
+
<tr id="gray">
+
  <td id="param_level3">codeSystemEntityId</td>
+
  <td>Long</td>
+
<td></td> <td id="cardinality_cell">-</td>
+
  <td></td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level3">effectiveDate</td>
+
  <td>java.util.Date</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Zeitpunkt der letzten Änderung</td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level3">insertTimestamp</td>
+
  <td>java.util.Date</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Zeitstempel, wann der Eintrag eingefügt worden ist</td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level3">isLeaf</td>
+
  <td>Boolean</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden.</td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level3">majorRevision</td>
+
  <td>Integer</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level3">minorRevision</td>
+
  <td>Integer</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level3">previousVersionId</td>
+
  <td>Long</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.</td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level3">status</td>
+
  <td>Integer</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
</tr>
+
<tr id="gray">
+
  <td id="param_level3">statusDate</td>
+
  <td>java.util.Date</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Änderungszeitpunkt des Status</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 130: Zeile 43:
 
   <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>Version-ID of Entity-Version</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Zeile 144: Zeile 57:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">ReturnType</td>
 
   <td id="param_level1">ReturnType</td>
   <td></td>
+
   <td>ReturnType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Entählt Informationen über die Antwort.</td>
+
   <td>Return information</td>
</tr>
+
<tr id="gray">
+
  <td id="param_level2">count</td>
+
  <td>Integer</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Anzahl der Ergebnisse</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 159: Zeile 66:
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td>Status- oder Fehlermeldung</td>
+
   <td>an additional message</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 175: Zeile 82:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level1">code_system_entity</td>
 
   <td id="param_level1">code_system_entity</td>
   <td></td>
+
   <td>code_system_entity</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Abstrakte Klasse. Eine Eintrag muss mindestens einen Eintrag in code_system_entity_version besitzen.</td>
+
   <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 183: Zeile 90:
 
   <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>Die aktuelle ID der code_system_entity_version</td>
+
   <td>Current ID of code_system_entity_version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 193: Zeile 100:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level2">code_system_entity_version</td>
 
   <td id="param_level2">code_system_entity_version</td>
   <td></td>
+
   <td>code_system_entity_version</td>
 
<td></td>  <td id="cardinality_cell">1..N</td>
 
<td></td>  <td id="cardinality_cell">1..N</td>
   <td>Ein code_system_entity_version ist die Oberklasse entweder eines Begriffs oder einer Beziehung.</td>
+
   <td>code_system_entity_version is the superclass of every Concept and Association.  </td>
</tr>
+
<tr id="gray">
+
  <td id="param_level3">codeSystemEntityId</td>
+
  <td>Long</td>
+
<td></td> <td id="cardinality_cell">-</td>
+
  <td></td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 207: Zeile 108:
 
   <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>Zeitpunkt der letzten Änderung</td>
+
   <td>Point in time of the last change.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 213: Zeile 114:
 
   <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>Zeitstempel, wann der Eintrag eingefügt worden ist</td>
+
   <td>Point in time, when entry was inserted.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 219: Zeile 120:
 
   <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>Gibt an, wenn ein Begriff das Blattelement ist. Dieser Wert wird durch Trigger gesetzt, kann also nur gelesen werden.</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>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 225: Zeile 126:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Hauptversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
+
   <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 231: Zeile 132:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Nebenversion dieses Eintrags (Zusammensetzung aus Haupt- und Nebenversion, z.B. 1.3)</td>
+
   <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 237: Zeile 138:
 
   <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>Gibt es mehr als 1 Version, zeigt diese ID auf die vorherige Version.</td>
+
   <td>Refers to the prior version, if there are more than one version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 243: Zeile 144:
 
   <td>Integer</td>
 
   <td>Integer</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Der Status des aktuellen Eintrags. Kann einer Domäne entnommen werden.</td>
+
   <td>Status of the current entry. Can be taken from a domain.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 249: Zeile 150:
 
   <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>Änderungszeitpunkt des Status</td>
+
   <td>Point of time of the last change of the status.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 255: Zeile 156:
 
   <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>Version-ID of Entity-Version</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level3">code_system_concept</td>
 
   <td id="param_level3">code_system_concept</td>
   <td></td>
+
   <td>code_system_concept</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Stellt ein Konzept bzw. ein Begriff dar. Speziealisierung von code_system_entity_version.</td>
+
   <td>Displays a concept or term. Specialization of code_system_entity_version.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 268: Zeile 169:
 
   <td>100</td>
 
   <td>100</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td></td>
+
   <td>Code of a concept or term.</td>
 
</tr>
 
</tr>
<tr id="gray">
+
<tr>
   <td id="param_level4">codeSystemEntityVersionId</td>
+
   <td id="param_level4">description</td>
   <td>Long</td>
+
   <td>String</td>
<td></td>  <td id="cardinality_cell">-</td>
+
 
   <td></td>
 
   <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Description of a term or concept</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 280: Zeile 182:
 
   <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></td>
+
   <td>Specifies, if a term or concept is preferred or not.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 287: Zeile 189:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td></td>
+
   <td>The term itself</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 294: Zeile 196:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td></td>
+
   <td>The abbrevation of the term.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level4">code_system_concept_translation</td>
 
   <td id="param_level4">code_system_concept_translation</td>
   <td></td>
+
   <td>code_system_concept_translation</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
   <td>Übersetzung eines Begriffs.</td>
+
   <td>Translation of a term</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 307: Zeile 209:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td></td>
 
   <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">description</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Description of the translated term.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 318: Zeile 227:
 
   <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>Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 325: Zeile 234:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td></td>
+
   <td>Translated term</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 332: Zeile 241:
 
   <td>50</td>
 
   <td>50</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td></td>
+
   <td>Abbreviation of the translated term.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level3">code_system_metadata_value</td>
 
   <td id="param_level3">code_system_metadata_value</td>
   <td></td>
+
   <td>code_system_metadata_value</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
   <td>Ausprägung von Metadaten</td>
+
   <td>Values of metadata</td>
</tr>
+
<tr id="gray">
+
  <td id="param_level4">codeSystemEntityVersionId</td>
+
  <td>Long</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td>Gibt an, zu welchem Entity dieser Eintrag gehört</td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 351: Zeile 254:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td></td>
 
   <td></td>
</tr>
 
<tr id="gray">
 
  <td id="param_level4">metadataParameterId</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
  <td>Gibt an, auf welches Metadata sich der Wert bezieht</td>
 
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 363: Zeile 260:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td>Werte von Metadaten</td>
+
   <td>Values of metadata.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level4">metadata_parameter</td>
 
   <td id="param_level4">metadata_parameter</td>
   <td></td>
+
   <td>metadata_parameter</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
   <td>Umfasst Sammlung von Metadaten (Liste der verfügbaren Bezeichnungen)</td>
+
   <td>Contains an accumulation of meta data. (List of the available descriptions)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 376: Zeile 273:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td></td>
 
   <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="param_level5">metadataParameterType</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">1..1</td>
 +
  <td>Type of the meta data. A possible list of values is contained in the domain table.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 382: Zeile 286:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td>Datentyp des Wertes, der in code_system_metadata_value steht.</td>
+
   <td>Data type of the value in code_system_metadata_value.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 389: Zeile 293:
 
   <td>65535</td>
 
   <td>65535</td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
   <td>Bezeichnung von Metadaten (z.B. Einheit)</td>
+
   <td>Description of meta data (e.g. measurement unit)</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level3">property</td>
 
   <td id="param_level3">property</td>
   <td></td>
+
   <td>property</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
<td></td>  <td id="cardinality_cell">0..N</td>
 
   <td></td>
 
   <td></td>
Zeile 409: Zeile 313:
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
<tr id="gray">
+
<tr>
 
   <td id="param_level4">name</td>
 
   <td id="param_level4">name</td>
 
   <td>String</td>
 
   <td>String</td>
 
   <td>65535</td>
 
   <td>65535</td>
   <td id="cardinality_cell">-</td>
+
   <td id="cardinality_cell">1..1</td>
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level4">property_version</td>
 
   <td id="param_level4">property_version</td>
   <td></td>
+
   <td>property_version</td>
 
<td></td>  <td id="cardinality_cell">1..N</td>
 
<td></td>  <td id="cardinality_cell">1..N</td>
  <td></td>
 
</tr>
 
<tr id="gray">
 
  <td id="param_level5">codeSystemEntityVersionId</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
Zeile 484: Zeile 382:
 
   <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>
 
</tr>
 
<tr id="gray">
 
  <td id="param_level5">propertyId</td>
 
  <td>Long</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
 
   <td></td>
 
   <td></td>
 
</tr>
 
</tr>
Zeile 518: Zeile 410:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="param_level2">code_system_version_entity_membership</td>
 
   <td id="param_level2">code_system_version_entity_membership</td>
   <td></td>
+
   <td>code_system_version_entity_membership</td>
 
<td></td>  <td id="cardinality_cell">1..N</td>
 
<td></td>  <td id="cardinality_cell">1..N</td>
   <td>Stellt die Verknüpfung zwischen einer Codesystem-Version und den Entitäten her.</td>
+
   <td>Connects the version of a Code System to the entities.</td>
</tr>
+
<tr id="gray">
+
  <td id="param_level3">codeSystemEntityId</td>
+
  <td>Long</td>
+
<td></td>  <td id="cardinality_cell">-</td>
+
  <td></td>
+
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 538: Zeile 424:
 
   <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>true, wenn die zugehörige Entity des Eintrags eine Achse des Codesystems ist</td>
+
   <td>true, if the belonging entity of the entry is an axis of the code system</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 544: Zeile 430:
 
   <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>true, wenn die zugehörige Entity des Eintrags eine Hauptklasse (root-Element) des Codesystems ist</td>
+
   <td>true, if the belonging entity of the entry is a root element of the code system.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>

Aktuelle Version vom 9. August 2013, 09:30 Uhr

Inhaltsverzeichnis

Functionality

Lists all details of the given concept. See response section for more details about the informations returned.

Prerequisites

Request/Response

Request

Parameter Typ Länge Kardinalität Beschreibung
LoginType LoginType 0..1 Login information
sessionID String 1..1 Session-ID from user (given by system)
code_system_entity code_system_entity 1..1 Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version.
code_system_entity_version code_system_entity_version 1..1 code_system_entity_version is the superclass of every Concept and Association.
versionId Long 1..1 Version-ID of Entity-Version

Response

Parameter Typ Länge Kardinalität Beschreibung
ReturnType ReturnType 1..1 Return information
message String 1..1 an additional message
overallErrorCategory 1..1 INFO, WARN, ERROR
status 1..1 OK, FAILURE
code_system_entity code_system_entity 1..1 Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version.
currentVersionId Long 1..1 Current ID of code_system_entity_version.
id Long 1..1
code_system_entity_version code_system_entity_version 1..N code_system_entity_version is the superclass of every Concept and Association.
effectiveDate java.util.Date 1..1 Point in time of the last change.
insertTimestamp java.util.Date 1..1 Point in time, when entry was inserted.
isLeaf Boolean 1..1 Indicates if a concept is a leaf element or not. Value will be set by a trigger and is therefore read only.
majorRevision Integer 1..1 Major revision of this entry (composition of major and minor version e.g. 1.3).
minorRevision Integer 1..1 Minor revision of this entry (composition of major and minor version e.g. 1.3)
previousVersionId Long 1..1 Refers to the prior version, if there are more than one version.
status Integer 1..1 Status of the current entry. Can be taken from a domain.
statusDate java.util.Date 1..1 Point of time of the last change of the status.
versionId Long 1..1 Version-ID of Entity-Version
code_system_concept code_system_concept 1..1 Displays a concept or term. Specialization of code_system_entity_version.
code String 100 1..1 Code of a concept or term.
description String 1..1 Description of a term or concept
isPreferred Boolean 1..1 Specifies, if a term or concept is preferred or not.
term String 65535 1..1 The term itself
termAbbrevation String 50 1..1 The abbrevation of the term.
code_system_concept_translation code_system_concept_translation 0..N Translation of a term
codeSystemEntityVersionId Long 1..1
description String 1..1 Description of the translated term.
id Long 1..1
languageId Long 1..1 Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes)
term String 65535 1..1 Translated term
termAbbrevation String 50 1..1 Abbreviation of the translated term.
code_system_metadata_value code_system_metadata_value 0..N Values of metadata
id Long 1..1
parameterValue String 65535 1..1 Values of metadata.
metadata_parameter metadata_parameter 1..1 Contains an accumulation of meta data. (List of the available descriptions)
id Long 1..1
metadataParameterType String 30 1..1 Type of the meta data. A possible list of values is contained in the domain table.
paramDatatype String 65535 1..1 Data type of the value in code_system_metadata_value.
paramName String 65535 1..1 Description of meta data (e.g. measurement unit)
property property 0..N
currentVersionId Long 1..1
id Long 1..1
name String 65535 1..1
property_version property_version 1..N
content byte[] 1..1
contentMimetype String 50 1..1
contentName String 255 1..1
contentSize Integer 1..1
description String 65535 1..1
insertTimestamp java.util.Date 1..1
languageId Long 1..1
name String 65535 1..1
previousVersionId Long 1..1
propertyKindId Long 1..1
status Integer 1..1
statusDate java.util.Date 1..1
versionId Long 1..1
code_system_version_entity_membership code_system_version_entity_membership 1..N Connects the version of a Code System to the entities.
codeSystemVersionId Long 1..1
isAxis Boolean 1..1 true, if the belonging entity of the entry is an axis of the code system
isMainClass Boolean 1..1 true, if the belonging entity of the entry is a root element of the code system.

Annotations

Noteworthiness

Hints

The result set is small.

Examples

SOAP messages

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
  <soapenv:Header/>
   <soapenv:Body>
    <sear:ReturnConceptDetails>
       <parameter>
          <codeSystemEntity>  
	     <id>2114</id>       
	     <codeSystemEntityVersions> 
		<versionId>2114</versionId>             			         
             </codeSystemEntityVersions>
          </codeSystemEntity>
       </parameter>
    </sear:ReturnConceptDetails>
   </soapenv:Body>
</soapenv:Envelope>

Code examples

Java

 
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge