oracle.hsgbu.ets.fdb

Interface FDBMedicationConcept

All Superinterfaces:

AttributableETSComponent, Concept, ETSComponent, FDBConcept, FDBDrugConcept, ReassignableETSComponent, RetirableETSComponent

public interface FDBMedicationConcept
extends FDBDrugConcept

Defines operations that are executed for this FDBMedicationConcept.

See Also:

FDBDrugConcept

Field Summary

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

STATUS_ACTIVE, STATUS_INACTIVE, STATUS_REPLACED, STATUS_RETIRED, STATUS_UNASSOCIATED

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
FDBETCConcept	getCommonETC() Gets the common FDB enhanced therapeutic classification concept of this FDBMedicationConcept.
String	getDEAClassCode() Gets the DEA class code associated with this FDBMedicationConcept.
FDBETCConcept	getDefaultETC() Gets the default FDB enhanced therapeutic classification concept of this FDBMedicationConcept.
FDBETCConcept[]	getETCs() Gets an array of active FDB enhanced therapeutic classification concepts that contain this FDBMedicationConcept.
String	getFederalLegendIndicator() Gets the federal legend indicator associated with this FDBMedicationConcept.
String	getGCNSEQAssgnCode() Gets the GCN sequence number assignment code associated with this FDBMedicationConcept.
String	getGCNSEQNO() Gets the GCN sequence number associated with this FDBMedicationConcept.
FDBMedicationConcept	getGenericMedication() Gets the FDB generic medication concept related to this FDBMedicationConcept.
String	getGenericMedID() Gets the generic medication identifier of this FDBMedicationConcept.
String	getMedRefGenNameCode() Gets the medication reference generic medication name code of this FDBMedicationConcept.
FDBNDCDrugConcept[]	getNDCDrugs() Gets an array of all active FDB NDC drug concepts related to this FDBMedicationConcept.
FDBRDFMedicationConcept	getRDFMedication() Gets the routed dosage form medication concept related to this FDBMedicationConcept.
String	getStrength() Gets the strength associated with this FDBMedicationConcept.
String	getStrengthUnits() Gets the units that measure the strength of this FDBMedicationConcept.
boolean	hasNDCDrugs() Indicates whether this FDBMedicationConcept is directly related to active FDBNDCDrugConcept.
boolean	isGeneric() Indicates whether this FDBMedicationConcept is a generic concept.

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

getAHFSClassifications, getStatusCode

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

getETCs

FDBETCConcept[] getETCs()
                 throws ETSDataException

Gets an array of active FDB enhanced therapeutic classification concepts that contain this FDBMedicationConcept. This method returns an empty array if none of the active FDB enhanced therapeutic classification concepts contain this FDBMedicationConcept.

Returns:

Array of active FDB enhanced therapeutic classification concepts that contain this FDBMedicationConcept, or an empty array if no active FDB enhanced therapeutic classification concept contains this FDBMedicationConcept.

Throws:

ETSDataException - If a data transport error occurs.

getDefaultETC

FDBETCConcept getDefaultETC()
                     throws ETSDataException,
                            ETSNotFoundException

Gets the default FDB enhanced therapeutic classification concept of this FDBMedicationConcept.

Returns:

Default FDB enhanced therapeutic classification concept of this FDBMedicationConcept.

Throws:

ETSNotFoundException - If this FDBMedicationConcept does not have a default FDB enhanced therapeutic classification concept.

ETSDataException - If a data transport error occurs.

getCommonETC

FDBETCConcept getCommonETC()
                    throws ETSDataException,
                           ETSNotFoundException

Gets the common FDB enhanced therapeutic classification concept of this FDBMedicationConcept.

Returns:

Common FDB enhanced therapeutic classification concept of this FDBMedicationConcept.

Throws:

ETSNotFoundException - If this FDBMedicationConcept does not have a common FDB enhanced therapeutic classification concept.

ETSDataException - If a data transport error occurs.

getDEAClassCode

String getDEAClassCode()
                throws ETSDataException

Gets the DEA class code associated with this FDBMedicationConcept. The maximum length of this attribute is 30.

Returns:

DEA class code associated with this FDBMedicationConcept.

Throws:

ETSDataException - If a data transport error occurs.

getFederalLegendIndicator

String getFederalLegendIndicator()
                          throws ETSDataException

Gets the federal legend indicator associated with this FDBMedicationConcept. The maximum length of this attribute is 30.

Returns:

federal legend indicator associated with this FDBMedicationConcept.

Throws:

ETSDataException - If a data transport error occurs.

getGCNSEQAssgnCode

String getGCNSEQAssgnCode()
                   throws ETSDataException

Gets the GCN sequence number assignment code associated with this FDBMedicationConcept. The maximum length of this attribute is 30.

Returns:

GCN sequence number assignment code associated with this FDBMedicationConcept.

Throws:

ETSDataException - If a data transport error occurs.

getGCNSEQNO

String getGCNSEQNO()
            throws ETSDataException

Gets the GCN sequence number associated with this FDBMedicationConcept. The maximum length of this attribute is 30.

Returns:

GCN sequence number associated with this FDBMedicationConcept.

Throws:

ETSDataException - If a data transport error occurs.

getGenericMedID

String getGenericMedID()
                throws ETSDataException

Gets the generic medication identifier of this FDBMedicationConcept. The generic medication identifier can be an external concept code of another FDB medication concept. This code represents the generic form of this FDBBrandMedication, or "00000000". The getConceptByExternalConceptCode(String conceptCode, String conceptType) method, defined in the FDBCodingSchemeVersion interface takes a valid medication identifier as the first parameter. However, the type code of the medication identifier is FDBCodingSchemeVersion.TYPE_MEDICATION. The getConceptByExternalConceptCode(String conceptCode, String conceptType) method returns the FDB concept that matches the specified external medication identifier and type identifier. The method throws an ETSNotFoundException if an invalid medication identifier is passed as a parameter.
The maximum length of this attribute is 30.

Returns:

generic medication identifier of this FDBMedicationConcept.

Throws:

ETSDataException - If a data transport error occurs.

getGenericMedication

FDBMedicationConcept getGenericMedication()
                                   throws ETSDataException,
                                          ETSNotFoundException

Gets the FDB generic medication concept related to this FDBMedicationConcept.

Returns:

FDB generic medication concept related to this FDBMedicationConcept. This method gives the same result as passing the generic medication identifier to the getConceptByExternalConceptCode (String conceptCode, String conceptType) method with a conceptType specified by FDBCodingSchemeVersion.TYPE_MEDICATION.

Throws:

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If this FDBMedicationConcept does not have a valid generic medication identifier.

isGeneric

boolean isGeneric()
           throws ETSDataException

Indicates whether this FDBMedicationConcept is a generic concept. This method returns true if this FDBMedicationConcept is generic or false if this FDBMedicationConcept is not generic. A medication concept is generic if it is not related to any generic medication. generic medication is one that has the generic medication ID as "00000000".

Returns:

true if this FDBMedicationConcept is a generic concept or false if this FDBMedicationConcept is not generic.

Throws:

ETSDataException - If a data transport error occurs.

getMedRefGenNameCode

String getMedRefGenNameCode()
                     throws ETSDataException

Gets the medication reference generic medication name code of this FDBMedicationConcept. The maximum length of this attribute is 30.

Returns:

Medication reference generic medication name code of this FDBMedicationConcept.

Throws:

ETSDataException - If a data transport error occurs.

getNDCDrugs

FDBNDCDrugConcept[] getNDCDrugs()
                         throws ETSDataException

Gets an array of all active FDB NDC drug concepts related to this FDBMedicationConcept. This method returns an empty array if this FDB medication concept is not related to any active FDB NDC drug concepts.

Returns:

Array of all active FDB NDC drug concepts related to this FDBMedicationConcept, or an empty array if this FDB medication concept is not related to any active FDB NDC drug concepts.

Throws:

ETSDataException - If a data transport error occurs.

hasNDCDrugs

boolean hasNDCDrugs()
             throws ETSDataException

Indicates whether this FDBMedicationConcept is directly related to active FDBNDCDrugConcept. This method returns true if this FDBMedicationConcept is directly related to active FDB NDC drug concepts or false if this FDBMedicationConcept is not related to active FDB NDC drug concepts.

Returns:

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

Throws:

ETSDataException - If a data transport error occurs.

getRDFMedication

FDBRDFMedicationConcept getRDFMedication()
                                  throws ETSNotFoundException,
                                         ETSDataException

Gets the routed dosage form medication concept related to this FDBMedicationConcept.

Returns:

routed dosage form medication concept related to this FDBMedicationConcept.

Throws:

ETSNotFoundException - If routed dosage form Medication is not found.

ETSDataException - If a data transport error occurs.

getStrength

String getStrength()
            throws ETSNotFoundException,
                   ETSDataException

Gets the strength associated with this FDBMedicationConcept. The strength depicts how much of the active ingredient is present in each dosage. For example, 100 mg is the strength of a 100 mg ibuprofen tablet. The maximum length of this attribute is 30.

Returns:

Strength associated with this FDBMedicationConcept. The strength depicts the unit of medication administered to the patient.

Throws:

ETSNotFoundException - If this FDBMedicationConcept does not have an associated strength.

ETSDataException - If a data transport error occurs.

getStrengthUnits

String getStrengthUnits()
                 throws ETSNotFoundException,
                        ETSDataException

Gets the units that measure the strength of this FDBMedicationConcept. For example, the units can be measured in milligrams. The maximum length of this attribute is 30.

Returns:

Units that measure the strength of this FDBMedicationConcept.

Throws:

ETSNotFoundException - If this FDBMedicationConcept has no associated strength and hence no units to measure the strength.

ETSDataException - If a data transport error occurs.