NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
titleContents of this Page
Table of Contents
minLevel2

 

Topic one

Text

Topic two

...

Introduction

The Asserted Value Set Search is an extension of the LexEVS API. It provides extended options value set searches

  • Text Match
  • Search Algorithm Choices
  • Coding Scheme Restrictions for both original source and target value set
  • Boolean flags for anonymous or active designations on the entity

 

SourceAssertedValueSetSearchExtension Class Diagram

Image Added

LexEVS Asserted Value Set Search  API

LexEVS Asserted Value Set Search Services provides search methods with a variety of inputs

  • Text to Match: unique identifier, presentation, or property value.
  • Algorithm for Match: exact match, contains, lucene query parser type search
  • Coding Scheme Reference: reference to source scheme(s)
  • Coding Scheme Reference: reference to coding scheme representation of a value set
  • Boolean: includes anonymous nodes
  • Boolean: includes inactive nodes

 

Asserted Value Set Search

Code Block
languagejava
 search

 

 

Description:

Lists matching concept reference based on property or presentation text or other matching criteria

Input:

String textMatch: Matching text for presentation, property or unique identifier (code)

Set<CodingSchemeReference> (optional): Coding scheme representation of asserted value set reference

Set<CodingSchemeReference> (not implemented): Resolved Value Sets to Include in search, currently can be included in the asserted group

MatchAlgorithm value: Generally exact or contains matches on text from property, presentation, or code

boolean isAnonymous (optional): Anonymous is normally excluded set to true if you want these included

boolean isActive (optional): Inactive entities are normally excluded but can be flagged for inclusion

Output:

ResolvedConceptRefenerencesIterator:  Iterator over ResolvedConceptRefernences retrieved from the value set

Exception:

LBException

Implementation Details:

Implementation:
Call this method on the on the search extension to query indexes of asserted value sets
Sample Call:

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

    Code Block
        LexBIGService lbsvc;
        SourceAssertedValueSetSearchExtensionImpl assertedVSsvc;
        lbsvc = LexBIGServiceImpl.defaultInstance();
        assertedVSsvc = (SourceAssertedValueSetSearchExtensionImpl) lbsvc
                    .getGenericExtension("AssertedValueSetSearchExtension");
    
  • Step 2: List all the coding scheme representations of the value sets

    Code Block
    //Instantiate a relevant value set coding scheme reference
    Set<CodingSchemeReference> refs = new HashSet<CodingSchemeReference>();
    CodingSchemeReference r = new CodingSchemeReference();
    r.setCodingScheme("http://evs.nci.nih.gov/valueset/FDA/C111112");
    refs.add(r);
    //Resolve a set of results as an iterator
    ResolvedConceptReferencesIterator itr = assertedVSsvc.
         search("red", refs, null,
          MatchAlgorithm.PROPERTY_EXACT, false, false);