GET/v3/live/healthcare/hcp/{aggkHcpId}

Get HCP

Returns a healthcare professional by AggK HCP ID. 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

Path parameters

  • aggkHcpIdstringRequired
    AggK HCP ID
Headers
x-api-key Required · API key for authentication

Response

  • affiliationsobject[]
    HCO affiliations for this HCP
    • affiliationIdinteger (int64)
      Affiliation ID
    • aggkHcoIdstring
      AggKnowledge HCO ID
    • categorystring
      Affiliation category (e.g. 'primary')
    • citystring
      City
    • countrystring
      Country
    • diagnosisCountinteger (int32)
      Number of diagnoses associated with this organization
    • flagsstring[]
      Flags describing the organization (e.g. 'teaching hospital')
    • institutionTypestring
      Institution type (e.g. 'hospital')
    • namestring
      Organization name
    • organizationNpisstring[]
      NPI numbers for this organization
    • peopleCountinteger (int32)
      Number of people affiliated with this organization
    • procedureCountinteger (int32)
      Number of procedures associated with this organization
    • statestring
      State or province
    • titlesstring
      Title held at this organization
    • trialsCountinteger (int32)
      Number of clinical trials associated with this organization
    • typestring
      Affiliation type (e.g. 'work affiliation')
  • aggkHcpIdstring
    AggKnowledge HCP ID
  • aggkPersonIdstring
    AggKnowledge Person ID
  • designationsstring[]
    Professional designations (e.g. MD)
  • firstNamestring
    First name
  • focusAreasobject[]
    Focus areas derived from this HCP's activity
  • gmcstring
    General Medical Council (GMC) reference number
  • isInactiveboolean
    Whether the HCP is inactive
  • isIndustryboolean
    Whether the HCP has industry affiliations
  • lastNamestring
    Last name
  • middleNamestring
    Middle name
  • npistring
    National Provider Identifier (NPI)
  • orcidstring
    ORCID identifier
  • patientCountinteger (int32)
    Number of patients
  • paymentsTotalstring
    Total payments received (formatted currency string)
  • rppsstring
    Répertoire Partagé des Professionnels de Santé (RPPS) number
  • socialMediaMentionTotalinteger (int32)
    Total social media mentions
  • socialMediaUrlstring
    Social Media URL of the professional. Null when the professional has no social media presence on file.
  • socialProfilestring
    Social profile URL of the professional. The same value as socialMediaUrl, under the name the rest of v3 uses; prefer this one.
  • specialtiesobject[]
    Medical specialties
  • topIndicationsobject[]
    Leading focus areas over the whole record, up to five per activity type, ordered by prevalence within each
  • worksCountsobject
    Publication, clinical trial, and congress counts (trailing 5-year and all-time)
  • 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