oracle.hsgbu.ets.fdb

Interface FDBClassificationConcept

All Superinterfaces:

AttributableETSComponent, Concept, ETSComponent, FDBConcept, ReassignableETSComponent, RetirableETSComponent

All Known Subinterfaces:

FDBAHFSClassificationConcept, FDBETCConcept

public interface FDBClassificationConcept
extends FDBConcept

Defines operations that are executed for this FDBClassificationConcept.

See Also:

FDBConcept

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_ACTIVE Object-retrieval type: ACTIVE CONCEPTS ONLY.
static int	TYPE_ALL Object-retrieval type: ALL CONCEPTS.

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
FDBClassificationConcept[]	getChildren() Gets an array of FDB classification concepts that are the direct children of this FDBClassificationConcept.
FDBMedicationNameConcept[]	getMedicationNames(int retrievalType) Gets an array that contains FDB medication name concepts related to this FDBClassificationConcept.
FDBMedicationConcept[]	getMedications(int retrievalType) Gets an array that contains FDB medication concepts related to this FDBClassificationConcept.
FDBNDCDrugConcept[]	getNDCDrugs(int retrievalType) Gets an array that contains FDB NDC drug concepts related to this FDBClassificationConcept.
FDBClassificationConcept	getParent() Gets the FDBClassificationConcept that is the immediate parent of this FDBClassificationConcept.
FDBRDFMedicationConcept[]	getRDFMedications(int retrievalType) Gets an array that contains routed dosage form medication concepts related to this FDBClassificationConcept.
FDBRoutedMedicationConcept[]	getRoutedMedications(int retrievalType) Gets an array that contains FDB routed medication concepts related to this FDBClassificationConcept.
boolean	hasMedicationNames(int retrievalType) Indicates whether this FDBClassificationConcept is related to one or more FDB Medication Name Concepts.
boolean	hasMedications(int retrievalType) Indicates whether this FDBClassificationConcept is related to one or more FDB Medication Concepts.
boolean	hasNDCDrugs(int retrievalType) Indicates whether this FDBClassificationConcept is directly related to one or more FDB NDC Drug Concepts.
boolean	hasRDFMedications(int retrievalType) Indicates whether this FDBClassificationConcept is related to one or more FDB Routed Dosage Form Medication Concepts.
boolean	hasRoutedMedications(int retrievalType) Indicates whether this FDBClassificationConcept is related to one or more FDB Routed Medication Concepts.

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

Field Detail

TYPE_ACTIVE

static final int TYPE_ACTIVE

Object-retrieval type: ACTIVE CONCEPTS ONLY.

This constant can be passed to methods such as getNDCDrugs(int) and getMedications(int) to specify that only active concepts are included in the result.

See Also:

Constant Field Values

TYPE_ALL

static final int TYPE_ALL

Object-retrieval type: ALL CONCEPTS.

This constant can be passed to methods such as getNDCDrugs(int) and getMedications(int) to specify that all concepts are included in the result. The included concepts can be both active and retired.

See Also:

Constant Field Values

Method Detail

getChildren

FDBClassificationConcept[] getChildren()
                                throws ETSDataException

Gets an array of FDB classification concepts that are the direct children of this FDBClassificationConcept. This method returns an empty array if this FDBClassificationConcept is not directly related to any child FDB classification concepts.

Returns:

Array of FDB classification concepts that are the direct children of this FDBClassificationConcept, or an empty array if this FDBClassificationConcept is not directly related to any child FDB classification concepts.

Throws:

ETSDataException - If a data transport error occurs.

hasNDCDrugs

boolean hasNDCDrugs(int retrievalType)
             throws ETSDataException

Indicates whether this FDBClassificationConcept is directly related to one or more FDB NDC Drug Concepts. This method returns true if this FDBClassificationConcept is directly related to FDB NDC drug concepts. The method returns false if this FDBClassificationConcept is not related to FDB NDC drug concepts.
For example, when a FDBClassificationConcept represents antibiotics, this method returns true if the FDBClassificationConcept is directly related to one or more Antibiotic NDC drug concepts.

FDB classification concepts share a parent-child relationship with FDB NDC drug concepts. This means that the FDB classification concept is the parent and FDB NDC drug concept is the child.

Parameters:

retrievalType - Specifies the mode of retrieval. The modes can be TYPE_ACTIVE or TYPE_ALL.

Returns:

true if this FDBClassificationConcept is directly related to FDB NDC drug concepts or false if this FDBClassificationConcept is not related to FDB NDC drug concepts.

Throws:

ETSDataException - If a data transport error occurs.

getNDCDrugs

FDBNDCDrugConcept[] getNDCDrugs(int retrievalType)
                         throws ETSDataException

Gets an array that contains FDB NDC drug concepts related to this FDBClassificationConcept. This method returns an empty array if this FDBClassificationConcept is not related to any FDB NDC drug concepts.

Parameters:

retrievalType - Specifies the mode of retrieval. The modes can be TYPE_ACTIVE or TYPE_ALL.

Returns:

Array that contains FDB NDC drug concepts related to this FDBClassificationConcept, or an empty array if there are no FDB NDC drug concepts related to this FDBClassificationConcept.

Throws:

ETSDataException - If a data transport error occurs.

hasMedications

boolean hasMedications(int retrievalType)
                throws ETSDataException

Indicates whether this FDBClassificationConcept is related to one or more FDB Medication Concepts. This method returns true if this FDBClassificationConcept is related to FDB medication concepts or false if this FDBClassificationConcept is not related to FDB medication concepts.

Parameters:

retrievalType - Specifies the mode of retrieval. The modes can be TYPE_ACTIVE or TYPE_ALL.

Returns:

true if this FDBClassificationConcept is related to FDB medication concepts or false if this FDBClassificationConcept is not related to FDB medication concepts.

Throws:

ETSDataException - If a data transport error occurs.

getMedications

FDBMedicationConcept[] getMedications(int retrievalType)
                               throws ETSDataException

Gets an array that contains FDB medication concepts related to this FDBClassificationConcept. This method returns an empty array if this FDBClassificationConcept is not related to any FDB medication concepts.

Parameters:

retrievalType - Specifies the mode of retrieval. The modes can be TYPE_ACTIVE or TYPE_ALL.

Returns:

Array that contains FDB medication concepts related to this FDBClassificationConcept, or an empty array if this FDBClassificationConcept is not related to any FDB Medication Concepts.

Throws:

ETSDataException - If a data transport error occurs.

hasRDFMedications

boolean hasRDFMedications(int retrievalType)
                   throws ETSDataException

Indicates whether this FDBClassificationConcept is related to one or more FDB Routed Dosage Form Medication Concepts. This method returns true if this FDBClassificationConcept is related to FDB routed dosage form medication concepts or false if this FDBClassificationConcept is not related to FDB routed dosage form medication concepts.

Parameters:

retrievalType - Specifies the mode of retrieval. The modes can be TYPE_ACTIVE or TYPE_ALL.

Returns:

true if this FDBClassificationConcept is related to routed dosage form medication concepts or false if this FDBClassificationConcept is not related to FDB routed dosage form medication concepts.

Throws:

ETSDataException - If a data transport error occurs.

getRDFMedications

FDBRDFMedicationConcept[] getRDFMedications(int retrievalType)
                                     throws ETSDataException

Gets an array that contains routed dosage form medication concepts related to this FDBClassificationConcept. This method returns an empty array if this FDBClassificationConcept is not related to any routed dosage form medication concepts.

Parameters:

retrievalType - Specifies the mode of retrieval. The modes can be TYPE_ACTIVE or TYPE_ALL.

Returns:

Array that contains routed dosage form medication concepts related to this FDBClassificationConcept, or an empty array if this FDBClassificationConcept is not related to any routed dosage form medication concepts.

Throws:

ETSDataException - If a data transport error occurs.

hasRoutedMedications

boolean hasRoutedMedications(int retrievalType)
                      throws ETSDataException

Indicates whether this FDBClassificationConcept is related to one or more FDB Routed Medication Concepts. This method returns true if this FDBClassificationConcept is related to FDB routed medication concepts or false if this FDBClassificationConcept is not related to FDB routed medication concepts.

Parameters:

retrievalType - Specifies the mode of retrieval. The modes can be TYPE_ACTIVE or TYPE_ALL.

Returns:

true if this FDBClassificationConcept is related to FDB routed medication concepts or false if this FDBClassificationConcept is not related to FDB routed medication concepts.

Throws:

ETSDataException - If a data transport error occurs.

getRoutedMedications

FDBRoutedMedicationConcept[] getRoutedMedications(int retrievalType)
                                           throws ETSDataException

Gets an array that contains FDB routed medication concepts related to this FDBClassificationConcept. This method returns an empty array if this FDBClassificationConcept is not related to any FDB routed medication concepts.

Parameters:

retrievalType - Specifies the mode of retrieval. The modes can be TYPE_ACTIVE or TYPE_ALL.

Returns:

Array that contains FDB routed medication concepts related to this FDBClassificationConcept or an empty array if there are no FDB routed medication concepts related to this FDBClassificationConcept.

Throws:

ETSDataException - If a data transport error occurs.

hasMedicationNames

boolean hasMedicationNames(int retrievalType)
                    throws ETSDataException

Indicates whether this FDBClassificationConcept is related to one or more FDB Medication Name Concepts. This method returns true if this FDBClassificationConcept is related to FDB medication name concepts or false if this FDBClassificationConcept is not related to FDB medication name concepts.

Parameters:

retrievalType - Specifies the mode of retrieval. The modes can be TYPE_ACTIVE or TYPE_ALL.

Returns:

true if this FDBClassificationConcept is related to FDB medication name concepts or false if this FDBClassificationConcept is not related to FDB medication name concepts.

Throws:

ETSDataException - If a data transport error occurs.

getMedicationNames

FDBMedicationNameConcept[] getMedicationNames(int retrievalType)
                                       throws ETSDataException

Gets an array that contains FDB medication name concepts related to this FDBClassificationConcept. This method returns an empty array if this FDBClassificationConcept is not related to any FDB medication name concepts.

Parameters:

retrievalType - Specifies the mode of retrieval. The modes can be TYPE_ACTIVE or TYPE_ALL.

Returns:

Array that contains medication name concepts related to this FDBClassificationConcept, or an empty array if this FDBClassificationConcept is not related to any FDB medication name concepts.

Throws:

ETSDataException - If a data transport error occurs.

getParent

FDBClassificationConcept getParent()
                            throws ETSNotFoundException,
                                   ETSDataException

Gets the FDBClassificationConcept that is the immediate parent of this FDBClassificationConcept.

Returns:

Parent FDBClassificationConcept of this FDBClassificationConcept.

Throws:

ETSNotFoundException - If this FDBClassificationConcept is not directly related to a parent concept.

ETSDataException - If a data transport error occurs.