Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elation Import API

Interact with data imports into a practice - submitting and managing bulk clinical and administrative data imports - via the Elation Import API.

Elation Import API is one of 16 APIs that Elation Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data Import, Migration, and Healthcare. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 14 operations across 6 paths, organized into 2 resource areas, and defines 34 schemas. It is described by OpenAPI 3.0.1, at version 1.0.2.

Requests are made against 2 base URLs: https://api.app.elationemr.com/api/2.0, https://sandbox.elationemr.com/api/2.0.

14 operations 6 paths 34 schemas 2 DELETE4 GET2 PATCH4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.2
Base URL
https://api.app.elationemr.com/api/2.0
Authentication
OAuth 2.0
Terms of Service
Resource Areas
2

Authentication & Security 1

Elation Import API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (elation_auth) using the password flow, exposing 1 scope.

Paths & Operations 14

Across 6 paths, the API surfaces 14 operations — 2 DELETE, 4 GET, 2 PATCH, 4 POST, 2 PUT. They span 2 resource areas: Data Import Request, patient chart import. Each is listed below with its method, path, parameters, and response codes.

Data Import Request 7

The parent resource for tracking batches of individual patient chart imports.

GET
/data-import-requests
Retrieve a list of existing data import requests.
getDIRs → 200401403
POST
/data-import-requests
Create a new data import request.
createDIR body → 200201400401403422
GET
/data-import-requests/{dir-id}
Retrieve an existing data import request.
getDIR 1 param → 200401403404
PUT
/data-import-requests/{dir-id}
Update an existing data import request.
updateDIR 1 param body → 200400401403404422
PATCH
/data-import-requests/{dir-id}
Update an existing data import request.
patchDIR 1 param body → 400401403404422
DELETE
/data-import-requests/{dir-id}
Delete an existing data import request.
deleteDIR 1 param → 401403404
POST
/data-import-requests/{dir-id}/run
Convenience call
runDIR 1 param → 202401403
patient chart import 7
GET
/data-import-requests/{dir-id}/patient-chart-imports
Finds patientchartimport records by status
findchartsByStatus 2 params → 200400401403404
POST
/data-import-requests/{dir-id}/patient-chart-imports
Add a new patient-chart-import to the associated data import request
addchart 1 param body → 400401403404422
GET
/data-import-requests/{dir-id}/patient-chart-imports/{pci-id}
Find patient-chart-import by ID
getPatientChartImportById 2 params → 200401403404
PUT
/data-import-requests/{dir-id}/patient-chart-imports/{pci-id}
Update an existing patient-chart-import
updatepatient-chart-import 2 params body → 400401403404422
PATCH
/data-import-requests/{dir-id}/patient-chart-imports/{pci-id}
Updates a patient-chart-import in the store with form data
updatepatient-chart-importWithForm 2 params body → 400405
DELETE
/data-import-requests/{dir-id}/patient-chart-imports/{pci-id}
Deletes a patient-chart-import
deletepatient-chart-import 2 params → 401403404
POST
/data-import-requests/{dir-id}/patient-chart-imports/{pci-id}/render-requests
uploads an document for rendering
uploadFile 2 params body → 200400404

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are demographic (24 properties), med_order (16 properties), immunization (15 properties), history_item_map (13 properties). Each schema is shown below with its type and property counts.

PatientChartInputPut
object
3 properties 2 required
PatientChartInputPost
object
3 properties 2 required
PatientChartInputGetList
object
8 properties 2 required
PatientChartInputGetId
object
1 property
ApiResponse
object
3 properties
JobStatus
string
The current status of the patient chart import. Options are open, pending, processing, failed, completed
BaseDataImportRequest
object
3 properties
ExistingDataImportRequestWithoutStatus
object
2 properties 5 required
ExistingDataImportRequest
object
1 property 6 required
CreateDataImportRequest
object
2 properties 3 required
DataImportRequestArray
array
ValidationErrorResponse
object
ChartBuilderJson
object
contains JSON schema that describes the json that chartbuilder.py consumes to create chart. Schemas are uploaded to a public s3 endpoint that is backing http:/…
genericJsonBlob
object
allergy
appointment
object
6 properties 3 required
demographic
object
24 properties 5 required
history_item
object
1 property 1 required
family_history_item
object
2 properties 2 required
smoking_status_item
object
2 properties 2 required
history_items
array
family_history_items
array
habit_history_items
array
history_item_map
object
13 properties
immunization
object
15 properties 2 required
immunization_decline
object
4 properties 2 required
problem
object
8 properties 3 required
lab_result
object
13 properties 6 required
lab_result_panel
object
6 properties 5 required
lab_report
object
9 properties 2 required
unstructured_report
object
6 properties 4 required
medication
object
5 properties 1 required
med_order
object
16 properties 3 required
non_visit_note
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elation-elation-import-api.json Raw ↑

Other APIs Elation Health publishes across the network.

Elation OAuth API
Elation Patient Profile API
Elation Visit Notes API
Elation Patient Document API
Elation Orders API
Elation Scheduling API
Elation Billing API
Elation Insurance API
Elation Patient Insurance API (Premium) & Eligibility
Elation Practice API
Elation User Management API
Elation Messaging API