oracle.hsgbu.ets.snomed

Interface SNOMEDConcept

All Superinterfaces:

AttributableETSComponent, Concept, ETSComponent, ReassignableETSComponent, RetirableETSComponent

public interface SNOMEDConcept
extends Concept

Defines extensions to the generic Concept object by providing information that is specific to the SNOMED terminology.

See Also:

Concept

Field Summary

Fields inherited from interface oracle.hsgbu.ets.base.Concept

DEFAULT_EQUIVALENCE_CONTEXT, EQUIVALENCE_TYPE_EXACT_CONCEPT, EQUIVALENCE_TYPE_MAPPING, EQUIVALENCE_TYPE_SEMANTIC, LOCAL_PREFERRED, MAXLENGTH_EXT_TYPE_CODE, NONE, TERMINOLOGY_PREFERRED, TERMINOLOGY_PREFERRED_AND_LOCAL_PREFERRED, TYPE_DESC, TYPE_PRINT

Method Summary

Modifier and Type	Method and Description
String	getCTV3ID() Gets the CTV3 identifier of this SNOMEDConcept.
SNOMEDDescription[]	getDescriptions(SNOMEDDescriptionFilter filter) Gets an array of SNOMED-CT descriptions defined by the SNOMED-CT terminology for this SNOMEDConcept.
SNOMEDConcept[]	getDirectSubtypes() Gets an array of direct sub type or child SNOMED-CT concepts that are related to this SNOMEDConcept through an IS_A relationship.
SNOMEDConcept[]	getDirectSupertypes() Gets an array of direct super type or parent SNOMED-CT concepts that are related to this SNOMEDConcept through an IS_A relationship.
Date	getEffectiveTime() Gets the Effective Time (RF2 Attribute) of this SNOMEDConcept.
String	getModuleId() Gets the Module identifier (RF2 Attribute) of this SNOMEDConcept.
SNOMEDRelationship[]	getRelationshipsForSource(SNOMEDConcept relType, int chType) Gets an array of SNOMED-CT relationships that have this SNOMEDConcept as their source.
SNOMEDRelationship[]	getRelationshipsForSource(SNOMEDConcept relType, int chType, int relGrp) Gets an array of SNOMED-CT relationships that have this SNOMEDConcept as their source.
SNOMEDRelationship[]	getRelationshipsForTarget(SNOMEDConcept relType, int chType) Gets an array of SNOMED-CT relationships that have this SNOMEDConcept as the target.
SNOMEDRelationship[]	getRelationshipsOrdered(int relation) Gets an array of unique SNOMED-CT relationships containing this SNOMEDConcept.
SNOMEDRelationship[]	getRelationshipsOrdered(int relation, SNOMEDConcept relationType) Gets an array of unique SNOMED-CT relationships containing this SNOMEDConcept that match the specified relation and relationship type concept.
String	getSNOMEDRTID() Gets the SNOMED-RT identifier of this SNOMEDConcept.
int	getSNOMEDStatus() Gets the status flag of this SNOMEDConcept.
boolean	hasAncestor(SNOMEDConcept ancestor) Indicates whether the specified SNOMED-CT concept is an ancestor to this SNOMEDConcept.
boolean	isNavigationConcept() Indicates whether this SNOMEDConcept is a SNOMED-CT navigation concept.
boolean	isPrimitive() Indicates whether this SNOMEDConcept is primitive.

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

getAllDescriptions, getAllDescriptions, getClassifications, getCodingSchemeVersion, getConceptCode, getConceptListsContainingConcept, getConceptListsContainingConcept, getDescription, getDescription, getDescription, getEquivalentConcepts, getEquivalentConcepts, getEquivalentConcepts, getExtendedTypeCode, getLocallyPreferredDescription, getLocallyPreferredDescription, getLocallySpecifiedDescriptions, getLocallySpecifiedDescriptions, getMappedConcepts, getMappedConcepts, getRelatedConcepts, getRelatedConcepts, getRelatedConcepts, getRelationships, getRelationships, getTerminologyPreferredDescription, getTerminologyPreferredDescription, getTerminologySpecifiedDescriptions, getTerminologySpecifiedDescriptions, isEquivalent, isEquivalent, isRelationType

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

getFinalAssignment, getNextAssignment, getPreviousAssignments, isReassigned

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

getRetiredDate, getVersionID, isActive, isInternal, isQuarantined, isRetired

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

getCTV3ID

String getCTV3ID()
          throws ETSDataException

Gets the CTV3 identifier of this SNOMEDConcept. This method returns null if this SNOMEDConcept does not have a CTV3 identifier. The maximum length of this attribute is 240.

Returns:

CTV3 identifier of this SNOMEDConcept or null if the identifier does not exist.

Throws:

ETSDataException - If a data transport error occurs.

getDescriptions

SNOMEDDescription[] getDescriptions(SNOMEDDescriptionFilter filter)
                             throws ETSDataException,
                                    ETSBadParameterException

Gets an array of SNOMED-CT descriptions defined by the SNOMED-CT terminology for this SNOMEDConcept. This method returns SNOMED-CT descriptions that match the specified SNOMED-CT description filter. The method returns an empty array if this SNOMEDConcept does not contain any terminology defined descriptions.

Parameters:

filter - SNOMED-CT description filter that depicts the database fields that have to be searched.

Returns:

Array that contains SNOMED-CT descriptions defined by the SNOMED-CT terminology that belongs to this SNOMEDConcept. The method returns an empty array if terminology defines descriptions are not available.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the specified SNOMED-CT description filter is null.

getDirectSubtypes

SNOMEDConcept[] getDirectSubtypes()
                           throws ETSDataException

Gets an array of direct sub type or child SNOMED-CT concepts that are related to this SNOMEDConcept through an IS_A relationship. This method returns an empty array if this SNOMEDConcept does not have any direct sub type SNOMED-CT concepts.

Returns:

Array of direct sub type SNOMED-CT concepts that are related to this SNOMEDConcept through an IS_A relationship. The method returns an empty array if there are no direct sub type SNOMED-CT concepts.

Throws:

ETSDataException - If a data transport error occurs.

getDirectSupertypes

SNOMEDConcept[] getDirectSupertypes()
                             throws ETSDataException

Gets an array of direct super type or parent SNOMED-CT concepts that are related to this SNOMEDConcept through an IS_A relationship. This method returns an empty array if this SNOMEDConcept does not have any direct super type SNOMED-CT concepts.

Returns:

Array of direct super type SNOMED-CT concepts that are related to this SNOMEDConcept through an IS_A relationship. The method returns an empty array if there are no direct super type SNOMED-CT concepts.

Throws:

ETSDataException - If a data transport error occurs.

getRelationshipsForSource

SNOMEDRelationship[] getRelationshipsForSource(SNOMEDConcept relType,
                                               int chType)
                                        throws ETSDataException,
                                               ETSBadParameterException

Gets an array of SNOMED-CT relationships that have this SNOMEDConcept as their source. This method also matches the SNOMED_CT relationships with the specified relationship type and characteristic type. Integer values 0, 1, and 2 depict valid characteristic types. For example, this method can take an IS_A as relationship type and 0 as characteristic type. A value of 0 depicts defining characteristic type. This method returns an empty array if none of the SNOMED-CT relationships match the search criteria.

Parameters:

relType - Relationship type concept.

chType - Integer constant specifying characteristic type. Valid characteristic types are 0, 1, and 2.

Returns:

Array of SNOMED-CT relationships that have this SNOMEDConcept as their source and match the specified search criteria. This method returns an empty array if none of the SNOMED-CT relationships match the search criteria.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the specified SNOMED-CT relationship type concept is null, or if the specified characteristic type is not valid.

getRelationshipsForSource

SNOMEDRelationship[] getRelationshipsForSource(SNOMEDConcept relType,
                                               int chType,
                                               int relGrp)
                                        throws ETSDataException,
                                               ETSBadParameterException

Gets an array of SNOMED-CT relationships that have this SNOMEDConcept as their source. This method also matches the SNOMED-CT relationships with the specified relationship type, characteristic type, and relationship group. Integer values 0, 1, and 2 depict valid characteristic types. Valid relationship group can be any integer that is greater than or equal to 0. This method sorts the result by relationship group. Relationship group is an integer value that depicts an association between 2 or more SNOMED-CT relationships. SNOMED-CT relationships that do not belong to a group have 0 as their relationship group value. This is the default value. This method returns an empty array if none of the SNOMED-CT relationships match the search criteria.

Parameters:

relType - Relationship type concept.

chType - Integer constant that depicts the characteristic type. Valid characteristic types are 0, 1, and 2.

relGrp - Integer constant that depicts the relationship group.

Returns:

Array of SNOMED-CT relationships that have this SNOMEDConcept as their source and also match the specified relationship type, characteristic type, and relationship group. This method returns an empty array if none of the SNOMED-CT relationships match the search criteria.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the specified SNOMED-CT relationship type concept is null, if the specified characteristic type is not valid, or if the specified relationship is not valid.

getRelationshipsForTarget

SNOMEDRelationship[] getRelationshipsForTarget(SNOMEDConcept relType,
                                               int chType)
                                        throws ETSDataException,
                                               ETSBadParameterException

Gets an array of SNOMED-CT relationships that have this SNOMEDConcept as the target. This method matches the SNOMED-CT relationships with the specified relationship type concept and characteristic type. Integer values 0, 1, and 2 depict valid characteristic types. This method returns an empty array if none of the SNOMED-CT relationships match the specified search criteria.

Parameters:

relType - Relationship type concept.

chType - Integer constant that depicts the characteristic type. Valid characteristic types are 0, 1, and 2.

Returns:

Array of SNOMED-CT relationships that have this SNOMED-CT concept as the target and also match the specified relationship type concept and characteristic type. This method returns an empty array if none of the SNOMED-CT relationships match the specified search criteria.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the specified relationship type concept is null, or the specified characteristic type is invalid.

getRelationshipsOrdered

SNOMEDRelationship[] getRelationshipsOrdered(int relation)
                                      throws ETSBadParameterException,
                                             ETSDataException

Gets an array of unique SNOMED-CT relationships containing this SNOMEDConcept. This method sorts the resulting array by the relationship group. The method returns an empty array if this SNOMEDConcept does not have any unique SNOMED-CT relationships.

The functionality of this method is similar to that of the getRelatedConcepts(int relation) method.

Parameters:

relation - Integer that depicts role of this SNOMEDConcept in the relationships. Valid values are defined in the Relationship interface.

Returns:

Array of unique SNOMED-CT relationships of this SNOMEDConcept, or an empty array if there are no unique SNOMED-CT relationships.

Throws:

ETSBadParameterException - If the specified relation value does not match the constants defined in the Relationship interface.

ETSDataException - If a data transport error occurs.

getRelationshipsOrdered

SNOMEDRelationship[] getRelationshipsOrdered(int relation,
                                             SNOMEDConcept relationType)
                                      throws ETSBadParameterException,
                                             ETSDataException

Gets an array of unique SNOMED-CT relationships containing this SNOMEDConcept that match the specified relation and relationship type concept. The method sorts the resulting array by relationship group. This method returns an empty array if none of the SNOMED-CT relationships match the specified search criteria.

Parameters:

relation - Integer that depicts role of this SNOMEDConcept in the relationships. Valid values are defined in the Relationship interface.

relationType - Specifies the relationship type concept.

Returns:

Array of unique SNOMED-CT relationships of this SNOMED-CT concept that match the specified relation and relationship type concept. This method returns an empty array if none of the SNOMED-CT relationships match the specified search criteria.

Throws:

ETSBadParameterException - If the specified relation does not match the constants defined in the Relationship interface, or if the specified concept is not a relationship type.

ETSDataException - If a data transport error occurs.

getSNOMEDRTID

String getSNOMEDRTID()
              throws ETSDataException

Gets the SNOMED-RT identifier of this SNOMEDConcept. This method returns null if this SNOMEDConcept does not have a SNOMED-RT identifier.

Returns:

SNOMED-RT identifier of this SNOMEDConcept, or null if there is no SNOMED-RT identifier. The maximum length of this attribute is 240.

Throws:

ETSDataException - If a data transport error occurs.

isNavigationConcept

boolean isNavigationConcept()
                     throws ETSDataException

Indicates whether this SNOMEDConcept is a SNOMED-CT navigation concept. This method returns true if this SNOMEDConcept is a SNOMED navigation concept and false if it is not. A SNOMED-CT navigation concept has the navigation concept as its super type. This super type is related through an IS_A relationship.

NOTE: The first time this method is called on this SNOMEDConcept, the call can generate extremely high system overheads due to complex database calls executed by this method. During the subsequent call the method execution does not generate high system overheads, because the results of the first call are cached.

Returns:

true if this SNOMEDConcept is a SNOMED navigation concept and false if it is not.

Throws:

ETSDataException - If a data transport error occurs.

getSNOMEDStatus

int getSNOMEDStatus()
             throws ETSDataException

Gets the status flag of this SNOMEDConcept. The SNOMED-CT status flag is an integer constant with the values ranging from 0 to 6.

Returns:

Status of this SNOMEDConcept.

Throws:

ETSDataException - If a data transport error occurs.

isPrimitive

boolean isPrimitive()
             throws ETSDataException

Indicates whether this SNOMEDConcept is primitive. The method returns true if this SNOMEDConcept is primitive, or false if it is fully defined.

Returns:

true if this SNOMEDConcept is primitive, or false if it is fully defined.

Throws:

ETSDataException - If a data transport error occurs.

hasAncestor

boolean hasAncestor(SNOMEDConcept ancestor)
             throws ETSDataException

Indicates whether the specified SNOMED-CT concept is an ancestor to this SNOMEDConcept. The method searches the super types or parent SNOMED-CT concepts of this SNOMEDConcept to establish whether the specified SNOMED-CT concept is the ancestor. The method returns true if the specified SNOMED-CT concept is an ancestor, or false if it is not. If this SNOMEDConcept is passed as the parameter to this method, true is returned.

Parameters:

ancestor - SNOMED-CT concept to be verified.

Returns:

true if the specified SNOMED-CT concept is an ancestor, or false if it is not. If this SNOMEDConcept is passed as the parameter to this method, true is returned.

Throws:

ETSDataException - If a data transport error occurs.

getModuleId

String getModuleId()
            throws ETSDataException

Gets the Module identifier (RF2 Attribute) of this SNOMEDConcept. This method returns null if this SNOMEDConcept does not have a Module identifier. This method returns null if this SNOMEDConcept belongs to a version loaded with RF1 file format.

Returns:

Module identifier of this SNOMEDConcept, or null if there is no Module identifier.

Throws:

ETSDataException - If a data transport error occurs.

getEffectiveTime

Date getEffectiveTime()
               throws ETSDataException

Gets the Effective Time (RF2 Attribute) of this SNOMEDConcept. This method returns null if this SNOMEDConcept does not have a Effective Time. This method returns null if this SNOMEDConcept belongs to a version loaded with RF1 file format.

Returns:

Module identifier of this SNOMEDConcept, or null if there is no Effective Time.

Throws:

ETSDataException - If a data transport error occurs.