Add Attachment

curl --request POST \
  --url https://api.decodahealth.com/attachments \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'TENANT: <tenant>' \
  --form attachment='@example-file' \
  --form 'patient_id=<string>' \
  --form 'note_id=<string>' \
  --form 'name=<string>'

{
  "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>"
    ],
    "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>"
  },
  "note": {
    "id": "<string>",
    "createdDate": "2023-11-07T05:31:56Z"
  }
}

POST

attachments

Add Attachment

curl --request POST \
  --url https://api.decodahealth.com/attachments \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'TENANT: <tenant>' \
  --form attachment='@example-file' \
  --form 'patient_id=<string>' \
  --form 'note_id=<string>' \
  --form 'name=<string>'

{
  "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>"
    ],
    "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>"
  },
  "note": {
    "id": "<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

multipart/form-data

attachment

file

required

patient_id

string

required

note_id

string | null

name

string | null

Response

Successful Response

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

Show child attributes

patient.id

string

required

The unique identifier for the user.

patient.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

patient.createdDate

string<date-time>

required

The date and time when the user was created.

patient.firstName

string | null

The user's first name.

patient.lastName

string | null

The user's last name.

patient.phoneNumber

string | null

The user's phone number.

patient.email

string | null

The user's email address.

patient.locationId

string | null

The location of the user.

patient.externalId

string | null

The user's external identifier if available.

patient.address

string | null

The user's primary address.

patient.addressLineTwo

string | null

Additional address information.

patient.city

string | null

The city of the user's address.

patient.state

string | null

The state of the user's address.

patient.zipCode

string | null

The postal code of the user's address.

patient.country

string | null

The country of the user's address.

patient.addressValid

boolean | null

Whether the user's address is valid.

patient.meta

Meta · object

Any additional metadata about the user relevant to your system.

patient.isArchived

boolean | null

Whether the user is archived.

patient.primaryLocationId

string | null

The primary location of the user.

patient.gender

string | null

The gender of the patient.

patient.dateOfBirth

string<date> | null

The date of birth of the patient.

patient.patientMedications

string[] | null

List of patient's self-reported medications.

patient.onSchedulingBlacklist

boolean | null

Whether the patient is on the scheduling blacklist.

patient.surchargeDisabled

boolean | null

Whether surcharges are disabled for this patient.

patient.tags

PatientTagSummary · object[] | null

List of patient tags

Show child attributes

patient.tags.id

string

required

Unique identifier for the patient tag

patient.tags.name

string

required

Name of the patient tag

patient.tags.isActive

boolean

required

Whether the tag is active

patient.tags.createdDate

string<date-time>

required

Date and time when the tag was created

patient.tags.emoji

string | null

Emoji associated with the tag

patient.tags.color

string | null

Color code for the tag (hex format)

patient.tags.updatedDate

string<date-time> | null

Date and time when the tag was last updated

patient.creditBalance

integer | null

Patient's credit balance in cents.

patient.preferredProviderId

string | null

The preferred provider ID for this patient.

note

NoteAttachmentNote · object

Show child attributes

note.id

string

required

note.createdDate

string<date-time>

required

Update Medication Add Note Attachment From Url

⌘I

Getting Started

API

Tenant

Webhook

Add Attachment

Headers

Body

Response