oracle.hsgbu.ets.fdb

Interface FDBNDCDrugConcept

All Superinterfaces:

AttributableETSComponent, Concept, ETSComponent, FDBConcept, ReassignableETSComponent, RetirableETSComponent

public interface FDBNDCDrugConcept
extends FDBConcept

Defines operations that are executed for this FDBNDCDrugConcept. NDC (National Drug Code) is a US Food and Drug Administration system of codes for identifying packaged drugs. For example, Prozac, bottle of 100 10mg tablets has an NDC code.

See Also:

FDBDrugConcept

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
FDBAHFSClassificationConcept[]	getAHFSClassifications() Gets array of AHFS classification concepts that are related to this FDBNDCDrugConcept.
FDBNDCBrandNameConcept	getBrandName() Gets the FDB brand name concept that is associated with this FDBNDCDrugConcept.
FDBETCConcept	getCommonETC() Gets the common enhanced therapeutic classification of this FDBNDCDrugConcept.
String	getDEACode() Gets the Drug Enforcement Administration (DEA) code that is associated with this FDBNDCDrugConcept.
FDBETCConcept	getDefaultETC() Gets the default enhanced therapeutic classification of this FDBNDCDrugConcept.
String	getDrugClass() Gets the drug class that is associated with this FDBNDCDrugConcept.
FDBETCConcept[]	getETCs() Gets an array of all enhanced therapeutic classifications to which this NDCDrugConcept belongs.
String	getExternalIdentifyingNDCCode() Gets the external FDB NDC drug code.
String	getGCNSEQNO() Gets the GCN sequence number that is associated with this FDBNDCDrug Concept.
String	getGenericNamedDrugIndicator() Gets the generic named drug indicator that is associated with this FDBNDCDrugConcept.
String	getHCFACommonProcedureCode() Gets the HCFA common procedure code associated with this FDBNDCDrugConcept.
String	getHospitalSelectionIndicator() Gets the hospital selection indicator associated with this FDBNDCDrugConcept.
FDBMedicationConcept	getMedication() Gets the FDB medication concept related to this FDBNDCDrugConcept.
int	getNDCFormatIndicator() Gets the NDC format indicator that is associated with this FDBNDCDrugConcept.
FDBNDCDrugConcept	getPreviousNDC() Gets the previous FDB NDC drug concept that is replaced by this FDBNDCDrugConcept.
FDBNDCDrugConcept	getReplacementNDC() Gets the FDB NDC drug concept that replaced this FDBNDCDrugConcept.
String	getSmartKey() Gets the smart key associated with this FDBNDCDrugConcept.
boolean	hasAHFSClassifications() Indicates if this FDBNDCDrugConcept is directly related to one or more AHFS classification concepts.
boolean	isDrug() Indicates whether this FDBNDCDrugConcept represents a drug.

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

getAHFSClassifications

FDBAHFSClassificationConcept[] getAHFSClassifications()
                                               throws ETSDataException

Gets array of AHFS classification concepts that are related to this FDBNDCDrugConcept. This method returns an empty array if this FDBNDCDrugConcept is not related to any AHFS classification concepts.

Returns:

Array that contains AHFS classification concepts related to this FDBNDCDrugConcept, or an empty array if this FDBNDCDrugConcept is not related to any AHFS classification concepts.

Throws:

ETSDataException - If a data transport error occurs.

getETCs

FDBETCConcept[] getETCs()
                 throws ETSDataException

Gets an array of all enhanced therapeutic classifications to which this NDCDrugConcept belongs. This method returns an empty array, if this NDCDrugConcept does not belong to any enhanced therapeutic classifications.

Returns:

Array of enhanced therapeutic classification concepts to which this NDCDrugConcept belongs, or an empty array if this NDCDrugConcept does not belong to any enhanced therapeutic classifications.

Throws:

ETSDataException - If a data transport error occurs.

getDefaultETC

FDBETCConcept getDefaultETC()
                     throws ETSDataException,
                            ETSNotFoundException

Gets the default enhanced therapeutic classification of this FDBNDCDrugConcept.

Returns:

Default enhanced therapeutic classification concept.

Throws:

ETSNotFoundException - If this FDBNDCDrugConcept does not have a default enhanced therapeutic classification.

ETSDataException - If a data transport error occurs.

getCommonETC

FDBETCConcept getCommonETC()
                    throws ETSDataException,
                           ETSNotFoundException

Gets the common enhanced therapeutic classification of this FDBNDCDrugConcept.

Returns:

Common enhanced therapeutic classification.

Throws:

ETSNotFoundException - If this FDBNDCDrugConcept does not have a common enhanced therapeutic classification.

ETSDataException - If a data transport error occurs.

hasAHFSClassifications

boolean hasAHFSClassifications()
                        throws ETSDataException

Indicates if this FDBNDCDrugConcept is directly related to one or more AHFS classification concepts. This method returns true if this FDBNDCDrugConcept is directly related to AHFS classification concepts or false if not directly related.

Returns:

true if this FDBNDCDrugConcept is directly related to AHFS classification concepts or false if not directly related.

Throws:

ETSDataException - If a data transport error occurs.

getBrandName

FDBNDCBrandNameConcept getBrandName()
                             throws ETSDataException

Gets the FDB brand name concept that is associated with this FDBNDCDrugConcept.

Returns:

FDB brand name concept that is associated with this FDBNDCDrugConcept.

Throws:

ETSDataException - If a data transport error occurs.

getDEACode

String getDEACode()
           throws ETSDataException

Gets the Drug Enforcement Administration (DEA) code that is associated with this FDBNDCDrugConcept. The DEA code denotes the degree of potential abuse and federal control of a drug. This code is subject to change by federal regulation.
For example, the DEA code 0 denotes No control and 1 denotes LSD, Heroin, and Marijuana. The maximum length of this attribute is 1.

Returns:

DEA code associated with this FDBNDCDrugConcept.

Throws:

ETSDataException - If a data transport error occurs.

getDrugClass

String getDrugClass()
             throws ETSDataException

Gets the drug class that is associated with this FDBNDCDrugConcept. The maximum length of this attribute is 1.

Returns:

drug class that is associated with this FDBNDCDrugConcept.

Throws:

ETSDataException - If a data transport error occurs.

getGCNSEQNO

String getGCNSEQNO()
            throws ETSDataException

Gets the GCN sequence number that is associated with this FDBNDCDrug Concept. The maximum length of this attribute is 240.

Returns:

GCN sequence number that is associated with this FDBNDCDrugConcept.

Throws:

ETSDataException - If a data transport error occurs.

getGenericNamedDrugIndicator

String getGenericNamedDrugIndicator()
                             throws ETSDataException

Gets the generic named drug indicator that is associated with this FDBNDCDrugConcept. The maximum length of this attribute is 1.

Returns:

Generic named drug indicator that is associated with this FDBNDCDrugConcept.

Throws:

ETSDataException - If a data transport error occurs.

getHCFACommonProcedureCode

String getHCFACommonProcedureCode()
                           throws ETSDataException

Gets the HCFA common procedure code associated with this FDBNDCDrugConcept. The maximum length of this attribute is 1.

Returns:

HCFA common procedure code associated with this FDBNDCDrugConcept.

Throws:

ETSDataException - If a data transport error occurs.

getHospitalSelectionIndicator

String getHospitalSelectionIndicator()
                              throws ETSDataException

Gets the hospital selection indicator associated with this FDBNDCDrugConcept. The maximum length of this attribute is 1.

Returns:

Hospital selection indicator associated with this FDBNDCDrugConcept.

Throws:

ETSDataException - If a data transport error occurs.

getMedication

FDBMedicationConcept getMedication()
                            throws ETSNotFoundException,
                                   ETSDataException

Gets the FDB medication concept related to this FDBNDCDrugConcept.

Returns:

FDB medication concept related to this FDBNDCDrugConcept.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If the required FDB medication concept is not found.

getPreviousNDC

FDBNDCDrugConcept getPreviousNDC()
                          throws ETSNotFoundException,
                                 ETSDataException

Gets the previous FDB NDC drug concept that is replaced by this FDBNDCDrugConcept.

Returns:

FDB NDC drug concept that is replaced by this .

Throws:

ETSNotFoundException - If the previous FDB NDC drug concept does not exist.

ETSDataException - If a data transport error occurs.

getReplacementNDC

FDBNDCDrugConcept getReplacementNDC()
                             throws ETSNotFoundException,
                                    ETSDataException

Gets the FDB NDC drug concept that replaced this FDBNDCDrugConcept.

Returns:

FDB NDC drug concept that replaced this FDBNDCDrugConcept.

Throws:

ETSNotFoundException - If the replacement FDB NDC drug concept does not exist.

ETSDataException - If a data transport error occurs.

getSmartKey

String getSmartKey()
            throws ETSDataException

Gets the smart key associated with this FDBNDCDrugConcept. The maximum length of this attribute is 24.

Returns:

Smart key associated with this FDBNDCDrugConcept.

Throws:

ETSDataException - If a data transport error occurs.

getNDCFormatIndicator

int getNDCFormatIndicator()
                   throws ETSDataException

Gets the NDC format indicator that is associated with this FDBNDCDrugConcept.

Returns:

NDC format indicator that is associated with this FDBNDCDrugConcept.

Throws:

ETSDataException - If a data transport error occurs.

isDrug

boolean isDrug()
        throws ETSDataException

Indicates whether this FDBNDCDrugConcept represents a drug. This method returns true if this FDBNDCDrugConcept represents a drug or false if this FDBNDCDrugConcept represents a non-drug.

Returns:

true if this FDBNDCDrugConcept represents a drug or false if this FDBNDCDrugConcept represents a non-drug.

Throws:

ETSDataException - If a data transport error occurs.

getExternalIdentifyingNDCCode

String getExternalIdentifyingNDCCode()
                              throws ETSDataException

Gets the external FDB NDC drug code. This method converts the NDC codes from the internal representation provided by FDB to an FDA NDC code, a PIN code, a UPC code, or an HRI code. The conversion is done depending upon the value of the NDC format indicator, The maximum length of this attribute is 30.

Returns:

External format of the FDB NDC drug code.

Throws:

ETSDataException - If a data transport error occurs.