|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ValueSetQueryOperation
LexEVS Implementation of CTS2 Value Set Query Operation.
Method Summary | |
---|---|
boolean |
checkConceptValueSetMembership(java.lang.String conceptCode,
java.net.URI entityCodeNamespace,
AbsoluteCodingSchemeVersionReference codeSystemAndVersion,
java.lang.String valueSetId,
java.lang.String valueSetVersion,
java.lang.String versionTag)
Determine whether the supplied coded concept exists in the supplied value set . |
boolean |
checkValueSetSubsumption(java.lang.String childValueSetId,
java.lang.String childValueSetVersion,
java.lang.String parentValueSetId,
java.lang.String parentValueSetVersion,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag)
Determine whether one of the two supplied value sets subsumes the other. |
ValueSetDefinition |
getValueSetDetails(java.lang.String valueSetId,
java.lang.String valueSetVersion)
Returns detailed information (meta data) for a given value set. |
java.util.List<java.lang.String> |
listAllValueSets(SortOption sortOption)
Lists all the value sets that are available to the CTS 2 service. |
ResolvedValueSetDefinition |
listValueSetContents(java.lang.String valueSetId,
java.lang.String valueSetVersion,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag,
SortOption sortOption)
Lists out the contents (entries) of a given value set, filtering based on input criteria. |
java.util.List<java.lang.String> |
listValueSets(java.lang.String codeSystemId,
java.lang.String conceptDomainId,
java.lang.String usageContextId,
java.lang.String codeSystemURI,
SortOption sortOption)
Lists the value sets that are available to the CTS 2 service. |
java.util.List<java.lang.String> |
listValueSetsWithConceptCode(java.lang.String conceptCode,
java.net.URI entityCodeNamespace,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag)
Returns all the value set definition uris that contains supplied concept code. |
Method Detail |
---|
java.util.List<java.lang.String> listValueSets(java.lang.String codeSystemId, java.lang.String conceptDomainId, java.lang.String usageContextId, java.lang.String codeSystemURI, SortOption sortOption) throws LBException
codeSystemId
- (Optional) code system id the value set should referenceconceptDomainId
- (Optional) conceptDomain the value set should be bound tousageContextId
- (Optional) usage context, the value set can be usedcodeSystemURI
- URI of code system the codeSystemId or conceptDomainId or usageContextId belongs tosortOption
- Ascending or Descending the return list of value set identifiers
LBException
java.util.List<java.lang.String> listAllValueSets(SortOption sortOption) throws LBException
sortOption
- Ascending or Descending the return list of value set identifiers
LBException
ValueSetDefinition getValueSetDetails(java.lang.String valueSetId, java.lang.String valueSetVersion) throws LBException
valueSetId
- id of the value setvalueSetVersion
- (Optional) version of the value set
LBException
ResolvedValueSetDefinition listValueSetContents(java.lang.String valueSetId, java.lang.String valueSetVersion, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag, SortOption sortOption) throws LBException
valueSetId
- id of value setvalueSetVersion
- (Optional) version of value setcsVersionList
- code system version reference list to be used to resolve value setversionTag
- the tag (e.g. "devel", "production", ...) to be used to determine which code system to be usedsortOption
- (Optional) sort option to apply on resolved concepts
LBException
boolean checkValueSetSubsumption(java.lang.String childValueSetId, java.lang.String childValueSetVersion, java.lang.String parentValueSetId, java.lang.String parentValueSetVersion, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag) throws LBException
childValueSetId
- child value set idchildValueSetVersion
- (Optional) child value set versionparentValueSetId
- parent value set idparentValueSetVersion
- (Optional) parent value set versioncsVersionList
- list of code system versions to use in resolution.versionTag
- the tag (e.g. "devel", "production", ...) to be used to determine which code system to be used
LBException
boolean checkConceptValueSetMembership(java.lang.String conceptCode, java.net.URI entityCodeNamespace, AbsoluteCodingSchemeVersionReference codeSystemAndVersion, java.lang.String valueSetId, java.lang.String valueSetVersion, java.lang.String versionTag) throws LBException
conceptCode
- coded concept identityCodeNamespace
- the URI of the entity code namespace. If omitted, the default coding scheme namespace for the value domain
will be used, if it is present. Otherwise the first matching entity code, if any, will passcodeSystemAndVersion
- code system and version reference to be usedvalueSetId
- value set idvalueSetVersion
- (Optional) value set versionversionTag
- the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present.
Note that non-tagged versions will be used if the tagged version is missing.
LBException
java.util.List<java.lang.String> listValueSetsWithConceptCode(java.lang.String conceptCode, java.net.URI entityCodeNamespace, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag) throws LBException
conceptCode
- - coded concept identityCodeNamespace
- - the URI of the entity code namespace. If omitted, the default coding scheme namespace for the value domain
will be used, if it is present. Otherwise the first matching entity code, if any, will passcsVersionList
- - a list of coding scheme URI's and versions to be used. These will be used only if they are present in
the service. If absent, the most recent version will be used instead.versionTag
- - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present.
Note that non-tagged versions will be used if the tagged version is missing.
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. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |