Skip to main content
PATCH
/
notes
/
{note_id}
Update Note By Id
curl --request PATCH \
  --url https://sandbox.elationemr.com/api/2.0/notes/{note_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bill": 123,
  "category": 123,
  "close_snapshot": true,
  "confidential": false,
  "content": {
    "attrs": {
      "ai_generation_info": {
        "is_finalized": true,
        "transcript_source_text": ""
      },
      "is_new": true,
      "ref_id": "<string>"
    },
    "content": [
      {
        "attrs": {
          "ai_generation_info": {
            "is_finalized": true,
            "transcript_source_text": ""
          },
          "is_new": true,
          "ref_id": "<string>"
        },
        "content": [
          {
            "attrs": {
              "ai_generation_info": {
                "is_finalized": true,
                "transcript_source_text": ""
              },
              "is_new": true,
              "ref_id": "<string>"
            },
            "content": [],
            "type": "columnLayout"
          }
        ],
        "type": "twoColumnLayout"
      }
    ],
    "type": "document"
  },
  "exam_reason": "<string>",
  "metadata": null,
  "provider": 123,
  "serviced_at": "2023-11-07T05:31:56Z",
  "snapshot_id": 123
}
'
{
  "category": 123,
  "id": 123,
  "is_draft": true,
  "patient": 123,
  "practice": 123,
  "provider": 123,
  "serviced_at": "<string>",
  "bill": 123,
  "confidential": false,
  "content": {
    "attrs": {
      "ai_generation_info": {
        "is_finalized": true,
        "transcript_source_text": ""
      },
      "is_new": true,
      "ref_id": "<string>"
    },
    "content": [
      {
        "attrs": {
          "ai_generation_info": {
            "is_finalized": true,
            "transcript_source_text": ""
          },
          "is_new": true,
          "ref_id": "<string>"
        },
        "content": [
          {
            "attrs": {
              "ai_generation_info": {
                "is_finalized": true,
                "transcript_source_text": ""
              },
              "is_new": true,
              "ref_id": "<string>"
            },
            "content": [],
            "type": "columnLayout"
          }
        ],
        "type": "twoColumnLayout"
      }
    ],
    "type": "document"
  },
  "doctags": [],
  "exam_reason": "<string>",
  "is_outdated": false,
  "metadata": {},
  "signatures": [],
  "snapshot_id": 123,
  "summary": "<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

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
note_id
integer
required

Body

application/json
​
bill
integer | null
​
category
integer | null
​
close_snapshot
boolean | null
​
confidential
boolean
default:false
​
content
DocumentNode · object
​
exam_reason
string | null
​
metadata
unknown
​
provider
integer | null
​
serviced_at
string<date-time> | null
​
snapshot_id
integer | null

Response

Successful Response

A full representation of a note.

Do not use this for endpoints that return notes in bulk. Use NoteMetadata for that instead.

​
category
integer
required

Practice-created identifiers for note category. A category is a Visit Note Type object. See https://docs.elationhealth.com/reference/visit_note_types_list for API to list all available categories.

​
id
integer
required
​
is_draft
boolean
required
​
patient
integer
required

The ID of the patient for whom the note was created.

​
practice
integer
required

Authoring practice ID.

​
provider
integer
required

The ID of the assigned provider.

​
serviced_at
string | null
required
​
bill
integer | null

The ID of the bill associated with the note

​
confidential
boolean
default:false

Whether the note is marked as confidential.

​
content
DocumentNode · object

An object representing the body of the note.

​
doctags
Doctag · object[]
​
exam_reason
string | null
​
is_outdated
boolean
default:false
​
metadata
Metadata · object

Unstructured data for storing related metadata.

​
signatures
DocumentSignature · object[]
​
snapshot_id
integer | null
​
summary
string | null