Page History
Scrollbar | ||
---|---|---|
|
...
Page info |
---|
...
|
Section | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Introduction
LexEVS CTS2 Code System Query API provides capability to query contents of Code System that are available in the system.
Interface
org.lexevs.cts2.query.CodeSystemQueryOperation
...
is
...
the
...
main
...
interface
...
for
...
all
...
the
...
queries
...
against
...
Code
...
System.
...
This
...
interface
...
can
...
be
...
accessed
...
using
...
main
...
LexEVSCTS2
...
interface,
...
like:
Code Block |
---|
} org.lexevs.cts2.query.CodeSystemQueryOperation csQueryOp = new org.lexevs.cts2.LexEvsCTS2Impl().getQueryOperation().getCodeSystemQueryOperation(); {code} h2. Query Functions Here are the major query functions available using CodeSystemQueryOperation interface: h3. listCodeSystems This function lists the coding systems that are available in cts 2 system. Optionally, return list can be restricted to Code System URI, version, local name, formal name or entity description. {{listCodeSystems(CodingSchemeSummary queryByExample)}} || *Description:* | List the coding systems that are available in cts 2 system. | || *Input:* | *_ |
Query Functions
Here are the major query functions available using CodeSystemQueryOperation interface:
listCodeSystems
This function lists the coding systems that are available in cts 2 system. Optionally, return list can be restricted to Code System URI, version, local name, formal name or entity description.
listCodeSystems(CodingSchemeSummary queryByExample)
Description: | List the coding systems that are available in cts 2 system. |
---|---|
Input: | org.LexGrid.LexBIG.DataModel.Core.CodingSchemeSummary |
...
queryByExample |
...
- |
...
(Optional) |
...
Restrict |
...
the |
...
return |
...
list |
...
only |
...
to |
...
those |
...
that |
...
matches |
...
the |
...
supplied |
...
data. |
...
return |
...
list |
...
can |
...
be |
...
restricted |
...
to |
...
Code |
...
System |
...
URI, |
...
version, |
...
local |
...
name, |
...
formal |
...
name |
...
or |
...
entity |
...
description. |
...
If |
...
empty, |
...
all |
...
the |
...
code |
...
systems |
...
available |
...
in |
...
the |
...
system |
...
will |
...
be |
...
returned. |
...
Output: |
---|
...
org.LexGrid.LexBIG.DataModel.Collections.CodingSchemeRenderingList |
...
- |
...
List |
...
of |
...
Code |
...
Systems | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
---|
...
Sample Call: |
|
---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
getCodeSystemDetails
This function provides the ability to retrieve detailed code system.
getCodeSystemDetails(String codingSchemeName, CodingSchemeVersionOrTag versionOrTag)
Description: | Return a detailed codingScheme according to provided codingName and versionOrTag |
---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
---|
...
org.LexGrid.codingSchemes.CodingScheme |
...
- |
...
detailed |
...
Code |
...
System | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
---|
...
Sample Call: |
|
---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
listCodeSystemConcepts
This function provides the ability to list concepts in specific code system.
listCodeSystemConcepts(String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, LocalNameList entityTypes, SortOptionList sortOptionList)
Description: | List the concepts in a specific codingSystem |
---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
---|
...
org.LexGrid.LexBIG.Utility.Iterators.ResolvedConceptReferencesIterator |
...
- |
...
An |
...
iterator |
...
for |
...
resolved |
...
concepts |
...
list | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
---|
...
Sample Call: |
|
---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
getConceptDetails
This function returns details of an entity specified.
getConceptDetails(String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, String code, String namespace)
Description: | Return an instance of Entity according the requests. |
---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
---|
...
org.LexGrid.concepts.Entity |
...
- |
...
Detailed |
...
Entity |
...
object | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
---|
...
Sample Call: |
|
---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
listAssociationTypes
This function returns all the supported association types with in the specified code system version.
listAssociationTypes(String codingSchemeName, CodingSchemeVersionOrTag versionOrTag)
Description: | List all the associationTypes in a specific code system. |
---|---|
Input: | java.lang.String |
...
codingSchemeName |
...
- |
...
( |
...
Mandatory |
...
) |
...
Name |
...
of |
...
the |
...
code |
...
system. |
...
|
...
versionOrTag |
...
- |
...
(Optional) |
...
Version |
...
or |
...
tag |
...
(like |
...
'dev', |
...
'production' |
...
etc) |
...
of |
...
the |
...
code |
...
system. |
...
Output: |
---|
...
java.util.List<org.LexGrid.naming.SupportedAssociation> |
...
- |
...
List |
...
of |
...
all |
...
supported |
...
association |
...
types |
...
in |
...
supplied |
...
code |
...
system |
...
version | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
---|
...
Sample Call: |
|
---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
getAssociationTypeDetails
This function returns detailed information for a certain association type with in the specified code system version.
getAssociationTypeDetails(String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, String associationName)
Description: | Return detailed information for a certain associationType in a specific code system. |
---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
| |
Output: | org.LexGrid.relations.AssociationEntity |
---|
...
- |
...
Association |
...
type |
...
details | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
---|
...
Sample Call: |
|
---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Scrollbar | ||
---|---|---|
|