Create Comparison Attachment
curl --request POST \
--url https://api.decodahealth.com/attachments/create-comparison \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"beforeAttachmentId": "<string>",
"afterAttachmentId": "<string>",
"patientId": "<string>",
"noteId": "<string>",
"mode": "side-by-side",
"sliderPosition": 50,
"name": "<string>",
"beforeImageName": "<string>",
"afterImageName": "<string>",
"beforeTransform": {
"panX": 0,
"panY": 0,
"zoom": 1,
"cropX": 123,
"cropY": 123,
"cropWidth": 123,
"cropHeight": 123,
"mirror": false
},
"afterTransform": {
"panX": 0,
"panY": 0,
"zoom": 1,
"cropX": 123,
"cropY": 123,
"cropWidth": 123,
"cropHeight": 123,
"mirror": false
}
}
'import requests
url = "https://api.decodahealth.com/attachments/create-comparison"
payload = {
"beforeAttachmentId": "<string>",
"afterAttachmentId": "<string>",
"patientId": "<string>",
"noteId": "<string>",
"mode": "side-by-side",
"sliderPosition": 50,
"name": "<string>",
"beforeImageName": "<string>",
"afterImageName": "<string>",
"beforeTransform": {
"panX": 0,
"panY": 0,
"zoom": 1,
"cropX": 123,
"cropY": 123,
"cropWidth": 123,
"cropHeight": 123,
"mirror": False
},
"afterTransform": {
"panX": 0,
"panY": 0,
"zoom": 1,
"cropX": 123,
"cropY": 123,
"cropWidth": 123,
"cropHeight": 123,
"mirror": False
}
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
beforeAttachmentId: '<string>',
afterAttachmentId: '<string>',
patientId: '<string>',
noteId: '<string>',
mode: 'side-by-side',
sliderPosition: 50,
name: '<string>',
beforeImageName: '<string>',
afterImageName: '<string>',
beforeTransform: {
panX: 0,
panY: 0,
zoom: 1,
cropX: 123,
cropY: 123,
cropWidth: 123,
cropHeight: 123,
mirror: false
},
afterTransform: {
panX: 0,
panY: 0,
zoom: 1,
cropX: 123,
cropY: 123,
cropWidth: 123,
cropHeight: 123,
mirror: false
}
})
};
fetch('https://api.decodahealth.com/attachments/create-comparison', 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.decodahealth.com/attachments/create-comparison",
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([
'beforeAttachmentId' => '<string>',
'afterAttachmentId' => '<string>',
'patientId' => '<string>',
'noteId' => '<string>',
'mode' => 'side-by-side',
'sliderPosition' => 50,
'name' => '<string>',
'beforeImageName' => '<string>',
'afterImageName' => '<string>',
'beforeTransform' => [
'panX' => 0,
'panY' => 0,
'zoom' => 1,
'cropX' => 123,
'cropY' => 123,
'cropWidth' => 123,
'cropHeight' => 123,
'mirror' => false
],
'afterTransform' => [
'panX' => 0,
'panY' => 0,
'zoom' => 1,
'cropX' => 123,
'cropY' => 123,
'cropWidth' => 123,
'cropHeight' => 123,
'mirror' => false
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$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.decodahealth.com/attachments/create-comparison"
payload := strings.NewReader("{\n \"beforeAttachmentId\": \"<string>\",\n \"afterAttachmentId\": \"<string>\",\n \"patientId\": \"<string>\",\n \"noteId\": \"<string>\",\n \"mode\": \"side-by-side\",\n \"sliderPosition\": 50,\n \"name\": \"<string>\",\n \"beforeImageName\": \"<string>\",\n \"afterImageName\": \"<string>\",\n \"beforeTransform\": {\n \"panX\": 0,\n \"panY\": 0,\n \"zoom\": 1,\n \"cropX\": 123,\n \"cropY\": 123,\n \"cropWidth\": 123,\n \"cropHeight\": 123,\n \"mirror\": false\n },\n \"afterTransform\": {\n \"panX\": 0,\n \"panY\": 0,\n \"zoom\": 1,\n \"cropX\": 123,\n \"cropY\": 123,\n \"cropWidth\": 123,\n \"cropHeight\": 123,\n \"mirror\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("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.decodahealth.com/attachments/create-comparison")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"beforeAttachmentId\": \"<string>\",\n \"afterAttachmentId\": \"<string>\",\n \"patientId\": \"<string>\",\n \"noteId\": \"<string>\",\n \"mode\": \"side-by-side\",\n \"sliderPosition\": 50,\n \"name\": \"<string>\",\n \"beforeImageName\": \"<string>\",\n \"afterImageName\": \"<string>\",\n \"beforeTransform\": {\n \"panX\": 0,\n \"panY\": 0,\n \"zoom\": 1,\n \"cropX\": 123,\n \"cropY\": 123,\n \"cropWidth\": 123,\n \"cropHeight\": 123,\n \"mirror\": false\n },\n \"afterTransform\": {\n \"panX\": 0,\n \"panY\": 0,\n \"zoom\": 1,\n \"cropX\": 123,\n \"cropY\": 123,\n \"cropWidth\": 123,\n \"cropHeight\": 123,\n \"mirror\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/attachments/create-comparison")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"beforeAttachmentId\": \"<string>\",\n \"afterAttachmentId\": \"<string>\",\n \"patientId\": \"<string>\",\n \"noteId\": \"<string>\",\n \"mode\": \"side-by-side\",\n \"sliderPosition\": 50,\n \"name\": \"<string>\",\n \"beforeImageName\": \"<string>\",\n \"afterImageName\": \"<string>\",\n \"beforeTransform\": {\n \"panX\": 0,\n \"panY\": 0,\n \"zoom\": 1,\n \"cropX\": 123,\n \"cropY\": 123,\n \"cropWidth\": 123,\n \"cropHeight\": 123,\n \"mirror\": false\n },\n \"afterTransform\": {\n \"panX\": 0,\n \"panY\": 0,\n \"zoom\": 1,\n \"cropX\": 123,\n \"cropY\": 123,\n \"cropWidth\": 123,\n \"cropHeight\": 123,\n \"mirror\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"gcsPath": "<string>",
"originalFilename": "<string>",
"signedUrl": "<string>",
"name": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"noteId": "<string>",
"thumbnailSignedUrl": "<string>",
"annotations": [
{}
],
"externalId": "<string>",
"patient": {
"id": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>",
"externalId": "<string>",
"address": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"addressValid": true,
"meta": {},
"isArchived": true,
"primaryLocationId": "<string>",
"gender": "<string>",
"pronouns": "<string>",
"preferredName": "<string>",
"dateOfBirth": "2023-12-25",
"patientMedications": [
"<string>"
],
"leadSource": "<string>",
"onSchedulingBlacklist": true,
"surchargeDisabled": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"isActive": true,
"createdDate": "2023-11-07T05:31:56Z",
"emoji": "<string>",
"color": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
],
"creditBalance": 123,
"preferredProviderId": "<string>",
"dosespotPatientId": "<string>"
},
"note": {
"id": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
},
"provider": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
},
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Notes
Create Comparison Attachment
Create a comparison image from two attachments.
POST
/
attachments
/
create-comparison
Create Comparison Attachment
curl --request POST \
--url https://api.decodahealth.com/attachments/create-comparison \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"beforeAttachmentId": "<string>",
"afterAttachmentId": "<string>",
"patientId": "<string>",
"noteId": "<string>",
"mode": "side-by-side",
"sliderPosition": 50,
"name": "<string>",
"beforeImageName": "<string>",
"afterImageName": "<string>",
"beforeTransform": {
"panX": 0,
"panY": 0,
"zoom": 1,
"cropX": 123,
"cropY": 123,
"cropWidth": 123,
"cropHeight": 123,
"mirror": false
},
"afterTransform": {
"panX": 0,
"panY": 0,
"zoom": 1,
"cropX": 123,
"cropY": 123,
"cropWidth": 123,
"cropHeight": 123,
"mirror": false
}
}
'import requests
url = "https://api.decodahealth.com/attachments/create-comparison"
payload = {
"beforeAttachmentId": "<string>",
"afterAttachmentId": "<string>",
"patientId": "<string>",
"noteId": "<string>",
"mode": "side-by-side",
"sliderPosition": 50,
"name": "<string>",
"beforeImageName": "<string>",
"afterImageName": "<string>",
"beforeTransform": {
"panX": 0,
"panY": 0,
"zoom": 1,
"cropX": 123,
"cropY": 123,
"cropWidth": 123,
"cropHeight": 123,
"mirror": False
},
"afterTransform": {
"panX": 0,
"panY": 0,
"zoom": 1,
"cropX": 123,
"cropY": 123,
"cropWidth": 123,
"cropHeight": 123,
"mirror": False
}
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
beforeAttachmentId: '<string>',
afterAttachmentId: '<string>',
patientId: '<string>',
noteId: '<string>',
mode: 'side-by-side',
sliderPosition: 50,
name: '<string>',
beforeImageName: '<string>',
afterImageName: '<string>',
beforeTransform: {
panX: 0,
panY: 0,
zoom: 1,
cropX: 123,
cropY: 123,
cropWidth: 123,
cropHeight: 123,
mirror: false
},
afterTransform: {
panX: 0,
panY: 0,
zoom: 1,
cropX: 123,
cropY: 123,
cropWidth: 123,
cropHeight: 123,
mirror: false
}
})
};
fetch('https://api.decodahealth.com/attachments/create-comparison', 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.decodahealth.com/attachments/create-comparison",
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([
'beforeAttachmentId' => '<string>',
'afterAttachmentId' => '<string>',
'patientId' => '<string>',
'noteId' => '<string>',
'mode' => 'side-by-side',
'sliderPosition' => 50,
'name' => '<string>',
'beforeImageName' => '<string>',
'afterImageName' => '<string>',
'beforeTransform' => [
'panX' => 0,
'panY' => 0,
'zoom' => 1,
'cropX' => 123,
'cropY' => 123,
'cropWidth' => 123,
'cropHeight' => 123,
'mirror' => false
],
'afterTransform' => [
'panX' => 0,
'panY' => 0,
'zoom' => 1,
'cropX' => 123,
'cropY' => 123,
'cropWidth' => 123,
'cropHeight' => 123,
'mirror' => false
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$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.decodahealth.com/attachments/create-comparison"
payload := strings.NewReader("{\n \"beforeAttachmentId\": \"<string>\",\n \"afterAttachmentId\": \"<string>\",\n \"patientId\": \"<string>\",\n \"noteId\": \"<string>\",\n \"mode\": \"side-by-side\",\n \"sliderPosition\": 50,\n \"name\": \"<string>\",\n \"beforeImageName\": \"<string>\",\n \"afterImageName\": \"<string>\",\n \"beforeTransform\": {\n \"panX\": 0,\n \"panY\": 0,\n \"zoom\": 1,\n \"cropX\": 123,\n \"cropY\": 123,\n \"cropWidth\": 123,\n \"cropHeight\": 123,\n \"mirror\": false\n },\n \"afterTransform\": {\n \"panX\": 0,\n \"panY\": 0,\n \"zoom\": 1,\n \"cropX\": 123,\n \"cropY\": 123,\n \"cropWidth\": 123,\n \"cropHeight\": 123,\n \"mirror\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("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.decodahealth.com/attachments/create-comparison")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"beforeAttachmentId\": \"<string>\",\n \"afterAttachmentId\": \"<string>\",\n \"patientId\": \"<string>\",\n \"noteId\": \"<string>\",\n \"mode\": \"side-by-side\",\n \"sliderPosition\": 50,\n \"name\": \"<string>\",\n \"beforeImageName\": \"<string>\",\n \"afterImageName\": \"<string>\",\n \"beforeTransform\": {\n \"panX\": 0,\n \"panY\": 0,\n \"zoom\": 1,\n \"cropX\": 123,\n \"cropY\": 123,\n \"cropWidth\": 123,\n \"cropHeight\": 123,\n \"mirror\": false\n },\n \"afterTransform\": {\n \"panX\": 0,\n \"panY\": 0,\n \"zoom\": 1,\n \"cropX\": 123,\n \"cropY\": 123,\n \"cropWidth\": 123,\n \"cropHeight\": 123,\n \"mirror\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/attachments/create-comparison")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"beforeAttachmentId\": \"<string>\",\n \"afterAttachmentId\": \"<string>\",\n \"patientId\": \"<string>\",\n \"noteId\": \"<string>\",\n \"mode\": \"side-by-side\",\n \"sliderPosition\": 50,\n \"name\": \"<string>\",\n \"beforeImageName\": \"<string>\",\n \"afterImageName\": \"<string>\",\n \"beforeTransform\": {\n \"panX\": 0,\n \"panY\": 0,\n \"zoom\": 1,\n \"cropX\": 123,\n \"cropY\": 123,\n \"cropWidth\": 123,\n \"cropHeight\": 123,\n \"mirror\": false\n },\n \"afterTransform\": {\n \"panX\": 0,\n \"panY\": 0,\n \"zoom\": 1,\n \"cropX\": 123,\n \"cropY\": 123,\n \"cropWidth\": 123,\n \"cropHeight\": 123,\n \"mirror\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"gcsPath": "<string>",
"originalFilename": "<string>",
"signedUrl": "<string>",
"name": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"noteId": "<string>",
"thumbnailSignedUrl": "<string>",
"annotations": [
{}
],
"externalId": "<string>",
"patient": {
"id": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>",
"externalId": "<string>",
"address": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"addressValid": true,
"meta": {},
"isArchived": true,
"primaryLocationId": "<string>",
"gender": "<string>",
"pronouns": "<string>",
"preferredName": "<string>",
"dateOfBirth": "2023-12-25",
"patientMedications": [
"<string>"
],
"leadSource": "<string>",
"onSchedulingBlacklist": true,
"surchargeDisabled": true,
"tags": [
{
"id": "<string>",
"name": "<string>",
"isActive": true,
"createdDate": "2023-11-07T05:31:56Z",
"emoji": "<string>",
"color": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
],
"creditBalance": 123,
"preferredProviderId": "<string>",
"dosespotPatientId": "<string>"
},
"note": {
"id": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
},
"provider": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
},
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Body
application/json
Transform parameters for image alignment in comparisons.
Show child attributes
Show child attributes
Transform parameters for image alignment in comparisons.
Show child attributes
Show child attributes
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
