Returns a list of referrals
curl --request GET \
--url https://api.staging.scan.com/api/v2/referrals \
--header 'Authorization: Bearer <token>'require 'uri'
require 'net/http'
url = URI("https://api.staging.scan.com/api/v2/referrals")
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_bodyimport requests
url = "https://api.staging.scan.com/api/v2/referrals"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.staging.scan.com/api/v2/referrals', 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.staging.scan.com/api/v2/referrals",
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.staging.scan.com/api/v2/referrals"
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))
}{
"appointments": [
{
"id": "11111111-1111-1111-1111-111111111111",
"reference": "1234567890",
"status": "pending",
"visits": [
{
"id": "11111111-1111-1111-1111-111111111111",
"modality": "MRI",
"procedures": [
{
"body_part": "Brain",
"procedure": "MRI Brain without contrast",
"contrast": "without_contrast",
"laterality": "not_present",
"cpt_code": "70551",
"cpt_system": "http://www.ama-assn.org/go/cpt",
"accession_id": "ACC-1001",
"study_uid": null,
"series_uid": null,
"image_link": null,
"report_link": null
}
],
"status": "pending",
"start_time": "2021-01-01T00:00:00Z",
"radiologist_group_name": "East Coast Radiology",
"location": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "Anytown Medical Center",
"npi": "1234567890",
"address_line_1": "123 Main St",
"address_line_2": null,
"city": "Anytown",
"state": "GA",
"zip_code": "30303"
}
}
],
"line_of_business": "workers_comp",
"payment_type": "insurance",
"incident_state": "GA",
"payor": {
"id": "44444444-4444-4444-4444-444444444444",
"name": "Harbor Insurance"
},
"insurance_number": "INS-123",
"wc_number": "WCB-456",
"referring_provider": "John Doe",
"provider": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "John Doe",
"npi": "1234567890"
},
"law_firm": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "Acme LLP"
},
"practice": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "Main Street Imaging"
},
"icd10_codes": [
{
"id": "11111111-1111-1111-1111-111111111111",
"code": "M54.5",
"system": "http://hl7.org/fhir/sid/icd-10-cm",
"short_description": "Low back pain"
}
],
"patient": {
"id": "11111111-1111-1111-1111-111111111111",
"identifier": {
"system": "https://scan.com/fhir/sid/patient-id",
"value": "11111111-1111-1111-1111-111111111111"
},
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"date_of_birth": "05/21/1988",
"date_of_birth_iso": "1988-05-21",
"email": "[email protected]",
"phone_number": "5551234567",
"gender": "male",
"address_line_1": "123 Main St",
"city": "Anytown",
"state": "GA",
"zip_code": "30303"
}
}
],
"meta": {
"current_page": 1,
"next_page": 2,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
Referrals
Returns a list of referrals
Returns a list of referrals that are associated with the user group.
GET
/
api
/
v2
/
referrals
Returns a list of referrals
curl --request GET \
--url https://api.staging.scan.com/api/v2/referrals \
--header 'Authorization: Bearer <token>'require 'uri'
require 'net/http'
url = URI("https://api.staging.scan.com/api/v2/referrals")
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_bodyimport requests
url = "https://api.staging.scan.com/api/v2/referrals"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.staging.scan.com/api/v2/referrals', 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.staging.scan.com/api/v2/referrals",
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.staging.scan.com/api/v2/referrals"
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))
}{
"appointments": [
{
"id": "11111111-1111-1111-1111-111111111111",
"reference": "1234567890",
"status": "pending",
"visits": [
{
"id": "11111111-1111-1111-1111-111111111111",
"modality": "MRI",
"procedures": [
{
"body_part": "Brain",
"procedure": "MRI Brain without contrast",
"contrast": "without_contrast",
"laterality": "not_present",
"cpt_code": "70551",
"cpt_system": "http://www.ama-assn.org/go/cpt",
"accession_id": "ACC-1001",
"study_uid": null,
"series_uid": null,
"image_link": null,
"report_link": null
}
],
"status": "pending",
"start_time": "2021-01-01T00:00:00Z",
"radiologist_group_name": "East Coast Radiology",
"location": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "Anytown Medical Center",
"npi": "1234567890",
"address_line_1": "123 Main St",
"address_line_2": null,
"city": "Anytown",
"state": "GA",
"zip_code": "30303"
}
}
],
"line_of_business": "workers_comp",
"payment_type": "insurance",
"incident_state": "GA",
"payor": {
"id": "44444444-4444-4444-4444-444444444444",
"name": "Harbor Insurance"
},
"insurance_number": "INS-123",
"wc_number": "WCB-456",
"referring_provider": "John Doe",
"provider": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "John Doe",
"npi": "1234567890"
},
"law_firm": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "Acme LLP"
},
"practice": {
"id": "11111111-1111-1111-1111-111111111111",
"name": "Main Street Imaging"
},
"icd10_codes": [
{
"id": "11111111-1111-1111-1111-111111111111",
"code": "M54.5",
"system": "http://hl7.org/fhir/sid/icd-10-cm",
"short_description": "Low back pain"
}
],
"patient": {
"id": "11111111-1111-1111-1111-111111111111",
"identifier": {
"system": "https://scan.com/fhir/sid/patient-id",
"value": "11111111-1111-1111-1111-111111111111"
},
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"date_of_birth": "05/21/1988",
"date_of_birth_iso": "1988-05-21",
"email": "[email protected]",
"phone_number": "5551234567",
"gender": "male",
"address_line_1": "123 Main St",
"city": "Anytown",
"state": "GA",
"zip_code": "30303"
}
}
],
"meta": {
"current_page": 1,
"next_page": 2,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
Authorizations
Authorization: Bearer <api_token>. Sandbox tokens come from Get API keys
and allow 2,000 successful requests or 7 days. Failed 4xx/5xx responses do
not consume the allowance. Production tokens are issued from the group's
API access tab.
Query Parameters
Page number
Number of referrals per page
Date of referral creation
Filter by visit start time. Pass one date (YYYY-MM-DD) for that Eastern day, or two dates for an inclusive range. A referral matches if any visit start falls in the window. Unscheduled visits are excluded.
When true, also include referrals whose billing-company name matches the authenticated group