Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Elation Health Non Visit Notes API
version: '1.0'
description: 'Operations tagged Non Visit Notes across 3 of this provider''s published API definitions: elation-api-settings.json, elation-health-api-full-openapi.yaml, elation-patient-document-api.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://sandbox.elationemr.com/api/2.0
- description: Sandbox Server
url: https://sandbox.elationemr.com
- description: Production Server
url: https://api.app.elationemr.com
tags:
- name: Non Visit Notes
paths:
/non_visit_notes/{id}/:
get:
summary: Get Non-Visit Note
description: ''
operationId: get-non-visit-note
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: Authorization
in: header
required: true
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"id\": 83792571234,\n // See Object Definition\n}"
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
x-readme:
code-samples:
- language: python
code: "import requests\nimport json\n\naccess_token = \"TyEPKw8fVGRKpCBa81ygwjCLXDNIAm\"\nauth_header = \"Bearer %s\" % (access_token)\n\nresp = requests.get(\"https://sandbox.elationemr.com/api/2.0/non_visit_notes/64184451073/\",\n headers={'Authorization': auth_header})\n\nprint resp.status_code\nprint json.dumps(json.loads(resp.content), indent=2)"
samples-languages:
- python
tags:
- Non Visit Notes
security:
- sec0: []
delete:
summary: Delete Non-Visit Note
description: ''
operationId: delete-non-visit-note
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: Authorization
in: header
required: true
schema:
type: string
responses:
'204':
description: '204'
content:
application/json:
examples:
Result:
value: ''
deprecated: false
x-readme:
code-samples:
- language: python
code: "import requests\nimport json\n\naccess_token = \"TyEPKw8fVGRKpCBa81ygwjCLXDNIAm\"\nauth_header = \"Bearer %s\" % (access_token)\n\nresp = requests.delete(\"https://sandbox.elationemr.com/api/2.0/non_visit_notes/54233202689/\",\n headers={'Authorization': auth_header})\n\nprint resp.status_code"
samples-languages:
- python
tags:
- Non Visit Notes
security:
- sec0: []
put:
summary: Update Non-Visit Note
description: ''
operationId: update-non-visit-note
parameters:
- name: id
in: path
schema:
type: integer
format: int64
required: true
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
required:
- type
- document_date
- chart_date
properties:
type:
type: string
description: The type of the non visit note
document_date:
type: string
description: The date of the document
format: date
chart_date:
type: string
description: The date of the patient chart
format: date
bullets:
type: array
description: The bullets of the non visit note
items:
properties:
id:
type: integer
description: Bullet ID
format: int64
author:
type: integer
description: The author of the bullet
format: int32
text:
type: string
description: The text of the bullet
required:
- id
- text
type: object
patient:
type: integer
description: The oid of the patient
format: int32
practice:
type: integer
description: The id of the practice
format: int32
tags:
type: array
description: The ids of the document tags you want to attach
items:
type: integer
format: int64
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"id\": 140758520102937,\n \"type\": \"nonvisit\",\n \"notes\": [\n {\n \"id\": 140758520168536,\n \"author\": 64,\n \"text\": \"this is phone note\",\n \"version\": 3,\n \"updated_date\": \"2022-05-13T13:25:43Z\"\n }\n ],\n \"bullets\": [\n {\n \"id\": 140758520168536,\n \"author\": 64,\n \"text\": \"this is phone note\",\n \"version\": 3,\n \"updated_date\": \"2022-05-13T13:25:43Z\"\n }\n ],\n \"tags\": [\n {\n \"code\": \"408289007\",\n \"code_type\": 2,\n \"concept_name\": \"wt-mgmt-referral\",\n \"context\": null,\n \"created_date\": \"2015-07-23T19:30:51Z\",\n \"deleted_date\": \"2019-05-29T00:06:03Z\",\n \"description\": \"Referral to weight management program\",\n \"id\": 58719011162,\n \"practice_created\": null,\n \"snomed_result_code\": null,\n \"value\": \"CQM: Ref to Wt Mgt Program\"\n }\n ],\n \"patient\": 140758510600193,\n \"document_date\": \"2022-05-05T07:50:20Z\",\n \"chart_date\": \"2022-05-05T07:50:20Z\",\n \"signed_date\": null,\n \"signed_by\": null,\n \"created_date\": \"2022-05-13T13:25:43.137904Z\",\n \"deleted_date\": null\n}"
schema:
type: object
properties:
id:
type: integer
example: 140758520102937
default: 0
type:
type: string
example: nonvisit
notes:
type: array
items:
type: object
properties:
id:
type: integer
example: 140758520168536
default: 0
author:
type: integer
example: 64
default: 0
text:
type: string
example: this is phone note
version:
type: integer
example: 3
default: 0
updated_date:
type: string
example: '2022-05-13T13:25:43Z'
bullets:
type: array
items:
type: object
properties:
id:
type: integer
example: 140758520168536
default: 0
author:
type: integer
example: 64
default: 0
text:
type: string
example: this is phone note
version:
type: integer
example: 3
default: 0
updated_date:
type: string
example: '2022-05-13T13:25:43Z'
tags:
type: array
items:
type: object
properties:
code:
type: string
example: '408289007'
code_type:
type: integer
example: 2
default: 0
concept_name:
type: string
example: wt-mgmt-referral
context: {}
created_date:
type: string
example: '2015-07-23T19:30:51Z'
deleted_date:
type: string
example: '2019-05-29T00:06:03Z'
description:
type: string
example: Referral to weight management program
id:
type: integer
example: 58719011162
default: 0
practice_created: {}
snomed_result_code: {}
value:
type: string
example: 'CQM: Ref to Wt Mgt Program'
patient:
type: integer
example: 140758510600193
default: 0
document_date:
type: string
example: '2022-05-05T07:50:20Z'
chart_date:
type: string
example: '2022-05-05T07:50:20Z'
signed_date: {}
signed_by: {}
created_date:
type: string
example: '2022-05-13T13:25:43.137904Z'
deleted_date: {}
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
x-readme:
code-samples:
- language: python
code: "import requests\nimport json\n\naccess_token = \"TyEPKw8fVGRKpCBa81ygwjCLXDNIAm\"\nauth_header = \"Bearer %s\" % (access_token)\n\n# sending only required data\ndata = {\n \"id\": 126532,\n \"type\": \"phone\",\n \"bullets\": [\n {\n \"id\": 126153,\n \"author\": 64,\n \"text\": \"this is phone note\"\n }\n ],\n \"patient\": 123467,\n \"practice\": 131074,\n \"document_date\": \"2017-03-05T07:22:13Z\",\n \"chart_date\": \"2017-03-05T07:22:13Z\",\n \"tags\": [\n 365784\n ],\n}\n\nresp = requests.put(\"https://sandbox.elationemr.com/api/2.0/non_visit_notes/126532/\",\n data=json.dumps(data),\n headers={'Authorization': auth_header,\n 'Content-type': 'application/json'})\n\nprint resp.status_code\nprint json.dumps(json.loads(resp.content), indent=2)"
samples-languages:
- python
tags:
- Non Visit Notes
security:
- sec0: []
patch:
summary: Update Non-Visit Note
description: ''
operationId: update-non-visit-note-1
parameters:
- name: Authorization
in: header
required: true
schema:
type: string
- name: id
in: path
schema:
type: integer
format: int64
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: The type of the non visit note
bullets:
type: array
description: The bullets of the non visit note.
items:
properties:
id:
type: integer
description: Bullet ID
format: int64
author:
type: integer
description: The author of the bullet
format: int32
text:
type: string
description: The text of the bullet
required:
- id
- text
type: object
patient:
type: integer
description: The oid of the patient
format: int32
practice:
type: integer
description: The id of the practice
format: int32
document_date:
type: string
description: The date of the document
format: date
chart_date:
type: string
description: The date of the patient chart
format: date
tags:
type: array
description: The ids of the document tags you want to attach
items:
type: integer
format: int64
sign_date:
type: string
description: The date and time to sign off the note. It is expected to be the current UTC time. eg. "2022-11-10T01:06:22Z"
format: date
signed_by:
type: integer
description: The user id of the physician who is signing off the note
format: int32
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"id\": 140758520102937,\n \"type\": \"nonvisit\",\n \"notes\": [\n {\n \"id\": 140758520168536,\n \"author\": 64,\n \"text\": \"this is phone note\",\n \"version\": 2,\n \"updated_date\": \"2022-05-13T13:25:43Z\"\n }\n ],\n \"bullets\": [\n {\n \"id\": 140758520168536,\n \"author\": 64,\n \"text\": \"this is phone note\",\n \"version\": 2,\n \"updated_date\": \"2022-05-13T13:25:43Z\"\n }\n ],\n \"tags\": [\n {\n \"code\": \"408289007\",\n \"code_type\": 2,\n \"concept_name\": \"wt-mgmt-referral\",\n \"context\": null,\n \"created_date\": \"2015-07-23T19:30:51Z\",\n \"deleted_date\": \"2019-05-29T00:06:03Z\",\n \"description\": \"Referral to weight management program\",\n \"id\": 58719011162,\n \"practice_created\": null,\n \"snomed_result_code\": null,\n \"value\": \"CQM: Ref to Wt Mgt Program\"\n }\n ],\n \"patient\": 140758510600193,\n \"document_date\": \"2022-05-05T07:50:20Z\",\n \"chart_date\": \"2022-05-05T07:50:20Z\",\n \"signed_date\": null,\n \"signed_by\": null,\n \"created_date\": \"2022-05-13T13:25:43.137904Z\",\n \"deleted_date\": null\n}"
schema:
type: object
properties:
id:
type: integer
example: 140758520102937
default: 0
type:
type: string
example: nonvisit
notes:
type: array
items:
type: object
properties:
id:
type: integer
example: 140758520168536
default: 0
author:
type: integer
example: 64
default: 0
text:
type: string
example: this is phone note
version:
type: integer
example: 2
default: 0
updated_date:
type: string
example: '2022-05-13T13:25:43Z'
bullets:
type: array
items:
type: object
properties:
id:
type: integer
example: 140758520168536
default: 0
author:
type: integer
example: 64
default: 0
text:
type: string
example: this is phone note
version:
type: integer
example: 2
default: 0
updated_date:
type: string
example: '2022-05-13T13:25:43Z'
tags:
type: array
items:
type: object
properties:
code:
type: string
example: '408289007'
code_type:
type: integer
example: 2
default: 0
concept_name:
type: string
example: wt-mgmt-referral
context: {}
created_date:
type: string
example: '2015-07-23T19:30:51Z'
deleted_date:
type: string
example: '2019-05-29T00:06:03Z'
description:
type: string
example: Referral to weight management program
id:
type: integer
example: 58719011162
default: 0
practice_created: {}
snomed_result_code: {}
value:
type: string
example: 'CQM: Ref to Wt Mgt Program'
patient:
type: integer
example: 140758510600193
default: 0
document_date:
type: string
example: '2022-05-05T07:50:20Z'
chart_date:
type: string
example: '2022-05-05T07:50:20Z'
signed_date: {}
signed_by: {}
created_date:
type: string
example: '2022-05-13T13:25:43.137904Z'
deleted_date: {}
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
x-readme:
code-samples:
- language: python
code: "import requests\nimport json\n\naccess_token = \"TyEPKw8fVGRKpCBa81ygwjCLXDNIAm\"\nauth_header = \"Bearer %s\" % (access_token)\n\n# sending only required data\ndata = {\n \"id\": 126532,\n \"type\": \"phone\",\n \"bullets\": [\n {\n \"id\": 126153,\n \"text\": \"this is phone note\"\n }\n ],\n \"patient\": 123467,\n \"practice\": 131074,\n \"document_date\": \"2017-03-05T07:22:13Z\",\n \"chart_date\": \"2017-03-05T07:22:13Z\",\n \"tags\": [\n 365784\n ],\n}\n\nresp = requests.patch(\"https://sandbox.elationemr.com/api/2.0/non_visit_notes/126532/\",\n data=json.dumps(data),\n headers={'Authorization': auth_header,\n 'Content-type': 'application/json'})\n\nprint resp.status_code\nprint json.dumps(json.loads(resp.content), indent=2)"
samples-languages:
- python
tags:
- Non Visit Notes
security:
- sec0: []
servers:
- url: https://sandbox.elationemr.com/api/2.0
/non_visit_notes/:
get:
summary: Find Non-Visit Notes
description: ''
operationId: find-non-visit-notes
parameters:
- name: Authorization
in: header
required: true
schema:
type: string
- name: patient
in: query
required: true
schema:
type: array
items:
type: integer
format: int64
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"count\": 123,\n \"next\": \"https://sandbox.elationemr.com/api/2.0/non_visit_notes/?limit=10&offset=10\",\n \"previous\": \"https://sandbox.elationemr.com/api/2.0/non_visit_notes/?limit=10\",\n \"results\": [ // list of objects\n { // See Object Definition },\n // ...\n { // See Object Definition },\n ]\n}"
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
x-readme:
code-samples:
- language: python
code: "import requests\nimport json\n\naccess_token = \"VFroUHsmrErlVI6nJ08Alwhri5RGCW\"\nauth_header = \"Bearer %s\" % (access_token)\n\nresp = requests.get(\"https://sandbox.elationemr.com/api/2.0/non_visit_notes/\",\n headers={'Authorization': auth_header})\n\nprint resp.status_code\nprint json.dumps(json.loads(resp.content), indent=2)"
samples-languages:
- python
tags:
- Non Visit Notes
security:
- sec0: []
post:
summary: Create Non-Visit Note
description: ''
operationId: create-non-visit-note
parameters:
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
required:
- type
- patient
- document_date
- chart_date
properties:
type:
type: string
description: The type of the non visit note
bullets:
type: array
description: The bullets of the non visit note
items:
properties:
text:
type: string
description: The text of the bullet
author:
type: integer
description: The author of the bullet
format: int32
category:
type: string
description: The category of the bullet
enum:
- Problem
- Past
- Family
- Social
- Instr
- PE
- ROS
- Med
- Data
- Assessment
- Test
- Tx
- Narrative
- Followup
- Reason
- Plan
- Objective
- Hpi
- Allergies
- Habits
- Assessplan
- Consultant
- Attending
- Dateprocedure
- Surgical
- Orders
- Referenced
- Procedure
sequence:
type: integer
description: The sequence of the bullet
format: int32
note_document:
type: object
description: A document referenced by the bullet
properties:
document:
type: integer
description: the id of the document, e.g. the id of the report or order
format: int32
document_summary:
type: string
description: A textual summary of the document. Will show up in the visit note editor view, while the bullet text will be used in views outisde the editor.
note_item:
type: object
description: An item in the clinical record on the left hand side of the chart referenced by the bullet.
properties:
id:
type: string
description: The id of the item being referenced, e.g. the problem or history id.
handout:
type: integer
description: The id of the handout to attach to this bullet.
format: int32
children:
type: array
description: bullet childrens
items:
properties:
text:
type: string
description: The text of the bullet
author:
type: integer
description: The author of the bullet
format: int32
category:
type: string
description: The category of the bullet
enum:
- Problem
- Past
- Family
- Social
- Instr
- PE
- ROS
- Med
- Data
- Assessment
- Test
- Tx
- Narrative
- Followup
- Reason
- Plan
- Objective
- Hpi
- Allergies
- Habits
- Assessplan
- Consultant
- Attending
- Dateprocedure
- Surgical
- Orders
- Referenced
- Procedure
sequence:
type: integer
description: The sequence of the bullet
format: int32
note_document:
type: object
description: A document referenced by the bullet
properties:
document:
type: integer
description: the id of the document, e.g. the id of the report or order
format: int32
document_summary:
type: string
description: A textual summary of the document. Will show up in the visit note editor view, while the bullet text will be used in views outisde the editor.
note_item:
type: object
description: An item in the clinical record on the left hand side of the chart referenced by the bullet.
properties:
id:
type: string
description: The id of the item being referenced, e.g. the problem or history id.
handout:
type: integer
description: The id of the handout to attach to this bullet.
format: int32
children:
type: array
description: bullet childrens
default: []
required:
- text
- author
- category
type: object
required:
- text
- author
- category
type: object
patient:
type: integer
description: The oid of the patient
format: int32
practice:
type: integer
description: The id of the practice
format: int32
document_date:
type: string
description: The date of the document
format: date
chart_date:
type: string
description: The date of the patient chart
format: date
tags:
type: array
description: The ids of the document tags you want to attach
items:
type: integer
format: int64
note_document:
type: array
description: The ids of the documents and summary
note_item:
type: array
description: The ids of the patient items
items:
type: integer
format: int64
responses:
'201':
description: '201'
content:
application/json:
examples:
Result:
value: "{\n \"id\": 140758520102937,\n \"type\": \"nonvisit\",\n \"notes\": [\n {\n \"id\": 140758520168536,\n \"author\": 64,\n \"text\": \"New POST non visit\",\n \"version\": 1,\n \"updated_date\": \
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/openapi/elation-health-non-visit-notes-api-openapi.yml