Value Sets
In LexEVS 6.2 CTS2, the following profile was implemented:
Structural Profile: Value Set
- Functional Profile: Read
- Functional Profile: Query
Value Set Read Methods
The following CTS2 Value Set Read services have been implemented:
http://<base url>/valuesets
http://<base url>/valueset/<value set name>/definition/<value set id>
http://<base url>/valueset/<value set name>/definition/<value set id>/resolution
Value Set Query Methods
The following CTS2 Value Set Query services have been implemented:
http://<base url>/valuesets?matchvalue=<search string>
Entities Active Flag
LexEVS 6.2 CTS2 service accepts an "active" flag for entities. If no flag is present, the LexEVS 6.2 CTS2 service will return only active entities.
The two options for the active flag are:
- ACTIVE_ONLY - The inquiry only applies to ACTIVE entries.
- ACTIVE_AND_INACTIVE - The inquiry applies to both ACTIVE and INACTIVE entries
http://<base url>/codesystem/Automobiles/version/1.0/entities?active=ACTIVE_ONLY
http://<base url>/codesystem/Automobiles/version/1.0/entities?active=ACTIVE_AND_INACTIVE
CTS2 Landing Page Configuration
The existing CTS2 landing page (http://<server name>/cts2) redirected to the CTS2 Framework homepage. LexEVS 6.2 CTS2 service allows the CTS2 landing page to redirect to an alternate page.
To add an alternate homepage, the following optional properties file will need to be created (if it is not already):
webapp-config.properties
- Create this new (optional properties file) in $USER_HOME/.cts2/[context]/config
This webapp-config.properties file should, at a minimum, include the following lines:
service.pid=edu.mayo.cts2.framework.webapp.rest.config alternateHomePage=<URL to alternate location>
Value Set Client Prototype
The NCI CTS2 Value Set Viewer client will expect the CTS2 Value Set Services to adhere to the a "Client Profile" listed below:
- CTS2 Version 1.1
- CTS2 Standard JSON
- Structural Profile: Value Set
- Functional Profile: Read
- Structural Profile: Value Set Definition
- Functional Profile: Read
- Functional Profile: Resolution
Value Set Client UI Design DetailsThis UI will initially be hosted at Mayo on Informatics
UI will use CTS2 1.1 based services and will expect a CTS2 JSON rendering to be returned.
UI will provide access to the following CTS2 Services:
- TLAMP (CTS2 1.1)
- NLM (CTS2 1.0)
- LexEVS (CTS2 1.1)
For the CTS2 Services at 1.0, the client will transform the CTS2 1.0 XML to CTS2 1.1 XML. This will then be transformed to CTS2 Standard JSON. This JSON will be the same as what CTS2 1.1 Services are returning.
UI will have the following features:
- Drop down to select a CTS2 Service.
- Provide list of Value Sets available in selected service.
- Provide list of Value sets entities in a selected Value Set.
- There is no search of value sets or value set entries.
- A single value set can be downloaded into CTS2 XML format.
Value Set Table
- Selecting a CTS2 Service from the drop down will make a request (valuesets) and will return a ValueSetCatalogEntryDirectory.
- These value sets from the ValueSetCatalogEntryDirectory will be displayed in a table.
- Since there is no search, all value sets will be returned.
- There will initially be client side paging.
- Each value set in the table will have a download button on it. Value sets can be downloaded one at a time.
- Format is CTS2 XML
- The columns displayed will be:
- Value Set Name
- Description
- Download
Value Set Entries Table
- Selecting a row in the value set table will make a request (ValueSetDefinitionResolution) to retrieve IteratableResolvedValueSet.
- This table will be to the left of the value set table.
- The columns for this table will be:
- Code
- Code System (Vocabulary)
- Description (Name)
Architecture
