POST/v3/live/healthcare/discover/resolve

Resolve healthcare discover filter values

Looks a name up in the healthcare discover vocabularies and returns the IDs a search takes: brands, ingredients, pharmacologic classes, mechanisms of action, clinical drug forms, product NDCs, conditions, specialties, congress series, manufacturers, leaderboard indications and publication topics. Each entry names the request field its ID goes in, and a specialty or condition carries the path above it as context. Every word of the query, at most 200 characters, must match the entry's name, the last as a prefix, and entries are ordered by how many HCPs they are counted for, so the brand or ingredient most prescribers use comes first. A brand, ingredient, class or mechanism is expanded by the search itself into the products or clinical drug forms it covers. Does not consume credits.

Version
v3
Rate limit
Tier 4 · 10–500 rps by plan
Billing
HEALTHCARE_DISCOVER · Resolve healthcare discover filter values

Request body

  • limitinteger (int32)Optional
    How many entries to return, 1 to 50. Defaults to 10
  • querystringOptional
    The name to look up, at most 200 characters, such as Ozempic, semaglutide or GLP-1. Every word must match; the last may be a prefix
  • vocabulariesenum[] HcpDiscoverVocabularyOptional
    Vocabularies to search. Every vocabulary when absent or empty
    BRANDINGREDIENT
    Pick a suggestion or press Enter · Backspace on empty removes the last
Headers
x-api-key Required · API key for authentication

Response

  • hasProblemsboolean
    Whether 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.
  • isRetryableboolean
    When isSuccess is false, whether sending the same input again could succeed. Always true when isSuccess is true.
  • isSuccessboolean
    true when the request was answered with a result. false means no result was returned: check isRetryable, which is true when a data source failed or timed out and false when the input matched nothing.
  • metadataobject
    Caller-supplied metadata echoed back from the request.
  • resultsobject[]
    Matching entries, ordered by HCP count, highest first

Status codes