 |
Page History
| Scrollbar | ||
|---|---|---|
|
...
| Page info |
|---|
...
|
| Section | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Introduction
LexEVS CTS2 Concept Domain Query API provides capability to query Concept Domain available in the system and also to query the binding between Value Set and Concept Domain. In LexEVS, the Concept Domain is essentially an entity of type 'conceptDomain' in a code system version. Using LexEVS CTS 2 Authoring or Loader interfaces, you could create a Code System specially for Concept Domain entities, but this is not necessary, but will be convenient to have concept domains in specific code system(s).
Interface
org.lexevs.cts2.query.ConceptDomainQueryOperation
...
is
...
the
...
main
...
interface
...
for
...
all
...
the
...
queries
...
against
...
Concept
...
Domain.
...
This
...
interface
...
can
...
be
...
accessed
...
using
...
main
...
LexEVSCTS2
...
interface,
...
like:
| Code Block |
|---|
} org.lexevs.cts2.query.ConceptDomainQueryOperation cdQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getConceptDomainQueryOperation(); {code} h2. Query Functions Here are the major query functions available using ConceptDomainQueryOperation interface: h3. getConceptDomainCodingScheme This function returns detailed concept domain code system. {{getConceptDomainCodingScheme(String codeSystemNameOrURI, String codeSystemVersion)}} || *Description:* | Gets the concept domain code system. | || *Input:* | * *_ |
Query Functions
Here are the major query functions available using ConceptDomainQueryOperation interface:
getConceptDomainCodingScheme
This function returns detailed concept domain code system.
getConceptDomainCodingScheme(String codeSystemNameOrURI, String codeSystemVersion)
Description: | Gets the concept domain code system. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
org.LexGrid.codingSchemes.CodingScheme |
...
- |
...
Detailed |
...
concept |
...
domain |
...
Code |
...
System | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
getConceptDomainEntity
This function returns detailed concept domain entity.
getConceptDomainEntity(String conceptDomainId, String namespace, String codeSystemNameOrURI, String codeSystemVersion)
Description: | Returns concept domain entity object of the concept domain id. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
org.LexGrid.concepts.Entity |
...
- |
...
Detailed |
...
concept |
...
domain |
...
entity | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
getConceptDomainEntitisWithName
This function returns all the concept domain entities that matches the concept domain name supplied.
getConceptDomainEntitisWithName(String conceptDomainName, String codeSystemNameOrURI, String codeSystemVersion, SearchDesignationOption option, String matchAlgorithm, String language)
Description: | Returns list of concept domain entities matching the name provided. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
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: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
getConceptDomainCodedNodeSet
This is a helper function that returns Coded Node Set(CNS)
...
for
...
concept
...
domain
...
entities.
...
Further
...
restrictions
...
like,
...
matchingDesignation,
...
Status,
...
Properties,
...
etc.,
...
can
...
be
...
applied
...
on
...
this
...
CNS
...
and
...
than
...
resolved.
...
getConceptDomainCodedNodeSet(String
...
codeSystemNameOrURI,
...
String
...
codeSystemVersion)
...
Description: |
|---|
...
Returns |
...
coded |
...
node |
...
set |
...
for |
...
concept |
...
domain |
...
entities. |
...
Input: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
org.LexGrid.LexBIG.LexBIGService.CodedNodeSet |
...
- |
...
Unresolved |
...
Concept |
...
Domain |
...
coded |
...
node |
...
set. |
...
Exception: |
|---|
...
org.LexGrid.LexBIG.Exceptions.LBException |
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
listAllConceptDomainEntities
This function returns all the Concept Domain entities found in supplied code system version.
listAllConceptDomainEntities(String codeSystemNameOrURI, String codeSystemVersion)
Description: | Returns all the Concept Domain entities found in supplied code system version. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
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: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
listAllConceptDomainIds
This function is similar to previous one, but instead of returning detailed Concept Domain entities, it just returns identifiers of the concept domain.
listAllConceptDomainIds(String codeSystemNameOrURI, String codeSystemVersion)
Description: | Returns all the Concept Domain identifiers found in supplied code system version. |
|---|---|
Input: |
|
Output: | java.util.List<String> - List of concept domain identifiers found in supplied code system version. |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
getConceptDomainBindings
This function returns list of value set definition URIs that are bound to given concept domain.
getConceptDomainBindings(String conceptDomainId, String codeSystemNameOrURI)
Description: | Returns list of value set definition URIs that are bound to given concept domain. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
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: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
isEntityInConceptDomain
This function 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.
isEntityInConceptDomain(String conceptDomainId, String namespace, String codeSystemNameOrURI, String entityCode, AbsoluteCodingSchemeVersionReferenceList codingSchemeVersionList, List<String> usageContext)
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: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
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: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
| Scrollbar | ||
|---|---|---|
|
