POST/v3/live/healthcare/drugs/match
Match drugs
Finds drug products by identifiers, fuzzy name matching, and structured attribute filters
Request body
Each filter is an object of and / or / not arrays. or boosts matches without excluding others; use and with a single value to filter.
- Filter by FDA application number
- atcCodesobjectOptionalFilter by ATC code
- atcCuisobjectOptionalFilter by ATC class UMLS CUI
- atcNamesobjectOptionalFilter by ATC name
- chemicalClassCuisobjectOptionalFilter by chemical class UMLS CUI
- Filter by chemical class
- chemicalInteractionCuisobjectOptionalFilter by chemical interaction UMLS CUI
- Filter by chemical interaction
- contraindicationCuisobjectOptionalFilter by contraindication UMLS CUI
- Filter by contraindication
- Filter by DEA schedule
- dispositionCuisobjectOptionalFilter by disposition UMLS CUI
- Filter by disposition
- Filter by dosage form name
- indicationCuisobjectOptionalFilter by indication UMLS CUI
- Filter by indication
- inducedConditionCuisobjectOptionalFilter by induced condition UMLS CUI
- Filter by induced condition
- Fuzzy match on labeler (manufacturer) name
- Filter by marketing category name
- Filter by derived marketing status: MARKETED, DISCONTINUED, NOT_YET_MARKETED or EXCLUDED
- mechanismCuisobjectOptionalFilter by mechanism of action UMLS CUI
- mechanismInteractionCuisobjectOptionalFilter by mechanism-of-action interaction UMLS CUI
- Filter by mechanism-of-action interaction
- Filter by mechanism of action
- metadataobjectOptionalOptional metadata to associate with the request. Will be returned in the response.
- Fuzzy match on non-proprietary (generic) name, e.g. "tirzepatide"
- packageNdcobjectOptionalFilter by an 11-digit HIPAA package NDC (5-4-2, no hyphens) — matches the product the package is sold under
- pharmClassCuisobjectOptionalFilter by Established Pharmacologic Class (EPC) UMLS CUI
- Filter by Established Pharmacologic Class (EPC) name
- pharmacokineticCuisobjectOptionalFilter by pharmacokinetic property UMLS CUI
- Filter by pharmacokinetics
- physiologicEffectCuisobjectOptionalFilter by physiologic effect UMLS CUI
- physiologicEffectInteractionCuisobjectOptionalFilter by physiologic-effect interaction UMLS CUI
- Filter by physiologic effect interaction
- Filter by physiologic effect
- preventionCuisobjectOptionalFilter by prevented condition UMLS CUI
- Filter by prevention
- Filter by 9-digit HIPAA-normalized product NDC (labeler + product, no hyphens)
- Filter by product type name (e.g. HUMAN PRESCRIPTION DRUG)
- Fuzzy match on proprietary (brand) name, e.g. "Zepbound"
- Filter by route name
- Filter by RxNorm DEA schedule
- structuralClassCuisobjectOptionalFilter by structural class UMLS CUI
- Filter by structural class
- Fuzzy match on substance name
- Filter by therapeutic category
- therapeuticCategoryCuisobjectOptionalFilter by therapeutic category UMLS CUI
- vaClassCodesobjectOptionalFilter by VA class code
- vaClassCuisobjectOptionalFilter by VA drug class UMLS CUI
- vaClassNamesobjectOptionalFilter by VA class name
- Headers
x-api-keyRequired · API key for authentication
Response
- resultsobject[]Matching drug products
- isSuccessboolean
truewhen the request was answered with a result.falsemeans no result was returned: checkisRetryable, which istruewhen a data source failed or timed out andfalsewhen the input matched nothing. - isRetryablebooleanWhen
isSuccessisfalse, whether sending the same input again could succeed. AlwaystruewhenisSuccessistrue. - hasProblemsbooleanWhether we hit a problem answering the request: the profile or company wasn't found, or a data source failed or timed out. Data may be missing or incomplete;
problems, where the response has it, says which. - metadataobjectCaller-supplied metadata echoed back from the request.
- inputParametersobjectCaller-supplied inputs echoed back in the response