Page History

Introduction

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. 

SourceAssertedValueSetService Class Diagram

LexEVS Asserted Value Set Definition Services API

LexEVS Value Set Definition Services provides three major functions:

• List function
• Read function
• Search function

Each of these functions are described in following sections.

List Functions

• List all value sets as coding schemes
• List all value set entities in the asserted source system

Coding Scheme Read Functions

• Get value sets by concept reference - Input an object that matches namespace and unique code of a value set member to return a list of containing schemes
• Get value sets by entity code - input is entity code only, no namespace is defined to read the value set that contains this as a value set member
• Get a single value set for its unique URI - The input should be an unique identifier for a coding scheme representation of a value set in the system
• Get a value set or value sets defined by a unique entity - The input is a unique entity code that identifies the top node of a given value set
• Get scheme references for a coding scheme representation - Pulls from a coding scheme those schemes from which the entities of the coding scheme representation of the value set is derived.

Resolved Concept Reference Read Functions

• Get references for unique URI identifier - Unique identifier returns all value set members of that coding scheme representation of a value set.
• Get a string unique identifier of a reference that is a top node - All top nodes of a system are returned based on the identification of the node that has a reference to the top of the hierarchy

Search Function

• Get value set coding scheme reference based on a text match for a member entity - Can be used with a text match algorithm determining match type.