|
The LexEVS Pre-CTS2 API provides programmatic access to LexEVS 6.0 implementation of CTS 2 features and services. Developers can build custom applications, tools, and services that can make calls as per CTS 2 specification against LexEVS CTS 2 API.
Visit Common Terminology Services 2 for services description, purpose and scope of CTS 2 specification.
The Pre-CTS2 API is split into three major operations:
Here is a overview diagram depicting CTS 2 API architecture:
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.
org.lexevs.cts2.LexEvsCTS2 cts2 = org.lexevs.cts2.LexEvsCTS2Impl.defaultInstance(); |
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:
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.
org.lexevs.cts2.LexEvsCTS2 cts2 = org.lexevs.cts2.LexEvsCTS2Impl.defaultInstance(); org.lexevs.cts2.admin.AdminOperation adminOp = cts2.getAdminOperation(); |
Administration Operation is comprised of three major APIs outlined below.
Load Operation provides ability to load complete or incremental update of Code System, Value Sets and Associations contents. It also provides capability to activate and deactivate loaded contents.
Export Operation provides ability to export complete or partial contents of Code System, Value Sets or Associations.
Notification Operation provides ability to listen for various content-related events.
The Query Operation provides the ability to query content that are available in the terminology services.
org.lexevs.cts2.query.QueryOperation
is the main interface for all the query operations.
org.lexevs.cts2.LexEvsCTS2 cts2 = org.lexevs.cts2.LexEvsCTS2Impl.defaultInstance(); org.lexevs.cts2.query.QueryOperation queryOp = cts2.getQueryOperation(); |
Query Operation is comprised of five major APIs outlined below.
Provides an interface to query associations.
Provides an interface to query code system contents that are available in the system.
Provides an interface to query concept domain as well as any binding between the concept domain and the value sets.
Provides an interface to query usage context contents that are available in the system.
Provides an interface to query value set contents that are available in the system.
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.
org.lexevs.cts2.LexEvsCTS2 cts2 = org.lexevs.cts2.LexEvsCTS2Impl.defaultInstance(); org.lexevs.cts2.author.AuthoringOperation authorOp = cts2.getAuthoringOperation(); |
Following are the authoring operations that can be performed on terminology contents(like: code system, concept, value set, concept domain etc):
The above authoring operations can be performed on following terminology contents:
These APIs are outlined below.
Provides an interface to author association.
Provides an interface to author code system contents.
Provides an interface to author concept domain.
Provides an interface to author usage context.
Provides an interface to author value set.