 |
Page History
...
The Pre-CTS2 API is split into three major operations:
...
- Administration Operation: This is a set of functionality that provides the ability to manage content as part of a terminology service. Administration functions include the ability to load terminologies, export terminologies, activate terminologies, and retire terminologies. These functions are generally protected and accessible by service administrators with appropriate authorization. Administration Operation also includes Notification service.
...
- Query/Search Operation: This is a set of functionality that provides the ability to find contents based on some search criteria. This includes restrictions to specific associations or other attributes of the terminology, including navigation of associations for result sets. This represents the primary utility for using terminology content in a number of application contexts.
...
- Authoring Operation: This is a set of functionality that provides the ability to create and maintain content. From a terminology service perspective, this would include the appropriate APIs to add, change, or delete concepts, associations etc. This would also include the processing of change events from various terminology providers.
Here is a overview diagram depicting CTS 2 API architecture:
LexEVS Pre-CTS2 Interface
org.lexevs.cts2.LexEVSCTS2 is the main interface that external API can use to access all the functions and services available in LexEVS CTS 2 implementation.
...
Using this interface, method calls can be made to get handle of three major CTS 2 operations i.e.Administration, Query and Authoring plus few utility methods:
...
- getAdminOperation() - Returns LexEVS implementation of CTS2 Administration Operations.
...
- getAuthoringOperation() - Returns LexEVS implementation of CTS Authoring Operations.
...
- getQueryOperation() - Returns LexEVS implementation of CTS Query Operations.
...
...
- getServiceInfo() - Returns service provider information.
...
- getSupportedSearchAlgorithms() - Returns list of Search Algorithms supported by this LexEVS instance.
...
- getSupportedLoaders() - Returns list of Loaders supported by this LexEVS instance.
...
- getSupportedExporters() - Returns list of Exporters supported by this LexEVS instance.
...
- getSupportedSearchAlgorithmNames() - Returns list of Search Algorithm names supported by this LexEVS instance.
...
- getSupportedLoaderNames() - Returns list of Loader names supported by this LexEVS instance.
...
- getSupportedExporterNames() - Returns list of Exporter names supported by this LexEVS instance.
Administration Operation
The Administration Operation provides the ability to manage content as part of a terminology service. This include the ability to load terminologies, export terminologies, activate terminologies, and retire terminologies. These functions are generally protected and accessible by service administrators with appropriate authorization. Administration Operation also includes Notification service.
org.lexevs.cts2.admin.AdminOperation is the main interface for all the administration operations.
...
The Authoring Operation provides the capability to author terminology contents like concepts, value sets, concept domain etc., using LexEVS CTS 2 API.
org.lexevs.cts2.author.AuthoringOperation is the main interface for all the authoring operations.
...
Following are the authoring operations that can be performed on terminology contents(like: code system, concept, value set, concept domain etc):
...
...
- Create - Capability to create a new entry. Ex: Adding new concept to a code system, adding new property to a concept etc.,
...
- Edit - Capability to edit attributes of existing entry. After each edit, the version of the changed entry will be changed. Entry state of each version will be saved.
...
- Remove - Capability to remove an existing entry. This operation will permanently remove entry from the system.
...
- Versionable Changes - Status, Effective Date, Expiration Date, etc are the Versionable attributes of an entity. This operation provides capability to modify versionable attributes of an entity. Ex : Status of a concept can be changed to 'Retired', deactivate a concept etc.
Authoring Operation APIs
The above authoring operations can be performed on following terminology contents:
...
...
- Association
...
- Code System
...
- Concept Domain
...
- Usage Context
...
- Value Set
These APIs are outlined below.
Association Authoring Operation API
...
