Page History
...
Each of these functions are described in following sections.
Administration Functions
LexEVS Value Set Definition Services provide s following administration functions:
...
Info | ||
---|---|---|
| ||
These administration operations can be performed in LexEVS 'Local' environment only. This can not be performed using LexEVS Distributed environment. |
Loading Value Set Definitions
There are two methods that could be used to load Value Set Definitions:
- Loading Value Set Definition Object - This function provides the capability to load supplied ValueSetDefinition object into the system.
- Loading Value Set Definitions in file - This function provides the capability to load Value Set Definitions found in file that are in LexGrid XML format.
Loading Value Set Definition Object
This function provides the capability to load supplied ValueSetDefinition object into the system.
...
Description: | Loads supplied valueSetDefinition object. Optionally, it can assign the release URI and mappings (supported attributes like SupportedCodingScheme, SupportedConceptDomain, SupportedAssociation etc) to the valueSetDefinition being loaded. | ||||||||||
Input: | org.LexGrid.valueSets.ValueSetDefinition vsdDef - (Mandatory) Value Set Definition object to be loaded. | ||||||||||
Output: | none | ||||||||||
Exception: | LBException | ||||||||||
Implementation Details: | Implementation:
|
Loading Value Set Definitions in File
This function provides the capability to load Value Set Definitions found in file that are in LexGrid XML format.
...
Description: | Loads valueSetDefinitions found in input XML file. The input XML file should in LexGrid format i.e. the contents should confirm to LexGrid valueSets schema [ | ||||
Input: | java.lang.String xmlFileLocation - (Mandatory) File containing ValueSetDefinitions in LexGrid XML format. | ||||
Output: | none | ||||
Exception: | LBException | ||||
Implementation Details: | Implementation:
|
Export Value Set
There are two export functions available :
1. Export Value Set Definition - This function provides the capability to export Value Set Definition to a file in LexGrid XML format. This will be helpful if there is a need to import this exported Value Set Definition in different instance of LexEVS.
2. Export Value Set Resolution (Expanded Value Set) - This function provides the capability to resolve the Value Set Definition and exports the resolved(expanded) contents as a LexGrid Coding Scheme in XML format.
Export Value Set Definition
This function provides the capability to export Value Set Definition to a file in LexGrid XML format. This will be helpful if there is a need to import this exported Value Set Definition in different instance of LexEVS.
...
Description: | Export Value Set Definition to a file in LexGrid XML format. | ||||
Input: | java.net.URI valueSetDefinitionURI - (Mandatory) the URI of value set definition to be exported.
| ||||
Output: | none | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
Export Value Set Resolution
This function provides the capability to export Value Set Resolution (Expanded Value Set) to a file in LexGrid XML format as a Coding Scheme. This will be helpful if there is a need to import the contents of a value set as a separate Coding Scheme. The URI of the Coding Scheme will be set to URI of Value Set Definition being exported. And all the contents of the value set will be represented as an entities within that Coding Scheme.
...
Description: | Export Value Set Resolution to a file in LexGrid XML format as a Coding Scheme. | ||||
Input: | java.net.URI valueSetDefinitionURI - (Mandatory) the URI of value set definition to be exported. | ||||
Output: | none | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
Remove Value Set Definition
Below is the function to remove value set definition from the system.
...
Description: | Removes supplied value set definition from the system. | ||||
Input: | java.net.URI valueSetDefinitionURI - (Mandatory) the URI of value set definition to be removed. | ||||
Output: | none | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
Query Functions
Here are some of the query functions that can be run against value set definitions using the LexEVS Value Set Definition Services.
Validate XML Resources
Function to perform validation of source XML file without loading.
...
Description: | Performs validation of the candidate resource without loading data. | ||||
Input: | java.net URI xmlFileLocation - (Mandatory) File containing ValueSetDefinitions in LexGrid XML format.
| ||||
Output: | none | ||||
Exception: | Org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
isEntityInValueSet
There are two methods to check if supplied concept code is part of supplied value set definition.
...
Description: | Determine whether the supplied entity code is a valid entity code somewhere in the supplied value set definition. This function is intended for use with simple value set definition that are drawn from a single coding scheme where most parameters can be defaulted. | ||||
Input: | java.lang.String entityCode - (Mandatory) the entity code to search for | ||||
Output: | org.LexGrid.LexBIG.DataModel.Core.AbsoluteCodingSchemeVersionReference - coding scheme and version if the entityCode is valid, null otherwise | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
isEntityInValueSet(String entityCode, URI entityCodeNamespace, URI valueSetDefinitionURI, String valueSetDefinitionRevisionId, AbsoluteCodingSchemeVersionReferenceList csVersionList, String versionTag)
isEntityInValueSet(String entityCode, URI entityCodeNamespace, URI valueSetDefinitionURI, String valueSetDefinitionRevisionId, AbsoluteCodingSchemeVersionReferenceList csVersionList, String versionTag)
Description: | Similar to the previous method, this method determines if the supplied entity code and entity namespace is a valid result for the supplied value set definition when resolved against the supplied Coding Scheme Version or Tag. | ||||
Input: | java.lang.String entityCode - (Mandatory) the entity code to search for | ||||
Output: | org.LexGrid.LexBIG.DataModel.Core. AbsoluteCodingSchemeVersionReference - The codingScheme URI and version of that asserts that the code is in the value set | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
listValueSetsWithEntityCode
Returns all the value set definition uris that contains supplied entity code.
...
Description: | Returns all the value set definition uris that contains supplied entity code. | ||||
Input: | java.lang.String entityCode - (Mandatory) the entity code to search for | ||||
Output: | java.util.List<String> - list of value set definition URIs that contain supplied entity code | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
getCodedNodeSetForValueSetDefinition
Returns unresolved CodedNodeSet populated using definition entries in the value set definition.
...
Description: | Returns unresolved CodedNodeSet populated using definition entries in the value set definition. | ||||
Input: | java.net.URI valueSetDefinitionURI - (Mandatory) the URI of the value set definition | ||||
Output: | org.lexgrid.valuesets.dto.ResolvedValueSetCodedNodeSet - Unresolved CodedNodeSet populated using definition entries in the value set definition. | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
isSubSet
This method checks if childValueSetDefinition is a sub set of parentValueSetDefinition.
...
Description: | Checks whether childValueSetDefinition is a sub set of parentValueSetDefinition | ||||
Input: | java.net.URI childValueSetDefinitionURI - (Mandatory) child value set definition URI | ||||
Output: | boolean - YES, if all the elements of the child value set are in the parent value set. NO otherwise. | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
getValueSetDefinition
Utility method that returns value set definition object for the supplied value set URI.
...
Description: | Returns value set definition object for the supplied value set definition URI. | ||||
Input: | java.net.URI valueSetDefinitionURI - (Mandatory) value set definition URI | ||||
Output: | org.LexGrid.valueSets.ValueSetDefinition - value set definition object | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
listValueSetDefinitions
Utility method that lists all the URI's of the value set definition(s) for the supplied value set definition name. If the name is null, returns everything. If the name is not null, returns the value set definition(s) that have the assigned name.
...
Description: | Returns the URI's of the value set definition(s) for the supplied name. If the name is null, returns everything. If the name is not null, returns the value set definition(s) that have the assigned name.
| |||||
Input: | java.lang.String valueSetDefinitionName - (Optional) name of the value set definition. If null, returns URIs all the value set definition(s) in the system, if empty string "", returns all unnamed value set definition URIs. If name is provided, returns value set definition uris with the name that matches supplied valueSetDefinitionName. | |||||
Output: | java.util.List<String> - List of matching value set definition uris | |||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | |||||
Implementation Details: | Implementation:
|
listValueSetDefinitionURIs
Utility method that lists all the URI's of the value set definition(s) that are loaded in the system.
...
Description: | Returns all the URI's of the value set definition(s) that are loaded in the system. | ||||
Input: | none | ||||
Output: | java.util.List<String> - List of all the value set definition uris available in the system | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
getAllValueSetDefinitionsWithNoNames
This method returns all the value set definition URI's that contains no names.
...
Description: | Returns the URI's of all unnamed value set definition(s). | ||||
Input: | none | ||||
Output: | java.util.List<String> - List of all unnamed value set definitions URI's | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
getValueSetDefinitionEntitiesForTerm
This method resolves the supplied value set definition and returns only those concept codes that matches the supplied term.
...
Description: | Resolves the value set definition supplied and restricts it to the term and matchAlgorith supplied. The returned object ResolvedValueSetCodedNodeSet contains the codingScheme URI and Version that was used to resolve and the CodedNodeSet.
| |||||
Input: | java.lang.String term - (Mandatory) text to match. Format is specific to the match algorithm | |||||
Output: | org.lexgrid.valuesets.dto.ResolvedValueSetCodedNodeSet - contains the codingScheme URI and Version that was used to resolve and the unresolved CodedNodeSet. | |||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | |||||
Implementation Details: | Implementation:
|
getCodingSchemesInValueSetDefinition
This method returns all the coding scheme referenced by supplied value set definition.
...
Description: | Returns list of coding scheme summary that is referenced by the supplied value set definition. | ||||
Input: | java.net.URI valueSetDefinitionURI - (Mandatory) value set definition uri | ||||
Output: | org.LexGrid.LexBIG.DataModel.Collections.AbsoluteCodingSchemeVersionReferenceList - list of coding scheme summary referenced by the supplied value set definition | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
isValueSetDefinition
This method checks if the supplied entityCode is of type 'valueSetDefinition' in supplued coding scheme and version.
...
Description: | Determines if the supplied entity code is of type valueSetDefinition in the supplied coding scheme and, if it is, returns true; otherwise returns false. | ||||
Input: | java.lang.String entityCode - (Mandatory) entity code | ||||
Output: | boolean - TRUE : If entityCode is of type valueSetDefinition in supplied coding scheme, FALSE : otherwise | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
getValueSetDefinitionURIsWithCodingScheme
This method returns a list of Value Set Definition URIs that references supplied coding scheme.
...
Description: | Returns a list of Value Set Definition URIs that references supplied coding scheme. | ||||
Input: | java.lang.String codingSchemename - (Mandatory) Name of coding scheme to check | ||||
Output: | java.util.List<String> - List of value set definition URIs that references the supplied coding scheme name | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
getValueSetDefinitionURIsWithConceptDomain
This method returns a list of Value Set Definition URIs that are bound to supplied concept domain.
...
Description: | Returns a list of Value Set Definition URIs that are bound to supplied concept domain. | ||||
Input: | java.lang.String conceptDomain- (Mandatory) name or uri of concept domain to check | ||||
Output: | java.util.List<String> - List of value set definition URIs that are bound to supplied concept domain | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
getValueSetDefinitionURIsWithUsageContext
This method returns a list of Value Set Definition URIs that references supplied list of usage context(s).
...
Description: | Returns a list of Value Set Definition URIs that references supplied list of usage context(s). | ||||
Input: | java.util.List<java.lang.String> usageContexts- (Mandatory) list of name or uri of usage context to check | ||||
Output: | java.util.List<String> - List of value set definition URIs that references the supplied list of usage context | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
getValueSetDefinitionURIsWithConceptDomainAndUsageContext
This method Returns list of Value Set Definition URIs that are bound to supplied concept domain and in supplied usage context.
...
Description: | Returns list of Value Set Definition URIs that are bound to supplied concept domain and in supplied usage context. | ||||
Input: | java.lang.String conceptDomain - (Mandatory) name or uri of concept domain to check | ||||
Output: | java.util.List<String> - List of value set definition URIs that are bound to supplied concept domain and references the supplied list of usage context | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
Resolve Functions
Rsolve functions provides the capability to resolve the value set definition against specific coding scheme version and get back the list of entities that belongs to the value set. If no coding scheme version is provided, the API will pick the latest version of the coding scheme.
...
- Resolve Stored Value Set Definition - This function allows you to resolve value set definition that are loaded in the system.
- Resolve Supplied Value Set Definition - This function allows you to pass a ValueSetDefinition object that may not be loaded in the system and get it resolved.
Resolving Stored Value Set Definition
This function resolves the value set definition that is loaded in the system and returns set of valied concept codes plus the code systems and its versions that were used.
...
Description: | Resolves a value set definition that is available in the system using the supplied set of coding scheme versions. | ||||||
Input: | java.net.URI valueSetDefinitionURI - (Mandatory) value set definition uri to resolve | ||||||
Output: | org.lexgrid.valuesets.dto.ResolvedValueSetDefinition - Resolved Value Set Definition | ||||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||||
Implementation Details: | Implementation:
|
Resolving Supplied Value Set Definition Objects
This function resolves the value set definition that is supplied against the supplied coding scheme version(s) and returns set of valied concept codes plus the code systems and its versions that were used.
...
Description: | Resolves a value set definition that is supplied using the supplied set of coding scheme version(s). | ||||||||
Input: | org.LexGrid.valueSets.ValueSetDefinition vsDef- (Mandatory) value set definition object to resolve | ||||||||
Output: | org.lexgrid.valuesets.dto.ResolvedValueSetDefinition - Resolved Value Set Definition | ||||||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||||||
Implementation Details: | Implementation:
|
Resolved Value Set Objects
ResolvedValueSetCodedNodeSet
Contains Coding Scheme Version reference list that was used to resolve the Value Set Definition and the CodedNodeSet.
Info | ||
---|---|---|
| ||
The CodedNodeSet is not resolved. |
ResolvedValueSetDefinition
A resolved Value Set Definition containing the Coding Scheme Version reference list that was used to resolve the Value Set Definition and an iterator for resolved concepts.
...