Search Compendium
curl --request POST \
--url https://api.us.junction.com/v3/compendium/search \
--header 'Content-Type: application/json' \
--header 'x-vital-api-key: <api-key>' \
--data '
{
"query": "<string>",
"cpt_codes": [
"<string>"
],
"loinc_set_hash": "<string>",
"labs": [],
"include_related": true,
"limit": 3
}
'import requests
url = "https://api.us.junction.com/v3/compendium/search"
payload = {
"query": "<string>",
"cpt_codes": ["<string>"],
"loinc_set_hash": "<string>",
"labs": [],
"include_related": True,
"limit": 3
}
headers = {
"x-vital-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-vital-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
cpt_codes: ['<string>'],
loinc_set_hash: '<string>',
labs: [],
include_related: true,
limit: 3
})
};
fetch('https://api.us.junction.com/v3/compendium/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.us.junction.com/v3/compendium/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'cpt_codes' => [
'<string>'
],
'loinc_set_hash' => '<string>',
'labs' => [
],
'include_related' => true,
'limit' => 3
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-vital-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.us.junction.com/v3/compendium/search"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"cpt_codes\": [\n \"<string>\"\n ],\n \"loinc_set_hash\": \"<string>\",\n \"labs\": [],\n \"include_related\": true,\n \"limit\": 3\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-vital-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.us.junction.com/v3/compendium/search")
.header("x-vital-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"cpt_codes\": [\n \"<string>\"\n ],\n \"loinc_set_hash\": \"<string>\",\n \"labs\": [],\n \"include_related\": true,\n \"limit\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.junction.com/v3/compendium/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-vital-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"cpt_codes\": [\n \"<string>\"\n ],\n \"loinc_set_hash\": \"<string>\",\n \"labs\": [],\n \"include_related\": true,\n \"limit\": 3\n}"
response = http.request(request)
puts response.read_body{
"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>"
]
}
]
}{
"detail": "<unknown>"
}Compendium
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 --request POST \
--url https://api.us.junction.com/v3/compendium/search \
--header 'Content-Type: application/json' \
--header 'x-vital-api-key: <api-key>' \
--data '
{
"query": "<string>",
"cpt_codes": [
"<string>"
],
"loinc_set_hash": "<string>",
"labs": [],
"include_related": true,
"limit": 3
}
'import requests
url = "https://api.us.junction.com/v3/compendium/search"
payload = {
"query": "<string>",
"cpt_codes": ["<string>"],
"loinc_set_hash": "<string>",
"labs": [],
"include_related": True,
"limit": 3
}
headers = {
"x-vital-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-vital-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
cpt_codes: ['<string>'],
loinc_set_hash: '<string>',
labs: [],
include_related: true,
limit: 3
})
};
fetch('https://api.us.junction.com/v3/compendium/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.us.junction.com/v3/compendium/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'cpt_codes' => [
'<string>'
],
'loinc_set_hash' => '<string>',
'labs' => [
],
'include_related' => true,
'limit' => 3
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-vital-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.us.junction.com/v3/compendium/search"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"cpt_codes\": [\n \"<string>\"\n ],\n \"loinc_set_hash\": \"<string>\",\n \"labs\": [],\n \"include_related\": true,\n \"limit\": 3\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-vital-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.us.junction.com/v3/compendium/search")
.header("x-vital-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"cpt_codes\": [\n \"<string>\"\n ],\n \"loinc_set_hash\": \"<string>\",\n \"labs\": [],\n \"include_related\": true,\n \"limit\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.junction.com/v3/compendium/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-vital-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"cpt_codes\": [\n \"<string>\"\n ],\n \"loinc_set_hash\": \"<string>\",\n \"labs\": [],\n \"include_related\": true,\n \"limit\": 3\n}"
response = http.request(request)
puts response.read_body{
"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>"
]
}
]
}{
"detail": "<unknown>"
}This feature is in closed beta.Interested in this feature? Get in touch with your Customer Success Manager.
Authorizations
Vital Team API Key
Body
application/json
ℹ️ This enum is non-exhaustive.
Available options:
canonical, crosswalk ℹ️ This enum is non-exhaustive.
Available options:
labcorp, quest, bioreference, sonora_quest Response
Successful Response
ℹ️ This enum is non-exhaustive.
Available options:
canonical, crosswalk Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Related topics
Compendium SearchDashboardChoosing Tests and MarkersCompendium ConvertGet search diagnosisWas this page helpful?