The Asserted Value Set services are integrated parts of the LexEVS API. It provide several functions:
Getting Source Asserted Value Sets as CodingScheme or Coding Scheme reference objects
Getting the entities of Source Asserted Value Sets as ResolvedConceptReference objects as Lists or Iterators
Getting a list of all unique identifiers of value set top nodes from this source terminology
Getting a list of all schemes used to resolve a given set of values from a resolved value set coding scheme
Most coding scheme representations and entity reference sets are resolved by the unique URL of the coding scheme. Some allow a definition of a concept or text match. All methods offer a resolution service to some set of values. These mechanisms are largely read functions requiring a listing of known values or an exact match of a unique identifier. Only one offers what could be classified as a search.
LexEVS Value Set Definition Services provides three major functions:
Each of these functions are described in following sections.
List All Value Sets As Fully Populated Coding Schemes
listAllSourceAssertedValueSets() |
Description: | Lists all coding schemes each with its own entity set fully resolved | ||
---|---|---|---|
Input: | none | ||
Output: | List<CodingScheme> | ||
Exception: | LBException | ||
Implementation Details: | Implementation:
|
List all Coding Schemes without entities
getMinimalSourceAssertedValueSetSchemes() |
Description: | Lists all coding schemes – no entities resolved | ||
---|---|---|---|
Input: | none | ||
Output: | List<CodingScheme> | ||
Exception: | LBException | ||
Implementation Details: | Implementation:
|
Get Value Sets by Concept Reference
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:
|
Get Value Sets For Entity Code
getSourceAssertedValueSetForValueSetURI |
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:
|
Get a single value set for its unique URL
getSourceAssertedValueSetForValueSetURI |
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 value set defined by this top node. | |||
Exception: | LBException | |||
Implementation Details: | Implementation:
|
Get Coding Scheme References for Any Source Schemes Used to Resolve a Coding Scheme Representation of a Value Set
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:
|
Get Resolved Concept References for the Coding Scheme Unique Identifier
Description: | Gets Resolved Concept Reference representations of entity values in a value set based on the unique identifier of the coding scheme representation | |||
---|---|---|---|---|
Input: | String uri: String representation of the coding scheme unique identifier | |||
Output: | ResolvedConceptReferenceList : Entities | |||
Exception: | none | |||
Implementation Details: | Implementation:
|