oracle.hsgbu.ets.snomed

Interface SNOMEDCodingSchemeVersion

All Superinterfaces:

AttributableETSComponent, CodingSchemeVersion, ConceptContainer, ETSComponent

public interface SNOMEDCodingSchemeVersion
extends CodingSchemeVersion

Defines extensions to the generic CodingSchemeVersion by providing information that is specific to the SNOMED-CT terminology.

See Also:

CodingSchemeVersion

Method Summary

Modifier and Type	Method and Description
SNOMEDActiveSet	getActiveSet() Gets an empty SNOMED-CT active set that can be populated with SNOMED subsets.
oracle.hsgbu.ets.util.ConceptIterator	getAllConcepts(int status) Gets ConceptIterator that contains all SNOMED-CT concepts that belong to this SNOMEDCodingSchemeVersion and that match the specified status value.
SNOMEDSubset[]	getAllSubsets() Gets an array that contains all SNOMED-CT subsets that belong to this SNOMEDCodingSchemeVersion.
SNOMEDConcept	getAttributeConcept() Gets the SNOMED-CT attribute concept.
SNOMEDConcept	getConceptByCTV3ID(String CTV3Id) Gets the SNOMED-CT concept available in SNOMED-CT coding scheme version.
SNOMEDConcept	getConceptByRTID(String RTId) Gets the SNOMED-CT concept available in this SNOMEDCodingSchemeVersion.
SNOMEDDescription	getDescriptionByID(String sctId) Gets the SNOMED-CT description that belongs to this SNOMEDCodingSchemeVersion.
SNOMEDDescriptionFilter	getDescriptionFilter() Gets an empty SNOMED-CT description filter that can be used to perform description queries.
SNOMEDConcept	getIsAConcept() Gets the SNOMED-CT IS_A relationship-type concept.
SNOMEDConcept	getNavigationConcept() Gets the SNOMED-CT navigation concept.
SNOMEDConcept	getNonCurrentConcept() Gets the SNOMED-CT non-current concept.
SNOMEDConcept	getQualifierConcept() Gets the SNOMED-CT qualifier concept.
SNOMEDRelationship	getRelationshipByID(String sctId) Gets the SNOMED-CT relationship that belongs to this SNOMEDCodingSchemeVersion.
SNOMEDConcept	getRootConcept() Gets the SNOMED-CT root concept.
SNOMEDConcept	getSpecialConcept() Gets the SNOMED-CT top-level 'Special' concept.
SNOMEDSubset	getSubsetByID(String subsetID) Gets SNOMED-CT subset available in this SNOMEDCodingSchemeVersion.
SNOMEDSubset[]	getSubsetsByType(int type) Gets an array that contains all SNOMED-CT subsets that belong to this SNOMEDCodingSchemeVersion.
SNOMEDDescription[]	getTerminologySpecifiedDescriptions(int status) Gets an array of SNOMED-CT descriptions that belong to this SNOMEDCodingSchemeVersion.

Methods inherited from interface oracle.hsgbu.ets.base.CodingSchemeVersion

findConceptsByMatchingDescPatternAndConTypeCode, findConceptsByMatchingDescPatternAndDescTypeCode, getAllVersions, getCodingScheme, getConceptByConceptCode, getConceptsByExtendedTypeCode, getDefaultVersion, getDescription, getLatestActiveVersion, getLoadDate, getLocaleMaps, getName, getNextVersion, getPreviousVersion, getRelationshipTypes, getRetiredDate, isActive, isDefaultVersion, isQuarantined, isRetired, isValidConceptCode

Methods inherited from interface oracle.hsgbu.ets.base.ConceptContainer

contains, getAllConcepts, getConceptsWithAttribute, getConceptsWithAttributeName, getMatchingConceptsByDescriptionTerm, getMatchingConceptsByDescriptionTerm, getNumberOfConcepts

Methods inherited from interface oracle.hsgbu.ets.base.AttributableETSComponent

getAttributeNames, getAttributes, getAttributes

Methods inherited from interface oracle.hsgbu.ets.base.ETSComponent

getCreationDate, getETSID, getImportDate, getLastUpdateDate

Method Detail

getActiveSet

SNOMEDActiveSet getActiveSet()

Gets an empty SNOMED-CT active set that can be populated with SNOMED subsets. This populated active set can be used to perform operations defined in the SNOMED-CT active set. For example, the empty SNOMED-CT active set can be used to execute a query that retrieves an array of SNOMED-CT concepts whose priority is greater than a threshold value.

Returns:

An empty SNOMED-CT active set.

getDescriptionFilter

SNOMEDDescriptionFilter getDescriptionFilter()

Gets an empty SNOMED-CT description filter that can be used to perform description queries.

Returns:

An empty SNOMED-CT description filter.

getAllConcepts

oracle.hsgbu.ets.util.ConceptIterator getAllConcepts(int status)
                                              throws ETSDataException,
                                                     ETSBadParameterException

Gets ConceptIterator that contains all SNOMED-CT concepts that belong to this SNOMEDCodingSchemeVersion and that match the specified status value. The status value must be within the range of 0 to 7. An empty ConceptIterator is returned if this SNOMEDCodingSchemeVersion does not contain matching SNOMED-CT concepts.

Parameters:

status - Integer constant specifying the status.

Returns:

ConceptIterator that contains all SNOMED-CT concepts that belong to this SNOMEDCodingSchemeVersion and match the specified status value. This method returns an empty array if the status value is not found.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the status value is not within the valid range of 0 to 7.

getSpecialConcept

SNOMEDConcept getSpecialConcept()
                         throws ETSDataException,
                                ETSNotFoundException

Gets the SNOMED-CT top-level 'Special' concept.

Returns:

SNOMED-CT top-level 'Special' concept.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If this SNOMEDCodingSchemeVersion does not have a designated special SNOMED-CT concept.

getAttributeConcept

SNOMEDConcept getAttributeConcept()
                           throws ETSDataException,
                                  ETSNotFoundException

Gets the SNOMED-CT attribute concept. This concept is a top-level structural concept with a concept code of 246061005.

Returns:

SNOMED-CT attribute concept.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If this SNOMEDCodingSchemeVersion does not have a designated SNOMED-CT attribute concept.

getConceptByCTV3ID

SNOMEDConcept getConceptByCTV3ID(String CTV3Id)
                          throws ETSNotFoundException,
                                 ETSDataException,
                                 ETSBadParameterException

Gets the SNOMED-CT concept available in SNOMED-CT coding scheme version. This method gets the concept that matches the specified Clinical Terms Version 3 (CTV3) identifier.

Parameters:

CTV3Id - String that specifies the CTV3 identifier.

Returns:

SNOMED-CT concept that matches the specified CTV3 identifier.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the SNOMED-CT concept that matches the CTV3 identifier is not found.

ETSBadParameterException - If the specified CTV3 identifier is null or empty.

getConceptByRTID

SNOMEDConcept getConceptByRTID(String RTId)
                        throws ETSNotFoundException,
                               ETSDataException,
                               ETSBadParameterException

Gets the SNOMED-CT concept available in this SNOMEDCodingSchemeVersion. This method gets the concept that matches the specified SNOMED-RT identifier.

NOTE: SNOMED-RT is the previous version of SNOMED. SNOMED-RT and CTV3 were merged to create SNOMED-CT.

Parameters:

RTId - String that specifies the SNOMED-RT identifier.

Returns:

SNOMED-CT concept that matches the specified SNOMED-RT identifier.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the SNOMED-CT concept that matches the specified SNOMED-RT identifier does not exist in this SNOMEDCodingSchemeVersion.

ETSBadParameterException - If the specified SNOMED-RT identifier is null or empty.

getIsAConcept

SNOMEDConcept getIsAConcept()
                     throws ETSDataException,
                            ETSNotFoundException

Gets the SNOMED-CT IS_A relationship-type concept. This SNOMED-CT concept has a concept code of 116680003.

Returns:

SNOMED-CT IS_A relationship-type concept.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If SNOMED-CT IS_A relationship-type concept is not found.

getNavigationConcept

SNOMEDConcept getNavigationConcept()
                            throws ETSDataException,
                                   ETSNotFoundException

Gets the SNOMED-CT navigation concept. This is a structural concept with a concept code of 363743006.

Returns:

SNOMED-CT navigation concept.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the SNOMED-CT navigation concept is not found.

getNonCurrentConcept

SNOMEDConcept getNonCurrentConcept()
                            throws ETSDataException,
                                   ETSNotFoundException

Gets the SNOMED-CT non-current concept. This is a structural concept with a concept code of 362955004.

Returns:

SNOMED-CT non-current concept.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the SNOMED-CT non-current concept is not found.

getQualifierConcept

SNOMEDConcept getQualifierConcept()
                           throws ETSDataException,
                                  ETSNotFoundException

Gets the SNOMED-CT qualifier concept. This is a top-level structural concept with a concept code of 362981000.

Returns:

SNOMED-CT qualifier concept.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the SNOMED-CT qualifier concept is not found.

getRootConcept

SNOMEDConcept getRootConcept()
                      throws ETSDataException,
                             ETSNotFoundException

Gets the SNOMED-CT root concept. This is a top-level structural concept with a concept code of 138875005.

Returns:

SNOMED-CT root concept.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the SNOMED-CT root concept is not found.

getSubsetByID

SNOMEDSubset getSubsetByID(String subsetID)
                    throws ETSDataException,
                           ETSNotFoundException,
                           ETSBadParameterException

Gets SNOMED-CT subset available in this SNOMEDCodingSchemeVersion. This method returns the SNOMED-CT subset that matches the specified SNOMED-CT subset identifier.

Parameters:

subsetID - The SNOMED-CT subset identifier.

Returns:

SNOMED-CT subset available in this SNOMEDCodingSchemeVersion.

Throws:

ETSNotFoundException - If SNOMED-CT subset matching the specified SNOMED-CT subset identifier does not exist in this SNOMEDCodingSchemeVersion.

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the specified SNOMED-CT subset is null or empty.

getAllSubsets

SNOMEDSubset[] getAllSubsets()
                      throws ETSDataException

Gets an array that contains all SNOMED-CT subsets that belong to this SNOMEDCodingSchemeVersion. This method returns an empty array if this SNOMED-CT coding scheme version does not contain any SNOMED-CT subsets.

Returns:

Gets array that contains all SNOMED-CT subsets that belong to this SNOMEDCodingSchemeVersion, or an empty array if subsets are not found.

Throws:

ETSDataException - If a data transport error occurs.

getSubsetsByType

SNOMEDSubset[] getSubsetsByType(int type)
                         throws ETSDataException,
                                ETSBadParameterException

Gets an array that contains all SNOMED-CT subsets that belong to this SNOMEDCodingSchemeVersion. This method returns the array that matches the specified SNOMED-CT subset type. The SNOMED-CT subset type should be within the valid range of one to seven. This method returns an empty array if none of the SNOMED-CT subsets match the specified SNOMED-CT subset type.

Parameters:

type - Integer value specifying the SNOMED subset type.

Returns:

Array containing all SNOMED-CT subsets that belong to this SNOMEDCodingSchemeVersion, or an empty array if a matching subset is not found.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the specified SNOMED-CT subset is not within the valid range of one to seven.

getDescriptionByID

SNOMEDDescription getDescriptionByID(String sctId)
                              throws ETSNotFoundException,
                                     ETSDataException

Gets the SNOMED-CT description that belongs to this SNOMEDCodingSchemeVersion. This method returns the description that matches the specified SNOMED-CT identifier.

Parameters:

sctId - SNOMED-CT identifier.

Returns:

SNOMED-CT description that belongs to this SNOMEDCodingSchemeVersion.

Throws:

ETSNotFoundException - If SNOMED-CT description that matches the specified SNOMED-CT identifier is not found in this SNOMEDCodingSchemeVersion.

ETSDataException - If a data transport error occurs.

getRelationshipByID

SNOMEDRelationship getRelationshipByID(String sctId)
                                throws ETSNotFoundException,
                                       ETSDataException

Gets the SNOMED-CT relationship that belongs to this SNOMEDCodingSchemeVersion. This method returns the relationship that matches the specified identifier.

Parameters:

sctId - SNOMED-CT identifier.

Returns:

SNOMED-CT relationship that belongs to this SNOMEDCodingSchemeVersion.

Throws:

ETSNotFoundException - If the SNOMED-CT relationship that matches the specified identifier is not found.

ETSDataException - If a data transport error occurs.

getTerminologySpecifiedDescriptions

SNOMEDDescription[] getTerminologySpecifiedDescriptions(int status)
                                                 throws ETSDataException,
                                                        ETSBadParameterException

Gets an array of SNOMED-CT descriptions that belong to this SNOMEDCodingSchemeVersion. This method returns the descriptions that match the specified description status. For Example, the description status 0 depicts current or active, and status 1 depicts retired. This method returns an empty array if this SNOMEDCodingSchemeVersion does not have any SNOMED-CT descriptions that match the specified description status.

Parameters:

status - Integer constant that specifies the description status.

Returns:

Array of SNOMED-CT descriptions that belong to this SNOMEDCodingSchemeVersion. This method returns an empty array if matching descriptions are not found.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the specified description status is not within the valid range. The description status ranges from 0 to 8 for the current release of SNOMED.