Get Notes

Get Notes

curl --request GET \
  --url https://api.decodahealth.com/notes/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "data": [
    {
      "id": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "visitDate": "2023-11-07T05:31:56Z",
      "lastEditedDate": "2023-11-07T05:31:56Z",
      "aiGenerated": true,
      "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>"
      },
      "version": 123,
      "content": "<string>",
      "summary": "<string>",
      "templateId": "<string>",
      "providers": [],
      "sourceDocuments": [],
      "signedOffProviderId": "<string>",
      "signedOffDate": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

GET

notes

list

Get Notes

curl --request GET \
  --url https://api.decodahealth.com/notes/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "data": [
    {
      "id": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "visitDate": "2023-11-07T05:31:56Z",
      "lastEditedDate": "2023-11-07T05:31:56Z",
      "aiGenerated": true,
      "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>"
      },
      "version": 123,
      "content": "<string>",
      "summary": "<string>",
      "templateId": "<string>",
      "providers": [],
      "sourceDocuments": [],
      "signedOffProviderId": "<string>",
      "signedOffDate": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Query Parameters

page

integer | null

per_page

integer | null

sort_by

string | null

sort_direction

enum<string> | null

Available options:

asc,

desc

location_id

string | null

provider_id

string | null

patient_id

string | null

note_id

string | null

patient_name

string | null

created_date

string<date-time>[] | null

string | null

template_id

string | null

location_ids

string[] | null

Response

Successful Response

data

NoteListItem · object[]

required

Show child attributes

data.id

string

required

data.createdDate

string<date-time>

required

data.visitDate

string<date-time>

required

data.lastEditedDate

string<date-time>

required

data.aiGenerated

boolean

required

data.patient

PatientSummary · object

required

Show child attributes

data.patient.id

string

required

The unique identifier for the user.

data.patient.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

data.patient.createdDate

string<date-time>

required

The date and time when the user was created.

data.patient.firstName

string | null

The user's first name.

data.patient.lastName

string | null

The user's last name.

data.patient.phoneNumber

string | null

The user's phone number.

data.patient.email

string | null

The user's email address.

data.patient.locationId

string | null

The location of the user.

data.patient.externalId

string | null

The user's external identifier if available.

data.patient.address

string | null

The user's primary address.

data.patient.addressLineTwo

string | null

Additional address information.

data.patient.city

string | null

The city of the user's address.

data.patient.state

string | null

The state of the user's address.

data.patient.zipCode

string | null

The postal code of the user's address.

data.patient.country

string | null

The country of the user's address.

data.patient.addressValid

boolean | null

Whether the user's address is valid.

data.patient.meta

Meta · object

Any additional metadata about the user relevant to your system.

data.patient.isArchived

boolean | null

Whether the user is archived.

data.patient.primaryLocationId

string | null

The primary location of the user.

data.patient.gender

string | null

The gender of the patient.

data.patient.dateOfBirth

string<date> | null

The date of birth of the patient.

data.patient.patientMedications

string[] | null

List of patient's self-reported medications.

data.patient.onSchedulingBlacklist

boolean | null

Whether the patient is on the scheduling blacklist.

data.patient.surchargeDisabled

boolean | null

Whether surcharges are disabled for this patient.

data.patient.tags

PatientTagSummary · object[] | null

List of patient tags

Show child attributes

data.patient.tags.id

string

required

Unique identifier for the patient tag

data.patient.tags.name

string

required

Name of the patient tag

data.patient.tags.isActive

boolean

required

Whether the tag is active

data.patient.tags.createdDate

string<date-time>

required

Date and time when the tag was created

data.patient.tags.emoji

string | null

Emoji associated with the tag

data.patient.tags.color

string | null

Color code for the tag (hex format)

data.patient.tags.updatedDate

string<date-time> | null

Date and time when the tag was last updated

data.patient.creditBalance

integer | null

Patient's credit balance in cents.

data.patient.preferredProviderId

string | null

The preferred provider ID for this patient.

data.version

integer

required

data.content

string | null

data.summary

string | null

data.templateId

string | null

data.providers

ProviderTiny · object[]

Show child attributes

data.providers.id

string

required

data.providers.firstName

string

required

data.providers.lastName

string | null

data.providers.email

string | null

data.providers.createdDate

string<date-time> | null

data.sourceDocuments

DocumentSummary · object[]

Show child attributes

data.sourceDocuments.id

string

required

data.sourceDocuments.patientId

string

required

data.sourceDocuments.filePath

string

required

data.sourceDocuments.fileType

string

required

data.sourceDocuments.title

string

required

data.sourceDocuments.summary

string | null

required

data.sourceDocuments.docType

enum<string>

required

Available options:

LAB,

PHARMACY,

IMAGE,

REPORT,

OTHER,

CONSENT,

NOTE_UPLOAD

data.sourceDocuments.signatureUrl

string | null

required

data.signedOffProviderId

string | null

data.signedOffDate

string<date-time> | null

total

integer

required

Get Note Versions Get Patients With Appointments Now

⌘I

Getting Started

API

Tenant

Webhook

Headers

Query Parameters

Response