Terminologieserver - Authoring - CreateConcept
Aus Termserver-CTS2
Version vom 30. September 2014, 12:19 Uhr von Muetzner (Diskussion | Beiträge)
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 | 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 | 1..1 | 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 | 1..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 | 1..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 | 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 | 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 | - | Point of time of the last change of the status. | |
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 | 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 | - | ||
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 | 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 | codeSystemEntityVersionId | Long | - | ||
5 | description | String | - | Description of the translated term. | |
5 | id | Long | - | ||
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 | 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 | - | If used, concepts are ordered by the given numbers. |
Response
Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|---|
1 | returnInfos | ReturnType | 1..1 | Return information | |
2 | count | Integer | - | 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 | 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 | 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 | - | Point of time of the last change of the status. | |
3 | statusWorkflow | Integer | - | A workflow status, can be unique for each codesystem. | |
3 | statusWorkflowDate | java.util.Date | - | Date when statusWorkflow changed | |
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>