Clinical encounter documentation
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/elation-visit-notes-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Elation Health Visit Notes API
version: '1.0'
description: 'Operations tagged Visit Notes across 4 of this provider''s published API definitions: elation-api-settings.json, elation-health-api-full-openapi.yaml, elation-health-visit-notes-api-openapi.yml, 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
- url: https://app.elationemr.com/api/2.0
description: Production
tags:
- name: Visit Notes
paths:
/visit_notes/{id}/:
get:
summary: Get Visit Note
description: ''
operationId: get-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/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:
- Visit Notes
security:
- sec0: []
delete:
summary: Delete Visit Note
description: ''
operationId: delete-visit-note
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: Authorization
in: header
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/visit_notes/54233202689/\",\n headers={'Authorization': auth_header})\n\nprint resp.status_code"
samples-languages:
- python
tags:
- Visit Notes
security:
- sec0: []
patch:
summary: Sign Visit Note
description: Users can sign a draft visit note using PATCH requests
operationId: sign-visit-note
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
required:
- signed_date
- signed_by
properties:
signed_date:
type: string
description: The time at which the visit note was signed. Cannot be in the future. (Requires Special Permission).
format: date
signed_by:
type: string
description: The user id of the provider who signed the visit note. (Requires special permission).
signatures:
type: array
description: Requires special co-signature permissions. If enabled, users can add co-signatures to the visit note by providing them in this field.
items:
properties:
user:
type: string
description: ID of the user whose signature this represents
user_name:
type: string
description: The full name and title of the user whose signature this represents
signed_date:
type: string
description: date-time timestamp for when this signature occurred
format: date
role:
type: string
description: the function of the signer
enum:
- '''cosigner'''
- '''rendering_provider'''
- '''amender'''
comments:
type: string
description: additional comments
type: object
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Visit Notes
security:
- sec0: []
put:
operationId: visit_notes_update
summary: Update a visit note
description: Replace all visit note fields with the provided values.
tags:
- Visit Notes
parameters:
- $ref: '#/components/parameters/id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VisitNoteCreate'
responses:
'200':
description: Visit note updated
content:
application/json:
schema:
$ref: '#/components/schemas/VisitNote_2'
security:
- sec0: []
servers:
- url: https://sandbox.elationemr.com/api/2.0
/visit_notes/:
get:
summary: Find Visit Notes
description: ''
operationId: find-visit-notes
parameters:
- name: patient
in: query
schema:
type: array
items:
type: integer
format: int64
- name: physician
in: query
schema:
type: array
items:
type: integer
format: int64
- name: practice
in: query
schema:
type: array
items:
type: integer
format: int64
- name: unsigned
in: query
schema:
type: boolean
- name: from_signed_date
in: query
schema:
type: string
format: date
- name: to_signed_date
in: query
schema:
type: string
format: date
- name: Authorization
in: header
required: true
schema:
type: string
- name: last_modified__gt
in: query
schema:
type: string
format: date
- name: last_modified__lt
in: query
schema:
type: string
format: date
- name: last_modified__gte
in: query
schema:
type: string
format: date
- name: last_modified__lte
in: query
schema:
type: string
format: date
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"count\": 123,\n \"next\": \"https://sandbox.elationemr.com/api/2.0/visit_notes/?limit=10&offset=10\",\n \"previous\": \"https://sandbox.elationemr.com/api/2.0/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\nfrom datetime import datetime, timedelta\n\naccess_token = \"VFroUHsmrErlVI6nJ08Alwhri5RGCW\"\nauth_header = \"Bearer %s\" % (access_token)\n\nquery_params = {\n \"from_signed_date\": (datetime.now() - timedelta(days=2))..strftime(\"%Y-%m-%dT%H:%M:%SZ\"),\n \"to_signed_date\": datetime.now().strftime(\"%Y-%m-%dT%H:%M:%SZ\")\n}\n\nresp = requests.get(\"https://sandbox.elationemr.com/api/2.0/visit_notes/\",\n params=query_params,\n headers={'Authorization': auth_header})\n\nprint resp.status_code\nprint json.dumps(json.loads(resp.content), indent=2)"
samples-languages:
- python
tags:
- Visit Notes
security:
- sec0: []
post:
summary: Create Visit Note
description: ''
operationId: create-visit-note
parameters:
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
required:
- bullets
- chart_date
- document_date
- patient
- template
- physician
properties:
bullets:
type: array
description: bullets in 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
chart_date:
type: string
description: visit note chart date
format: date
document_date:
type: string
description: visit note document date
format: date
patient:
type: integer
description: id patient
format: int32
template:
type: string
description: visit note template
enum:
- Simple
- SOAP
- Complete H&P (1 col)
- Complete H&P (2 col)
- Complete H&P (2 col A/P)
- Pre-Op
physician:
type: integer
description: ip prescribing physician
format: int32
type:
type: string
description: type of visit note
default: Office Visit Note
confidential:
type: boolean
description: Whether this note is confidential to the practice and shouldn't be shared automatically with third parties
default: false
signed_by:
type: integer
description: The user id of the provider who signed the visit note. (Requires special permission).
format: int32
signed_date:
type: string
description: The time at which the visit note was signed. Cannot be in the future. (Requires Special Permission).
format: date
signatures:
type: array
description: The list of signatures if co-signing is enabled for the practice. (Requires Special Permission).
items:
properties:
user:
type: string
description: ID of the user whose signature this represents
user_name:
type: string
description: The full name and title of the user whose signature this represents
signed_date:
type: string
description: date-time timestamp for when this signature occurred
format: date
role:
type: string
description: the function of the signer
enum:
- '''cosigner'''
- '''rendering_provider'''
- '''amender'''
comments:
type: string
description: additional comments
type: object
responses:
'201':
description: '201'
content:
application/json:
examples:
Result:
value: "{\n \"id\": 67176497153, \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\n# sending only required data to create a \"Simple\" visit note\n# for \"Simple\" template, at least one of \"Reason\", \"Narrative\", \"Followup\" \n# is required\ndata = {\n \"bullets\": [\n {\n \"category\": \"Reason\",\n \"text\": \"Sample Exam Reason\",\n \"author\": 10\n },\n {\n \"category\": \"Narrative\",\n \"text\": \"Sample Narrative\",\n \"author\": 10\n },\n {\n \"category\": \"Followup\",\n \"text\": \"Sample Followup\",\n \"author\": 10,\n \"sequence\": 3\n }\n ],\n \"type\": \"Office Visit Note\",\n \"template\": \"Simple\",\n \"patient\": 64058687489,\n \"physician\": 131074,\n \"document_date\": \"2017-03-05T07:22:13Z\",\n \"chart_date\": \"2017-03-05T07:22:13Z\"\n}\n\nresp = requests.post(\"https://sandbox.elationemr.com/api/2.0/visit_notes/\",\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)\n\n# sending only required data to create a \"SOAP\" visit note\n# for SOAP note, at least one of \"Reason\", \"Problem\", \"Objective\", \n# \"Assessment\", \"Plan\", \"Followup\" is required\ndata = {\n \"bullets\": [\n {\n \"category\": \"Reason\",\n \"text\": \"Sample Exam Reason\",\n \"author\": 10\n },\n {\n \"category\": \"Problem\",\n \"text\": \"Sample Subjective\",\n \"author\": 10\n },\n {\n \"category\": \"Objective\",\n \"text\": \"Sample Objective\",\n \"author\": 10\n },\n {\n \"category\": \"Assessment\",\n \"text\": \"Sample Assessment\",\n \"author\": 10\n },\n {\n \"category\": \"Plan\",\n \"text\": \"Sample Plan\",\n \"author\": 10\n },\n {\n \"category\": \"Followup\",\n \"text\": \"Sample Followup\",\n \"author\": 10\n }\n ],\n \"type\": \"Office Visit Note\",\n \"template\": \"SOAP\",\n \"patient\": 64057638913,\n \"physician\": 131074,\n \"document_date\": \"2017-03-05T07:26:16Z\",\n \"chart_date\": \"2017-03-05T07:26:16Z\"\n}\n\n# example of a care plan visit note type\n# with Two Column H&P Note\ndata = {\n \"bullets\": [\n {\n \"category\": \"Reason\",\n \"text\": \"Progress Towards Goal of Weight - Goal Not Achieved as of 6/22/2015\",\n\t\t\t \"author\": 10,\n \"note_document\": {\n \"document\": 3342369,\n \"document_summary\": \"some_text\"\n },\n \"note_item\": 8716332,\n \"handout\": 140755830505637 \n },\n {\n \"category\": \"Assessplan\",\n \"text\": \"Progress Towards Goal of Weight - Goal Not Achieved as of 6/22/2015\",\n \t\"note_item\": 234245664,\n\t\t\t \"author\": 10\n },\n {\n \"category\": \"Instr\",\n \"text\": \"Schedule follow on visit with Neighborhood Physicians Practice on 7/1/2015\",\n\t\t\t \"author\": 10\n \"children\": [\n {\n \"category\": \"Instr\",\n \"text\": \"Get rid of intermittent fever that is occurring every few weeks,\n \t\"author\": 10\n },\n {\n \"category\": \"Instr\",\n \"text\": \"Need to gain more energy to do regular activities\",\n \t\"author\": 10\n },\n {\n \"category\": \"Instr\",\n \"text\": \"Keep weight under 105kg.\",\n \"author\": 10\n },\n ],\n },\n {\n \"category\": \"Followup\",\n \"text\": \"Nutrition Recommendations:\\n\\n1. Follow dietary regime as discussed\\n2. Read about nutrition as discussed\",\n \t\"author\": 10\n },\n ],\n \"type\": \"Care Plan\",\n \"template\": \"Complete H&P (2 col A/P)\",\n \"patient\": 64057638913,\n \"physician\": 131074,\n \"practice\": 12345,\n \"document_date\": \"2017-03-05T07:22:13Z\",\n \"chart_date\": \"2017-03-05T07:22:13Z\",\n}\n"
samples-languages:
- python
tags:
- Visit Notes
security:
- sec0: []
servers:
- url: https://sandbox.elationemr.com/api/2.0
/api/2.0/visit_notes/:
get:
operationId: visit_notes_list
parameters:
- in: query
name: from_signed_date
schema:
format: date-time
type: string
- in: query
name: last_modified__gt
schema:
format: date-time
type: string
- in: query
name: last_modified__gte
schema:
format: date-time
type: string
- in: query
name: last_modified__lt
schema:
format: date-time
type: string
- in: query
name: last_modified__lte
schema:
format: date-time
type: string
- description: Number of results to return per page.
in: query
name: limit
required: false
schema:
type: integer
- description: The initial index from which to return the results.
in: query
name: offset
required: false
schema:
type: integer
- description: Which field to use when ordering the results.
in: query
name: order_by
required: false
schema:
type: string
- description: Multiple values may be separated by commas.
explode: false
in: query
name: patient
schema:
items:
format: int64
type: integer
type: array
style: form
- description: Multiple values may be separated by commas.
explode: false
in: query
name: physician
schema:
items:
format: int64
type: integer
type: array
style: form
- description: Multiple values may be separated by commas.
explode: false
in: query
name: practice
schema:
items:
format: int64
type: integer
type: array
style: form
- in: query
name: to_signed_date
schema:
format: date-time
type: string
- in: query
name: unsigned
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedVisitNoteList'
description: ''
security:
- oauth2: []
summary: List Visit Notes
tags:
- Visit Notes
x-el8-docs-category: Patient Document API
x-el8-docs-versions:
- '2.1'
- '2.0'
post:
description: Create a new visit note.
operationId: visit_notes_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VisitNote'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/VisitNote'
description: ''
security:
- oauth2: []
summary: Create Visit Note
tags:
- Visit Notes
x-el8-docs-category: Patient Document API
x-el8-docs-versions:
- '2.1'
- '2.0'
servers:
- description: Sandbox Server
url: https://sandbox.elationemr.com
- description: Production Server
url: https://api.app.elationemr.com
/api/2.0/visit_notes/{id}/:
delete:
description: Delete an existing visit note.
operationId: visit_notes_destroy
parameters:
- in: path
name: id
required: true
schema:
format: int64
type: integer
responses:
'204':
description: No response body
security:
- oauth2: []
summary: Delete Visit Note
tags:
- Visit Notes
x-el8-docs-category: Patient Document API
x-el8-docs-versions:
- '2.1'
- '2.0'
get:
operationId: visit_notes_retrieve
parameters:
- in: path
name: id
required: true
schema:
format: int64
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VisitNote'
description: ''
security:
- oauth2: []
summary: Retrieve Visit Note
tags:
- Visit Notes
x-el8-docs-category: Patient Document API
x-el8-docs-versions:
- '2.1'
- '2.0'
patch:
description: Update an existing visit note.
operationId: visit_notes_partial_update
parameters:
- in: path
name: id
required: true
schema:
format: int64
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedAddSignaturesToNote'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AddSignaturesToNote'
description: ''
security:
- oauth2: []
summary: Partially Update Visit Note
tags:
- Visit Notes
x-el8-docs-category: Patient Document API
x-el8-docs-versions:
- '2.1'
- '2.0'
put:
description: Replace an existing visit note.
operationId: visit_notes_update
parameters:
- in: path
name: id
required: true
schema:
format: int64
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddSignaturesToNote'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AddSignaturesToNote'
description: ''
security:
- oauth2: []
summary: Update Visit Note
tags:
- Visit Notes
x-el8-docs-category: Patient Document API
x-el8-docs-versions:
- '2.1'
- '2.0'
servers:
- description: Sandbox Server
url: https://sandbox.elationemr.com
- description: Production Server
url: https://api.app.elationemr.com
/api/2.0/visit_notes/{id}/clinical_summary/:
get:
operationId: visit_notes_clinical_summary_retrieve
parameters:
- in: path
name: id
required: true
schema:
format: int64
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VisitNote'
description: ''
security:
- oauth2: []
summary: Retrieve Visit Notes Clinical Summary
tags:
- Visit Notes
x-el8-docs-category: Patient Document API
x-el8-docs-versions:
- '2.1'
- '2.0'
servers:
- description: Sandbox Server
url: https://sandbox.elationemr.com
- description: Production Server
url: https://api.app.elationemr.com
/api/2.0/visit_notes/{id}/visit_summary/:
get:
operationId: visit_notes_visit_summary_retrieve
parameters:
- in: path
name: id
required: true
schema:
format: int64
type: integer
responses:
'200':
c
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/openapi/elation-health-visit-notes-api-openapi.yml