org.lexevs.cts2.query
Interface ConceptDomainQueryOperation

All Known Implementing Classes:
ConceptDomainQueryOperationImpl

public interface ConceptDomainQueryOperation

LexEVS CTS 2 Concept Domain Query Operations.

Author:
Sridhar Dwarkanath

Method Summary
 java.util.List<java.lang.String> getConceptDomainBindings(java.lang.String conceptDomainId, java.lang.String codeSystemNameOrURI)
          Returns list of value set definition URIs that are bound to given concept domain.
 CodedNodeSet getConceptDomainCodedNodeSet(java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion)
          Returns coded node set for concept domain entities.
 CodingScheme getConceptDomainCodingScheme(java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion)
          Gets the concept domain coding scheme.
 java.util.List<Entity> getConceptDomainEntitisWithName(java.lang.String conceptDomainName, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, CodedNodeSet.SearchDesignationOption option, java.lang.String matchAlgorithm, java.lang.String language)
          Returns list of concept domain entities matching the name provided.
 Entity getConceptDomainEntity(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion)
          Returns concept domain entity object of the concept domain id.
 java.util.List<java.lang.String> isEntityInConceptDomain(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String entityCode, AbsoluteCodingSchemeVersionReferenceList codingSchemeVersionList, java.util.List<java.lang.String> usageContext)
          Determines whether the supplied coded concept exists in a code system in use for the specified concept domain, optionally within specific usage contexts.
 java.util.List<Entity> listAllConceptDomainEntities(java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion)
          Gets all the concept domain found in the system as entities.
 java.util.List<java.lang.String> listAllConceptDomainIds(java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion)
          Returns all the concept domain identifiers found in the system.
 

Method Detail

getConceptDomainCodingScheme

CodingScheme getConceptDomainCodingScheme(java.lang.String codeSystemNameOrURI,
                                          java.lang.String codeSystemVersion)
                                          throws LBException
Gets the concept domain coding scheme.

Parameters:
codeSystemNameOrURI - concept domain coding scheme name or URI
codeSystemVersion - concept domain coding scheme version
Returns:
the concept domain coding scheme
Throws:
LBException

getConceptDomainEntity

Entity getConceptDomainEntity(java.lang.String conceptDomainId,
                              java.lang.String namespace,
                              java.lang.String codeSystemNameOrURI,
                              java.lang.String codeSystemVersion)
                              throws LBException
Returns concept domain entity object of the concept domain id.

Parameters:
conceptDomainId - id of concept domain
namespace - concept domain name space
codeSystemNameOrURI - concept domain coding scheme name or URI
codeSystemVersion - concept domain coding scheme version
Returns:
concept domain entity object
Throws:
LBException

getConceptDomainEntitisWithName

java.util.List<Entity> getConceptDomainEntitisWithName(java.lang.String conceptDomainName,
                                                       java.lang.String codeSystemNameOrURI,
                                                       java.lang.String codeSystemVersion,
                                                       CodedNodeSet.SearchDesignationOption option,
                                                       java.lang.String matchAlgorithm,
                                                       java.lang.String language)
                                                       throws LBException
Returns list of concept domain entities matching the name provided.

Parameters:
conceptDomainName - match name of concept domain
codeSystemNameOrURI - concept domain coding scheme name or URI
codeSystemVersion - concept domain coding scheme version
option - Indicates the designations to search (one of the enumerated type SearchDesignationOption).
matchAlgorithm - Local name of the match algorithm - possible algorithms are returned in LexBigService.getMatchAlgorithms().
language - Language of search string. If missing, use the default language specified in the context.
Returns:
list of entities containing matching concept domain name
Throws:
LBException

getConceptDomainCodedNodeSet

CodedNodeSet getConceptDomainCodedNodeSet(java.lang.String codeSystemNameOrURI,
                                          java.lang.String codeSystemVersion)
                                          throws LBException
Returns coded node set for concept domain entities.

Parameters:
codeSystemNameOrURI - concept domain coding scheme name or URI
codeSystemVersion - concept domain coding scheme version
Returns:
codedNodeSet of concept domain entities
Throws:
LBException

listAllConceptDomainEntities

java.util.List<Entity> listAllConceptDomainEntities(java.lang.String codeSystemNameOrURI,
                                                    java.lang.String codeSystemVersion)
                                                    throws LBException
Gets all the concept domain found in the system as entities.

Parameters:
codeSystemNameOrURI - concept domain coding scheme name or URI
codeSystemVersion - concept domain coding scheme version
Returns:
List of concept domain entities
Throws:
LBException

listAllConceptDomainIds

java.util.List<java.lang.String> listAllConceptDomainIds(java.lang.String codeSystemNameOrURI,
                                                         java.lang.String codeSystemVersion)
                                                         throws LBException
Returns all the concept domain identifiers found in the system.

Parameters:
codeSystemNameOrURI - concept domain coding scheme name or URI
codeSystemVersion - concept domain coding scheme version
Returns:
List of concept domain identifiers
Throws:
LBException

getConceptDomainBindings

java.util.List<java.lang.String> getConceptDomainBindings(java.lang.String conceptDomainId,
                                                          java.lang.String codeSystemNameOrURI)
                                                          throws LBException
Returns list of value set definition URIs that are bound to given concept domain.

Parameters:
conceptDomainId - - Identifier of the concept domain
codeSystemNameOrURI - - coding scheme name or URI to which the concept domain belongs to
Returns:
list of value set definition URIs
Throws:
LBException

isEntityInConceptDomain

java.util.List<java.lang.String> isEntityInConceptDomain(java.lang.String conceptDomainId,
                                                         java.lang.String namespace,
                                                         java.lang.String codeSystemNameOrURI,
                                                         java.lang.String entityCode,
                                                         AbsoluteCodingSchemeVersionReferenceList codingSchemeVersionList,
                                                         java.util.List<java.lang.String> usageContext)
                                                         throws LBException
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.

Parameters:
conceptDomainId - - id of concept domain
namespace - - code system namespace
codeSystemNameOrURI - - concept domain code system name or URI
entityCode - - entity code to check if it participates in concept domain
codingSchemeVersionList - - list of coding scheme URI and version that contains the entity code and to be used to resolve.
usageContext - - (Optional) list of usage context
Returns:
list of value set definition URIs that are bound to concept domain (and usageContext) and that contains given entity code.
Throws:
LBException

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.