---
title: "Search Compendium"
method: POST
path: "/v3/compendium/search"
tags: ["compendium"]
---

# Search Compendium

`POST /v3/compendium/search`

## Request body

- SearchCompendiumBody
  - `mode` 'canonical' | 'crosswalk', required — ℹ️ This enum is non-exhaustive.
  - `query` string, nullable
  - `cpt_codes` string[]
  - `loinc_set_hash` string, nullable
  - `labs` CompendiumSearchLabs[], nullable
  - `include_related` boolean
  - `limit` integer

## Response `200`

Successful Response

- SearchCompendiumResponse
  - `mode` 'canonical' | 'crosswalk', required — ℹ️ This enum is non-exhaustive.
  - `selected_canonical` CanonicalCandidate
    - `loinc_set_hash` string, required
    - `display_name` string, required
    - `aliases` string[]
    - `loinc_codes` string[]
    - `provider_ids` string[]
    - `loinc_components` string[]
    - `loinc_groups` string[]
    - `cpt_codes` string[]
    - `popularity_score` number, required
    - `confidence` number, required
  - `canonical_candidates` CanonicalCandidate[]
    - `loinc_set_hash` string, required
    - `display_name` string, required
    - `aliases` string[]
    - `loinc_codes` string[]
    - `provider_ids` string[]
    - `loinc_components` string[]
    - `loinc_groups` string[]
    - `cpt_codes` string[]
    - `popularity_score` number, required
    - `confidence` number, required
  - `per_lab` object
  - `related` RelatedCandidate[]
    - `canonical` CanonicalCandidate, required
      - `loinc_set_hash` string, required
      - `display_name` string, required
      - `aliases` string[]
      - `loinc_codes` string[]
      - `provider_ids` string[]
      - `loinc_components` string[]
      - `loinc_groups` string[]
      - `cpt_codes` string[]
      - `popularity_score` number, required
      - `confidence` number, required
    - `relation` string, required
    - `confidence` number, required
    - `reason_codes` string[]

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/tryvital/apis/junction-api.md) · [All operations](https://skmtc.net/tryvital/apis/junction-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tryvital/junction-api/revisions/034402e2bbe3/schema)