WS-Beschreibung - Terminologieserver Search ReturnConceptDetails
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Becker (Diskussion | Beiträge) |
Becker (Diskussion | Beiträge) (→Request/Response) |
||
(3 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
− | + | =Functionality= | |
− | + | Lists all details of the given concept. See response section for more details about the informations returned. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | = | + | =Prerequisites= |
=Request/Response= | =Request/Response= | ||
+ | ==Request== | ||
+ | <table border="1" cellpadding="1" class="ws_table"> | ||
+ | <tr class="ws_table_head"> | ||
+ | <th>Parameter</th> | ||
+ | <th>Typ</th> | ||
+ | <th>Länge</th> | ||
+ | <th id="cardinality_cell">Kardinalität</th> | ||
+ | <th>Beschreibung</th> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level1">LoginType</td> | ||
+ | <td>LoginType</td> | ||
+ | <td></td> <td id="cardinality_cell">0..1</td> | ||
+ | <td>Login information</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level2">sessionID</td> | ||
+ | <td>String</td> | ||
+ | <td></td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Session-ID from user (given by system)</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level1">code_system_entity</td> | ||
+ | <td>code_system_entity</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level2">code_system_entity_version</td> | ||
+ | <td>code_system_entity_version</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>code_system_entity_version is the superclass of every Concept and Association. </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level3">versionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Version-ID of Entity-Version</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | ==Response== | ||
+ | <table border="1" cellpadding="1" class="ws_table"> | ||
+ | <tr class="ws_table_head"> | ||
+ | <th>Parameter</th> | ||
+ | <th>Typ</th> | ||
+ | <th>Länge</th> | ||
+ | <th id="cardinality_cell">Kardinalität</th> | ||
+ | <th>Beschreibung</th> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level1">ReturnType</td> | ||
+ | <td>ReturnType</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Return information</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level2">message</td> | ||
+ | <td>String</td> | ||
+ | <td></td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>an additional message</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level2">overallErrorCategory</td> | ||
+ | <td></td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>INFO, WARN, ERROR</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level2">status</td> | ||
+ | <td></td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>OK, FAILURE</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level1">code_system_entity</td> | ||
+ | <td>code_system_entity</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level2">currentVersionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Current ID of code_system_entity_version.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level2">id</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level2">code_system_entity_version</td> | ||
+ | <td>code_system_entity_version</td> | ||
+ | <td></td> <td id="cardinality_cell">1..N</td> | ||
+ | <td>code_system_entity_version is the superclass of every Concept and Association. </td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level3">effectiveDate</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Point in time of the last change.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level3">insertTimestamp</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Point in time, when entry was inserted.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level3">isLeaf</td> | ||
+ | <td>Boolean</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> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level3">majorRevision</td> | ||
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Major revision of this entry (composition of major and minor version e.g. 1.3).</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level3">minorRevision</td> | ||
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <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="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="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> | ||
+ | <td id="param_level3">versionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Version-ID of Entity-Version</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level3">code_system_concept</td> | ||
+ | <td>code_system_concept</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Displays a concept or term. Specialization of code_system_entity_version.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level4">code</td> | ||
+ | <td>String</td> | ||
+ | <td>100</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Code of a concept or term.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level4">description</td> | ||
+ | <td>String</td> | ||
+ | <td></td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Description of a term or concept</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level4">isPreferred</td> | ||
+ | <td>Boolean</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Specifies, if a term or concept is preferred or not.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level4">term</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>The term itself</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level4">termAbbrevation</td> | ||
+ | <td>String</td> | ||
+ | <td>50</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>The abbrevation of the term.</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level4">code_system_concept_translation</td> | ||
+ | <td>code_system_concept_translation</td> | ||
+ | <td></td> <td id="cardinality_cell">0..N</td> | ||
+ | <td>Translation of a term</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">codeSystemEntityVersionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</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> | ||
+ | <td id="param_level5">id</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">languageId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Language of the translation. Value comes from Domain-Value with Domain-ID 1 (ISO_639_1_Language_Codes)</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">term</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Translated term</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">termAbbrevation</td> | ||
+ | <td>String</td> | ||
+ | <td>50</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Abbreviation of the translated term.</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level3">code_system_metadata_value</td> | ||
+ | <td>code_system_metadata_value</td> | ||
+ | <td></td> <td id="cardinality_cell">0..N</td> | ||
+ | <td>Values of metadata</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level4">id</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level4">parameterValue</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Values of metadata.</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level4">metadata_parameter</td> | ||
+ | <td>metadata_parameter</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Contains an accumulation of meta data. (List of the available descriptions)</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">id</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</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> | ||
+ | <td id="param_level5">paramDatatype</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Data type of the value in code_system_metadata_value.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">paramName</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td>Description of meta data (e.g. measurement unit)</td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level3">property</td> | ||
+ | <td>property</td> | ||
+ | <td></td> <td id="cardinality_cell">0..N</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level4">currentVersionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level4">id</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level4">name</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level4">property_version</td> | ||
+ | <td>property_version</td> | ||
+ | <td></td> <td id="cardinality_cell">1..N</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">content</td> | ||
+ | <td>byte[]</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">contentMimetype</td> | ||
+ | <td>String</td> | ||
+ | <td>50</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">contentName</td> | ||
+ | <td>String</td> | ||
+ | <td>255</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">contentSize</td> | ||
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">description</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">insertTimestamp</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">languageId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">name</td> | ||
+ | <td>String</td> | ||
+ | <td>65535</td> | ||
+ | <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">previousVersionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">propertyKindId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">status</td> | ||
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">statusDate</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level5">versionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr id="row_object"> | ||
+ | <td id="param_level2">code_system_version_entity_membership</td> | ||
+ | <td>code_system_version_entity_membership</td> | ||
+ | <td></td> <td id="cardinality_cell">1..N</td> | ||
+ | <td>Connects the version of a Code System to the entities.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level3">codeSystemVersionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level3">isAxis</td> | ||
+ | <td>Boolean</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>true, if the belonging entity of the entry is an axis of the code system</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="param_level3">isMainClass</td> | ||
+ | <td>Boolean</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> | ||
+ | </tr> | ||
+ | </table> | ||
− | = | + | =Annotations= |
− | == | + | ==Noteworthiness== |
− | + | ==Hints== | |
− | == | + | The result set is small. |
− | + | ||
− | = | + | =Examples= |
− | ==SOAP | + | ==SOAP messages== |
<source lang="xml"> | <source lang="xml"> | ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> | ||
Zeile 50: | Zeile 459: | ||
</source> | </source> | ||
− | ==Code | + | ==Code examples== |
===Java=== | ===Java=== | ||
<source lang="java"> | <source lang="java"> | ||
</source> | </source> |
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>