Terminologieserver - Authoring - CreateConceptAssociationType
Aus Termserver-CTS2
Version vom 30. September 2014, 12:19 Uhr von Muetzner (Diskussion | Beiträge)
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Create a new association type.
If a code system is specified, the new association type will be available in that code system only. Otherwise it will be available in all code systems.
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 | 0..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 | associationType | association_type | 1..1 | Name of an association. Specialization of code_system_entity_version. The codeSystemEntityVersionId is the same as the versionId of code_system_entity_version | |
| 4 | codeSystemEntityVersionId | Long | - | Match to the versionId of code_system_entity_version | |
| 4 | forwardName | String | 50 | 1..1 | Name of association in normal reading direction (ID 1->2) |
| 4 | reverseName | String | 50 | 1..1 | Name of association in reversed reading direction (ID 2->1) |
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 new association without relation to a code system
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:CreateConceptAssociationType> <parameter> <codeSystemEntity> <codeSystemEntityVersions> <associationTypes> <forwardName>Vor</forwardName> <reverseName>Zurück</reverseName> </associationTypes> </codeSystemEntityVersions> </codeSystemEntity> <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> </parameter> </aut:CreateConceptAssociationType> </soapenv:Body> </soapenv:Envelope>
