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

Get HCP procedures performed

Returns every procedure category a healthcare professional performed, from their claims. Filter by year range, procedure category, RBCS service-type family and minimum volume; results are ordered by claims summed over the requested years, largest first. 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 performed

Path parameters

  • aggkHcpIdstringRequired
    AggK HCP ID

Request body

  • procedureCategoryIdsstring[]Optional
    Only these procedure category IDs
  • rbcsFamilyCodesstring[]Optional
    Only categories in these RBCS service-type families
    PM
    Enter adds a value · Backspace on empty removes the last
  • minClaimCountinteger (int64)Optional
    Only procedures with at least this many claims over the requested years
  • limitinteger (int32)Optional
    Maximum number of concepts 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 filters that produced it
  • yearsobjectOptional
    Years to include, inclusive at both ends. Totals, ordering and minimum filters are computed over this range; omit for all years
    • maxinteger (int32)Optional
      Maximum value (inclusive)
    • mininteger (int32)Optional
      Minimum value (inclusive)
  • 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[]
    Procedures the HCP performed, one entry per procedure category
  • 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