Upload a document
curl --request POST \
--url https://api.usecobalt.com/v1/documents \
--header 'Content-Type: multipart/form-data' \
--header 'access_token: <api-key>' \
--header 'client_id: <api-key>' \
--header 'client_secret: <api-key>' \
--form document=@example-file \
--form patient_mrn=12345 \
--form 'folder_name=Lab Results' \
--form 'template_name=Progress Note' \
--form emr_assigned_to_id=staff-123 \
--form is_reviewed=false \
--form 'notes=Please review before the next visit.' \
--form is_high_priority=false \
--form location_id=location-1 \
--form 'tags[0]=lab' \
--form 'tags[1]=urgent' \
--form 'association_id=<string>' \
--form callback_urls=https://example.com/webhooks/cobaltimport requests
url = "https://api.usecobalt.com/v1/documents"
files = { "document": ("example-file", open("example-file", "rb")) }
payload = {
"patient_mrn": "12345",
"folder_name": "Lab Results",
"template_name": "Progress Note",
"emr_assigned_to_id": "staff-123",
"is_reviewed": "false",
"notes": "Please review before the next visit.",
"is_high_priority": "false",
"location_id": "location-1",
"tags[0]": "lab",
"tags[1]": "urgent",
"association_id": "<string>",
"callback_urls": "https://example.com/webhooks/cobalt"
}
headers = {
"client_id": "<api-key>",
"client_secret": "<api-key>",
"access_token": "<api-key>"
}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('document', '<string>');
form.append('patient_mrn', '12345');
form.append('folder_name', 'Lab Results');
form.append('template_name', 'Progress Note');
form.append('emr_assigned_to_id', 'staff-123');
form.append('is_reviewed', 'false');
form.append('notes', 'Please review before the next visit.');
form.append('is_high_priority', 'false');
form.append('location_id', 'location-1');
form.append('tags[0]', 'lab');
form.append('tags[1]', 'urgent');
form.append('association_id', '<string>');
form.append('callback_urls', 'https://example.com/webhooks/cobalt');
const options = {
method: 'POST',
headers: {client_id: '<api-key>', client_secret: '<api-key>', access_token: '<api-key>'}
};
options.body = form;
fetch('https://api.usecobalt.com/v1/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.usecobalt.com/v1/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 => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"patient_mrn\"\r\n\r\n12345\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_name\"\r\n\r\nLab Results\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_name\"\r\n\r\nProgress Note\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emr_assigned_to_id\"\r\n\r\nstaff-123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_reviewed\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\nPlease review before the next visit.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_high_priority\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"location_id\"\r\n\r\nlocation-1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B0%5D\"\r\n\r\nlab\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B1%5D\"\r\n\r\nurgent\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"association_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_urls\"\r\n\r\nhttps://example.com/webhooks/cobalt\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"access_token: <api-key>",
"client_id: <api-key>",
"client_secret: <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.usecobalt.com/v1/documents"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"patient_mrn\"\r\n\r\n12345\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_name\"\r\n\r\nLab Results\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_name\"\r\n\r\nProgress Note\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emr_assigned_to_id\"\r\n\r\nstaff-123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_reviewed\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\nPlease review before the next visit.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_high_priority\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"location_id\"\r\n\r\nlocation-1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B0%5D\"\r\n\r\nlab\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B1%5D\"\r\n\r\nurgent\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"association_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_urls\"\r\n\r\nhttps://example.com/webhooks/cobalt\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("client_id", "<api-key>")
req.Header.Add("client_secret", "<api-key>")
req.Header.Add("access_token", "<api-key>")
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.usecobalt.com/v1/documents")
.header("client_id", "<api-key>")
.header("client_secret", "<api-key>")
.header("access_token", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"patient_mrn\"\r\n\r\n12345\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_name\"\r\n\r\nLab Results\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_name\"\r\n\r\nProgress Note\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emr_assigned_to_id\"\r\n\r\nstaff-123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_reviewed\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\nPlease review before the next visit.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_high_priority\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"location_id\"\r\n\r\nlocation-1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B0%5D\"\r\n\r\nlab\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B1%5D\"\r\n\r\nurgent\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"association_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_urls\"\r\n\r\nhttps://example.com/webhooks/cobalt\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usecobalt.com/v1/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["client_id"] = '<api-key>'
request["client_secret"] = '<api-key>'
request["access_token"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"patient_mrn\"\r\n\r\n12345\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_name\"\r\n\r\nLab Results\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_name\"\r\n\r\nProgress Note\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emr_assigned_to_id\"\r\n\r\nstaff-123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_reviewed\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\nPlease review before the next visit.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_high_priority\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"location_id\"\r\n\r\nlocation-1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B0%5D\"\r\n\r\nlab\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B1%5D\"\r\n\r\nurgent\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"association_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_urls\"\r\n\r\nhttps://example.com/webhooks/cobalt\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"document_id": "<string>",
"job_id": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}Documents
Upload Document
Upload a document to a patient’s chart.
POST
/
documents
Upload a document
curl --request POST \
--url https://api.usecobalt.com/v1/documents \
--header 'Content-Type: multipart/form-data' \
--header 'access_token: <api-key>' \
--header 'client_id: <api-key>' \
--header 'client_secret: <api-key>' \
--form document=@example-file \
--form patient_mrn=12345 \
--form 'folder_name=Lab Results' \
--form 'template_name=Progress Note' \
--form emr_assigned_to_id=staff-123 \
--form is_reviewed=false \
--form 'notes=Please review before the next visit.' \
--form is_high_priority=false \
--form location_id=location-1 \
--form 'tags[0]=lab' \
--form 'tags[1]=urgent' \
--form 'association_id=<string>' \
--form callback_urls=https://example.com/webhooks/cobaltimport requests
url = "https://api.usecobalt.com/v1/documents"
files = { "document": ("example-file", open("example-file", "rb")) }
payload = {
"patient_mrn": "12345",
"folder_name": "Lab Results",
"template_name": "Progress Note",
"emr_assigned_to_id": "staff-123",
"is_reviewed": "false",
"notes": "Please review before the next visit.",
"is_high_priority": "false",
"location_id": "location-1",
"tags[0]": "lab",
"tags[1]": "urgent",
"association_id": "<string>",
"callback_urls": "https://example.com/webhooks/cobalt"
}
headers = {
"client_id": "<api-key>",
"client_secret": "<api-key>",
"access_token": "<api-key>"
}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('document', '<string>');
form.append('patient_mrn', '12345');
form.append('folder_name', 'Lab Results');
form.append('template_name', 'Progress Note');
form.append('emr_assigned_to_id', 'staff-123');
form.append('is_reviewed', 'false');
form.append('notes', 'Please review before the next visit.');
form.append('is_high_priority', 'false');
form.append('location_id', 'location-1');
form.append('tags[0]', 'lab');
form.append('tags[1]', 'urgent');
form.append('association_id', '<string>');
form.append('callback_urls', 'https://example.com/webhooks/cobalt');
const options = {
method: 'POST',
headers: {client_id: '<api-key>', client_secret: '<api-key>', access_token: '<api-key>'}
};
options.body = form;
fetch('https://api.usecobalt.com/v1/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.usecobalt.com/v1/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 => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"patient_mrn\"\r\n\r\n12345\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_name\"\r\n\r\nLab Results\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_name\"\r\n\r\nProgress Note\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emr_assigned_to_id\"\r\n\r\nstaff-123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_reviewed\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\nPlease review before the next visit.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_high_priority\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"location_id\"\r\n\r\nlocation-1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B0%5D\"\r\n\r\nlab\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B1%5D\"\r\n\r\nurgent\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"association_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_urls\"\r\n\r\nhttps://example.com/webhooks/cobalt\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"access_token: <api-key>",
"client_id: <api-key>",
"client_secret: <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.usecobalt.com/v1/documents"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"patient_mrn\"\r\n\r\n12345\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_name\"\r\n\r\nLab Results\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_name\"\r\n\r\nProgress Note\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emr_assigned_to_id\"\r\n\r\nstaff-123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_reviewed\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\nPlease review before the next visit.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_high_priority\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"location_id\"\r\n\r\nlocation-1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B0%5D\"\r\n\r\nlab\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B1%5D\"\r\n\r\nurgent\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"association_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_urls\"\r\n\r\nhttps://example.com/webhooks/cobalt\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("client_id", "<api-key>")
req.Header.Add("client_secret", "<api-key>")
req.Header.Add("access_token", "<api-key>")
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.usecobalt.com/v1/documents")
.header("client_id", "<api-key>")
.header("client_secret", "<api-key>")
.header("access_token", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"patient_mrn\"\r\n\r\n12345\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_name\"\r\n\r\nLab Results\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_name\"\r\n\r\nProgress Note\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emr_assigned_to_id\"\r\n\r\nstaff-123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_reviewed\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\nPlease review before the next visit.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_high_priority\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"location_id\"\r\n\r\nlocation-1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B0%5D\"\r\n\r\nlab\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B1%5D\"\r\n\r\nurgent\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"association_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_urls\"\r\n\r\nhttps://example.com/webhooks/cobalt\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usecobalt.com/v1/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["client_id"] = '<api-key>'
request["client_secret"] = '<api-key>'
request["access_token"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"patient_mrn\"\r\n\r\n12345\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_name\"\r\n\r\nLab Results\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_name\"\r\n\r\nProgress Note\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"emr_assigned_to_id\"\r\n\r\nstaff-123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_reviewed\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\nPlease review before the next visit.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_high_priority\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"location_id\"\r\n\r\nlocation-1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B0%5D\"\r\n\r\nlab\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags%5B1%5D\"\r\n\r\nurgent\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"association_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_urls\"\r\n\r\nhttps://example.com/webhooks/cobalt\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"document_id": "<string>",
"job_id": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}Documents are processed asynchronously. You’ll receive a webhook notification when the upload is complete or if there was an error.
To attach the document to an existing referral or order instead of a folder, send
To route the document to a staff member for review, send
Example Request
curl -X POST https://api.usecobalt.com/v1/documents \
-H 'Content-Type: multipart/form-data' \
-H 'client_id: ci_live_198908HJDKJSH98789OHKJL' \
-H 'client_secret: cs_live_9827hofdsklOYYHJLJh' \
-H 'access_token: 493JKLHIU98789hLKH9HHJH' \
-F 'folder_name=MedicalRecords' \
-F 'patient_mrn=123456' \
-F 'location_id=20' \
-F 'tags=Estimate' \
-F 'tags=Referral' \
-F 'document=@/path/to/document.pdf'
association_type and association_id (the Cobalt id from GET /v1/referrals or GET /v1/orders) in place of folder_name:
curl -X POST https://api.usecobalt.com/v1/documents \
-H 'Content-Type: multipart/form-data' \
-H 'client_id: ci_live_198908HJDKJSH98789OHKJL' \
-H 'client_secret: cs_live_9827hofdsklOYYHJLJh' \
-H 'access_token: 493JKLHIU98789hLKH9HHJH' \
-F 'patient_mrn=123456' \
-F 'association_type=order' \
-F 'association_id=b1c2d3e4-5678-4abc-9def-0123456789ab' \
-F 'document=@/path/to/document.pdf'
emr_assigned_to_id. This is the EMR-native staff ID, not a Cobalt ID. Valid IDs are the ehr_id values returned by GET /v1/staff.
Example Response
{
"success": true,
"message": "Document uploaded successfully. It will be processed soon.",
"document_id": "9988776655443322"
}
Example Success Webhook
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"object": "event",
"created": "2023-10-01T12:34:56Z",
"type": "document.uploaded",
"data": {
"document_id": "9988776655443322",
"patient_mrn": "123456",
"folder_name": "MedicalRecords"
}
}
Example Failure Webhook
{
"id": "123e4567-e89b-12d3-a456-426614174001",
"object": "event",
"created": "2023-10-01T12:34:56Z",
"type": "document.upload_failed",
"data": {
"document_id": "9988776655443322",
"patient_mrn": "123456",
"folder_name": "MedicalRecords",
"failure_reason": "Patient not found. Please check the patient MRN and try again."
}
}
Authorizations
Body
multipart/form-data
The document file to upload (PDF, JPEG, or PNG; max 30MB).
Medical Record Number of the patient the document is for.
Example:
"12345"
Destination folder in the EMR. Either folder_name or template_name is required.
Example:
"Lab Results"
Destination template in the EMR (max 255 chars). Either folder_name or template_name is required.
Example:
"Progress Note"
EMR staff ID to assign the document to. Validated against the account’s staff; valid ids are the ehr_id values from GET /v1/staff.
Example:
"staff-123"
Whether the document should be flagged for review in the EMR. One of: "true", "false".
Example:
"false"
Free-text notes for the document (max 1000 characters).
Example:
"Please review before the next visit."
Whether the document is high priority. One of: "true", "false".
Example:
"false"
EMR location ID the document belongs to. Validated against the account’s locations.
Example:
"location-1"
Tags to attach to the document. Repeat the field for multiple tags.
Example:
["lab", "urgent"]
Attach the document to an existing entity instead of a chart folder. One of: "referral", "order". When set, association_id is required and folder_name/template_name must be omitted. eClinicalWorks only.
Available options:
referral, order Cobalt id of the entity to attach to (the referral id from GET /v1/referrals, or the order id from GET /v1/orders). Required when association_type is set.
URLs to receive the completion webhook for this document, in addition to the account webhook.
Example:
["https://example.com/webhooks/cobalt"]