NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Old Version 21

changes.mady.by.user Bauer, Scott (NIH/NCI) [C]

Saved on

compared with

New Version 22

changes.mady.by.user Bauer, Scott (NIH/NCI) [C]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejava
listAllSourceAssertedValueSets()

Description:

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

Input:

none

Output:

List<CodingScheme>

Exception:

LBException

Implementation Details:

Implementation:
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:

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

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

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

     

     

...

Code Block
languagejava
getMinimalSourceAssertedValueSetSchemes()

Description:

Lists all coding schemes – no entities resolved

Input:

none

Output:

List<CodingScheme>

Exception:

LBException

Implementation Details:

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

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

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

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

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

     

     

...

Code Block
languagejava
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:
Call this method on the associated LexEVS Asserted Value Set service instance to get a coding scheme representation of a vale set containing this concept reference
Sample Call:

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

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

  • Step 2: Construct the ConceptReference object:

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

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

    Code Block
    List<CodingScheme> schemes = assVSServ.getSourceAssertedValueSetsForConceptReference(ref);

...

Code Block
languagejava
themeEclipse
getSourceAssertedValueSetForValueSetURIgetSourceAssertedValueSetforTopNodeEntityCode

Description:

Lists all coding schemes that have a top node defined by a unique entity code

Input:

String matchCode: unique identifier of the top node entity

Output:

List<CodingScheme>:  Might be more than one value set defined by this top node.

Exception:

LBException

Implementation Details:

Implementation:
Call this method on the associated LexEVS Asserted Value Set service instance to get one or more coding scheme representations of value sets that have a top node defined by this identifier
Sample Call:

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

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

  • Step 2: List all the coding schemes defined by the top node designated by the unique identifier

    Code Block
    List<CodingScheme> schemes = assVSServ.getSourceAssertedValueSetforTopNodeEntityCode("C12434");

     

     

...

Description:

Gets a coding scheme representation of a value set based on its unique URI designation

Input:

URI uri: unique identifier of the top node entity wrapped in a URI object

Output:

CodingScheme:  Might be more than one The coding scheme representation of the value set defined represented by this top node.uniquely identifying URI

Exception:

LBException

Implementation Details:

Implementation:
Call this method on the associated LexEVS Asserted Value Set service instance to get a single coding scheme representation of a value set using it's unique identifier wrapped in a URI object.
Sample Call:

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

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

  • Step 2: Instantiate a URI object using a string representation of the URI designation

    Code Block
    URI uri = new URI("http://evs.nci.nih.gov/valueset/CDISC/C12434");

  • Step 2: List all the coding schemes defined by the top node designated by the unique identifier

    Code Block
    CodingScheme scheme = assVSServ.getSourceAssertedValueSetForValueSetURI(uri);

     

     

...

Description:

Gets minimal coding scheme references of value sets for a text match

Input:

String matchText: Text to match on for contains, exact, other algorithms as allowed.

MatchAlgorithm matchType: Type of matching for any given match type in this enum.

Output:

List<AbsoluteCodingSchemeVersionReference>:  String references to entity top node designations of the Asserted Value Sets

Exception:

noneLBException

Implementation Details:

Implementation:
Call this method on the associated LexEVS Asserted Value Set service instance to get any coding scheme references that have a member entity with text matching the text and algorithm
Sample Call:

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

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

  • Step 2: Get a list of all the top nodes in the Asserted Value Set system:

    Code Block
    List<AbsoluteCodingSchemeVersionReference> list = assVSServ.getSourceAssertedValueSetsforTextSearch("blood", MatchAlgorithm.PRESENTATION_EXACT);

     

     

...