Elation Health

Elation Health Data Import Request API

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

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /data-import-requests List data import requests · Retrieve a list of existing data import requests #
Ask an LLM
“What data import requests already exist for bringing charts into Elation?”
“Can I see every chart migration request we have opened?”
Tell an agent
List all data import requests.
Show my existing chart data import requests.
POST /data-import-requests Open a data import request · Create a new data import request #
Ask an LLM
“How do I start a new data import for a physician's patient charts?”
“Which physician and practice must a data import request name?”
Tell an agent
Create a data import request for physician {physician} in practice {practice}.
Open a chart import request for physician {physician}, practice {practice}, with notes {notes}.
GET /data-import-requests/{dir-id} Check a data import request's progress · Retrieve an existing data import request #
Ask an LLM
“How do I check the status of the patient chart imports under one request?”
“Is my data import request finished processing its charts?”
Tell an agent
Get data import request {dir}.
Check the status of every chart import under request {dir}.
PUT /data-import-requests/{dir-id} Replace a data import request · Update an existing data import request #
Ask an LLM
“Can I update a data import request by resending all its editable fields?”
“Which call requires status, physician and practice even when unchanged?”
Tell an agent
Replace data import request {dir} with status {status}, physician {physician}, practice {practice}.
Overwrite import request {dir} in full, setting status {status}.
PATCH /data-import-requests/{dir-id} Change a data import request's status · Update an existing data import request #
Ask an LLM
“Can I change only the status of a data import request?”
“Which call updates just the fields that changed on an import request?”
Tell an agent
Patch data import request {dir} to status {status}.
Move import request {dir} to physician {physician}.
DELETE /data-import-requests/{dir-id} Delete a data import request · Delete an existing data import request #
Ask an LLM
“How do I delete a data import request I no longer need?”
“Why can't I delete an import request that already has chart imports?”
Tell an agent destructive · confirm first
Delete data import request {dir}.
Remove unused import request {dir} before any charts are imported.
POST /data-import-requests/{dir-id}/run Start all open chart imports in a request · Convenience call #
Ask an LLM
“How do I kick off every open patient chart import under a request at once?”
“Can I move all open chart imports to pending in one call?”
Tell an agent
Run data import request {dir}.
Move every open chart import in request {dir} to pending.

Documentation

📖
Documentation
https://docs.elationhealth.com/docs/oauth
📖
APIReference
https://docs.elationhealth.com/reference/get-token
📖
Documentation
https://docs.elationhealth.com/reference/scopes
📖
Documentation
https://docs.elationhealth.com/docs/api-overview
📖
APIReference
https://docs.elationhealth.com/reference
📖
APIReference
https://docs.elationhealth.com/reference/insurance-eligibility
📖
APIReference
https://docs.elationhealth.com/reference/message-threads
📖
Documentation
https://docs.elationhealth.com/docs/webhooks
📖
APIReference
https://docs.elationhealth.com/reference/event-subscriptions
📖
Documentation
https://help.elationhealth.com/articles/rest/overview/api-overview
📖
APIReference
https://help.elationhealth.com/api-reference
📖
Authentication
https://help.elationhealth.com/articles/rest/overview/oauth

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/openapi/elation-health-data-import-request-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/json-schema/elation-health-existing-data-import-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/json-schema/elation-health-data-import-request-array-schema.json

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/asyncapi/elation-health-events-webhooks.yml
🔗
OAuthScopes
https://help.elationhealth.com/articles/rest/overview/scopes
🔗
ChangeLog
https://help.elationhealth.com/articles/rest/changelog/changelog

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/elation-health:elation-health-data-import-request-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

elation-health-data-import-request-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: 'This set of API resources allows you to import patient data into the Elation

    EMR.'
  version: 1.0.2
  title: Elation Import Data Import Request API
  termsOfService: https://www.elationhealth.com/terms-of-use/
  contact:
    email: api-support@elationhealth.com
servers:
- description: Elation Production API
  url: https://api.app.elationemr.com/api/2.0
- description: Elation Sandbox API
  url: https://sandbox.elationemr.com/api/2.0
tags:
- name: Data Import Request
  description: The parent resource for tracking batches of individual patient chart imports.
paths:
  /data-import-requests:
    get:
      tags:
      - Data Import Request
      summary: Retrieve a list of existing data import requests
      description: ''
      operationId: getDIRs
      responses:
        '200':
          description: An array of Data Import Request details without statuses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataImportRequestArray'
        '401':
          description: No valid credentials provided
        '403':
          description: Your credentials are not authorized to use the import API resources
      security:
      - elation_auth:
        - import
    post:
      tags:
      - Data Import Request
      summary: Create a new data import request
      description: ''
      operationId: createDIR
      responses:
        '200':
          description: Details of the created Data Import Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExistingDataImportRequest'
        '201':
          description: New Data Import Request successfully created; check Location reponse header
        '400':
          description: Validation error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: No valid credentials provided
        '403':
          description: Your credentials are not authorized to use the import API resources
        '422':
          description: The request body could not be parsed as JSON
      security:
      - elation_auth:
        - import
      requestBody:
        $ref: '#/components/requestBodies/CreateDataImportRequest'
  /data-import-requests/{dir-id}:
    parameters:
    - in: path
      name: dir-id
      required: true
      schema:
        type: integer
        format: int64
      description: The id of the existing Data Import Request
    get:
      tags:
      - Data Import Request
      summary: Retrieve an existing data import request
      description: This can be used to check on the status of all child Patient Chart Import Requests.
      operationId: getDIR
      responses:
        '200':
          description: Details of the Data Import Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExistingDataImportRequest'
        '401':
          description: No valid credentials provided
        '403':
          description: Your credentials are not authorized to use the import API resources
        '404':
          description: Existing Data Import Request not found
      security:
      - elation_auth:
        - import
    put:
      tags:
      - Data Import Request
      summary: Update an existing data import request
      description: All editable fields must be included even if the value is unchanged.
      operationId: updateDIR
      responses:
        '200':
          description: Details of the updated Data Import Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExistingDataImportRequest'
        '400':
          description: Validation error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: No valid credentials provided
        '403':
          description: Your credentials are not authorized to use the import API resources
        '404':
          description: Existing Data Import Request not found
        '422':
          description: The request body could not be parsed as JSON
      security:
      - elation_auth:
        - import
      requestBody:
        $ref: '#/components/requestBodies/ExistingDataImportRequest'
    patch:
      tags:
      - Data Import Request
      summary: Update an existing data import request
      description: Only include fields where the value is changing.
      operationId: patchDIR
      responses:
        '400':
          description: Validation error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: No valid credentials provided
        '403':
          description: Your credentials are not authorized to use the import API resources
        '404':
          description: Existing Data Import Request not found
        '422':
          description: The request body could not be parsed as JSON
      security:
      - elation_auth:
        - import
      requestBody:
        $ref: '#/components/requestBodies/ExistingDataImportRequest'
    delete:
      tags:
      - Data Import Request
      summary: Delete an existing data import request
      description: Only possible if no Patient Chart Import Requests have ever been created for this Data Import Request.
      operationId: deleteDIR
      responses:
        '401':
          description: No valid credentials provided
        '403':
          description: The Data Import Request cannot be deleted because child records already exist; or your credentials are not authorized to use the import API resources
        '404':
          description: Existing Data Import Request not found
      security:
      - elation_auth:
        - import
  /data-import-requests/{dir-id}/run:
    parameters:
    - in: path
      name: dir-id
      required: true
      schema:
        type: integer
        format: int64
      description: The id of the existing Data Import Request
    post:
      tags:
      - Data Import Request
      summary: Convenience call
      description: Convenience call to transition all child Patient Chart Import Requests in `open` to `pending`
      operationId: runDIR
      responses:
        '202':
          description: Request accepted; Patient Chart Import Requests will be updated
        '401':
          description: No valid credentials provided
        '403':
          description: Your credentials are not authorized to use the import API resources
      security:
      - elation_auth:
        - import
components:
  schemas:
    JobStatus:
      type: string
      default: open
      description: The current status of the patient chart import. Options are open, pending, processing, failed, completed
      enum:
      - open
      - pending
      - processing
      - failed
      - completed
    CreateDataImportRequest:
      required:
      - physician_id
      - practice_id
      - sections_to_import
      allOf:
      - $ref: '#/components/schemas/BaseDataImportRequest'
      - type: object
      properties:
        physician_id:
          type: integer
          format: int64
          description: The id of the physician provider to import all child patient charts for; cannot be updated after initial create
        practice_id:
          type: integer
          format: int64
          description: The id of the practice to import all child patient charts for; cannot be updated after initial create
    ValidationErrorResponse:
      type: object
      additionalProperties:
        description: Name of the field with validation errors
        type: array
        items:
          type: string
          description: Validation error string
    DataImportRequestArray:
      type: array
      items:
        $ref: '#/components/schemas/ExistingDataImportRequestWithoutStatus'
    BaseDataImportRequest:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
          description: The id of the Data Import Request
        created_at:
          type: string
          format: date-time
          readOnly: true
          description: The creation timestamp for the Data Import Request
        notes:
          type: string
          description: Arbitrary notes to associate with the Data Import Request
    ExistingDataImportRequestWithoutStatus:
      required:
      - id
      - created_at
      - physician_id
      - practice_id
      - sections_to_import
      allOf:
      - $ref: '#/components/schemas/BaseDataImportRequest'
      - type: object
      properties:
        physician_id:
          type: integer
          format: int64
          readOnly: true
          description: The id of the physician provider to import all child patient charts for; cannot be updated after initial create
        practice_id:
          type: integer
          format: int64
          readOnly: true
          description: The id of the practice to import all child patient charts for; cannot be updated after initial create
    ExistingDataImportRequest:
      required:
      - id
      - created_at
      - physician_id
      - practice_id
      - sections_to_import
      - status
      allOf:
      - $ref: '#/components/schemas/ExistingDataImportRequestWithoutStatus'
      - type: object
      properties:
        status:
          type: array
          readOnly: true
          items:
            type: object
            properties:
              importStatus:
                $ref: '#/components/schemas/JobStatus'
              numPatientImports:
                type: integer
                format: int32
                description: The number of child Patient Chart Import Requests in the associated status
  requestBodies:
    ExistingDataImportRequest:
      description: Data Import Request object
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ExistingDataImportRequest'
    CreateDataImportRequest:
      description: Data Import Request object
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateDataImportRequest'
  securitySchemes:
    elation_auth:
      type: oauth2
      flows:
        password:
          tokenUrl: http://www.elationhealth.com/api/2.0/oauth
          refreshUrl: http://www.elationhealth.com/api/2.0/oauth
          scopes:
            import: interact with data imports in your practice
externalDocs:
  description: Elation API v2 Documentation
  url: https://docs.elationhealth.com/reference