oracle.hsgbu.ets.snomed

Interface SNOMEDDescription

All Superinterfaces:

AttributableETSComponent, ConceptDescription, ETSComponent, RetirableETSComponent, TerminologyConceptDescription

public interface SNOMEDDescription
extends TerminologyConceptDescription

Defines extensions to the generic TerminologyConceptDescription object by providing operations that are specific to the SNOMED-CT terminology.

See Also:

TerminologyConceptDescription

Method Summary

Modifier and Type	Method and Description
Date	getEffectiveTime() Gets the Effective Time (RF2 Attribute) of this SNOMEDDescription.
boolean	getInitialCapitalStatus() Gets the flag value that indicates whether the initial capitalization of this SNOMEDDescription reflects the correct meaning.
String	getLanguageCode() Gets the language code of this SNOMEDDescription.
String	getModuleId() Gets the Module identifier (RF2 Attribute) of this SNOMEDDescription.
String	getSNOMEDID() Gets the SNOMED-CT identifier of this SNOMEDDescription.
int	getSNOMEDStatus() Gets the SNOMED-CT status flag of this SNOMEDDescription.
int	getType() Gets the description type flag for this SNOMEDDescription.
String	getTypeId() Gets the Description type identifier (RF2 Attribute) of this SNOMEDDescription.

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

getConcept, getExtendedTypeCode, getLocale, getSynonyms, getTerm, isLocal, isLocallyPreferred, isTerminologyPreferred

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

getInitialCapitalStatus

boolean getInitialCapitalStatus()
                         throws ETSDataException

Gets the flag value that indicates whether the initial capitalization of this SNOMEDDescription reflects the correct meaning. This flag value is set to true if the initial capitalization of this description term reflects the correct meaning. For example, if the description of a SNOMED component is meant to be milligrams and the actual description is Mg, the flag returns false. In this case, the initial capitalization does not convey the correct meaning, as milligrams is depicted as mg, where as Mg depicts Magnesium.

Returns:

true if the initial capitalization of this description term reflects the correct meaning, or false if its does not convey.

Throws:

ETSDataException - If a data transport error occurs.

getLanguageCode

String getLanguageCode()
                throws ETSDataException

Gets the language code of this SNOMEDDescription. The language code identifies the means of communication for this SNOMEDDescription. The maximum length of this attribute is 8.

Returns:

Language code of this SNOMEDDescription.

Throws:

ETSDataException - If a data transport occurs.

getSNOMEDID

String getSNOMEDID()
            throws ETSDataException

Gets the SNOMED-CT identifier of this SNOMEDDescription. The maximum length of this attribute is 50.

Returns:

SNOMED-CT identifier of this SNOMEDDescription.

Throws:

ETSDataException - If a data transport error occurs.

getType

int getType()
     throws ETSDataException

Gets the description type flag for this SNOMEDDescription. This flag is an integer value that indicates whether this SNOMEDDescription is a terminology preferred description, a synonym, or a fully specified name. The flag value can range from 1 to 3.

Returns:

Description type flag for this SNOMEDDescription.

Throws:

ETSDataException - If a data transport error occurs.

getSNOMEDStatus

int getSNOMEDStatus()
             throws ETSDataException

Gets the SNOMED-CT status flag of this SNOMEDDescription. The flag is an integer whose value ranges from 0 to 8. Consult SNOMED Clinical Terms (Documentation from the terminology maintainer, the College of American Pathologists) for value meanings.

Returns:

SNOMED-CT status flag of this SNOMEDDescription.

Throws:

ETSDataException - If a data transport error occurs.

getModuleId

String getModuleId()
            throws ETSDataException

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

Returns:

Module identifier of this SNOMEDDescription, 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 SNOMEDDescription. This method returns null if this SNOMEDDescription does not have a Effective Time. This method returns null if this SNOMEDDescription belongs to a version loaded with RF1 file format.

Returns:

Module identifier of this SNOMEDDescription, or null if there is no effective Time.

Throws:

ETSDataException - If a data transport error occurs.

getTypeId

String getTypeId()
          throws ETSDataException

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

Returns:

Module identifier of this SNOMEDDescription, or null if there is no Description type identifier.

Throws:

ETSDataException - If a data transport error occurs.