POST/v3/live/healthcare/hcp/{aggkHcpId}/payments

Get HCP payments

Returns industry payments to a healthcare professional, from US CMS Open Payments (program years 2013 onward) and from national transparency disclosures elsewhere, with source saying which. One row per manufacturer, product, nature of payment and program year, largest amount first. A payment naming several products splits its amount evenly across them, so amounts add up across rows. Meals are included and flagged with isMeal. A payment is evidence of a commercial relationship, not of product use. Paginated with limit (default 100, max 1000) and an opaque cursor. Consumes 1 credit, billed once per distinct HCP per billing period.

Version
v3
Rate limit
Tier 3 · 10–200 rps by plan
Billing
Healthcare (HCP) · Get HCP payments

Path parameters

  • aggkHcpIdstringRequired
    AggK HCP ID

Request body

  • limitinteger (int32)Optional
    Maximum number of results to return (default 100, max 1000)
  • cursorstringOptional
    Opaque cursor returned by a previous page; omit to fetch the first page
  • metadataobjectOptional
    Optional metadata to associate with the request. Will be returned in the response.
Headers
x-api-key Required · API key for authentication

Response

  • resultsobject[]
    Industry payments to this HCP by manufacturer, product, nature of payment and program year, largest amount first
    • amountstring
      Amount paid in US dollars, as a decimal string. A payment naming several products is split evenly across them, so amounts add up across rows
    • disclosureCountrystring
      Country of a NATIONAL_DISCLOSURE, as the HCP's country is recorded; absent for Open Payments
    • isMealboolean
      Whether these are food and beverage payments
    • manufacturerstring
      Manufacturer that made the payments: the CMS name for a manufacturerId, else the name as disclosed
    • manufacturerIdstring
      Manufacturer's CMS Open Payments payer ID, the value the Discover industry.manufacturers filter takes. Payments before 2019 are matched to it by manufacturer name and carry it only when that match is certain; absent on an unmatched name and on national disclosures, which the Discover filter does not match
    • natureOfPaymentstring
      Nature of payment as CMS Open Payments words it. Research for research payments, Not reported when the source gave none
    • paymentCountinteger (int32)
      Payments that named this product. A payment naming several products counts once in each of their rows, so this does not add up across products
    • paymentIdstring
      Stable identifier of this row
    • productstring
      Product the payments were made in connection with, upper-case as reported; absent when a payment named no product
    • programYearinteger (int32)
      Program year the payments were made in
    • sourceenum PaymentDisclosureSource
      The transparency regime the payments were disclosed under
  • nextCursorstring
    Cursor for the next page; absent when there are no more results
  • 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.
  • isRetryableboolean
    When isSuccess is false, whether sending the same input again could succeed. Always true when isSuccess is true.
  • 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.
  • metadataobject
    Caller-supplied metadata echoed back from the request.
  • inputParametersobject
    Caller-supplied inputs echoed back in the response

Status codes