Get Note Detail

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

{
  "id": "<string>",
  "parentNoteId": "<string>",
  "version": 123,
  "currentVersion": 123,
  "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>",
    "memberships": [
      {
        "id": "<string>",
        "membership": {
          "id": "<string>",
          "name": "<string>",
          "textColor": "<string>"
        },
        "startDate": "2023-11-07T05:31:56Z",
        "status": "ACTIVE"
      }
    ],
    "goalWeight": 123,
    "measurements": [
      {
        "patientId": "<string>",
        "createdDate": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "height": 123,
        "weight": 123,
        "systolicBp": 123,
        "diastolicBp": 123,
        "pulse": 123,
        "temperature": 123,
        "waistCircumference": 123,
        "noteId": "<string>",
        "measurementDate": "2023-11-07T05:31:56Z",
        "eventId": "<string>",
        "creatorId": "<string>"
      }
    ],
    "medications": [
      {
        "id": "<string>",
        "createdDate": "2023-11-07T05:31:56Z",
        "patientId": "<string>",
        "name": "<string>",
        "providerId": "<string>",
        "sideEffects": "<string>",
        "administrationLocation": "<string>",
        "amount": 123,
        "unit": "AMPOULES",
        "lotNumber": "<string>",
        "stockId": "<string>",
        "noteId": "<string>",
        "doseDate": "2023-11-07T05:31:56Z",
        "comment": "<string>",
        "frequency": "<string>",
        "quantity": 123,
        "isUsedAsTemplate": true,
        "signedOffProviderId": "<string>",
        "signedOffDate": "2023-11-07T05:31:56Z",
        "provider": {
          "id": "<string>",
          "type": "PROVIDER",
          "firstName": "<string>",
          "lastName": "<string>",
          "phoneNumber": "<string>",
          "email": "<string>",
          "locationId": "<string>"
        }
      }
    ],
    "optedOutOfSms": true,
    "appointmentCount": 123,
    "totalSpent": 123
  },
  "createdDate": "2023-11-07T05:31:56Z",
  "eventId": "<string>",
  "duration": 123,
  "content": "<string>",
  "summary": "<string>",
  "template": {
    "id": "<string>",
    "name": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "contentTemplate": "<string>",
    "attachments": []
  },
  "transcript": {
    "id": "<string>",
    "transcript": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "duration": 123
  },
  "providers": [],
  "sourceDocuments": [],
  "icd10Codes": [
    {
      "code": "<string>",
      "shortDesc": "<string>",
      "longDesc": "<string>",
      "categorical": true
    }
  ],
  "cptCodes": [
    {
      "code": "<string>",
      "category1": "<string>",
      "category2": "<string>",
      "category3": "<string>",
      "category4": "<string>",
      "category5": "<string>",
      "category6": "<string>",
      "description": "<string>",
      "notes": "<string>"
    }
  ],
  "signedOffProviderId": "<string>",
  "signedOffDate": "2023-11-07T05:31:56Z"
}

GET

notes

{note_id}

detail

Get Note Detail

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

{
  "id": "<string>",
  "parentNoteId": "<string>",
  "version": 123,
  "currentVersion": 123,
  "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>",
    "memberships": [
      {
        "id": "<string>",
        "membership": {
          "id": "<string>",
          "name": "<string>",
          "textColor": "<string>"
        },
        "startDate": "2023-11-07T05:31:56Z",
        "status": "ACTIVE"
      }
    ],
    "goalWeight": 123,
    "measurements": [
      {
        "patientId": "<string>",
        "createdDate": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "height": 123,
        "weight": 123,
        "systolicBp": 123,
        "diastolicBp": 123,
        "pulse": 123,
        "temperature": 123,
        "waistCircumference": 123,
        "noteId": "<string>",
        "measurementDate": "2023-11-07T05:31:56Z",
        "eventId": "<string>",
        "creatorId": "<string>"
      }
    ],
    "medications": [
      {
        "id": "<string>",
        "createdDate": "2023-11-07T05:31:56Z",
        "patientId": "<string>",
        "name": "<string>",
        "providerId": "<string>",
        "sideEffects": "<string>",
        "administrationLocation": "<string>",
        "amount": 123,
        "unit": "AMPOULES",
        "lotNumber": "<string>",
        "stockId": "<string>",
        "noteId": "<string>",
        "doseDate": "2023-11-07T05:31:56Z",
        "comment": "<string>",
        "frequency": "<string>",
        "quantity": 123,
        "isUsedAsTemplate": true,
        "signedOffProviderId": "<string>",
        "signedOffDate": "2023-11-07T05:31:56Z",
        "provider": {
          "id": "<string>",
          "type": "PROVIDER",
          "firstName": "<string>",
          "lastName": "<string>",
          "phoneNumber": "<string>",
          "email": "<string>",
          "locationId": "<string>"
        }
      }
    ],
    "optedOutOfSms": true,
    "appointmentCount": 123,
    "totalSpent": 123
  },
  "createdDate": "2023-11-07T05:31:56Z",
  "eventId": "<string>",
  "duration": 123,
  "content": "<string>",
  "summary": "<string>",
  "template": {
    "id": "<string>",
    "name": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "contentTemplate": "<string>",
    "attachments": []
  },
  "transcript": {
    "id": "<string>",
    "transcript": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "duration": 123
  },
  "providers": [],
  "sourceDocuments": [],
  "icd10Codes": [
    {
      "code": "<string>",
      "shortDesc": "<string>",
      "longDesc": "<string>",
      "categorical": true
    }
  ],
  "cptCodes": [
    {
      "code": "<string>",
      "category1": "<string>",
      "category2": "<string>",
      "category3": "<string>",
      "category4": "<string>",
      "category5": "<string>",
      "category6": "<string>",
      "description": "<string>",
      "notes": "<string>"
    }
  ],
  "signedOffProviderId": "<string>",
  "signedOffDate": "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

Path Parameters

note_id

string

required

Response

Successful Response

string

required

parentNoteId

string

required

version

integer

required

currentVersion

integer

required

aiGenerated

boolean

required

patient

PatientDetail · object

required

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.

patient.memberships

MemberTiny · object[] | null

List of memberships for this patient

Show child attributes

patient.memberships.id

string

required

Unique identifier for the member

patient.memberships.membership

MembershipTiny · object

required

Membership details

Show child attributes

patient.memberships.membership.id

string

required

Unique identifier for the membership

patient.memberships.membership.name

string

required

Name of the membership

patient.memberships.membership.textColor

string | null

Text color of the membership

patient.memberships.startDate

string<date-time>

required

When the patient joined the membership

patient.memberships.status

enum<string>

required

Current status of the membership

Available options:

ACTIVE,

EXPIRED,

CANCELLED,

DELINQUENT,

FROZEN

patient.goalWeight

number | null

The goal weight of the patient.

patient.measurements

MeasurementSummary · object[] | null

List of patient's measurements.

Show child attributes

patient.measurements.patientId

string

required

patient.measurements.createdDate

string<date-time>

required

patient.measurements.id

string

required

patient.measurements.height

number | null

The height of the patient in cms.

patient.measurements.weight

number | null

The weight of the patient in kgs.

patient.measurements.systolicBp

number | null

patient.measurements.diastolicBp

number | null

patient.measurements.pulse

number | null

patient.measurements.temperature

number | null

patient.measurements.waistCircumference

number | null

The waist circumference of the patient in cms.

patient.measurements.noteId

string | null

patient.measurements.measurementDate

string<date-time>

The date and time the measurement was taken. Defaults to now if not provided.

patient.measurements.eventId

string | null

The event that the measurement was taken for.

patient.measurements.creatorId

string | null

ID of the user who created this measurement (optional for legacy measurements)

patient.medications

DeprecatedMedicationSummary · object[] | null

List of provider-administered medication doses.

Show child attributes

patient.medications.id

string

required

patient.medications.createdDate

string<date-time>

required

patient.medications.patientId

string

required

patient.medications.name

string

required

patient.medications.providerId

string | null

patient.medications.sideEffects

string | null

patient.medications.administrationLocation

string | null

patient.medications.amount

number | null

patient.medications.unit

enum<string> | null

Available options:

AMPOULES,

APPLICATORS,

BOTTLES,

BOXES,

CAPSULES,

CUPS,

DOSES,

G_PER_ML,

GRAMS,

IU,

IU_PER_ML,

OUNCES,

FLUID_OUNCES,

KG,

KITS,

LITERS,

MCG,

MG,

MG_PER_ML,

ML,

MMOL,

MICROGRAM_PER_ML,

PACKS,

PAIRS,

PATCHES,

PERCENTAGE,

PIECES,

POUCHES,

ROLLS,

SACHETS,

SHEETS,

SPRAYS,

STRIPS,

SYRINGES,

TABLETS,

TABLETS_PER_DAY,

TESTS,

TUBES,

UNITS,

VIALS,

TREATMENTS,

SESSIONS,

PULSES,

JOULES,

CENTIMETERS,

THREAD_COUNT,

INJECTIONS,

WRINKLE_UNITS,

POUNDS,

FEET,

INCHES

patient.medications.lotNumber

string | null

patient.medications.stockId

string | null

patient.medications.noteId

string | null

patient.medications.doseDate

string<date-time> | null

patient.medications.comment

string | null

patient.medications.frequency

string | null

patient.medications.quantity

number | null

patient.medications.isUsedAsTemplate

boolean | null

patient.medications.signedOffProviderId

string | null

patient.medications.signedOffDate

string<date-time> | null

patient.medications.provider

UserTiny · object

Show child attributes

patient.medications.provider.id

string

required

The unique identifier for the user.

patient.medications.provider.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

patient.medications.provider.firstName

string | null

The user's first name.

patient.medications.provider.lastName

string | null

The user's last name.

patient.medications.provider.phoneNumber

string | null

The user's phone number.

patient.medications.provider.email

string | null

The user's email address.

patient.medications.provider.locationId

string | null

The location of the user.

patient.optedOutOfSms

boolean | null

Whether patient has opted out of SMS

patient.appointmentCount

integer | null

Total number of appointments for this patient

patient.totalSpent

integer | null

Total amount spent by this patient in cents

createdDate

string<date-time>

required

eventId

string | null

duration

integer | null

content

string | null

summary

string | null

template

NoteTemplateTableItem · object

Show child attributes

template.id

string

required

template.name

string

required

template.createdDate

string<date-time>

required

template.contentTemplate

string | null

template.attachments

NoteTemplateAttachmentResponse · object[]

Show child attributes

template.attachments.id

string

required

template.attachments.name

string

required

template.attachments.createdDate

string<date-time>

required

template.attachments.gcsPath

string | null

template.attachments.signedUrl

string | null

transcript

NoteTranscriptSummary · object

Show child attributes

transcript.id

string

required

transcript.transcript

string

required

transcript.createdDate

string<date-time>

required

transcript.duration

integer | null

providers

ProviderTiny · object[]

Show child attributes

providers.id

string

required

providers.firstName

string

required

providers.lastName

string | null

providers.email

string | null

providers.createdDate

string<date-time> | null

sourceDocuments

DocumentSummary · object[]

Show child attributes

sourceDocuments.id

string

required

sourceDocuments.patientId

string

required

sourceDocuments.filePath

string

required

sourceDocuments.fileType

string

required

sourceDocuments.title

string

required

sourceDocuments.summary

string | null

required

sourceDocuments.docType

enum<string>

required

Available options:

LAB,

PHARMACY,

IMAGE,

REPORT,

OTHER,

CONSENT,

NOTE_UPLOAD

sourceDocuments.signatureUrl

string | null

required

icd10Codes

ICDTenCode · object[] | null

Show child attributes

icd10Codes.code

string

required

icd10Codes.shortDesc

string

required

icd10Codes.longDesc

string | null

required

icd10Codes.categorical

boolean | null

required

cptCodes

CPTCode · object[] | null

Show child attributes

cptCodes.code

string

required

cptCodes.category1

string | null

required

cptCodes.category2

string | null

required

cptCodes.category3

string | null

required

cptCodes.category4

string | null

required

cptCodes.category5

string | null

required

cptCodes.category6

string | null

required

cptCodes.description

string

required

cptCodes.notes

string | null

required

signedOffProviderId

string | null

signedOffDate

string<date-time> | null

Get Note Attachments Get Note Revision

⌘I

Getting Started

API

Tenant

Webhook

Get Note Detail

Headers

Path Parameters

Response