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

Get HCP procedures

Returns the procedure categories on a healthcare professional's medical claims, counted for one claim role: PERFORMED (default) or REFERRED. Each row is a category at any depth of the procedure taxonomy, with its ancestor path, counts over a fixed five-year window, trailing-window counts and a percentile rank against other HCPs in the same category and role; there are no filters. For performed procedures as flat categories with their RBCS service-type family, a year range and filters, use Get HCP procedures performed. 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 procedures

Path parameters

  • aggkHcpIdstringRequired
    AggK HCP ID

Request body

  • roleenum HcpClaimRoleOptional
    The HCP's role on the counted claims (default PERFORMED)
  • 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. Valid only with the same role that produced it
  • metadataobjectOptional
    Optional metadata to associate with the request. Will be returned in the response.
Headers
x-api-key Required · API key for authentication

Response

  • nextCursorstring
    Cursor for the next page; absent when there are no more results
  • resultsobject[]
    One row per procedure category the HCP has claims in for the requested role, at every depth of the taxonomy, ordered by trailing 12-month count, largest first
  • 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