Note

A note documents the interaction that a provider had with a patient and contains a summary of the most important information discussed.

The note model

Properties

Name
id
Type
string
Description
Unique identifier for the note.
Name
object
Type
string
Description
Always 'note'.
Name
patient
Type
string
Description
Patient this note is for.
Name
template
Type
string
Description
Template this note is based on.
Name
template_version
Type
string
Description
Template version this note is based on.
Name
appointment
Type
string
Description
Appointment this note is associated with.
Name
name
Type
string
Description
Name of the note.
Name
share_with_patient
Type
boolean
Description
Whether this note should be shared with the patient.
Name
sections
Type
array of objects
Description
All the sections and answers in the note.
Name
orders
Type
array of strings
Description
List of physician orders sent in this note.
Name
comments
Type
array of strings
Description
List of comments added to the note.
Name
addendums
Type
array of strings
Description
List of addendums appended to the note after the note has been signed and locked.
Name
status_history
Type
array of objects
Description
Status history of the note.
Name
reviews
Type
array of objects
Description
Review history of the note.
Name
created_by
Type
string
Description
Creator of the note.
Name
created_at
Type
number
Description
Timestamp (in Unix epoch time in milliseconds) of when the note was created.
Name
last_updated_at
Type
number
Description
Timestamp (in Unix epoch time in milliseconds) of when the note was last updated.

Response

{
    "id": "note_2UxtAULYUrX7GVsTKePy",
    "object": "note",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
    "template": "tmlt_NOIYLBGOBNhSwTWCUzfu",
    "template_version": "tver_1JtjV1QEY84Fv395Hl7h",
    "appointment": "appt_4BxtAULYUrX7GVsTKePy",
    "name": "Annual Check-In Visit Note — 9/18/22",
    "share_with_patient": false,
    "sections": [{
      "id": "nsec_2UxtAULYUrX7GVsTKePy",
      "object": "note_section",
      "section": "tsec_YUrX7GUxt2LAUVsTKePy",
      "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
      "answers": [{
        "id": "nans_ap0jVVAdR23DgkQPpdX8",
        "object": "note_answer",
        "question": "tqst_ap0jVVAdR23DgkQPpdX8",
        "response": 646077022000
        }]
    }],
    "orders": [
        "ordr_900jVVAdR23DgkQPpdX8"
    ],
    "comments": [
        "cmmt_op0jVVAdR23DgkQPpdX8"
    ],
    "addendums": [
        "addm_pdX8op0jVVAdR23DgkQP"
    ],
    "status_history": [
        {
        "status": "inProgress",
        "changed_by": "user_Z1zXZKvqrpwxbznuW6lJ",
        "changed_at": 1653798303
        }
    ],
    "reviews": [],
    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}

POST/v1/notes

Create a note

Creates a new visit note.

Required attributes

Name
patient
Type
string
Description
Patient this note is for.
Name
template
Type
string
Description
Template this note is based on.
Name
template_version
Type
string
Description
Template version this note is based on.
Name
created_by
Type
string
Description
Creator of the note.

Optional attributes

Name
appointment
Type
string
Description
Appointment this note is associated with.
Name
name
Type
string
Description
Name of the note.
Name
share_with_patient
Type
boolean
Description
Whether this note should be shared with the patient. Defaults to whatever the default for this note template is. Only applies if the note template allows the default to be overridden.

Response

{
   "id": "note_2UxtAULYUrX7GVsTKePy",
    "object": "note",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
    "template": "tmlt_NOIYLBGOBNhSwTWCUzfu",
    "template_version": "tver_1JtjV1QEY84Fv395Hl7h",
    "appointment": "appt_4BxtAULYUrX7GVsTKePy",
    "name": "Annual Check-In Visit Note — 9/18/22",
    "share_with_patient": false,
    "sections": [{
      "id": "nsec_2UxtAULYUrX7GVsTKePy",
      "object": "note_section",
      "section": "tsec_YUrX7GUxt2LAUVsTKePy",
      "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
      "answers": [{
        "id": "nans_ap0jVVAdR23DgkQPpdX8",
        "object": "note_answer",
        "question": "tqst_ap0jVVAdR23DgkQPpdX8",
        "response": 646077022000
        }]
    }],
    "orders": [
        "ordr_900jVVAdR23DgkQPpdX8"
    ],
    "comments": [
        "cmmt_op0jVVAdR23DgkQPpdX8"
    ],
    "addendums": [
        "addm_pdX8op0jVVAdR23DgkQP"
    ],
    "status_history": [
        {
        "status": "inProgress",
        "changed_by": "user_Z1zXZKvqrpwxbznuW6lJ",
        "changed_at": 1653798303
        }
    ],
    "reviews": [],
    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}

GET/v1/notes/:id

Retrieve a note

Retrieves the specified note.

Response

{
    "id": "note_2UxtAULYUrX7GVsTKePy",
    "object": "note",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
    "template": "tmlt_NOIYLBGOBNhSwTWCUzfu",
    "template_version": "tver_1JtjV1QEY84Fv395Hl7h",
    "appointment": "appt_4BxtAULYUrX7GVsTKePy",
    "name": "Annual Check-In Visit Note — 9/18/22",
    "share_with_patient": false,
    "sections": [{
      "id": "nsec_2UxtAULYUrX7GVsTKePy",
      "object": "note_section",
      "section": "tsec_YUrX7GUxt2LAUVsTKePy",
      "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
      "answers": [{
        "id": "nans_ap0jVVAdR23DgkQPpdX8",
        "object": "note_answer",
        "question": "tqst_ap0jVVAdR23DgkQPpdX8",
        "response": 646077022000
        }]
    }],
    "orders": [
        "ordr_900jVVAdR23DgkQPpdX8"
    ],
    "comments": [
        "cmmt_op0jVVAdR23DgkQPpdX8"
    ],
    "addendums": [
        "addm_pdX8op0jVVAdR23DgkQP"
    ],
    "status_history": [
        {
        "status": "inProgress",
        "changed_by": "user_Z1zXZKvqrpwxbznuW6lJ",
        "changed_at": 1653798303
        }
    ],
    "reviews": [],
    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}

POST/v1/notes/:id

Update a note

Update the specified note object by setting the values of the parameters passed. Any other parameters not provided will not be modified.

Required attributes

Name
updated_by
Type
string
Description
Updates to the note made by.

Optional attributes

Name
signed_by
Type
boolean
Description
Who the note is signed by. If the note is signed by a provider or a support team member (not a patient), the note is automatically locked and can no longer be edited.
Name
share_with_patient
Type
boolean
Description
Whether this note should be shared with the patient.

Response

{
    "id": "note_2UxtAULYUrX7GVsTKePy",
    "object": "note",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
    "template": "tmlt_NOIYLBGOBNhSwTWCUzfu",
    "template_version": "tver_1JtjV1QEY84Fv395Hl7h",
    "appointment": "appt_4BxtAULYUrX7GVsTKePy",
    "name": "Annual Check-In Visit Note — 9/18/22",
    "share_with_patient": false,
    "sections": [{
      "id": "nsec_2UxtAULYUrX7GVsTKePy",
      "object": "note_section",
      "section": "tsec_YUrX7GUxt2LAUVsTKePy",
      "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
      "answers": [{
        "id": "nans_ap0jVVAdR23DgkQPpdX8",
        "object": "note_answer",
        "question": "tqst_ap0jVVAdR23DgkQPpdX8",
        "response": 646077022000
        }]
    }],
    "orders": [
        "ordr_900jVVAdR23DgkQPpdX8"
    ],
    "comments": [
        "cmmt_op0jVVAdR23DgkQPpdX8"
    ],
    "addendums": [
        "addm_pdX8op0jVVAdR23DgkQP"
    ],
    "status_history": [
        {
        "status": "inProgress",
        "changed_by": "user_Z1zXZKvqrpwxbznuW6lJ",
        "changed_at": 1653798303
        }
    ],
    "reviews": [],
    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}

GET/v1/notes

List all notes

Returns a list of all notes.

Response

{
  "object": "list",
  "data": [
    {
        "id": "note_2UxtAULYUrX7GVsTKePy",
        "object": "note",
        "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
        "template": "tmlt_NOIYLBGOBNhSwTWCUzfu",
        "template_version": "tver_1JtjV1QEY84Fv395Hl7h",
        "appointment": "appt_4BxtAULYUrX7GVsTKePy",
        "name": "Annual Check-In Visit Note — 9/18/22",
        "share_with_patient": false,
        "sections": [{
          "id": "nsec_2UxtAULYUrX7GVsTKePy",
          "object": "note_section",
          "section": "tsec_YUrX7GUxt2LAUVsTKePy",
          "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
          "answers": [{
            "id": "nans_ap0jVVAdR23DgkQPpdX8",
            "object": "note_answer",
            "question": "tqst_ap0jVVAdR23DgkQPpdX8",
            "response": 646077022000
            }]
        }],
        "orders": [
            "ordr_900jVVAdR23DgkQPpdX8"
        ],
        "comments": [
            "cmmt_op0jVVAdR23DgkQPpdX8"
        ],
        "addendums": [
            "addm_pdX8op0jVVAdR23DgkQP"
        ],
        "status_history": [
            {
            "status": "inProgress",
            "changed_by": "user_Z1zXZKvqrpwxbznuW6lJ",
            "changed_at": 1653798303
            }
        ],
        "reviews": [],
        "created_by": "user_xeDpGyt67wTor93qKtS7",
        "created_at": 1653798303000,
        "last_updated_at": 1653798303000
    },
  ]
}