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
}
'
import requests

url = "https://sandbox.elationemr.com/api/2.0/notes/{note_id}"

payload = {
    "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": None,
    "provider": 123,
    "serviced_at": "2023-11-07T05:31:56Z",
    "snapshot_id": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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
  })
};

fetch('https://sandbox.elationemr.com/api/2.0/notes/{note_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.elationemr.com/api/2.0/notes/{note_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.elationemr.com/api/2.0/notes/{note_id}"

	payload := strings.NewReader("{\n  \"bill\": 123,\n  \"category\": 123,\n  \"close_snapshot\": true,\n  \"confidential\": false,\n  \"content\": {\n    \"attrs\": {\n      \"ai_generation_info\": {\n        \"is_finalized\": true,\n        \"transcript_source_text\": \"\"\n      },\n      \"is_new\": true,\n      \"ref_id\": \"<string>\"\n    },\n    \"content\": [\n      {\n        \"attrs\": {\n          \"ai_generation_info\": {\n            \"is_finalized\": true,\n            \"transcript_source_text\": \"\"\n          },\n          \"is_new\": true,\n          \"ref_id\": \"<string>\"\n        },\n        \"content\": [\n          {\n            \"attrs\": {\n              \"ai_generation_info\": {\n                \"is_finalized\": true,\n                \"transcript_source_text\": \"\"\n              },\n              \"is_new\": true,\n              \"ref_id\": \"<string>\"\n            },\n            \"content\": [],\n            \"type\": \"columnLayout\"\n          }\n        ],\n        \"type\": \"twoColumnLayout\"\n      }\n    ],\n    \"type\": \"document\"\n  },\n  \"exam_reason\": \"<string>\",\n  \"metadata\": null,\n  \"provider\": 123,\n  \"serviced_at\": \"2023-11-07T05:31:56Z\",\n  \"snapshot_id\": 123\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://sandbox.elationemr.com/api/2.0/notes/{note_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bill\": 123,\n  \"category\": 123,\n  \"close_snapshot\": true,\n  \"confidential\": false,\n  \"content\": {\n    \"attrs\": {\n      \"ai_generation_info\": {\n        \"is_finalized\": true,\n        \"transcript_source_text\": \"\"\n      },\n      \"is_new\": true,\n      \"ref_id\": \"<string>\"\n    },\n    \"content\": [\n      {\n        \"attrs\": {\n          \"ai_generation_info\": {\n            \"is_finalized\": true,\n            \"transcript_source_text\": \"\"\n          },\n          \"is_new\": true,\n          \"ref_id\": \"<string>\"\n        },\n        \"content\": [\n          {\n            \"attrs\": {\n              \"ai_generation_info\": {\n                \"is_finalized\": true,\n                \"transcript_source_text\": \"\"\n              },\n              \"is_new\": true,\n              \"ref_id\": \"<string>\"\n            },\n            \"content\": [],\n            \"type\": \"columnLayout\"\n          }\n        ],\n        \"type\": \"twoColumnLayout\"\n      }\n    ],\n    \"type\": \"document\"\n  },\n  \"exam_reason\": \"<string>\",\n  \"metadata\": null,\n  \"provider\": 123,\n  \"serviced_at\": \"2023-11-07T05:31:56Z\",\n  \"snapshot_id\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.elationemr.com/api/2.0/notes/{note_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bill\": 123,\n  \"category\": 123,\n  \"close_snapshot\": true,\n  \"confidential\": false,\n  \"content\": {\n    \"attrs\": {\n      \"ai_generation_info\": {\n        \"is_finalized\": true,\n        \"transcript_source_text\": \"\"\n      },\n      \"is_new\": true,\n      \"ref_id\": \"<string>\"\n    },\n    \"content\": [\n      {\n        \"attrs\": {\n          \"ai_generation_info\": {\n            \"is_finalized\": true,\n            \"transcript_source_text\": \"\"\n          },\n          \"is_new\": true,\n          \"ref_id\": \"<string>\"\n        },\n        \"content\": [\n          {\n            \"attrs\": {\n              \"ai_generation_info\": {\n                \"is_finalized\": true,\n                \"transcript_source_text\": \"\"\n              },\n              \"is_new\": true,\n              \"ref_id\": \"<string>\"\n            },\n            \"content\": [],\n            \"type\": \"columnLayout\"\n          }\n        ],\n        \"type\": \"twoColumnLayout\"\n      }\n    ],\n    \"type\": \"document\"\n  },\n  \"exam_reason\": \"<string>\",\n  \"metadata\": null,\n  \"provider\": 123,\n  \"serviced_at\": \"2023-11-07T05:31:56Z\",\n  \"snapshot_id\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "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>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

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 | null
​
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 | null

An object representing the body of the note.

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

Unstructured data for storing related metadata.

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