Compendium Search

Create or submit compendium search via the Junction API. Requires authentication with your team API key.

POST /v3/compendium/search

Search Compendium

cURL

curl --request POST \
  --url https://api.tryvital.io/v3/compendium/search \
  --header 'Content-Type: application/json' \
  --header 'x-vital-api-key: <api-key>' \
  --data '
{
  "mode": "canonical",
  "query": "<string>",
  "cpt_codes": [
    "<string>"
  ],
  "loinc_set_hash": "<string>",
  "labs": [
    "labcorp"
  ],
  "include_related": true,
  "limit": 3
}
'

200

{
  "mode": "canonical",
  "selected_canonical": {
    "loinc_set_hash": "<string>",
    "display_name": "<string>",
    "popularity_score": 123,
    "confidence": 123,
    "aliases": [
      "<string>"
    ],
    "loinc_codes": [
      "<string>"
    ],
    "provider_ids": [
      "<string>"
    ],
    "loinc_components": [
      "<string>"
    ],
    "loinc_groups": [
      "<string>"
    ],
    "cpt_codes": [
      "<string>"
    ]
  },
  "canonical_candidates": [
    {
      "loinc_set_hash": "<string>",
      "display_name": "<string>",
      "popularity_score": 123,
      "confidence": 123,
      "aliases": [
        "<string>"
      ],
      "loinc_codes": [
        "<string>"
      ],
      "provider_ids": [
        "<string>"
      ],
      "loinc_components": [
        "<string>"
      ],
      "loinc_groups": [
        "<string>"
      ],
      "cpt_codes": [
        "<string>"
      ]
    }
  ],
  "per_lab": {},
  "related": [
    {
      "canonical": {
        "loinc_set_hash": "<string>",
        "display_name": "<string>",
        "popularity_score": 123,
        "confidence": 123,
        "aliases": [
          "<string>"
        ],
        "loinc_codes": [
          "<string>"
        ],
        "provider_ids": [
          "<string>"
        ],
        "loinc_components": [
          "<string>"
        ],
        "loinc_groups": [
          "<string>"
        ],
        "cpt_codes": [
          "<string>"
        ]
      },
      "relation": "<string>",
      "confidence": 123,
      "reason_codes": [
        "<string>"
      ]
    }
  ]
}

This feature is in closed beta.

Interested in this feature? Get in touch with your Customer Success Manager.

Authorizations

x-vital-api-key · string · header · required

Vital Team API Key

Query Parameters

team_id · string<uuid> string · default: infer_from_context

Body

application/json

mode · enum<string> · required

ℹ️ This enum is non-exhaustive.

Available options: canonical, crosswalk

query · string | null

cpt_codes · string[]

loinc_set_hash · string | null

labs · enum<string>[] | null

ℹ️ This enum is non-exhaustive.

Available options: labcorp, quest, bioreference, sonora_quest

include_related · boolean · default: true

limit · integer · default: 3

Response

200

application/json

Successful Response

mode · enum<string> · required

ℹ️ This enum is non-exhaustive.

Available options: canonical, crosswalk

selected_canonical · CanonicalCandidate · object

Show child attributes

canonical_candidates · CanonicalCandidate · object[]

Show child attributes

per_lab · Per Lab · object

Show child attributes

related · RelatedCandidate · object[]

Show child attributes