Get Medical Inquiry
curl --request GET \
--url https://api.example.com/api/v0/medical/inquiries/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v0/medical/inquiries/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v0/medical/inquiries/{id}', 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.example.com/api/v0/medical/inquiries/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v0/medical/inquiries/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v0/medical/inquiries/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v0/medical/inquiries/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "SUCCESS",
"creation_ts": "2023-11-07T05:31:56Z",
"request": {
"type": "BENEFITS",
"desired_completion_date": "<string>",
"patient_name": "<string>",
"dob": "<string>",
"member_id": "<string>",
"tax_id": "<string>",
"group_id": "<string>",
"insurance_in_network": true,
"npi": "<string>",
"billing_npi": "<string>",
"rendering_npi": "<string>",
"external_id": "<string>",
"practice_billing_address": "<string>",
"diagnosis_codes": [
"<string>"
],
"claims_date_of_service": "<string>",
"claim_number": "<string>",
"additional_info": "<string>",
"call_script_id": "<string>",
"insurance": "<string>",
"benefits_query": [],
"benefits_codes": [
"<string>"
],
"benefits_form_name": "<string>",
"is_specialist": true,
"place_of_service": "<string>",
"billed_amount": 123,
"insurance_payor_id": "<string>",
"insurance_phone_number": "<string>"
},
"summary": "<string>",
"results": {
"call_details": [
{
"representative_name": "<string>",
"reference_number": "<string>",
"call_end_time": "2023-11-07T05:31:56Z",
"call_recording_url": "<string>",
"call_transcript_url": "<string>",
"call_transcript": "<string>",
"custom_answers": {}
}
],
"plan_information": {
"is_active": true,
"plan_type": "PPO",
"effective_date": "10-01-2020",
"termination_date": "10-31-2021",
"is_calendar_year_plan": true,
"is_provider_in_network": true,
"is_primary_insurance": true
},
"maximums": {
"individual_deductible": "100",
"individual_deductible_used": "80",
"individual_out_of_pocket_maximum": "1000",
"individual_out_of_pocket_maximum_used": "800",
"family_deductible": "200",
"family_deductible_used": "100",
"family_out_of_pocket_maximum": "2000",
"family_out_of_pocket_maximum_used": "1000"
},
"procedure_classes": {},
"procedure_codes": [
[
"<unknown>"
]
]
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Medical
Get Medical Inquiry
GET
/
api
/
v0
/
medical
/
inquiries
/
{id}
Get Medical Inquiry
curl --request GET \
--url https://api.example.com/api/v0/medical/inquiries/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v0/medical/inquiries/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v0/medical/inquiries/{id}', 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.example.com/api/v0/medical/inquiries/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v0/medical/inquiries/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v0/medical/inquiries/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v0/medical/inquiries/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "SUCCESS",
"creation_ts": "2023-11-07T05:31:56Z",
"request": {
"type": "BENEFITS",
"desired_completion_date": "<string>",
"patient_name": "<string>",
"dob": "<string>",
"member_id": "<string>",
"tax_id": "<string>",
"group_id": "<string>",
"insurance_in_network": true,
"npi": "<string>",
"billing_npi": "<string>",
"rendering_npi": "<string>",
"external_id": "<string>",
"practice_billing_address": "<string>",
"diagnosis_codes": [
"<string>"
],
"claims_date_of_service": "<string>",
"claim_number": "<string>",
"additional_info": "<string>",
"call_script_id": "<string>",
"insurance": "<string>",
"benefits_query": [],
"benefits_codes": [
"<string>"
],
"benefits_form_name": "<string>",
"is_specialist": true,
"place_of_service": "<string>",
"billed_amount": 123,
"insurance_payor_id": "<string>",
"insurance_phone_number": "<string>"
},
"summary": "<string>",
"results": {
"call_details": [
{
"representative_name": "<string>",
"reference_number": "<string>",
"call_end_time": "2023-11-07T05:31:56Z",
"call_recording_url": "<string>",
"call_transcript_url": "<string>",
"call_transcript": "<string>",
"custom_answers": {}
}
],
"plan_information": {
"is_active": true,
"plan_type": "PPO",
"effective_date": "10-01-2020",
"termination_date": "10-31-2021",
"is_calendar_year_plan": true,
"is_provider_in_network": true,
"is_primary_insurance": true
},
"maximums": {
"individual_deductible": "100",
"individual_deductible_used": "80",
"individual_out_of_pocket_maximum": "1000",
"individual_out_of_pocket_maximum_used": "800",
"family_deductible": "200",
"family_deductible_used": "100",
"family_out_of_pocket_maximum": "2000",
"family_out_of_pocket_maximum_used": "1000"
},
"procedure_classes": {},
"procedure_codes": [
[
"<unknown>"
]
]
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
OAuth2PasswordBearerHTTPBasic
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Response
Successful Response
unique generated (uuid4) id for the inquiry
status of the inquiry
Available options:
SCHEDULED, IN_PROGRESS, SUCCESS, UNSUCCESSFUL, CANCELLED, UNKNOWN Example:
"SUCCESS"
timestamp of when the inquiry was created
Example:
"2020-01-01T00:00:00.000000Z"
The request that was used to create the inquiry.
Show child attributes
Show child attributes
summary of the call results
Example:
"Benefits retrieved successfully."
The output from the call containing the benefits results..
Show child attributes
Show child attributes
⌘I