Terminologieserver - Authoring - CreateConcept
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
||
Zeile 28: | Zeile 28: | ||
<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> | ||
<tr> | <tr> | ||
Zeile 58: | Zeile 35: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td>Internal ID = Primary Key of Code System</td> | <td>Internal ID = Primary Key of Code System</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 80: | Zeile 42: | ||
<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> | ||
<tr> | <tr> | ||
Zeile 207: | Zeile 56: | ||
<td></td> <td id="cardinality_cell">1..1</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> | <td>Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. </td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 228: | Zeile 63: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..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> | ||
<tr> | <tr> | ||
Zeile 270: | Zeile 77: | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
<td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td> | <td>Minor revision of this entry (composition of major and minor version e.g. 1.3)</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 341: | Zeile 92: | ||
<td id="cardinality_cell">1..1</td> | <td id="cardinality_cell">1..1</td> | ||
<td>Code of a concept or term.</td> | <td>Code of a concept or term.</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 386: | Zeile 122: | ||
<td></td> <td id="cardinality_cell">0..N</td> | <td></td> <td id="cardinality_cell">0..N</td> | ||
<td>Translation of a term</td> | <td>Translation of a term</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 439: | Zeile 153: | ||
<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> | ||
<tr> | <tr> | ||
Zeile 467: | Zeile 167: | ||
<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> | ||
</table> | </table> | ||
Zeile 493: | Zeile 186: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td>Return information</td> | <td>Return information</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 550: | Zeile 236: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..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> | ||
<tr> | <tr> |
Aktuelle Version vom 30. September 2014, 12:30 Uhr
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Adds new concepts to the specified and existing code system version.
Request/Response
Request
Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|---|
1 | loginToken | String | 1..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 | id | Long | 1..1 | Internal ID = Primary Key of Code System | |
2 | codeSystemVersion | code_system_version | 1..1 | Version of a Code System | |
3 | versionId | Long | 1..1 | ||
1 | codeSystemEntity | code_system_entity | 1..1 | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
2 | codeSystemEntityVersion | code_system_entity_version | 1..1 | code_system_entity_version is the superclass of every Concept and Association. | |
3 | majorRevision | Integer | 0..1 | Major revision of this entry (composition of major and minor version e.g. 1.3). | |
3 | minorRevision | Integer | 0..1 | Minor revision of this entry (composition of major and minor version e.g. 1.3) | |
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 | 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 | 0..1 | The abbrevation of the term. |
4 | codeSystemConceptTranslation | code_system_concept_translation | 0..N | Translation of a term | |
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 | 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 | 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. |
Response
Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|---|
1 | returnInfos | ReturnType | 1..1 | Return information | |
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 | 1..1 | 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 | versionId | Long | 1..1 | The ID of this entry. |
Beispiele
SOAP
Create a simple concept
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:CreateConcept> <parameter> <codeSystem> <id>1</id> <codeSystemVersions> <versionId>1</versionId> </codeSystemVersions> </codeSystem> <codeSystemEntity> <codeSystemEntityVersions> <codeSystemConcepts> <code>x</code> <term>y</term> <isPreferred>true</isPreferred> </codeSystemConcepts> </codeSystemEntityVersions> </codeSystemEntity> <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> </parameter> </aut:CreateConcept> </soapenv:Body> </soapenv:Envelope>