{
  "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"
}

{
  "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."
}

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",
  "visit_note_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."
      }
    },
    "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

Event Payload

Hide fields

string

required

Unique identifier for the visit note.

CEL

id

Example

"123456789"

string

required

ID ID of the patient this visit note belongs to.

CEL

patient_id

Example

"64058687489"

timing.v1.Timestamp

required

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

CEL

chart_datetime

Example

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

timing.v1.Timestamp

required

Date and time when the document was created.

CEL

document_datetime

Example

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

elation.v1.VisitNoteTemplate

required

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

CEL

template

Example

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

string

required

ID of the prescribing physician.

CEL

physician_id

Example

"131074"

[]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
}
]

[]string

required

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

CEL

bullets.map(x, x.text)

Example

[
"Dizziness"
]

[]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"
]

elation.v1.VisitNoteBulletCategory

required

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

CEL

category

Example

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

[]int64

required

Mapped array of: Version number of the bullet point.

CEL

bullets.map(x, x.version)

Example

[
1
]

[]int64

required

Mapped array of: Sequence number of the bullet point.

CEL

bullets.map(x, x.sequence)

Example

[
0
]

[]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"
]

[]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"
]

[]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"
]

[]string

required

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

CEL

bullets.map(x, x.edit)

Example

[
"140755736526872"
]

[]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"
]

[]bool

required

Mapped array of: Document reference associated with this bullet point, if any.

CEL

bullets.map(x, x.note_document)

Example

[
"{\"id\":\"99483787\"}"
]

[]bool

required

Mapped array of: Note item reference associated with this bullet point, if any.

CEL

bullets.map(x, x.note_item)

Example

[
"{\"id\":\"338362508\"}"
]

[]string

required

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

CEL

bullets.map(x, x.handout)

Example

[
"140758529736869"
]

[]bool

required

Mapped array of: List of child bullet points.

CEL

bullets.map(x, x.children)

Example

[
"[{\"text\":\"happens often\",\"author_id\":\"10\"}]"
]

string

Type of visit note. Defaults to Office Visit Note.

CEL

visit_note_type

Example

"Office Visit Note"

bool

required

Whether this note is confidential to the practice and shouldn’t be shared automatically with third parties. Defaults to false.

CEL

confidential

Example

false

[]object

required

List of checklist items in the visit note.

CEL

checklists

Example

"[{\"name\":\"General\",\"value\":\"well nourished\",\"sequence\":0}]"

[]string

required

Mapped array of: Name of the checklist item.

CEL

checklists.map(x, x.name)

Example

[
"General"
]

[]string

required

Mapped array of: Value of the checklist item.

CEL

checklists.map(x, x.value)

Example

[
"well nourished"
]

[]int64

required

Mapped array of: Sequence number of the checklist item.

CEL

checklists.map(x, x.sequence)

Example

[
0
]

elation.v1.VisitNoteBulletCategory

required

Mapped array of: Category of the checklist item.

CEL

category

Example

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

[]object

required

List of signatures on the visit note.

CEL

signatures

Example

[
{
"comments": "Reviewed and approved",
"role": "cosigner",
"signed_at": "2022-10-31T12:30:00Z",
"user_id": "12",
"user_name": "Douglas Ross, MD"
}
]

[]string

required

Mapped array of: ID of the user who signed.

CEL

signatures.map(x, x.user_id)

Example

[
"12"
]

[]string

required

Mapped array of: Name of the user who signed.

CEL

signatures.map(x, x.user_name)

Example

[
"Douglas Ross, MD"
]

[]timing.v1.Timestamp

required

Mapped array of: Date when the note was signed.

CEL

signatures.map(x, x.signed_at)

Example

[
"2022-10-31T12:30:00Z"
]

[]string

required

Mapped array of: Role of the user who signed.

CEL

signatures.map(x, x.role)

Example

[
"cosigner"
]

[]string

required

Mapped array of: Comments associated with the signature.

CEL

signatures.map(x, x.comments)

Example

[
"Reviewed and approved"
]

string

Amendment request details if any.

CEL

amendment_request

Example

"Please review and update this note"

string

required

ID of the practice this visit note belongs to.

CEL

practice_id

Example

"34323"

string

required

Link to the clinical summary.

CEL

clinical_summary_link

Example

"http://localhost/api/2.0/visit_notes/140758496444440/clinical_summary"

string

required

Link to the visit summary.

CEL

visit_summary_link

Example

"http://localhost/api/2.0/visit_notes/140758496444440/clinical_summary"

timing.v1.Timestamp

Date and time when the note was signed.

CEL

signed_at

Example

"2010-06-10T11:05:08Z"

string

ID of the provider who signed the note.

CEL

signed_by

Example

"131074"

timing.v1.Timestamp

required

Date and time when the note was created.

CEL

created_at

Example

"2010-06-10T11:05:08Z"

timing.v1.Timestamp

required

Date and time when the note was last modified.

CEL

last_modified_at

Example

"2022-05-20T11:06:12.507775Z"

timing.v1.Timestamp

Date and time when the note was deleted, if applicable.

CEL

deleted_at

Example

"2022-06-01T10:00:00Z"

[]object

required

List of tags associated with the note.

CEL

tags

Example

"[{\"code\":\"408289007\",\"value\":\"CQM: Ref to Wt Mgt Program\"}]"

[]string

required

Mapped array of: Unique identifier for the tag.

CEL

tags.map(x, x.id)

Example

[
"123456"
]

[]string

required

Mapped array of: Code identifier for the tag.

CEL

tags.map(x, x.code)

Example

[
"TAG_001"
]

[]string

required

Mapped array of: Value or display text of the tag.

CEL

tags.map(x, x.value)

Example

[
"Follow-up"
]

[]int64

required

Mapped array of: Type identifier for the tag code.

CEL

tags.map(x, x.code_type)

Example

[
1
]

[]string

required

Mapped array of: Concept name associated with the tag.

CEL

tags.map(x, x.concept_name)

Example

[
"Follow-up Visit"
]

[]timing.v1.Timestamp

required

Mapped array of: Date and time when the tag was created.

CEL

tags.map(x, x.created_at)

Example

[
"2024-01-15T10:30:00Z"
]

[]timing.v1.Timestamp

required

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

CEL

tags.map(x, x.deleted_at)

Example

[
"2024-01-16T10:30:00Z"
]

[]string

required

Mapped array of: Description of the tag’s purpose or meaning.

CEL

tags.map(x, x.description)

Example

[
"Tag for follow-up visits"
]

⌘I

​Events

​Triggering Webhook Types

​Payload Field Details

Events

Triggering Webhook Types

Payload Field Details