POST/v3/live/healthcare/discover/hcps/validate

Validate a discover HCPs request

Validates a healthcare discover request and returns a warning for every problem: identifiers of the wrong shape (an NDC is 9 digits, an NCT ID is NCT and 8 digits, a quarter is yyyyQn), brand, ingredient, class and mechanism IDs the drug vocabularies do not hold (UNKNOWN_VALUE), combinations the index cannot answer (ELEVEN_PLUS with quarters, quarters on ICD-10 codes, positions with guidelinesOnly), missing required filters, unknown fields, and a request too large to evaluate (QUERY_TOO_LARGE), which a search would refuse with a 400. Warnings about a filter group's contents name the group they came from. Looks brand, ingredient, class and mechanism IDs up but does not search HCPs or consume credits; an expansion cut at its cap is not a problem here and is reported in the search and count responses' warnings.

Version
v3
Rate limit
Tier 2 · 10–100 rps by plan
Billing
HEALTHCARE_DISCOVER · Validate a discover HCPs request

Request body

  • metadataobjectOptional
    Optional metadata to associate with the request. Will be returned in the response.
  • orobject[]Optional
    One or more filter groups. An HCP matches the request when they satisfy at least one group; within a group every block is ANDed
    • congressesobjectOptional
      Congress sessions the HCP presented at
    • diagnosesobjectOptional
      Conditions the HCP diagnosed or referred for
    • industryobjectOptional
      Manufacturers the HCP received non-meal payments from, as reported to CMS Open Payments. A payment is a financial relationship, not evidence the HCP uses the product; use 'not' on manufacturers to screen out conflicts of interest
    • leaderboardsobjectOptional
      The HCP's decile on per-indication leaderboards
    • namestringOptional
      Name for this group. Echoed in matchedFilterGroups on every result the group produced, and in validate warnings about the group
    • practiceSettingobjectOptional
      The kind of organization the HCP currently works at. An HCP carries every setting that applies
    • prescribingobjectOptional
      Drugs the HCP prescribed or administered over the trailing twelve months
    • proceduresobjectOptional
      Procedures the HCP performed or ordered
    • professionalobjectOptional
      Who the HCP is and where they practice
    • publicationsobjectOptional
      Publications the HCP authored, by MeSH topic
    • trialsobjectOptional
      Clinical trials the HCP is linked to on the trial record
  • paginationobjectOptional
    Page-based pagination controls
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.
  • isValidboolean
    Whether all provided values are valid (true when warnings is empty)
  • metadataobject
    Caller-supplied metadata echoed back from the request.
  • querySizeobject
    How much of the query size limit the request uses, present whether or not it fits. Null when the request could not be sized: it did not parse, or it has a malformed keywords expression, activeWithin or company.keywords to fix first, and QUERY_TOO_LARGE is not checked until it can be. company.keywords is also sized on its own against the companies it searches, so a QUERY_TOO_LARGE naming company.keywords can arrive with 'used' under 'limit'.
  • warningsobject[]
    List of validation warnings, one per invalid field value

Status codes