NIH | National Cancer Institute | NCI Wiki  

WIKI MAINTENANCE NOTICE

Please be advised that NCI Wiki will be undergoing maintenance Monday, July 22nd between 1700 ET and 1800 ET and will be unavailable during this period.
Please ensure all work is saved before said time.

If you have any questions or concerns, please contact the CBIIT Atlassian Management Team.

Error rendering macro 'rw-search'

null

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Introduction

The Asserted Value Set services are integrated parts of the LexEVS API. It provide several functions:

Getting Source Asserted Value Sets as CodingScheme or Coding Scheme reference objects

Getting the entities of Source Asserted Value Sets as ResolvedConceptReference objects as Lists or Iterators

Getting a list of all unique identifiers of value set top nodes from this source terminology

Getting a list of all schemes used to resolve a given set of values from a resolved value set coding scheme

Most coding scheme representations and entity reference sets are resolved by the unique URL of the coding scheme.  Some allow a definition of a concept or text match.  All methods offer a resolution service to some set of values.  These mechanisms are largely read functions requiring a listing of known values or an exact match of a unique identifier.  Only one offers what could be classified as a search. 

 

SourceAssertedValueSetService Class Diagram

 

LexEVS Asserted Value Set Definition Services API

LexEVS Value Set Definition Services provides three major functions:

  • List function
  • Read function
  • Search function

Each of these functions are described in following sections.

 

List Functions

  • List all value sets as coding schemes
  • List all value set entities in the asserted source system

List All Value Sets As Fully Populated Coding Schemes

listAllSourceAssertedValueSets()

Description:

Lists all coding schemes each with its own entity set fully resolved

Input:

none

Output:

List<CodingScheme>

Exception:

LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Asserted Value Set service instance to list a full set of coding schemes along with all of their entities
Sample Call:

  • Step 1:Instantiate SourceAssertedValueSetService if it is not done yet:

    org.lexgrid.valuesets.SourceAssertedValueSetServiceImpl  assVSServ = new SourceAssertedValueSetServiceImpl(new AssertedValueSetParameters.Builder().build());

  • Step 2: List all the coding scheme representations of the value sets

    List<CodingScheme> schemes = assVSService.listAllSourceAssertedValueSets();

     

     

 

List all Coding Schemes without entities

getMinimalSourceAssertedValueSetSchemes()

Description:

Lists all coding schemes – no entities resolved

Input:

none

Output:

List<CodingScheme>

Exception:

LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Asserted Value Set service instance to list a full set of coding schemes along with all of their entities
Sample Call:

  • Step 1:Instantiate SourceAssertedValueSetService if it is not done yet:

    org.lexgrid.valuesets.SourceAssertedValueSetServiceImpl  assVSServ = new SourceAssertedValueSetServiceImpl(new AssertedValueSetParameters.Builder().build());

  • Step 2: List all the coding scheme representations of the value sets

    List<CodingScheme> schemes = assVSService.getMinimalSourceAssertedValueSetSchemes();

     

     

Coding Scheme Read Functions

  • Get value sets by concept reference - Input an object that matches namespace and unique code of a value set member to return a list of containing schemes
  • Get value sets by entity code - input is entity code only, no namespace is defined to read the value set that contains this as a value set member
  • Get a single value set for its unique URI - The input should be an unique identifier for a coding scheme representation of a value set in the system
  • Get a value set or value sets defined by a unique entity - The input is a unique entity code that identifies the top node of a given value set
  • Get scheme references for a coding scheme representation - Pulls from a coding scheme those schemes from which the entities of the coding scheme representation of the value set is derived.

Get Value Sets by Concept Reference

getSourceAssertedValueSetsForConceptReference(ConceptReference ref)

Description:

Lists all coding schemes containing a particular concept reference

Input:

ConceptReference ref - Configurable to contain both the unique identifier and the namespace of the target coding scheme (both are tied to the asserting source in this case)

Output:

List<CodingScheme>

Exception:

none

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Asserted Value Set service instance to list a full set of coding schemes along with all of their entities
Sample Call:

  • Step 1:Instantiate SourceAssertedValueSetService if it is not done yet:

    org.lexgrid.valuesets.SourceAssertedValueSetServiceImpl  assVSServ = new SourceAssertedValueSetServiceImpl(new AssertedValueSetParameters.Builder().build());

  • Step 2: Construct the ConceptReference object:

    ConceptReference ref = new ConceptReference();
ref.setConceptCode("C1234");
ref.setCodeNamespace("ncit");

  • Step 3: List all the coding scheme representations of the value sets

    List<CodingScheme> schemes = getSourceAssertedValueSetsForConceptReference(ref)

Resolved Concept Reference Read Functions

  • Get references for unique URI identifier - Unique identifier returns all value set members of that coding scheme representation of a value set.
  • Get a string unique identifier of a reference that is a top node - All top nodes of a system are returned based on the identification of the node that has a reference to the top of the hierarchy

Search Function

  • Get value set coding scheme reference based on a text match for a member entity - Can be used with a text match algorithm determining match type.

 

 

 

  • No labels