NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Old Version 5

changes.mady.by.user Jackel, Laura (NIH/NCI) [C]

Saved on

compared with

New Version 6

changes.mady.by.user Jackel, Laura (NIH/NCI) [C]

Saved on

Key

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

...

Description:

Returns list of concept domain entities matching the name provided.

Input:

  • java.lang.String conceptDomainName - (Mandatory) Name of a concept domain to match.
  • java.lang.String codeSystemNameOrURI - (Mandatory) Name or URI of code system that contains the concept domain.
  • java.lang.String codeSystemVersion - (Optional) Version of code system that contains the concept domain.
    org.LexGrid.LexBIG.LexBIGService.CodedNodeSet.SearchDesignationOption option - (Optional) Indicates the designations to search (one of the enumerated type SearchDesignationOption).
  • java.lang.String matchAlgorithm - (Mandatory) Local name of the match algorithm - possible algorithms are returned in LexEVSCTS2.getSupportedSearchAlgorithmNames().
  • java.lang.String language - (Optional) Language of search string. If missing, uses the default language specified in the context.

Output:

*java.util.List<org.LexGrid.concepts.Entity> - List of detailed concept domain entities that match supplied concept domain name.

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate ConceptDomainQueryOperation if it is not done yet:
    Code Block
    org.lexevs.cts2.query.ConceptDomainQueryOperation cdQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getConceptDomainQueryOperation();
  • Step 2: Call getConceptDomainEntitisWithName method by passing the name to search:
    Code Block
    java.util.List<org.LexGrid.concepts.Entity> conceptDomainEntities = cdQuery.getConceptDomainEntitisWithName("code", "conceptDomainCodingScheme", null, null, "subString", null);

...

Description:

Returns all the Concept Domain entities found in supplied code system version.

Input:

  • java.lang.String codeSystemNameOrURI - (Mandatory) Name or URI of code system that contains the concept domain.
  • java.lang.String codeSystemVersion - (Optional) Version of code system that contains the concept domain.

Output:

java.util.List<org.LexGrid.concepts.Entity> - List of concept domain entities found in supplied code system version.

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate ConceptDomainQueryOperation if it is not done yet:
    Code Block
    org.lexevs.cts2.query.ConceptDomainQueryOperation cdQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getConceptDomainQueryOperation();
  • Step 2: Call listAllConceptDomainEntities to get all Concept Domains:
    Code Block
    java.util.List<org.LexGrid.concepts.Entity> conceptDomains = cdQuery.listAllConceptDomainEntities("conceptDomainCodingScheme", "1.0");

...

Description:

Returns all the Concept Domain identifiers found in supplied code system version.

Input:

  • java.lang.String codeSystemNameOrURI - (Mandatory) Name or URI of code system that contains the concept domain.
  • java.lang.String codeSystemVersion - (Optional) Version of code system that contains the concept domain.

Output:

java.util.List<String> - List of concept domain identifiers found in supplied code system version.

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate ConceptDomainQueryOperation if it is not done yet:
    Code Block
    org.lexevs.cts2.query.ConceptDomainQueryOperation cdQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getConceptDomainQueryOperation();
  • Step 2: Call listAllConceptDomainIds to get all Concept Domain identifiers:
    Code Block
    java.util.List<java.lang.String> conceptDomainIds = cdQuery.listAllConceptDomainIds("conceptDomainCodingScheme", "1.0");

...

Description:

Returns list of value set definition URIs that are bound to given concept domain.

Input:

  • java.lang.String conceptDomainId - (Mandatory) Concept Domain identifier.
  • java.lang.String codeSystemNameOrURI - (Mandatory) Name or URI of code system that contains the concept domain.

Output:

java.util.List<String> - List of Value Set Definition URIs that are bound to supplied concept domain.

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate ConceptDomainQueryOperation if it is not done yet:
    Code Block
    org.lexevs.cts2.query.ConceptDomainQueryOperation cdQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getConceptDomainQueryOperation();
  • Step 2: Call getConceptDomainBindings to get all Concept Domain identifiers:
    Code Block
    java.util.List<java.lang.String> valueSetURIS = cdQuery.getConceptDomainBindings("AcknowledgementDetailCode", "conceptDomainCodingScheme");

...

Description:

Determines whether the supplied coded concept exists in a code system in use for the specified concept domain, optionally within specific usage contexts. Returns true if a coded concept is an element of a value set expansion bound to the provided concept domain, or bound to both concept domain and usage context.

Input:

  • java.lang.String conceptDomainId - (Mandatory) Concept Domain identifier.
  • java.lang.String namespace - (Optional) Concept Domain namespace.
  • java.lang.String codeSystemNameOrURI - (Mandatory) Name or URI of code system that contains the concept domain.
  • java.lang.String entityCode - (Mandatory) Entity code to check if it participates in concept domain.
    org.LexGrid.LexBIG.DataModel.Collections.AbsoluteCodingSchemeVersionReferenceList codingSchemeVersionList - (Mandatory) List of code system URI and version that contains the entity code and to be used to resolve.
  • java.util.List<java.lang.String> usageContext - (Optional) List of usage context.

Output:

java.util.List<String> - List of Value Set Definition URIs that are bound to concept domain (and usageContext) and that contains given entity code.

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate ConceptDomainQueryOperation if it is not done yet:
    Code Block
    org.lexevs.cts2.query.ConceptDomainQueryOperation cdQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getConceptDomainQueryOperation();
  • Step 2: Populate CodingSchemeVersionList that contains the entity code:
    Code Block
    org.LexGrid.LexBIG.DataModel.Collections.AbsoluteCodingSchemeVersionReferenceList codingSchemeVersionList = new org.LexGrid.LexBIG.DataModel.Collections.AbsoluteCodingSchemeVersionReferenceList();
org.LexGrid.LexBIG.DataModel.Collections.AbsoluteCodingSchemeVersionReference codingSchemeVersion = new org.LexGrid.LexBIG.DataModel.Collections.AbsoluteCodingSchemeVersionReference();
codingSchemeVersion.setCodingSchemeURN("urn:oid:cts:1.1.1");
codingSchemeVersion.setCodingSchemeVersion("1.0");
codingSchemeVersionList.addAbsoluteCodingSchemeVersionReference(codingSchemeVersion);
  • Step 3: Call isEntityInConceptDomain to get all value set definition URIs that are bound to concept domain and contains given entity code:
    Code Block
    java.util.List<java.lang.String> valueSetURIS = cdQuery.isEntityInConceptDomain("Automobiles", null, "conceptDomainCodingScheme", "GM", codingSchemeVersionList, null);

...