Retrieve Visit Notes Clinical Summary
curl --request GET \
--url https://sandbox.elationemr.com/api/2.0/visit_notes/{id}/clinical_summary/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox.elationemr.com/api/2.0/visit_notes/{id}/clinical_summary/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.elationemr.com/api/2.0/visit_notes/{id}/clinical_summary/', 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/visit_notes/{id}/clinical_summary/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.elationemr.com/api/2.0/visit_notes/{id}/clinical_summary/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.elationemr.com/api/2.0/visit_notes/{id}/clinical_summary/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elationemr.com/api/2.0/visit_notes/{id}/clinical_summary/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"bullets": [
{
"category": "Allergies",
"text": "<string>",
"author": 123,
"children": [
{
"category": "Allergies",
"text": "<string>",
"author": 123,
"deleted_date": "2023-11-07T05:31:56Z",
"edit": 123,
"handout": 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>"
},
"note_item": {
"item": {
"is_confidential": true,
"patient": 123,
"type": "<string>",
"created_date": "2023-11-07T05:31:56Z",
"deleted_date": "2023-11-07T05:31:56Z",
"id": 123
},
"id": 123
},
"replaced_by": 123,
"replaced_by_edit": 123,
"sequence": 1,
"updated_date": "2023-11-07T05:31:56Z",
"version": 32767
}
],
"deleted_date": "2023-11-07T05:31:56Z",
"edit": 123,
"handout": 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>"
},
"note_item": {
"item": {
"is_confidential": true,
"patient": 123,
"type": "<string>",
"created_date": "2023-11-07T05:31:56Z",
"deleted_date": "2023-11-07T05:31:56Z",
"id": 123
},
"id": 123
},
"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,
"template": "Complete H&P (1 col)",
"amendment_request": {
"amendment_source": "Patient",
"request_description": "<string>",
"status": "accepted",
"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",
"tags": [
123
],
"type": "Office Visit Note",
"visit_summary_link": "<string>"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
- Token URL
- /api/2.0/oauth2/token/
Path Parameters
Response
The bullets of the visit note, including child bullets. Which categories are accepted, and whether a category may repeat or hold child bullets, is determined by template.
Show child attributes
Show child attributes
Visit note chart date.
Visit note document date.
The note's format. The format determines which bullet categories the note accepts, whether a category may repeat within the note, and whether a category may hold child bullets.
Complete H&P (1 col), Complete H&P (2 col A/P), Complete H&P (2 col), Pre-Op, SOAP, Simple Show child attributes
Show child attributes
Dictionary of checklists by type (e.g. 'pe', 'ros'), where each checklist contains a list of fields with name, value and sequence
Show child attributes
Show child attributes
Whether this note is confidential to the practice and shouldn't be shared automatically with third parties.
Show child attributes
Show child attributes
The list of signatures if co-signing is enabled for the practice. (Requires Special Permission).
Show child attributes
Show child attributes
The user id of the provider who signed the visit note. (Requires special permission).
The time at which the visit note was signed. Cannot be in the future. (Requires Special Permission).
Visit note type.
Was this page helpful?
curl --request GET \
--url https://sandbox.elationemr.com/api/2.0/visit_notes/{id}/clinical_summary/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox.elationemr.com/api/2.0/visit_notes/{id}/clinical_summary/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.elationemr.com/api/2.0/visit_notes/{id}/clinical_summary/', 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/visit_notes/{id}/clinical_summary/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.elationemr.com/api/2.0/visit_notes/{id}/clinical_summary/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.elationemr.com/api/2.0/visit_notes/{id}/clinical_summary/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elationemr.com/api/2.0/visit_notes/{id}/clinical_summary/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"bullets": [
{
"category": "Allergies",
"text": "<string>",
"author": 123,
"children": [
{
"category": "Allergies",
"text": "<string>",
"author": 123,
"deleted_date": "2023-11-07T05:31:56Z",
"edit": 123,
"handout": 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>"
},
"note_item": {
"item": {
"is_confidential": true,
"patient": 123,
"type": "<string>",
"created_date": "2023-11-07T05:31:56Z",
"deleted_date": "2023-11-07T05:31:56Z",
"id": 123
},
"id": 123
},
"replaced_by": 123,
"replaced_by_edit": 123,
"sequence": 1,
"updated_date": "2023-11-07T05:31:56Z",
"version": 32767
}
],
"deleted_date": "2023-11-07T05:31:56Z",
"edit": 123,
"handout": 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>"
},
"note_item": {
"item": {
"is_confidential": true,
"patient": 123,
"type": "<string>",
"created_date": "2023-11-07T05:31:56Z",
"deleted_date": "2023-11-07T05:31:56Z",
"id": 123
},
"id": 123
},
"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,
"template": "Complete H&P (1 col)",
"amendment_request": {
"amendment_source": "Patient",
"request_description": "<string>",
"status": "accepted",
"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",
"tags": [
123
],
"type": "Office Visit Note",
"visit_summary_link": "<string>"
}