NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

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

...

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);

 

Get Value Sets For Entity Code

...

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");

     

     

 

Get a single value set for its unique URL

Code Block
getSourceAssertedValueSetForValueSetURI

Description:

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

Input:

String matchCode

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

Output:

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 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);

     

     

 

Get Coding Scheme References for Any Source Schemes Used to Resolve a Coding Scheme Representation of a Value Set

Code Block
getListOfCodingSchemeVersionsUsedInResolution

Description:

Gets minimal representations of coding schemes based on what was used to resolve a value set

Input:

CodingScheme cs: CodingScheme object with full metadata populated, entity representation not necessary

Output:

AbsoluteCodingSchemeVersionReferenceList:  Might be more than one coding scheme that defines this value set

Exception:

none

Implementation Details:

Implementation:
Call this method on the associated LexEVS Asserted Value Set service instance to determine what coding schemes define the value set. 
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 coding scheme using one of the Asserted Value Set Service methods: 

    Code Block
    CodingScheme cs = assVSServ.getSourceAssertedValueSetForValueSetURI(new URI("http://evs.nci.nih.gov/valueset/CDISC/C12434")) ;
  • Step  3: List all the coding schemes defined by the top node designated by the unique identifier

    Code Block
    AbsoluteCodingSchemeVersionReferenceList list = assVSServ.getListOfCodingSchemeVersionsUsedInResolution(cs);

     

     

Resolved Concept Reference Read Functions

...