Uploads a document on a referral

curl --request POST \
  --url https://api.staging.scan.com/api/v2/referrals/{referral_id}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": {
    "file": "data:application/pdf;name=invoice.pdf;base64,JVBERi0xLjQK",
    "visit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'

require 'uri'
require 'net/http'

url = URI("https://api.staging.scan.com/api/v2/referrals/{referral_id}/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document\": {\n    \"file\": \"data:application/pdf;name=invoice.pdf;base64,JVBERi0xLjQK\",\n    \"visit_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}"

response = http.request(request)
puts response.read_body

import requests

url = "https://api.staging.scan.com/api/v2/referrals/{referral_id}/documents"

payload = { "document": {
        "file": "data:application/pdf;name=invoice.pdf;base64,JVBERi0xLjQK",
        "visit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    document: {
      file: 'data:application/pdf;name=invoice.pdf;base64,JVBERi0xLjQK',
      visit_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    }
  })
};

fetch('https://api.staging.scan.com/api/v2/referrals/{referral_id}/documents', 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/{referral_id}/documents",
  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([
    'document' => [
        'file' => 'data:application/pdf;name=invoice.pdf;base64,JVBERi0xLjQK',
        'visit_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.staging.scan.com/api/v2/referrals/{referral_id}/documents"

	payload := strings.NewReader("{\n  \"document\": {\n    \"file\": \"data:application/pdf;name=invoice.pdf;base64,JVBERi0xLjQK\",\n    \"visit_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

{
  "type": "invoice",
  "filename": "<string>",
  "content_type": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Referrals

Uploads a document on a referral

Attaches one file to a referral the authenticated group can access. type is invoice, pfr (letter of protection), drivers_license, aob, or hcfa. file is a base64 data URI, the same shape as order_form: data:application/pdf;name=file.pdf;base64,.... PDF, PNG, and JPEG only. The file must be 20 MB or smaller. Base64 expansion is already included in that limit.

An invoice replaces the current invoice and keeps the previous file. A letter of protection is added alongside existing ones. A driver’s license replaces the patient’s current license. An assignment of benefits replaces the current one. An HCFA is stored on a visit. Send visit_id when the referral has more than one visit. With one visit, that visit is used.

Returns 403 until Scan enables referral_documents_create for the group.

POST

api

referrals

{referral_id}

documents

Uploads a document on a referral

curl --request POST \
  --url https://api.staging.scan.com/api/v2/referrals/{referral_id}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": {
    "file": "data:application/pdf;name=invoice.pdf;base64,JVBERi0xLjQK",
    "visit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'

require 'uri'
require 'net/http'

url = URI("https://api.staging.scan.com/api/v2/referrals/{referral_id}/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document\": {\n    \"file\": \"data:application/pdf;name=invoice.pdf;base64,JVBERi0xLjQK\",\n    \"visit_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}"

response = http.request(request)
puts response.read_body

import requests

url = "https://api.staging.scan.com/api/v2/referrals/{referral_id}/documents"

payload = { "document": {
        "file": "data:application/pdf;name=invoice.pdf;base64,JVBERi0xLjQK",
        "visit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    document: {
      file: 'data:application/pdf;name=invoice.pdf;base64,JVBERi0xLjQK',
      visit_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    }
  })
};

fetch('https://api.staging.scan.com/api/v2/referrals/{referral_id}/documents', 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/{referral_id}/documents",
  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([
    'document' => [
        'file' => 'data:application/pdf;name=invoice.pdf;base64,JVBERi0xLjQK',
        'visit_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.staging.scan.com/api/v2/referrals/{referral_id}/documents"

	payload := strings.NewReader("{\n  \"document\": {\n    \"file\": \"data:application/pdf;name=invoice.pdf;base64,JVBERi0xLjQK\",\n    \"visit_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

{
  "type": "invoice",
  "filename": "<string>",
  "content_type": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Authorization: Bearer <api_token>. Reuse the same token on later requests until it expires or is revoked. Do not request a new token for each call. The token does not expire after 24 hours. Sandbox tokens come from Get API keys and allow 2,000 successful requests or 7 days, or 90 days with an access code. Failed 4xx/5xx responses do not consume the allowance. Production tokens are issued from the group's API access tab and last until the expiry set there, or until revoked when no expiry is set.

Path Parameters

referral_id

string<uuid>

required

Referral ID

Body

application/json

document

object

required

Show child attributes

Response

Document stored

type

enum<string>

required

Available options:

invoice,

pfr,

drivers_license,

aob,

hcfa

filename

string

required

content_type

string

required

created_at

string<date-time>

required

Referrals

Courier SSO

Referral Orders

Patients

Practices

Law Firms

Body Parts

CPT Codes

ICD-10 Codes

Modalities

Locations

Order Documents

Status

Testing

FHIR

Uploads a document on a referral

Authorizations

Path Parameters

Body

Response