com.aetna.api.hhs
Class HHSAPI

java.lang.Object
  com.aetna.api.hhs.HHSAPI

public class HHSAPI
extends java.lang.Object

HHS application program interface java endpoitns.

Constructor Summary

HHSAPI(java.lang.String apiKey)

Method Summary

java.util.List<Alternative>	getAllAlternatives(java.lang.String nda) Retrieves alternative therapies for the provided
java.util.List<DrugNDC>	getAllDrugByNDC(java.lang.String ndc2) Retrieves a list of drugs according to the NC2 segment with its package info and imprints
java.util.List<DrugImage>	getAllDrugImages(java.lang.String ndc2) Retrieves a list of images of the drugs for the given NDC2 segment
java.util.List<DrugPackageInfo>	getAllDrugPackageInfo(java.lang.String ndc2, java.lang.String ndc3) Retrieves the package info of drug according to the given NDC2 segment and the NDC3 segment
java.util.List<Nda>	getAllNDA(java.lang.String nda) Retrieves a list of NDAs based on the NDA supplied
java.lang.String	getApiKey() Retrieve current api key that was specified
java.util.List<Document>	getDocuments(java.lang.String nda) Retrieves list of Drug Documents
java.util.List<ART>	listARTs(java.util.Map<java.lang.String,java.lang.String> searchParameter, boolean exactMatch) Finds a ART based on the given parameter and value
ClinicalTrialsSearch	listClinicalTrials(java.util.Map<java.lang.String,java.lang.String> searchParameter) Finds a Clinical Trial based on the given parameter and value
java.util.List<ClinicalTrialsNCTID>	listClinicalTrialsNCTID(java.lang.String nctid) Finds clinical trials information according to the registry number indicated
java.util.List<DrugResource>	listDrugResources(java.lang.String nda) Retrieves a list of DrugResources InvalidCredentialException
java.util.List<DrugSearch>	listDrugs(java.lang.String drugName) Finds a drug based on drug name
java.util.List<FDARecallSearch>	listFDARecall(java.util.Map<java.lang.String,java.lang.String> searchParameter) Finds a FDA Recall based on the given parameter and value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HHSAPI

public HHSAPI(java.lang.String apiKey)

Parameters:

apiKey - the API key

Method Detail

getApiKey

public java.lang.String getApiKey()

Retrieve current api key that was specified

Returns:

apiKey

getDocuments

public java.util.List<Document> getDocuments(java.lang.String nda)
                                      throws InvalidCredentialException,
                                             java.io.IOException,
                                             java.net.MalformedURLException

Retrieves list of Drug Documents

Parameters:

nda - The NDA code

Returns:

List

Throws:

InvalidCredentialException

java.io.IOException

java.net.MalformedURLException

getAllNDA

public java.util.List<Nda> getAllNDA(java.lang.String nda)
                              throws InvalidCredentialException,
                                     java.io.IOException,
                                     java.net.MalformedURLException

Retrieves a list of NDAs based on the NDA supplied

Parameters:

nda - The NDA code

Returns:

List

Throws:

InvalidCredentialException

java.io.IOException

java.net.MalformedURLException

getAllAlternatives

public java.util.List<Alternative> getAllAlternatives(java.lang.String nda)
                                               throws InvalidCredentialException,
                                                      java.io.IOException,
                                                      java.net.MalformedURLException

Retrieves alternative therapies for the provided

Parameters:

nda - The NDA code

Returns:

List

Throws:

InvalidCredentialException

java.io.IOException

java.net.MalformedURLException

listDrugResources

public java.util.List<DrugResource> listDrugResources(java.lang.String nda)
                                               throws InvalidCredentialException,
                                                      java.io.IOException,
                                                      java.net.MalformedURLException

Retrieves a list of DrugResources InvalidCredentialException

Parameters:

nda - The NDA code

Returns:

List

Throws:

InvalidCredentialException

java.io.IOException

java.net.MalformedURLException

listDrugs

public java.util.List<DrugSearch> listDrugs(java.lang.String drugName)
                                     throws InvalidCredentialException,
                                            java.io.IOException,
                                            java.net.MalformedURLException

Finds a drug based on drug name

Parameters:

drugName - The drug name

Returns:

List

Throws:

InvalidCredentialException

java.io.IOException

java.net.MalformedURLException

getAllDrugImages

public java.util.List<DrugImage> getAllDrugImages(java.lang.String ndc2)
                                           throws InvalidCredentialException,
                                                  java.io.IOException,
                                                  java.net.MalformedURLException

Retrieves a list of images of the drugs for the given NDC2 segment

Parameters:

ndc2 - the given NDC2 segment

Returns:

List

Throws:

InvalidCredentialException

java.io.IOException

java.net.MalformedURLException

getAllDrugByNDC

public java.util.List<DrugNDC> getAllDrugByNDC(java.lang.String ndc2)
                                        throws InvalidCredentialException,
                                               java.io.IOException,
                                               java.net.MalformedURLException

Retrieves a list of drugs according to the NC2 segment with its package info and imprints

Parameters:

ndc2 - the NDC two segment

Returns:

List

Throws:

InvalidCredentialException

java.io.IOException

java.net.MalformedURLException

getAllDrugPackageInfo

public java.util.List<DrugPackageInfo> getAllDrugPackageInfo(java.lang.String ndc2,
                                                             java.lang.String ndc3)
                                                      throws InvalidCredentialException,
                                                             java.io.IOException,
                                                             java.net.MalformedURLException

Retrieves the package info of drug according to the given NDC2 segment and the NDC3 segment

Parameters:

ndc2 - the NDC two segment

ndc3 - the NDC three segment

Returns:

List

Throws:

InvalidCredentialException

java.io.IOException

java.net.MalformedURLException

listARTs

public java.util.List<ART> listARTs(java.util.Map<java.lang.String,java.lang.String> searchParameter,
                                    boolean exactMatch)
                             throws InvalidCredentialException,
                                    java.io.IOException,
                                    java.net.MalformedURLException

Finds a ART based on the given parameter and value

Parameters:

searchParameter - the parameters for the ART search. The values are represented in a map where the parameter is the key and parameter's value is the value

exactMatch - true if and only if it requires exact match.

Returns:

List

Throws:

InvalidCredentialException

java.io.IOException

java.net.MalformedURLException

listClinicalTrialsNCTID

public java.util.List<ClinicalTrialsNCTID> listClinicalTrialsNCTID(java.lang.String nctid)
                                                            throws InvalidCredentialException,
                                                                   java.io.IOException,
                                                                   java.net.MalformedURLException

Finds clinical trials information according to the registry number indicated

Parameters:

nctid - The NCT id

Returns:

List

Throws:

InvalidCredentialException

java.io.IOException

java.net.MalformedURLException

listClinicalTrials

public ClinicalTrialsSearch listClinicalTrials(java.util.Map<java.lang.String,java.lang.String> searchParameter)
                                        throws InvalidCredentialException,
                                               java.io.IOException,
                                               java.net.MalformedURLException

Finds a Clinical Trial based on the given parameter and value

Parameters:

searchParameter - the parameters for the clinical trials search. The values are represented in a map where the parameter is the key and parameter's value is the value

Returns:

ClinicalTrialsSearch

Throws:

InvalidCredentialException

java.io.IOException

java.net.MalformedURLException

listFDARecall

public java.util.List<FDARecallSearch> listFDARecall(java.util.Map<java.lang.String,java.lang.String> searchParameter)
                                              throws InvalidCredentialException,
                                                     java.io.IOException,
                                                     java.net.MalformedURLException

Finds a FDA Recall based on the given parameter and value.

Parameters:

searchParameter - the parameters for the clinical trials search. The values are represented in a map where the parameter is the key and parameter's value is the value

Returns:

List

Throws:

InvalidCredentialException

java.io.IOException

java.net.MalformedURLException