POST/v3/live/healthcare/hco/match

Match HCO

Accepts attributes and returns matching healthcare organizations

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

Request body

Each filter is an object of and / or / not arrays. or boosts matches without excluding others; use and with a single value to filter.

  • cityobjectOptional
    Filter by city; case-insensitive exact match
  • countryobjectOptional
    Filter by country; case-insensitive exact match
  • institutionTypeobjectOptional
    Filter by organization type, e.g. hospital or practice; case-insensitive exact match
  • namestringOptional
    Match on organization name; combines exact and fuzzy matching
  • npiobjectOptional
    Filter by National Provider Identifier (NPI)

    and is a hard filter only when strict is true; in the default ranked mode these values influence matching and ranking without excluding results.

    AND

    With strict: true, values that must all match; a value also in not is rejected with a 400, as is, on a field the record holds once, more than one distinct value or a value outside the field's or values. Otherwise treated the same as or

    OR
    1407589070

    With strict: true, values of which at least one must match; if every one is also in not, the request is rejected with a 400. Otherwise alternatives that resolve or rank the match, as strict describes

    NOT

    Values that must not match (hard exclusion), with or without strict

    Enter adds a value · Backspace on empty removes the last
  • postalCodeobjectOptional
    Filter by postal code; case-insensitive exact match
  • stateobjectOptional
    Filter by state or province; case-insensitive exact match
  • strictbooleanOptional
    When true, every supplied field is a hard filter: and values must all match, or values need at least one match, and the name must match. When false or omitted (the default), and and or are treated alike as alternatives. Any one NPI value resolves the match, and the name then only ranks; with no NPI, the name must match instead. Other fields only rank results, unless the request has neither an NPI nor a name, when at least one of their values must match. not values always exclude, and a request with only not values is rejected with a 400. With strict: true, a request is rejected with a 400 when any field has an and value that is also in not, or an or list whose every value is in not; fields an organization holds once (institutionType, city, state, country, postalCode) also accept at most one distinct and value, which must be among the field's or values when both are given.
  • 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[]
    Matching healthcare organizations
    • aggkHcoIdstring
      AggKnowledge HCO ID
    • citystring
      City
    • countrystring
      Country
    • institutionTypestring
      Organization type (e.g. hospital, practice)
    • namestring
      Organization name
    • npistring
      National Provider Identifier (NPI)
    • postalCodestring
      Postal code
    • scorenumber
      Relevance score for this match; higher indicates a stronger match. Results are ordered by score descending, so callers can auto-accept the top hit or review the top N. Scores are relative within a single response and not comparable across requests.
    • statestring
      State or province
    • 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