Skip to main content
POST
/
api
/
2.0
/
visit_notes
Create Visit Note
curl --request POST \
  --url https://sandbox.elationemr.com/api/2.0/visit_notes/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bullets": [
    {
      "text": "<string>",
      "author": 123,
      "edit": 123,
      "note_document": {
        "document": {
          "authoring_practice": 123,
          "chart_date": "2023-11-07T05:31:56Z",
          "document_date": "2023-11-07T05:31:56Z",
          "id": 123,
          "patient": 123,
          "last_modified": "2023-11-07T05:31:56Z"
        },
        "summary": "<string>"
      },
      "replaced_by": 123,
      "replaced_by_edit": 123,
      "sequence": 1,
      "updated_date": "2023-11-07T05:31:56Z",
      "version": 32767
    }
  ],
  "chart_date": "2023-11-07T05:31:56Z",
  "document_date": "2023-11-07T05:31:56Z",
  "patient": 123,
  "physician": 123,
  "checklists": {},
  "confidential": false,
  "edits": [
    {
      "visit_note": 123,
      "create_user": 123,
      "new_bmi": 123,
      "new_note_time": "2023-11-07T05:31:56Z",
      "new_note_type": "<string>",
      "new_prev_bmi": 123,
      "new_prev_time": "2023-11-07T05:31:56Z",
      "new_prev_weight": "<string>",
      "previous_bmi": 123,
      "previous_note_time": "2023-11-07T05:31:56Z",
      "previous_note_type": "<string>",
      "previous_prev_bmi": 123,
      "previous_prev_time": "2023-11-07T05:31:56Z",
      "previous_prev_weight": "<string>"
    }
  ],
  "last_modified": "2023-11-07T05:31:56Z",
  "signatures": [
    {
      "comments": "<string>",
      "role": "<string>",
      "signed_date": "2023-11-07T05:31:56Z",
      "user": "<string>",
      "user_name": "<string>"
    }
  ],
  "signed_by": 123,
  "signed_date": "2023-11-07T05:31:56Z",
  "type": "Office Visit Note"
}
'
{
  "bullets": [
    {
      "text": "<string>",
      "author": 123,
      "deleted_date": "2023-11-07T05:31:56Z",
      "edit": 123,
      "note_document": {
        "document": {
          "authoring_practice": 123,
          "chart_date": "2023-11-07T05:31:56Z",
          "document_date": "2023-11-07T05:31:56Z",
          "id": 123,
          "patient": 123,
          "created_date": "2023-11-07T05:31:56Z",
          "deleted_date": "2023-11-07T05:31:56Z",
          "document_type": 123,
          "last_modified": "2023-11-07T05:31:56Z",
          "sign_date": "2023-11-07T05:31:56Z",
          "signed_by": 123
        },
        "id": 123,
        "summary": "<string>"
      },
      "replaced_by": 123,
      "replaced_by_edit": 123,
      "sequence": 1,
      "updated_date": "2023-11-07T05:31:56Z",
      "version": 32767
    }
  ],
  "chart_date": "2023-11-07T05:31:56Z",
  "document_date": "2023-11-07T05:31:56Z",
  "patient": 123,
  "physician": 123,
  "amendment_request": {
    "request_description": "<string>",
    "request_date": "2023-11-07T05:31:56Z",
    "status_updated_date": "2023-11-07T05:31:56Z"
  },
  "checklists": {},
  "clinical_summary_link": "<string>",
  "confidential": false,
  "created_date": "2023-11-07T05:31:56Z",
  "deleted_date": "2023-11-07T05:31:56Z",
  "edits": [
    {
      "visit_note": 123,
      "create_user": 123,
      "created_date": "2023-11-07T05:31:56Z",
      "new_bmi": 123,
      "new_note_time": "2023-11-07T05:31:56Z",
      "new_note_type": "<string>",
      "new_prev_bmi": 123,
      "new_prev_time": "2023-11-07T05:31:56Z",
      "new_prev_weight": "<string>",
      "previous_bmi": 123,
      "previous_note_time": "2023-11-07T05:31:56Z",
      "previous_note_type": "<string>",
      "previous_prev_bmi": 123,
      "previous_prev_time": "2023-11-07T05:31:56Z",
      "previous_prev_weight": "<string>"
    }
  ],
  "id": 123,
  "last_modified": "2023-11-07T05:31:56Z",
  "practice": 123,
  "signatures": [
    {
      "comments": "<string>",
      "role": "<string>",
      "signed_date": "2023-11-07T05:31:56Z",
      "user": "<string>",
      "user_name": "<string>"
    }
  ],
  "signed_by": 123,
  "signed_date": "2023-11-07T05:31:56Z",
  "type": "Office Visit Note",
  "visit_summary_link": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://help.elationhealth.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
bullets
object[]
required

The bullets of the visit note.

​
chart_date
string<date-time>
required

Visit note chart date.

​
document_date
string<date-time>
required

Visit note document date.

​
patient
integer<int64>
required
​
physician
integer<int64>
required
​
template
enum<string>
required
Available options:
Complete H&P (1 col),
Complete H&P (2 col A/P),
Complete H&P (2 col),
Pre-Op,
SOAP,
Simple
​
checklists
object

Dictionary of checklists by type (e.g. 'pe', 'ros'), where each checklist contains a list of fields with name, value and sequence

​
confidential
boolean
default:false

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

​
edits
object[]
​
last_modified
string<date-time>
​
signatures
object[]

The list of signatures if co-signing is enabled for the practice. (Requires Special Permission).

​
signed_by
integer<int64> | null

The user id of the provider who signed the visit note. (Requires special permission).

​
signed_date
string<date-time> | null

The time at which the visit note was signed. Cannot be in the future. (Requires Special Permission).

​
type
string
default:Office Visit Note

Visit note type.

Response

201 - application/json
​
bullets
object[]
required

The bullets of the visit note.

​
chart_date
string<date-time>
required

Visit note chart date.

​
document_date
string<date-time>
required

Visit note document date.

​
patient
integer<int64>
required
​
physician
integer<int64>
required
​
template
enum<string>
required
Available options:
Complete H&P (1 col),
Complete H&P (2 col A/P),
Complete H&P (2 col),
Pre-Op,
SOAP,
Simple
​
amendment_request
object
​
checklists
object

Dictionary of checklists by type (e.g. 'pe', 'ros'), where each checklist contains a list of fields with name, value and sequence

​
clinical_summary_link
string<uri>
read-only
​
confidential
boolean
default:false

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

​
created_date
string<date-time> | null
read-only
​
deleted_date
string<date-time> | null
read-only
​
edits
object[]
​
id
integer
read-only
​
last_modified
string<date-time>
​
practice
integer<int64>
read-only
​
signatures
object[]

The list of signatures if co-signing is enabled for the practice. (Requires Special Permission).

​
signed_by
integer<int64> | null

The user id of the provider who signed the visit note. (Requires special permission).

​
signed_date
string<date-time> | null

The time at which the visit note was signed. Cannot be in the future. (Requires Special Permission).

​
type
string
default:Office Visit Note

Visit note type.

​
visit_summary_link
string<uri>
read-only