Page History

*Description: *

Gets the usage context code system.

*Input: *

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

*Output: *

org.LexGrid.codingSchemes.CodingScheme - Detailed usage context Code System

*Exception: *

org.LexGrid.LexBIG.Exceptions.LBException

*Sample Call: *

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

  ...

  Code Block org.lexevs.cts2.query.UsageContextQueryOperation ucQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getUsageContextQueryOperation(); Step 2: Call getUsageContextCodingScheme method to get detailed Usage Context code system: ... Code Block org.LexGrid.codingSchemes.CodingScheme usageContextCS = ucQuery.getUsageContextCodingScheme("usageContextCodingScheme", "1.0"); ... getUsageContextEntity This function returns detailed Usage Context entity. getUsageContextEntity(String usageContextId, String namespace, String codeSystemNameOrURI, String codeSystemVersion) *Description: * Returns Usage Context entity object. *Input: * ... java.lang.String usageContextId - (Mandatory) ID of a Usage Context. java.lang.String namespace - (Optional) Namespace of a Usage Context. java.lang.String codeSystemNameOrURI - (Mandatory) Name or URI of code system that contains the Usage Context. java.lang.String codeSystemVersion - (Optional) Version of code system that contains the Usage Context. ... *Output: * ... org.LexGrid.concepts.Entity - Detailed Usage Context Entity ... *Exception: * ... org.LexGrid.LexBIG.Exceptions.LBException ... *Sample Call: * Step 1: Instantiate UsageContextQueryOperation if it is not done yet : ... Code Block org.lexevs.cts2.query.UsageContextQueryOperation ucQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getUsageContextQueryOperation(); Step 2: Call getUsageContextEntity method to get detailed Usage Context Entity: ... Code Block org.LexGrid.concepts.Entity usageContextEntity = ucQuery.getUsageContextEntity("ActAdjudicationInformationCode", null, "usageContextCodingScheme", "1.0"); | getUsageContextEntitisWithName This function returns all the Usage Context entities that matches the name supplied. getUsageContextEntitisWithName(String usageContextName, String codeSystemNameOrURI, String codeSystemVersion, SearchDesignationOption option, String matchAlgorithm, String language) *Description: * Returns list of Usage Context entities matching the name provided. *Input: * ... java.lang.String usageContextName - (Mandatory) Name of a Usage Context to match. java.lang.String codeSystemNameOrURI - (Mandatory) Name or URI of code system that contains the Usage Context. java.lang.String codeSystemVersion - (Optional) Version of code system that contains the Usage Context. 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 Usage Context entities that match supplied name. ... *Exception: * ... org.LexGrid.LexBIG.Exceptions.LBException ... *Sample Call: * Step 1: Instantiate UsageContextQueryOperation if it is not done yet : ... Code Block org.lexevs.cts2.query.UsageContextQueryOperation ucQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getUsageContextQueryOperation(); Step 2: Call getUsageContextEntitisWithName method by passing the name to search: ... Code Block java.util.List<org.LexGrid.concepts.Entity> usageContextEntities = ucQuery.getUsageContextEntitisWithName("code", "usageContextCodingScheme", null, null, "subString", null); | getUsageContextCodedNodeSet This is a helper function that returns Coded Node Set(CNS) for Usage Context entities. Further restrictions like, matchingDesignation, Status, Properties, etc., can be applied on this CNS and than resolved. getUsageContextCodedNodeSet(String codeSystemNameOrURI, String codeSystemVersion) *Description: * Returns coded node set for UsageContext entities. *Input: * ... java.lang.String codeSystemNameOrURI - (Mandatory) Name or URI of code system that contains the Usage Context. java.lang.String codeSystemVersion - (Optional) Version of code system that contains the Usage Context. ... *Output: * ... org.LexGrid.LexBIG.LexBIGService.CodedNodeSet - Unresolved Usage Context coded node set. ... *Exception: * ... org.LexGrid.LexBIG.Exceptions.LBException ... *Sample Call: * Step 1: Instantiate UsageContextQueryOperation if it is not done yet : ... Code Block org.lexevs.cts2.query.UsageContextQueryOperation ucQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getUsageContextQueryOperation(); Step 2: Call getUsageContextCodedNodeSet to get Usage Context Coded node Set: ... Code Block CodedNodeSet usageContextCNS = ucQuery.getUsageContextCodedNodeSet("usageContextCodingScheme", null); Step 3: Apply restrictions to the CNS and resolve: ... Code Block ... usageContextCNS.restrictToMatchingProperties(null, new PropertyType[] { PropertyType.PRESENTATION }, "Auto", "startsWith", null); ... ... org.LexGrid.LexBIG.DataModel.Core.ResolvedConceptReference[] rcr = usageContextCNS.resolveToList(null, null, null, 1).getResolvedConceptReference(); ... ... listAllUsageContextEntities This function returns all the Usage Context entities found in supplied code system version. listAllUsageContextEntities(String codeSystemNameOrURI, String codeSystemVersion) *Description: * Returns all the Usage Context entities found in supplied code system version. *Input: * ... java.lang.String codeSystemNameOrURI - (Mandatory) Name or URI of code system that contains the Usage Context. java.lang.String codeSystemVersion - (Optional) Version of code system that contains the Usage Context. ... *Output: * ... java.util.List<org.LexGrid.concepts.Entity> - List of Usage Context entities found in supplied code system version. ... *Exception: * ... org.LexGrid.LexBIG.Exceptions.LBException ... *Sample Call: * Step 1: Instantiate UsageContextQueryOperation if it is not done yet : ... Code Block org.lexevs.cts2.query.UsageContextQueryOperation ucQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getUsageContextQueryOperation(); Step 2: Call listAllUsageContextEntities to get all Usage Context entities: ... Code Block java.util.List<org.LexGrid.concepts.Entity> usageContexts = ucQuery.listAllUsageContextEntities("usageContextCodingScheme", "1.0"); ... listAllUsageContextIds This function is similar to previous one, but instead of returning detailed Usage Context entities, it just returns identifiers of the Usage Context. listAllUsageContextIds(String codeSystemNameOrURI, String codeSystemVersion) *Description: * Returns all the Usage Context identifiers found in supplied code system version. *Input: * ... java.lang.String codeSystemNameOrURI - (Mandatory) Name or URI of code system that contains the Usage Context. java.lang.String codeSystemVersion - (Optional) Version of code system that contains the Usage Context. ... *Output: * ... java.util.List<String> - List of Usage Context identifiers found in supplied code system version. ... *Exception: * ... org.LexGrid.LexBIG.Exceptions.LBException ... *Sample Call: * Step 1: Instantiate UsageContextQueryOperation if it is not done yet : ... Code Block org.lexevs.cts2.query.UsageContextQueryOperation ucQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getUsageContextQueryOperation(); Step 2: Call listAllUsageContextIds to get all Usage Context identifiers: ... Code Block java.util.List<java.lang.String> usageContextIds = ucQuery.listAllUsageContextIds("usageContextCodingScheme", "1.0"); ... Scrollbar icons false Accessibility | Contact CBIIT | FOIA | HHS Vulnerability Disclosure | Comment Policy U.S. Department of Health and Human Services | National Institutes of Health | National Cancer Institute | USA.gov NIH ... Turning Discovery Into Health® Powered by Atlassian Confluence, themed by RefinedTheme null