GET/v3/live/healthcare/hco/{aggkHcoId}

Get HCO

Returns a healthcare organization by AggK HCO ID

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

Path parameters

  • aggkHcoIdstringRequired
    AggK HCO ID
Headers
x-api-key Required · API key for authentication

Response

  • aggkCompanyIdstring
    AggKnowledge company ID for this organization
  • aggkHcoIdstring
    AggKnowledge HCO ID
  • citystring
    City
  • countrystring
    Country
  • diagnosisCountinteger (int32)
    Number of diagnoses associated with this organization
  • flagsstring[]
    Flags describing the organization (e.g. teaching hospital)
  • namestring
    Organization name
  • npistring
    National Provider Identifier (NPI)
  • peopleCountinteger (int32)
    Number of people affiliated with this organization
  • postalCodestring
    Postal code
  • procedureCountinteger (int32)
    Number of procedures associated with this organization
  • statestring
    State or province
  • trialsCountinteger (int32)
    Number of clinical trials associated with this organization
  • typestring
    Organization type (e.g. work affiliation)
  • websitestring
    Organization website
  • 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