Events
Triggering Webhook Types
The following event types are associated with the Visit Note event payload from Elation.Elation Visit Note UpdatedElation Visit Note Deleted
Copy
Ask AI
{
"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",
"visit_note_type": "Office Visit Note",
"visit_summary_link": "http://localhost/api/2.0/visit_notes/140758496444440/clinical_summary"
}
Copy
Ask AI
{
"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."
}
},
"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).",
"visit_note_type": "Type of visit note. Defaults to Office Visit Note.",
"visit_summary_link": "Link to the visit summary."
}
Payload Field Details
Hide fields
Hide fields
Unique identifier for the visit note.
CEL
Copy
Ask AI
id
Example
Copy
Ask AI
"123456789"
ID ID of the patient this visit note belongs to.CEL
Copy
Ask AI
patient_id
Example
Copy
Ask AI
"64058687489"
Date and time when the note was added to the chart.
CEL
Copy
Ask AI
chart_datetime
Example
Copy
Ask AI
"2024-01-15T10:30:00Z"
Date and time when the document was created.
CEL
Copy
Ask AI
document_datetime
Example
Copy
Ask AI
"2024-01-15T10:30:00Z"
Template type for the visit note. Currently only supports Complete H&P (1 col).
CEL
Copy
Ask AI
template
Example
Copy
Ask AI
elation.v1.VisitNoteTemplate.VISIT_NOTE_TEMPLATE_SIMPLE
elation.v1.VisitNoteTemplate.VISIT_NOTE_TEMPLATE_SOAP
elation.v1.VisitNoteTemplate.VISIT_NOTE_TEMPLATE_COMPLETE_HP_1_COL
elation.v1.VisitNoteTemplate.VISIT_NOTE_TEMPLATE_COMPLETE_HP_2_COL
elation.v1.VisitNoteTemplate.VISIT_NOTE_TEMPLATE_COMPLETE_HP_2_COL_A_P
elation.v1.VisitNoteTemplate.VISIT_NOTE_TEMPLATE_PRE_OP
ID of the prescribing physician.
CEL
Copy
Ask AI
physician_id
Example
Copy
Ask AI
"131074"
List of bullet points in the visit note.
CEL
Copy
Ask AI
bullets
Example
Copy
Ask AI
[
{
"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
}
]
Mapped array of: Content of the bullet point. Must not be empty.
CEL
Copy
Ask AI
bullets.map(x, x.text)
Example
Copy
Ask AI
[
"Dizziness"
]
Mapped array of: ID of the author who created this bullet point. Should be the ID of a User in Elation.
CEL
Copy
Ask AI
bullets.map(x, x.author_id)
Example
Copy
Ask AI
[
"10"
]
Mapped array of: Category of the bullet point. Currently only supports ROS (Review of Systems).
CEL
Copy
Ask AI
category
Example
Copy
Ask AI
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_PROBLEM
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_PAST
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_FAMILY
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_SOCIAL
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_INSTR
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_PE
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_ROS
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_MED
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_DATA
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_ASSESSMENT
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_TEST
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_TX
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_NARRATIVE
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_FOLLOWUP
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_REASON
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_PLAN
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_OBJECTIVE
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_HPI
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_ALLERGIES
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_HABITS
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_ASSESSPLAN
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_CONSULTANT
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_ATTENDING
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_DATEPROCEDURE
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_SURGICAL
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_ORDERS
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_REFERENCED
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_PROCEDURE
Mapped array of: Version number of the bullet point.
CEL
Copy
Ask AI
bullets.map(x, x.version)
Example
Copy
Ask AI
[
1
]
Mapped array of: Sequence number of the bullet point.
CEL
Copy
Ask AI
bullets.map(x, x.sequence)
Example
Copy
Ask AI
[
0
]
Mapped array of: Date and time when the bullet point was last updated.
CEL
Copy
Ask AI
bullets.map(x, x.updated_at)
Example
Copy
Ask AI
[
"2022-05-20T04:06:13Z"
]
Mapped array of: ID of the edit that replaced this bullet point, if any.
CEL
Copy
Ask AI
bullets.map(x, x.replaced_by_edit)
Example
Copy
Ask AI
[
"140755736526872"
]
Mapped array of: ID of the bullet point that replaced this one, if any.
CEL
Copy
Ask AI
bullets.map(x, x.replaced_by)
Example
Copy
Ask AI
[
"140758500900952"
]
Mapped array of: ID of the edit associated with this bullet point, if any.
CEL
Copy
Ask AI
bullets.map(x, x.edit)
Example
Copy
Ask AI
[
"140755736526872"
]
Mapped array of: Date and time when the bullet point was deleted, if applicable.
CEL
Copy
Ask AI
bullets.map(x, x.deleted_at)
Example
Copy
Ask AI
[
"2022-06-01T10:00:00Z"
]
Mapped array of: Document reference associated with this bullet point, if any.
CEL
Copy
Ask AI
bullets.map(x, x.note_document)
Example
Copy
Ask AI
[
"{\"id\":\"99483787\"}"
]
Mapped array of: Note item reference associated with this bullet point, if any.
CEL
Copy
Ask AI
bullets.map(x, x.note_item)
Example
Copy
Ask AI
[
"{\"id\":\"338362508\"}"
]
Mapped array of: ID of the handout associated with this bullet point, if any.
CEL
Copy
Ask AI
bullets.map(x, x.handout)
Example
Copy
Ask AI
[
"140758529736869"
]
Mapped array of: List of child bullet points.
CEL
Copy
Ask AI
bullets.map(x, x.children)
Example
Copy
Ask AI
[
"[{\"text\":\"happens often\",\"author_id\":\"10\"}]"
]
Type of visit note. Defaults to Office Visit Note.
CEL
Copy
Ask AI
visit_note_type
Example
Copy
Ask AI
"Office Visit Note"
Whether this note is confidential to the practice and shouldn’t be shared automatically with third parties. Defaults to false.
CEL
Copy
Ask AI
confidential
Example
Copy
Ask AI
false
List of checklist items in the visit note.
CEL
Copy
Ask AI
checklists
Example
Copy
Ask AI
"[{\"name\":\"General\",\"value\":\"well nourished\",\"sequence\":0}]"
Mapped array of: Name of the checklist item.
CEL
Copy
Ask AI
checklists.map(x, x.name)
Example
Copy
Ask AI
[
"General"
]
Mapped array of: Value of the checklist item.
CEL
Copy
Ask AI
checklists.map(x, x.value)
Example
Copy
Ask AI
[
"well nourished"
]
Mapped array of: Sequence number of the checklist item.
CEL
Copy
Ask AI
checklists.map(x, x.sequence)
Example
Copy
Ask AI
[
0
]
Mapped array of: Category of the checklist item.
CEL
Copy
Ask AI
category
Example
Copy
Ask AI
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_PROBLEM
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_PAST
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_FAMILY
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_SOCIAL
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_INSTR
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_PE
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_ROS
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_MED
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_DATA
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_ASSESSMENT
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_TEST
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_TX
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_NARRATIVE
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_FOLLOWUP
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_REASON
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_PLAN
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_OBJECTIVE
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_HPI
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_ALLERGIES
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_HABITS
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_ASSESSPLAN
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_CONSULTANT
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_ATTENDING
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_DATEPROCEDURE
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_SURGICAL
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_ORDERS
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_REFERENCED
elation.v1.VisitNoteBulletCategory.VISIT_NOTE_BULLET_CATEGORY_PROCEDURE
List of signatures on the visit note.
CEL
Copy
Ask AI
signatures
Example
Copy
Ask AI
[
{
"comments": "Reviewed and approved",
"role": "cosigner",
"signed_at": "2022-10-31T12:30:00Z",
"user_id": "12",
"user_name": "Douglas Ross, MD"
}
]
Mapped array of: ID of the user who signed.
CEL
Copy
Ask AI
signatures.map(x, x.user_id)
Example
Copy
Ask AI
[
"12"
]
Mapped array of: Name of the user who signed.
CEL
Copy
Ask AI
signatures.map(x, x.user_name)
Example
Copy
Ask AI
[
"Douglas Ross, MD"
]
Mapped array of: Date when the note was signed.
CEL
Copy
Ask AI
signatures.map(x, x.signed_at)
Example
Copy
Ask AI
[
"2022-10-31T12:30:00Z"
]
Mapped array of: Role of the user who signed.
CEL
Copy
Ask AI
signatures.map(x, x.role)
Example
Copy
Ask AI
[
"cosigner"
]
Mapped array of: Comments associated with the signature.
CEL
Copy
Ask AI
signatures.map(x, x.comments)
Example
Copy
Ask AI
[
"Reviewed and approved"
]
Amendment request details if any.
CEL
Copy
Ask AI
amendment_request
Example
Copy
Ask AI
"Please review and update this note"
ID of the practice this visit note belongs to.
CEL
Copy
Ask AI
practice_id
Example
Copy
Ask AI
"34323"
Link to the clinical summary.
CEL
Copy
Ask AI
clinical_summary_link
Example
Copy
Ask AI
"http://localhost/api/2.0/visit_notes/140758496444440/clinical_summary"
Link to the visit summary.
CEL
Copy
Ask AI
visit_summary_link
Example
Copy
Ask AI
"http://localhost/api/2.0/visit_notes/140758496444440/clinical_summary"
Date and time when the note was signed.
CEL
Copy
Ask AI
signed_at
Example
Copy
Ask AI
"2010-06-10T11:05:08Z"
ID of the provider who signed the note.
CEL
Copy
Ask AI
signed_by
Example
Copy
Ask AI
"131074"
Date and time when the note was created.
CEL
Copy
Ask AI
created_at
Example
Copy
Ask AI
"2010-06-10T11:05:08Z"
Date and time when the note was last modified.
CEL
Copy
Ask AI
last_modified_at
Example
Copy
Ask AI
"2022-05-20T11:06:12.507775Z"
Date and time when the note was deleted, if applicable.
CEL
Copy
Ask AI
deleted_at
Example
Copy
Ask AI
"2022-06-01T10:00:00Z"
List of tags associated with the note.
CEL
Copy
Ask AI
tags
Example
Copy
Ask AI
"[{\"code\":\"408289007\",\"value\":\"CQM: Ref to Wt Mgt Program\"}]"
Mapped array of: Unique identifier for the tag.
CEL
Copy
Ask AI
tags.map(x, x.id)
Example
Copy
Ask AI
[
"123456"
]
Mapped array of: Code identifier for the tag.
CEL
Copy
Ask AI
tags.map(x, x.code)
Example
Copy
Ask AI
[
"TAG_001"
]
Mapped array of: Value or display text of the tag.
CEL
Copy
Ask AI
tags.map(x, x.value)
Example
Copy
Ask AI
[
"Follow-up"
]
Mapped array of: Type identifier for the tag code.
CEL
Copy
Ask AI
tags.map(x, x.code_type)
Example
Copy
Ask AI
[
1
]
Mapped array of: Concept name associated with the tag.
CEL
Copy
Ask AI
tags.map(x, x.concept_name)
Example
Copy
Ask AI
[
"Follow-up Visit"
]
Mapped array of: Date and time when the tag was created.
CEL
Copy
Ask AI
tags.map(x, x.created_at)
Example
Copy
Ask AI
[
"2024-01-15T10:30:00Z"
]
Mapped array of: Date and time when the tag was deleted, if applicable.
CEL
Copy
Ask AI
tags.map(x, x.deleted_at)
Example
Copy
Ask AI
[
"2024-01-16T10:30:00Z"
]
Mapped array of: Description of the tag’s purpose or meaning.
CEL
Copy
Ask AI
tags.map(x, x.description)
Example
Copy
Ask AI
[
"Tag for follow-up visits"
]
