oracle.hsgbu.ets.fdb

Interface FDBETCConcept

All Superinterfaces:

AttributableETSComponent, Concept, ETSComponent, FDBClassificationConcept, FDBConcept, ReassignableETSComponent, RetirableETSComponent

public interface FDBETCConcept
extends FDBClassificationConcept

Defines operations that are executed for the current FDB Enhanced Therapeutic Classification (ETC) concept.

See Also:

FDBClassificationConcept

Field Summary

Fields inherited from interface oracle.hsgbu.ets.fdb.FDBClassificationConcept

TYPE_ACTIVE, TYPE_ALL

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
boolean	getDrugConceptLinkIndicator() Gets the drug concept link indicator of this FDBETCConcept.
int	getFormularyLevelIndicator() Gets the formulary level indicator of this FDBETCConcept.
FDBHICConcept[]	getHICs() Gets an array of FDB HIC concepts that are related to this FDBETCConcept.
int	getHierarchyLevel() Gets the hierarchy level of this FDBETCConcept within the FDB ETC concept hierarchy.
int	getPresentationSequenceNumber() Gets the presentation sequence number of this FDBETCConcept.
int	getSortNumber() Gets the sort number of this FDBETCConcept.
boolean	getUltimateChildIndicator() Indicates whether this FDBETCConcept is a leaf concept.
FDBETCConcept	getUltimateParent() Gets an FDB ETC concept that is the final parent of this FDBETCConcept.
boolean	hasHICs() Indicates whether this FDBETCConcept has related HIC concepts.

Methods inherited from interface oracle.hsgbu.ets.fdb.FDBClassificationConcept

getChildren, getMedicationNames, getMedications, getNDCDrugs, getParent, getRDFMedications, getRoutedMedications, hasMedicationNames, hasMedications, hasNDCDrugs, hasRDFMedications, hasRoutedMedications

Methods inherited from interface oracle.hsgbu.ets.fdb.FDBConcept

getExternalConceptCode

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

hasHICs

boolean hasHICs()
         throws ETSDataException

Indicates whether this FDBETCConcept has related HIC concepts. This method returns true if this FDBETCConcept has related HIC concepts or false if this FDBETCConcept does not have related HIC concepts.

Returns:

true if this FDBETCConcept has related HIC concepts or false if this FDBETCConcept does not have related HIC concepts.

Throws:

ETSDataException - If a data transport error occurs.

getHICs

FDBHICConcept[] getHICs()
                 throws ETSDataException

Gets an array of FDB HIC concepts that are related to this FDBETCConcept. This method returns an empty array if this FDBETCConcept is not related to any FDB HIC concepts.

Returns:

Array that contains all FDB HIC concepts that are related to this FDBETCConcept, or an empty array if this FDBETCConcept is not related to any FDB HIC concepts.

Throws:

ETSDataException - If a data transport error occurs.

getUltimateParent

FDBETCConcept getUltimateParent()
                         throws ETSNotFoundException,
                                ETSDataException

Gets an FDB ETC concept that is the final parent of this FDBETCConcept. The final parent is the root FDB ETC concept in a hierarchy of FDB ETC concepts.

Returns:

FDB ETC concept that is the ultimate parent of this FDBETCConcept.

Throws:

ETSNotFoundException - If this FDBETCConcept does not have a parent FDB ETC concept.

ETSDataException - If a data transport error occurs.

getUltimateChildIndicator

boolean getUltimateChildIndicator()
                           throws ETSDataException,
                                  ETSNotFoundException

Indicates whether this FDBETCConcept is a leaf concept. A leaf concept is the ultimate child concept. This method returns true if this FDBETCConcept is a leaf concept or false if this FDBETCConcept is not a leaf concept.

Returns:

true if this FDBETCConcept is a leaf concept or false if this FDBETCConcept is not a leaf concept.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If this FDBETCConcept is not a child concept.

getDrugConceptLinkIndicator

boolean getDrugConceptLinkIndicator()
                             throws ETSDataException

Gets the drug concept link indicator of this FDBETCConcept.

Returns:

true if this FDBETCConcept has at least one associated GCNSEQNO.

Throws:

ETSDataException - If a data transport error occurs.

getFormularyLevelIndicator

int getFormularyLevelIndicator()
                        throws ETSDataException

Gets the formulary level indicator of this FDBETCConcept. The formulary level indicator is the suggested level for building formularies. This method returns 0 or 1 as values.

Returns:

Formulary level indicator of this FDBETCConcept.

Throws:

ETSDataException - If a data transport error occurs.

getPresentationSequenceNumber

int getPresentationSequenceNumber()
                           throws ETSDataException

Gets the presentation sequence number of this FDBETCConcept. The presentation sequence number is the recommended order of presenting this FDBETCConcept with its siblings.

Returns:

Presentation sequence number of this FDBETCConcept.

Throws:

ETSDataException - If a data transport error occurs.

getHierarchyLevel

int getHierarchyLevel()
               throws ETSDataException

Gets the hierarchy level of this FDBETCConcept within the FDB ETC concept hierarchy.

Returns:

Hierarchy level of this FDBETCConcept.

Throws:

ETSDataException - If a data transport error occurs.

getSortNumber

int getSortNumber()
           throws ETSDataException

Gets the sort number of this FDBETCConcept. The sort number is the recommended order of presenting this FDBETCConcept regardless of parents.

Returns:

Sort number of this FDBETCConcept.

Throws:

ETSDataException - If a data transport error occurs.