oracle.hsgbu.ets.fdb

Interface FDBCodingSchemeVersion

All Superinterfaces:

AttributableETSComponent, CodingSchemeVersion, ConceptContainer, ETSComponent

public interface FDBCodingSchemeVersion
extends CodingSchemeVersion

Defines extensions to the generic CodingSchemeVersion by providing operations that are specific to the First Data Bank (FDB) drug codes terminology. ETS assigns an internal concept code to the FDB Concepts. This internal code consists of FDB code (external concept code) of the concept, suffixed with a string that identifies the concept type. For example, an FDB allergen group concept that has an external concept code of 001 can have an internal concept code of 001-AGRP. An internal concept code is passed as a parameter to the getConceptByConceptCode(String) method defined in CodingSchemeVersion interface.

See Also:

CodingSchemeVersion

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_AHFS_CLASSIFICATION Constant that contains the AHFS Classification (AHFS) type code.
static String	TYPE_ALLERGEN_GROUP Constant that contains the Allergen Group (AGRP) type code.
static String	TYPE_BRAND_NAME Constant that contains the Brand Name (BN) type code.
static String	TYPE_DOSAGE_FORM Constant that contains the Dosage Form (DF) type code.
static String	TYPE_ETC Constant that contains the Enhanced Therapeutic Classification (ETC) type Code.
static String	TYPE_HIC Constant that contains the Hierarchical Ingredient Code (HIC) type code.
static String	TYPE_MEDICATION Constant that contains the Medication (MED) type code.
static String	TYPE_MEDICATION_NAME Constant that contains the Medication Name (MEDNM) type code.
static String	TYPE_MEDICATION_ROUTE Constant that contains the Medication Route (RT) type code.
static String	TYPE_NDC Constant that contains the NDC Drug (NDC) type code.
static String	TYPE_RDF_MEDICATION Constant that contains the Routed Dosage Form Medication (RDFM) type code.
static String	TYPE_ROUTED_MEDICATION Constant that contains the Routed Medication (RTMED) type code.

Method Summary

Modifier and Type	Method and Description
String	convertToFDBNDCCode(String code, int ndcFormatIndicator) Converts an FDA NDC, PIN, HRI, or UPC code to an FDB NDC code by using the specified NDC format indicator.
FDBAHFSClassificationConcept[]	getAllAHFSClassifications() Gets an array of AHFS classification concepts available within this FDBCodingSchemeVersion.
FDBAllergenGroupConcept[]	getAllAllergenGroups() Gets an array of all FDB allergen group concepts available in this FDBCodingSchemeVersion.
FDBETCConcept[]	getAllETCs() Gets an array of all FDB ETC concepts available in this FDBCodingSchemeVersion.
FDBConcept	getConceptByExternalConceptCode(String conceptCode, String conceptType) Gets the FDB concept that matches the specified external concept code and type identifier.
boolean	isValidExternalConceptCode(String conceptCode, String conceptType) Indicates whether the specified FDB external concept code is valid for the given Concept Type Identifier.

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

findConceptsByMatchingDescPatternAndConTypeCode, findConceptsByMatchingDescPatternAndDescTypeCode, getAllVersions, getCodingScheme, getConceptByConceptCode, getConceptsByExtendedTypeCode, getDefaultVersion, getDescription, getLatestActiveVersion, getLoadDate, getLocaleMaps, getName, getNextVersion, getPreviousVersion, getRelationshipTypes, getRetiredDate, isActive, isDefaultVersion, isQuarantined, isRetired, isValidConceptCode

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

contains, getAllConcepts, getConceptsWithAttribute, getConceptsWithAttributeName, getMatchingConceptsByDescriptionTerm, getMatchingConceptsByDescriptionTerm, getNumberOfConcepts

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_MEDICATION_NAME

static final String TYPE_MEDICATION_NAME

Constant that contains the Medication Name (MEDNM) type code.

See Also:

Constant Field Values

TYPE_MEDICATION

static final String TYPE_MEDICATION

Constant that contains the Medication (MED) type code.

See Also:

Constant Field Values

TYPE_ROUTED_MEDICATION

static final String TYPE_ROUTED_MEDICATION

Constant that contains the Routed Medication (RTMED) type code.

See Also:

Constant Field Values

TYPE_MEDICATION_ROUTE

static final String TYPE_MEDICATION_ROUTE

Constant that contains the Medication Route (RT) type code.

See Also:

Constant Field Values

TYPE_NDC

static final String TYPE_NDC

Constant that contains the NDC Drug (NDC) type code.

See Also:

Constant Field Values

TYPE_RDF_MEDICATION

static final String TYPE_RDF_MEDICATION

Constant that contains the Routed Dosage Form Medication (RDFM) type code.

See Also:

Constant Field Values

TYPE_DOSAGE_FORM

static final String TYPE_DOSAGE_FORM

Constant that contains the Dosage Form (DF) type code.

See Also:

Constant Field Values

TYPE_AHFS_CLASSIFICATION

static final String TYPE_AHFS_CLASSIFICATION

Constant that contains the AHFS Classification (AHFS) type code.

See Also:

Constant Field Values

TYPE_ETC

static final String TYPE_ETC

Constant that contains the Enhanced Therapeutic Classification (ETC) type Code.

See Also:

Constant Field Values

TYPE_BRAND_NAME

static final String TYPE_BRAND_NAME

Constant that contains the Brand Name (BN) type code.

See Also:

Constant Field Values

TYPE_HIC

static final String TYPE_HIC

Constant that contains the Hierarchical Ingredient Code (HIC) type code.

See Also:

Constant Field Values

TYPE_ALLERGEN_GROUP

static final String TYPE_ALLERGEN_GROUP

Constant that contains the Allergen Group (AGRP) type code.

See Also:

Constant Field Values

Method Detail

getAllAHFSClassifications

FDBAHFSClassificationConcept[] getAllAHFSClassifications()
                                                  throws ETSDataException

Gets an array of AHFS classification concepts available within this FDBCodingSchemeVersion. This method returns an empty array if this FDBCodingSchemeVersion does not contain any AHFS classification concepts.

Returns:

Array of FDB AHFS classification concepts, or an empty array if this FDBCodingSchemeVersion does not contain any AHFS classification concepts.

Throws:

ETSDataException - If a data transport error occurs.

getAllETCs

FDBETCConcept[] getAllETCs()
                    throws ETSDataException

Gets an array of all FDB ETC concepts available in this FDBCodingSchemeVersion. This method returns an empty array if this FDBCodingSchemeVersion does not contain any FDB ETC concepts.

Returns:

Array of FDB ETC concepts, or an empty array if this FDBCodingSchemeVersion does not contain any FDB ETC concepts.

Throws:

ETSDataException - If a data transport error occurs.

getAllAllergenGroups

FDBAllergenGroupConcept[] getAllAllergenGroups()
                                        throws ETSDataException

Gets an array of all FDB allergen group concepts available in this FDBCodingSchemeVersion. This method returns an empty array if this FDBCodingSchemeVersion does not contain any FDB allergen group concepts.

Returns:

Array of FDB allergen group concepts, or an empty array if this FDBCodingSchemeVersion does not contain any FDB allergen group concepts.

Throws:

ETSDataException - If a data transport error occurs.

getConceptByExternalConceptCode

FDBConcept getConceptByExternalConceptCode(String conceptCode,
                                           String conceptType)
                                    throws ETSNotFoundException,
                                           ETSBadParameterException,
                                           ETSDataException

Gets the FDB concept that matches the specified external concept code and type identifier. The type identifier can be any of the String constants provided by this interface. If the method cannot find the FDB concept with the given concept code and type, it throws an ETSNotFoundException.

Parameters:

conceptCode - External concept code of the specified FDB concept.

conceptType - Concept type identifier of the specified FDB concept.

Returns:

FDB concept that matches the specified external concept code and type identifier.

Throws:

ETSNotFoundException - If FDB concept cannot be found.

ETSBadParameterException - If invalid argument is passed. For example, if a null parameter is passed to the method.

ETSDataException - If a data transport error occurs.

isValidExternalConceptCode

boolean isValidExternalConceptCode(String conceptCode,
                                   String conceptType)
                            throws ETSBadParameterException,
                                   ETSDataException

Indicates whether the specified FDB external concept code is valid for the given Concept Type Identifier. This method returns true if the specified external concept code is valid for the given concept type Identifier. The method returns false if the specified external concept code is invalid for the given concept type Identifier.

Parameters:

conceptCode - FDB external concept code.

conceptType - Concept type identifier.

Returns:

true if the specified external concept code is valid for the given concept type identifier or false if the specified external concept code is invalid for the given concept type identifier.

Throws:

ETSBadParameterException - If an invalid parameter is passed.

ETSDataException - If a data transport error occurs.

convertToFDBNDCCode

String convertToFDBNDCCode(String code,
                           int ndcFormatIndicator)
                    throws ETSBadParameterException

Converts an FDA NDC, PIN, HRI, or UPC code to an FDB NDC code by using the specified NDC format indicator. All NDC codes stored in ETS use the FDB concept code format. The format of the code parameter must be compatible with the NDC format indicator, else the method returns an invalid result.

Parameters:

code - FDA NDC, PIN, HRI, or UPC code to convert.

ndcFormatIndicator - NDC format indicator that specifies the format of conversion.

Returns:

An FDB concept Code.

Throws:

ETSBadParameterException - If an invalid parameter is passed.