Skip to main content
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
  }
}
'
{
  "id": "<string>",
  "gcsPath": "<string>",
  "originalFilename": "<string>",
  "signedUrl": "<string>",
  "name": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "noteId": "<string>",
  "thumbnailSignedUrl": "<string>",
  "annotations": [
    {}
  ],
  "patient": {
    "id": "<string>",
    "type": "PROVIDER",
    "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>",
    "dateOfBirth": "2023-12-25",
    "patientMedications": [
      "<string>"
    ],
    "patientSource": "SELF_SCHEDULING",
    "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"
    }
  ]
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
beforeAttachmentId
string
required
afterAttachmentId
string
required
patientId
string
required
noteId
string | null
mode
string
default:side-by-side
sliderPosition
number
default:50
name
string | null
beforeImageName
string | null
afterImageName
string | null
beforeTransform
ImageTransform · object

Transform parameters for image alignment in comparisons.

afterTransform
ImageTransform · object

Transform parameters for image alignment in comparisons.

Response

Successful Response

id
string
required
gcsPath
string
required
originalFilename
string
required
signedUrl
string
required
name
string
required
createdDate
string<date-time>
required
noteId
string | null
thumbnailSignedUrl
string | null
annotations
Annotations · object[] | null
patient
PatientSummary · object
note
NoteAttachmentNote · object
provider
ProviderTiny · object
tags
NoteAttachmentTagSummary · object[]