Elation Health patient chart import API

The patient chart import API from Elation Health — 3 operation(s) for patient chart import.

Documentation GitHub OpenAPI

Business capability

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/{dir-id}/patient-chart-imports List chart imports by status · Finds patient_chart_import records by status #

Ask an LLM

“Which patient chart imports in a data import request are still pending?”

“Can I filter chart imports by several statuses at once?”

Tell an agent

List chart imports in data import request {dir-id} with status {status}.

Show every chart import under request {dir-id}.

POST /data-import-requests/{dir-id}/patient-chart-imports Add a patient chart to an import request · Add a new patient-chart-import to the associated data import request #

Ask an LLM

“How do I load a patient's chart JSON into a data import request?”

“Can I tag an imported chart with the patient id from the source system?”

Tell an agent

Add chart {chart_json} with status {status} to import request {dir-id}.

Import source patient {source_patient_id}'s chart into request {dir-id}.

GET /data-import-requests/{dir-id}/patient-chart-imports/{pci-id} Get one patient chart import · Find patient-chart-import by ID #

Ask an LLM

“How do I check the state of one chart import?”

“What does a single patient-chart-import record return?”

Tell an agent

Get chart import {pci-id} in request {dir-id}.

Show the status of patient chart import {pci-id} under {dir-id}.

PUT /data-import-requests/{dir-id}/patient-chart-imports/{pci-id} Replace a patient chart import · Update an existing patient-chart-import #

Ask an LLM

“Can I resend the full chart JSON for an import that already exists?”

“How do I link an imported chart to an existing patient?”

Tell an agent

Replace chart import {pci-id} in request {dir-id} with chart {chart_json} and status {status}.

Link chart import {pci-id} under {dir-id} to patient {patient_id}.

PATCH /data-import-requests/{dir-id}/patient-chart-imports/{pci-id} Change a chart import's status with form data · Updates a patient-chart-import in the store with form data #

Ask an LLM

“Can I update only the status of a chart import using form data?”

“How do I rename a chart import without resending its JSON?”

Tell an agent

Set the status of chart import {pci-id} in {dir-id} to {status}.

Rename chart import {pci-id} under {dir-id} to {name}.

DELETE /data-import-requests/{dir-id}/patient-chart-imports/{pci-id} Delete a patient chart import · Deletes a patient-chart-import #

Ask an LLM

“How do I drop a chart from a data import request?”

“Can a bad chart import be deleted before it is processed?”

Tell an agent destructive · confirm first

Delete chart import {pci-id} from request {dir-id}.

Remove patient chart import {pci-id} under import request {dir-id}.

POST /data-import-requests/{dir-id}/patient-chart-imports/{pci-id}/render-requests Upload a document for rendering · uploads an document for rendering #

Ask an LLM

“How do I upload a document to be rendered as part of a chart import?”

“Can I attach extra metadata when uploading a file for rendering?”

Tell an agent

Upload {file} for rendering on chart import {pci-id} in request {dir-id}.

Send a render request for chart import {pci-id} under {dir-id} with metadata {additionalMetadata}.

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-patient-chart-import-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

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 patient chart import 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: patient chart import
paths:
  /data-import-requests/{dir-id}/patient-chart-imports:
    parameters:
    - name: dir-id
      in: path
      description: ID of the data-import-request
      required: true
      schema:
        type: integer
    get:
      tags:
      - patient chart import
      summary: Finds patient_chart_import records by status
      description: Multiple status values can be provided with comma separated strings
      operationId: findchartsByStatus
      parameters:
      - name: status
        in: query
        description: Status values that need to be considered for filter
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            default: open
            enum:
            - open
            - pending
            - processing
            - failed
            - completed
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PatientChartInputGetList'
              example:
              - id: 10
                patientId: 11
                dataImportRequestId: 12
                completedAt: 12341234123
                errors: null
                sectionStatus: []
                status: open
                startedProcessingAt: null
        '400':
          description: Invalid status value
          content: {}
        '401':
          description: No valid credentials provided
        '403':
          description: Your credentials are not authorized to use the import API resources
        '404':
          description: Data Import Request not found
      security:
      - elation_auth:
        - import
    post:
      tags:
      - patient chart import
      summary: Add a new patient-chart-import to the associated data import request
      operationId: addchart
      requestBody:
        description: patient-chart-import object that needs to be added to the DIR
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatientChartInputPost'
        required: true
      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
  /data-import-requests/{dir-id}/patient-chart-imports/{pci-id}:
    parameters:
    - name: dir-id
      in: path
      description: ID of the data-import-request
      required: true
      schema:
        type: integer
        format: int64
    - name: pci-id
      in: path
      description: ID of patient-chart-import to return
      required: true
      schema:
        type: integer
        format: int64
    get:
      tags:
      - patient chart import
      summary: Find patient-chart-import by ID
      description: Returns a single patient-chart-import
      operationId: getPatientChartImportById
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientChartInputGetId'
        '401':
          description: No valid credentials provided
        '403':
          description: Your credentials are not authorized to use the import API resources
        '404':
          description: Data Import Request or Patient Chart Import not found
          content: {}
      security:
      - elation_auth:
        - import
    put:
      tags:
      - patient chart import
      summary: Update an existing patient-chart-import
      operationId: updatepatient-chart-import
      requestBody:
        description: patient-chart-import object that needs to be added to the DIR
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatientChartInputPut'
        required: true
      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: Data Import Request or Patient Chart Import not found
          content: {}
        '422':
          description: The request body could not be parsed as JSON
      security:
      - elation_auth:
        - import
    patch:
      tags:
      - patient chart import
      summary: Updates a patient-chart-import in the store with form data
      operationId: updatepatient-chart-importWithForm
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  description: Updated name of the patient-chart-import
                status:
                  $ref: '#/components/schemas/JobStatus'
      responses:
        '400':
          description: Validation error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '405':
          description: Invalid input
          content: {}
      security:
      - elation_auth:
        - import
    delete:
      tags:
      - patient chart import
      summary: Deletes a patient-chart-import
      operationId: deletepatient-chart-import
      responses:
        '401':
          description: No valid credentials provided
        '403':
          description: Patient Chart Import is in a state where it cannot be deleted; or your credentials are not authorized to use the import API resources
        '404':
          description: Data Import Request or Patient Chart Import not found
          content: {}
      security:
      - elation_auth:
        - import
  /data-import-requests/{dir-id}/patient-chart-imports/{pci-id}/render-requests:
    parameters:
    - name: dir-id
      in: path
      description: ID of data-import-request to update
      required: true
      schema:
        type: integer
        format: int64
    - name: pci-id
      in: path
      description: ID of patient-chart-import to update
      required: true
      schema:
        type: integer
        format: int64
    post:
      tags:
      - patient chart import
      summary: uploads an document for rendering
      operationId: uploadFile
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                additionalMetadata:
                  type: string
                  description: Additional data to pass to server
                file:
                  type: string
                  description: file to upload
                  format: binary
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        '400':
          description: Validation error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '404':
          description: Data Import Request or Patient Chart Import not found
          content: {}
      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
    ApiResponse:
      type: object
      properties:
        code:
          type: integer
          format: int32
        type:
          type: string
        message:
          type: string
    PatientChartInputPut:
      required:
      - chart_json
      - status
      type: object
      properties:
        patient_id:
          type: integer
          format: int64
          description: read-only, Only set after import has occurred
        chart_json:
          $ref: '#/components/schemas/ChartBuilderJson'
        status:
          $ref: '#/components/schemas/JobStatus'
    ValidationErrorResponse:
      type: object
      additionalProperties:
        description: Name of the field with validation errors
        type: array
        items:
          type: string
          description: Validation error string
    ChartBuilderJson:
      description: contains JSON schema that describes the json that chart_builder.py consumes to create chart. Schemas are uploaded to a public s3 endpoint that is backing http://data-import.elationemr.com. The files are stored in the /spec/ folder.
      type: object
    PatientChartInputPost:
      required:
      - chart_json
      - status
      type: object
      properties:
        source_patient_id:
          type: string
          description: a patient key, normally (fname|lname|dob|gender)
        chart_json:
          $ref: '#/components/schemas/ChartBuilderJson'
        status:
          $ref: '#/components/schemas/JobStatus'
    PatientChartInputGetId:
      allOf:
      - $ref: '#/components/schemas/PatientChartInputGetList'
      - type: object
      properties:
        chart_json:
          $ref: '#/components/schemas/ChartBuilderJson'
    PatientChartInputGetList:
      required:
      - chart_json
      - status
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: read-only
        patient_id:
          type: integer
          format: int64
          description: read-only, Only set after import has occurred
        data_import_request_id:
          type: integer
          format: int64
          description: read-only after initial creation
        completed_at:
          type: integer
          format: date-time
          description: unix UTC timestamp
        errors:
          type: array
          items:
            type: object
            format: json
            description: List of field/message tuples describing the issues with the latest attempt to import the associated chart_json
        section_status:
          type: object
          description: TBD.  Some object that indicates which sections of the chart were successfully imported and which failed.
        status:
          $ref: '#/components/schemas/JobStatus'
        started_processing_at:
          type: string
          format: date-time
          description: (iso8601) datetime. read-only
  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

Elation Health patient chart import API

Operations 7

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification