GET/v3/live/healthcare/taxonomies/{taxonomyId}

Browse a healthcare taxonomy

Navigates the diagnosis or procedure category taxonomy. Omit parentId to list the root chapters, pass a node id as parentId to list its immediate children, or pass q to search the whole taxonomy by category name or code prefix.

Version
v3
Rate limit
Tier 4 · 10–500 rps by plan
Billing
No entitlement required · Browse a healthcare taxonomy

Path parameters

Query parameters

  • parentIdstringOptional
    Return the children of this node id; omit to list root chapters
  • qstringOptional
    Search the whole taxonomy by category name or code prefix
  • pageintegerOptional
    1-based page number for search results (default 1)
  • pageSizeintegerOptional
    Search results per page (default 50, max 200)
Headers
x-api-key Required · API key for authentication

Response

  • resultsobject[]Required
    Matching taxonomy nodes
    • idstring
      Stable identifier; pass as parentId to fetch this node's children
    • codestring
      ICD-10-CM code or code range of a diagnosis category, e.g. C81-C96. Omitted for procedure categories, whose CPT and HCPCS codes are AMA-licensed and can't be redistributed.
    • namestring
      Category name
    • depthinteger (int32)
      Depth in the taxonomy (1 = broadest chapter)
    • parentIdstring
      Identifier of the parent category; absent for root chapters
    • hasChildrenboolean
      Whether this category has child categories to expand
    • pathobject[]
      Ancestor categories from root chapter to immediate parent; empty for root chapters
    • hcpCountinteger (int64)
      Distinct HCPs with activity in this category
    • hcoCountinteger (int64)
      Distinct HCOs with activity in this category
    • containedCountinteger (int64)
      Distinct underlying codes (procedures/diagnoses) contained anywhere under this category
    • containedCuisstring[]
      Distinct UMLS CUIs of the underlying codes contained anywhere under this category
    • descendantCategoryCountinteger (int64)
      Sub-categories nested anywhere under this category; 0 for leaf categories
  • totalinteger (int64)
    Total number of matches (equals the level size when browsing, or the full match count when searching)
  • hasMoreboolean
    Whether more pages of search results are available
  • 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