Events

Actions

Integrations

{
  "amendment_request": "Please review and update this note",
  "bullets": [
    {
      "author_id": "10",
      "category": "VISIT_NOTE_BULLET_CATEGORY_ROS",
      "children": "[{\"text\":\"happens often\",\"author_id\":\"10\"}]",
      "deleted_at": "2022-06-01T10:00:00Z",
      "edit": "140755736526872",
      "handout": "140758529736869",
      "note_document": "{\"id\":\"99483787\"}",
      "note_item": "{\"id\":\"338362508\"}",
      "replaced_by": "140758500900952",
      "replaced_by_edit": "140755736526872",
      "sequence": 0,
      "text": "Dizziness",
      "updated_at": "2022-05-20T04:06:13Z",
      "version": 1
    }
  ],
  "chart_datetime": "2024-01-15T10:30:00Z",
  "checklists": "[{\"name\":\"General\",\"value\":\"well nourished\",\"sequence\":0}]",
  "clinical_summary_link": "http://localhost/api/2.0/visit_notes/140758496444440/clinical_summary",
  "confidential": false,
  "created_at": "2010-06-10T11:05:08Z",
  "deleted_at": "2022-06-01T10:00:00Z",
  "document_datetime": "2024-01-15T10:30:00Z",
  "id": "123456789",
  "last_modified_at": "2022-05-20T11:06:12.507775Z",
  "patient_id": "64058687489",
  "physician_id": "131074",
  "practice_id": "34323",
  "signatures": [
    {
      "comments": "Reviewed and approved",
      "role": "cosigner",
      "signed_at": "2022-10-31T12:30:00Z",
      "user_id": "12",
      "user_name": "Douglas Ross, MD"
    }
  ],
  "signed_at": "2010-06-10T11:05:08Z",
  "signed_by": "131074",
  "tags": "[{\"code\":\"408289007\",\"value\":\"CQM: Ref to Wt Mgt Program\"}]",
  "template": "VISIT_NOTE_TEMPLATE_COMPLETE_HP_1_COL",
  "type": "Office Visit Note",
  "visit_summary_link": "http://localhost/api/2.0/visit_notes/140758496444440/clinical_summary"
}

{
  "amendment_request": "Amendment request details if any.",
  "bullets": {
    "author_id": "ID of the author who created this bullet point. Should be the ID of a User in Elation.",
    "category": "Category of the bullet point. Currently only supports ROS (Review of Systems).",
    "children": null,
    "deleted_at": "Date and time when the bullet point was deleted, if applicable.",
    "edit": "ID of the edit associated with this bullet point, if any.",
    "handout": "ID of the handout associated with this bullet point, if any.",
    "note_document": {
      "document": {
        "authoring_practice": "ID of the practice that authored the document.",
        "chart_datetime": "Date when the document was added to the chart.",
        "created_at": "Date when the document was created.",
        "deleted_at": "Date when the document was deleted, if applicable.",
        "document_datetime": "Date of the document.",
        "document_type": "Type of the document.",
        "id": "Unique identifier for the document.",
        "last_modified_at": "Date when the document was last modified.",
        "patient_id": "ID of the patient this document belongs to.",
        "signed_at": "Date when the document was signed.",
        "signed_by": "ID of the provider who signed the document."
      },
      "id": "Unique identifier for the document.",
      "summary": "Summary of the document."
    },
    "note_item": {
      "id": "Unique identifier for the note item.",
      "item": {
        "created_at": "Date when the item was created.",
        "deleted_at": "Date when the item was deleted, if applicable.",
        "id": "Unique identifier for the item.",
        "is_confidential": "Whether this item is confidential.",
        "item_type": "Type of the item.",
        "patient_id": "ID of the patient this item belongs to.",
        "type": "Type of the item."
      }
    },
    "replaced_by": "ID of the bullet point that replaced this one, if any.",
    "replaced_by_edit": "ID of the edit that replaced this bullet point, if any.",
    "sequence": "Sequence number of the bullet point.",
    "text": "Content of the bullet point. Must not be empty.",
    "updated_at": "Date and time when the bullet point was last updated.",
    "version": "Version number of the bullet point."
  },
  "chart_datetime": "Date and time when the note was added to the chart.",
  "checklists": {
    "category": "Category of the checklist item.",
    "name": "Name of the checklist item.",
    "sequence": "Sequence number of the checklist item.",
    "value": "Value of the checklist item."
  },
  "clinical_summary_link": "Link to the clinical summary.",
  "confidential": "Whether this note is confidential to the practice and shouldn't be shared automatically with third parties. Defaults to false.",
  "created_at": "Date and time when the note was created.",
  "deleted_at": "Date and time when the note was deleted, if applicable.",
  "document_datetime": "Date and time when the document was created.",
  "id": "Unique identifier for the visit note.",
  "last_modified_at": "Date and time when the note was last modified.",
  "patient_id": "ID of the patient this visit note belongs to.",
  "physician_id": "ID of the prescribing physician.",
  "practice_id": "ID of the practice this visit note belongs to.",
  "signatures": {
    "comments": "Comments associated with the signature.",
    "role": "Role of the user who signed.",
    "signed_at": "Date when the note was signed.",
    "user_id": "ID of the user who signed.",
    "user_name": "Name of the user who signed."
  },
  "signed_at": "Date and time when the note was signed.",
  "signed_by": "ID of the provider who signed the note.",
  "tags": {
    "code": "Code identifier for the tag.",
    "code_type": "Type identifier for the tag code.",
    "concept_name": "Concept name associated with the tag.",
    "created_at": "Date and time when the tag was created.",
    "deleted_at": "Date and time when the tag was deleted, if applicable.",
    "description": "Description of the tag's purpose or meaning.",
    "id": "Unique identifier for the tag.",
    "value": "Value or display text of the tag."
  },
  "template": "Template type for the visit note. Currently only supports Complete H&P (1 col).",
  "type": "Type of visit note. Defaults to Office Visit Note.",
  "visit_summary_link": "Link to the visit summary."
}

Events

Triggering Webhook Types

The following event types are associated with the Visit Note event payload from Elation.

Elation Visit Note Updated
Elation Visit Note Deleted

{
  "amendment_request": "Please review and update this note",
  "bullets": [
    {
      "author_id": "10",
      "category": "VISIT_NOTE_BULLET_CATEGORY_ROS",
      "children": "[{\"text\":\"happens often\",\"author_id\":\"10\"}]",
      "deleted_at": "2022-06-01T10:00:00Z",
      "edit": "140755736526872",
      "handout": "140758529736869",
      "note_document": "{\"id\":\"99483787\"}",
      "note_item": "{\"id\":\"338362508\"}",
      "replaced_by": "140758500900952",
      "replaced_by_edit": "140755736526872",
      "sequence": 0,
      "text": "Dizziness",
      "updated_at": "2022-05-20T04:06:13Z",
      "version": 1
    }
  ],
  "chart_datetime": "2024-01-15T10:30:00Z",
  "checklists": "[{\"name\":\"General\",\"value\":\"well nourished\",\"sequence\":0}]",
  "clinical_summary_link": "http://localhost/api/2.0/visit_notes/140758496444440/clinical_summary",
  "confidential": false,
  "created_at": "2010-06-10T11:05:08Z",
  "deleted_at": "2022-06-01T10:00:00Z",
  "document_datetime": "2024-01-15T10:30:00Z",
  "id": "123456789",
  "last_modified_at": "2022-05-20T11:06:12.507775Z",
  "patient_id": "64058687489",
  "physician_id": "131074",
  "practice_id": "34323",
  "signatures": [
    {
      "comments": "Reviewed and approved",
      "role": "cosigner",
      "signed_at": "2022-10-31T12:30:00Z",
      "user_id": "12",
      "user_name": "Douglas Ross, MD"
    }
  ],
  "signed_at": "2010-06-10T11:05:08Z",
  "signed_by": "131074",
  "tags": "[{\"code\":\"408289007\",\"value\":\"CQM: Ref to Wt Mgt Program\"}]",
  "template": "VISIT_NOTE_TEMPLATE_COMPLETE_HP_1_COL",
  "type": "Office Visit Note",
  "visit_summary_link": "http://localhost/api/2.0/visit_notes/140758496444440/clinical_summary"
}

{
  "amendment_request": "Amendment request details if any.",
  "bullets": {
    "author_id": "ID of the author who created this bullet point. Should be the ID of a User in Elation.",
    "category": "Category of the bullet point. Currently only supports ROS (Review of Systems).",
    "children": null,
    "deleted_at": "Date and time when the bullet point was deleted, if applicable.",
    "edit": "ID of the edit associated with this bullet point, if any.",
    "handout": "ID of the handout associated with this bullet point, if any.",
    "note_document": {
      "document": {
        "authoring_practice": "ID of the practice that authored the document.",
        "chart_datetime": "Date when the document was added to the chart.",
        "created_at": "Date when the document was created.",
        "deleted_at": "Date when the document was deleted, if applicable.",
        "document_datetime": "Date of the document.",
        "document_type": "Type of the document.",
        "id": "Unique identifier for the document.",
        "last_modified_at": "Date when the document was last modified.",
        "patient_id": "ID of the patient this document belongs to.",
        "signed_at": "Date when the document was signed.",
        "signed_by": "ID of the provider who signed the document."
      },
      "id": "Unique identifier for the document.",
      "summary": "Summary of the document."
    },
    "note_item": {
      "id": "Unique identifier for the note item.",
      "item": {
        "created_at": "Date when the item was created.",
        "deleted_at": "Date when the item was deleted, if applicable.",
        "id": "Unique identifier for the item.",
        "is_confidential": "Whether this item is confidential.",
        "item_type": "Type of the item.",
        "patient_id": "ID of the patient this item belongs to.",
        "type": "Type of the item."
      }
    },
    "replaced_by": "ID of the bullet point that replaced this one, if any.",
    "replaced_by_edit": "ID of the edit that replaced this bullet point, if any.",
    "sequence": "Sequence number of the bullet point.",
    "text": "Content of the bullet point. Must not be empty.",
    "updated_at": "Date and time when the bullet point was last updated.",
    "version": "Version number of the bullet point."
  },
  "chart_datetime": "Date and time when the note was added to the chart.",
  "checklists": {
    "category": "Category of the checklist item.",
    "name": "Name of the checklist item.",
    "sequence": "Sequence number of the checklist item.",
    "value": "Value of the checklist item."
  },
  "clinical_summary_link": "Link to the clinical summary.",
  "confidential": "Whether this note is confidential to the practice and shouldn't be shared automatically with third parties. Defaults to false.",
  "created_at": "Date and time when the note was created.",
  "deleted_at": "Date and time when the note was deleted, if applicable.",
  "document_datetime": "Date and time when the document was created.",
  "id": "Unique identifier for the visit note.",
  "last_modified_at": "Date and time when the note was last modified.",
  "patient_id": "ID of the patient this visit note belongs to.",
  "physician_id": "ID of the prescribing physician.",
  "practice_id": "ID of the practice this visit note belongs to.",
  "signatures": {
    "comments": "Comments associated with the signature.",
    "role": "Role of the user who signed.",
    "signed_at": "Date when the note was signed.",
    "user_id": "ID of the user who signed.",
    "user_name": "Name of the user who signed."
  },
  "signed_at": "Date and time when the note was signed.",
  "signed_by": "ID of the provider who signed the note.",
  "tags": {
    "code": "Code identifier for the tag.",
    "code_type": "Type identifier for the tag code.",
    "concept_name": "Concept name associated with the tag.",
    "created_at": "Date and time when the tag was created.",
    "deleted_at": "Date and time when the tag was deleted, if applicable.",
    "description": "Description of the tag's purpose or meaning.",
    "id": "Unique identifier for the tag.",
    "value": "Value or display text of the tag."
  },
  "template": "Template type for the visit note. Currently only supports Complete H&P (1 col).",
  "type": "Type of visit note. Defaults to Office Visit Note.",
  "visit_summary_link": "Link to the visit summary."
}

Payload Field Details

Visit Note

Event Payload

string

required

Unique identifier for the visit note.

CEL
id

Example
"123456789"

patient_id

string

required

ID ID of the patient this visit note belongs to.

CEL
patient_id

Example
"64058687489"

chart_datetime

timing.v1.Timestamp

required

Date and time when the note was added to the chart.

CEL
chart_datetime

Example
"2024-01-15T10:30:00Z"

document_datetime

timing.v1.Timestamp

required

Date and time when the document was created.

CEL
document_datetime

Example
"2024-01-15T10:30:00Z"

template

elation.v1.VisitNoteTemplate

required

Template type for the visit note. Currently only supports Complete H&P (1 col).

CEL
template

Example
VISIT_NOTE_TEMPLATE_SIMPLE
VISIT_NOTE_TEMPLATE_SOAP
VISIT_NOTE_TEMPLATE_COMPLETE_HP_1_COL
VISIT_NOTE_TEMPLATE_COMPLETE_HP_2_COL
VISIT_NOTE_TEMPLATE_COMPLETE_HP_2_COL_A_P
VISIT_NOTE_TEMPLATE_PRE_OP

physician_id

string

required

ID of the prescribing physician.

CEL
physician_id

Example
"131074"

bullets

object

required

List of bullet points in the visit note.

CEL
bullets

Example
[
{
"author_id": "10",
"category": "VISIT_NOTE_BULLET_CATEGORY_ROS",
"children": "[{\"text\":\"happens often\",\"author_id\":\"10\"}]",
"deleted_at": "2022-06-01T10:00:00Z",
"edit": "140755736526872",
"handout": "140758529736869",
"note_document": "{\"id\":\"99483787\"}",
"note_item": "{\"id\":\"338362508\"}",
"replaced_by": "140758500900952",
"replaced_by_edit": "140755736526872",
"sequence": 0,
"text": "Dizziness",
"updated_at": "2022-05-20T04:06:13Z",
"version": 1
}
]

bullets.map(x, x.text)

[]string

required

Mapped array of: Content of the bullet point. Must not be empty.

CEL
bullets.map(x, x.text)

Example
[
"Dizziness"
]

bullets.map(x, x.author_id)

[]string

required

Mapped array of: ID of the author who created this bullet point. Should be the ID of a User in Elation.

CEL
bullets.map(x, x.author_id)

Example
[
"10"
]

category

elation.v1.VisitNoteBulletCategory

required

Mapped array of: Category of the bullet point. Currently only supports ROS (Review of Systems).

CEL
category

Example
VISIT_NOTE_BULLET_CATEGORY_PROBLEM
VISIT_NOTE_BULLET_CATEGORY_PAST
VISIT_NOTE_BULLET_CATEGORY_FAMILY
VISIT_NOTE_BULLET_CATEGORY_SOCIAL
VISIT_NOTE_BULLET_CATEGORY_INSTR
VISIT_NOTE_BULLET_CATEGORY_PE
VISIT_NOTE_BULLET_CATEGORY_ROS
VISIT_NOTE_BULLET_CATEGORY_MED
VISIT_NOTE_BULLET_CATEGORY_DATA
VISIT_NOTE_BULLET_CATEGORY_ASSESSMENT
VISIT_NOTE_BULLET_CATEGORY_TEST
VISIT_NOTE_BULLET_CATEGORY_TX
VISIT_NOTE_BULLET_CATEGORY_NARRATIVE
VISIT_NOTE_BULLET_CATEGORY_FOLLOWUP
VISIT_NOTE_BULLET_CATEGORY_REASON
VISIT_NOTE_BULLET_CATEGORY_PLAN
VISIT_NOTE_BULLET_CATEGORY_OBJECTIVE
VISIT_NOTE_BULLET_CATEGORY_HPI
VISIT_NOTE_BULLET_CATEGORY_ALLERGIES
VISIT_NOTE_BULLET_CATEGORY_HABITS
VISIT_NOTE_BULLET_CATEGORY_ASSESSPLAN
VISIT_NOTE_BULLET_CATEGORY_CONSULTANT
VISIT_NOTE_BULLET_CATEGORY_ATTENDING
VISIT_NOTE_BULLET_CATEGORY_DATEPROCEDURE
VISIT_NOTE_BULLET_CATEGORY_SURGICAL
VISIT_NOTE_BULLET_CATEGORY_ORDERS
VISIT_NOTE_BULLET_CATEGORY_REFERENCED
VISIT_NOTE_BULLET_CATEGORY_PROCEDURE

bullets.map(x, x.version)

[]int64

required

Mapped array of: Version number of the bullet point.

CEL
bullets.map(x, x.version)

Example
[
1
]

bullets.map(x, x.sequence)

[]int64

required

Mapped array of: Sequence number of the bullet point.

CEL
bullets.map(x, x.sequence)

Example
[
0
]

bullets.map(x, x.updated_at)

[]timing.v1.Timestamp

required

Mapped array of: Date and time when the bullet point was last updated.

CEL
bullets.map(x, x.updated_at)

Example
[
"2022-05-20T04:06:13Z"
]

bullets.map(x, x.replaced_by_edit)

[]string

required

Mapped array of: ID of the edit that replaced this bullet point, if any.

CEL
bullets.map(x, x.replaced_by_edit)

Example
[
"140755736526872"
]

bullets.map(x, x.replaced_by)

[]string

required

Mapped array of: ID of the bullet point that replaced this one, if any.

CEL
bullets.map(x, x.replaced_by)

Example
[
"140758500900952"
]

bullets.map(x, x.edit)

[]string

required

Mapped array of: ID of the edit associated with this bullet point, if any.

CEL
bullets.map(x, x.edit)

Example
[
"140755736526872"
]

bullets.map(x, x.deleted_at)

[]timing.v1.Timestamp

required

Mapped array of: Date and time when the bullet point was deleted, if applicable.

CEL
bullets.map(x, x.deleted_at)

Example
[
"2022-06-01T10:00:00Z"
]

bullets.map(x, x.note_document)

[]bool

required