FirstDataBank MedKnowledge Web API Help Page

Introduction

WEB services provide internet access to First Databank (FDB) databases installed on customer’s sites.
FDB provides two products known as OrderKnowledge and MedKnowledge.
This Help Page contains description of MedKnowledge API calls

FirstDatabankMedKnowledge

API	Description
GET api/FirstDatabankMedKnowledge/Version	Version. Current version of FDB MedKnowledge WEB API
GET api/FirstDatabankMedKnowledge/FormularyLookup?ndc=String[ ]	No documentation available.
GET api/FirstDatabankMedKnowledge/Ingredient?startsWith=String &contains=String &soundsLike=String	Ingredient. Find an ingredient by name
GET api/FirstDatabankMedKnowledge/PackagedDrugs?medId=Int32[ ] &ndc=String[ ] &gcnSeqNo=Int32[ ] &dose=String &doseUnit=String &activeOnly=Boolean &genericOnly=Boolean &inFormulary=Boolean &absoluteAmount=Int64	PackagedDrugs. PackagedDrug identifies the unique packaged drug. The object contains most of stable identifiers, including NDC. It has gender specific information as well as information about dosage, strength, and therapeutic classification of the drug.
GET api/FirstDatabankMedKnowledge/Allergy?startsWith=String &contains=String &soundsLike=String	Allergy. Find an allergy by name There are 3 types of allergens that identified by “UID”: FDB.INGREDIENT+xxx - ingredient FDB.ALGNGRP+xxx - allergen group FDB.DRUGNAME+xxx - particular drug
GET api/FirstDatabankMedKnowledge/DoseRange?medId=Int32[ ] &ndc=String[ ] &gcnSeqNo=Int32[ ] &patientDOB=String &patientAgeInDays=Int32 &weightInKg=Decimal &BSA=Decimal &CCL=Decimal	DoseRange. Returns Low / High / NTE (Not To Exceed) dosages for a drug
GET api/FirstDatabankMedKnowledge/DoseScreen	DoseScreen. Provides dosage checking based on a patient’s profile.
GET api/FirstDatabankMedKnowledge/DrugAllergy?gcnSeqNo=Int32[ ] &medId=Int32[ ] &ndc=String[ ] &hicSeqNo=Int32[ ] &newGcnSeqNo=Int32[ ] &newMedId=Int32[ ] &newNdc=String[ ] &newHicSeqNo=Int32[ ] &uid=String[ ] &newUid=String[ ] &doInactiveScreening=Boolean	DrugAllergy. Screens prospective and/or retrospective drugs for Drug-Allergy Interactions
GET api/FirstDatabankMedKnowledge/DrugDiseaseScreen?gcnSeqNo=Int32[ ] &medId=Int32[ ] &ndc=String[ ] &newGcnSeqNo=Int32[ ] &newMedId=Int32[ ] &newNdc=String[ ] &icd9cm=String[ ] &icd10cm=String[ ] &snomedCt=String[ ] &uid=String[ ]	DrugDiseaseScreen. Screens prospective and/or retrospective drugs for MedicalConditions in the presence of which you should not use the drug
GET api/FirstDatabankMedKnowledge/MedConditions?startsWith=String &contains=String &resType=String &parentOnly=Boolean &uid=String[ ] &icd9cm=String[ ] &icd10cm=String[ ] &snomedCt=String[ ] &dxid=String[ ]	MedConditions. Find Medical Condition code by name and/or find Medical Condition name by code. The function returns Medical Condition data. A Medical Condition may include “parent’s” conditions if applicable.
GET api/FirstDatabankMedKnowledge/DrugDrugScreen?gcnSeqNo=Int32[ ] &medId=Int32[ ] &ndc=String[ ] &newGcnSeqNo=Int32[ ] &newMedId=Int32[ ] &newNdc=String[ ] &doInactiveScreening=Boolean	DrugDrugScreen. Screens prospective drugs for Drug-Drug Interactions. If all prospective drugs are skipped then passed retrospective drugs are screened for Drug-Drug Interactions
GET api/FirstDatabankMedKnowledge/DrugFoodScreen?gcnSeqNo=Int32[ ] &medId=Int32[ ] &ndc=String[ ] &newGcnSeqNo=Int32[ ] &newMedId=Int32[ ] &newNdc=String[ ]	DrugFoodScreen. Retrieves foods known to have an interaction with the drug.
GET api/FirstDatabankMedKnowledge/DupScreen?gcnSeqNo=Int32[ ] &medId=Int32[ ] &ndc=String[ ] &newGcnSeqNo=Int32[ ] &newMedId=Int32[ ] &newNdc=String[ ]	DupScreen. Find duplicates (drugs with the same therapeutic effect though having different names). Prospective screening checks that new drug(s) have duplicates among the list of existing drugs. Retrospective screening checks all drugs in a list for duplicates.
GET api/FirstDatabankMedKnowledge/DrugDiseaseContraindication?gcnSeqNo=Int32[ ] &medId=Int32[ ] &ndc=String[ ]	DrugDiseaseContraindication. Returns MedicalConditions in the presence of which you should not use the drug
GET api/FirstDatabankMedKnowledge/GenderSpecific?gcnSeqNo=Int32 &medId=Int32 &ndc=String	GenderSpecific. Returns Gender Specific information for a drug
GET api/FirstDatabankMedKnowledge/PrecautionGeriatric?gcnSeqNo=Int32 &medId=Int32 &ndc=String &patientDOB=String &patientAgeInDays=Int32	PrecautionGeriatric. Precautions for geriatric patients.
GET api/FirstDatabankMedKnowledge/PrecautionPediatric?gcnSeqNo=Int32 &medId=Int32 &ndc=String &patientDOB=String &patientAgeInDays=Int32	PrecautionPediatric. Precautions for pediatric patients
GET api/FirstDatabankMedKnowledge/PrecautionPregnancy?gcnSeqNo=Int32 &medId=Int32 &ndc=String &patientDOB=String &patientAgeInDays=Int32	PrecautionPregnancy. Precautions for pregnant patients
GET api/FirstDatabankMedKnowledge/PrecautionLactation?gcnSeqNo=Int32 &medId=Int32 &ndc=String &patientDOB=String &patientAgeInDays=Int32	PrecautionLactation. Lactation precaution
GET api/FirstDatabankMedKnowledge/BatchScreen?gcnSeqNo=Int32[ ] &medId=Int32[ ] &ndc=String[ ] &newGcnSeqNo=Int32[ ] &newMedId=Int32[ ] &newNdc=String[ ] &uid=String[ ] &icd9cm=String[ ] &icd10cm=String[ ] &snomedCt=String[ ] &doInactiveScreening=Boolean &patientDOB=String &patientAgeInDays=Int32 &parientWeightInKg=Decimal &BSA=Decimal	BatchScreen. The function returns combined interaction warnings for a list of drugs.
GET api/FirstDatabankMedKnowledge/SetFormulary?ndc=String[ ] &op=String &siteId=String &description=String &brandName=String &orderInterface=String	No documentation available.
GET api/FirstDatabankMedKnowledge/SetFormulary2?ndc=String[ ] &description=String[ ] &orderInterface=String[ ] &siteId=String &clearBeforeImport=Boolean &saveOnError=Boolean	No documentation available.
GET api/FirstDatabankMedKnowledge/Formulary?startsWith=String &contains=String &gcnSeqNo=Int32[ ] &medId=Int32[ ] &ndc=String[ ]	Formulary. Search formulary by name or IDs.
POST api/FirstDatabankMedKnowledge/LoadFormulary	See http://www.strathweb.com/2012/08/a-guide-to-asynchronous-file-uploads-in-asp-net-web-api-rtm/
POST api/FirstDatabankMedKnowledge/LoadExcel	No documentation available.
GET api/FirstDatabankMedKnowledge/Drugs?startsWith=String &contains=String &representative=Boolean &inFormulary=Boolean &includeDevices=Boolean &activeOnly=Boolean &searchPhoneticallyOnEmpty=Boolean &strength=String &medId=Int32[ ] &ndc=String[ ] &gcnSeqNo=Int32[ ] &orderInterface=String	No documentation available.
GET api/FirstDatabankMedKnowledge/DrugInfo?startsWith=String &contains=String &representative=Boolean &inFormulary=Boolean &includeDevices=Boolean &activeOnly=Boolean &searchPhoneticallyOnEmpty=Boolean &strength=String &medId=Int32[ ] &ndc=String[ ] &gcnSeqNo=Int32[ ] &orderInterface=String	No documentation available.