Elation Health

Elation Health Incoming Files API

The Incoming Files API from Elation Health — 8 operation(s) for incoming files.

GitHub OpenAPI

Operations 9

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 /incoming_files/ Find incoming faxes and files (legacy endpoint) · Find incoming files #
Ask an LLM
“Which faxes came in from a particular number, according to the legacy search?”
“Can I find incoming files still waiting to be processed with the older lookup?”
Tell an agent
Using the legacy lookup, find incoming files from number {from_number}.
Find old-path incoming files in process state {process_state} received after {received_date__gte}.
GET /incoming_files/{id} Get an incoming file (legacy endpoint) · Get incoming file #
Ask an LLM
“Can I open one incoming fax record on the legacy path?”
“Does the older incoming file lookup show its processing state?”
Tell an agent
Open incoming file {id} using the legacy endpoint.
Show the processing state of old-path incoming file {id}.
POST /incoming_files Upload an incoming file group (legacy endpoint) · Create Incoming Files #
Ask an LLM
“How do I push scanned documents into a practice's inbox through the legacy endpoint?”
“Can I upload images and files together as one group the old way?”
Tell an agent
Via the legacy endpoint, upload file group {group_name} to practice {practice}.
Send old-path incoming files {files} as group {group_name} for practice {practice}.
GET /api/2.0/incoming_files/ List incoming files in API 2.0 · List Incoming Files #
Ask an LLM
“How do I list incoming faxes received on a specific practice fax line in API 2.0?”
“Can API 2.0 show incoming files received within a time window?”
Tell an agent
List 2.0 incoming files on practice fax {practice_fax}.
List API 2.0 incoming files received between {received_time__gte} and {received_time__lte}.
POST /api/2.0/incoming_files/ Create an incoming file group in API 2.0 · Create Incoming File #
Ask an LLM
“How do I record an inbound fax with its sender number in the 2.0 API?”
“Can I include page count and subject when creating an incoming file?”
Tell an agent
In API 2.0, create incoming file group {group_name} for practice {practice}.
Record a 2.0 inbound fax {group_name} for practice {practice} from {from_number} with subject {subject}.
GET /api/2.0/incoming_files/{file_group_id}/files/{file_id}/ Download a file from an incoming file group · Retrieve Incoming Files File #
Ask an LLM
“How do I download one document out of an incoming fax group?”
“Can I get a specific file attached to an incoming file group?”
Tell an agent
Download file {file_id} from incoming group {file_group_id}.
Fetch document {file_id} out of fax group {file_group_id}.
GET /api/2.0/incoming_files/{file_group_id}/images/{image_id}/ Get a page image from an incoming file group · Retrieve Incoming Files Image #
Ask an LLM
“Can I view a page image from an incoming fax at a chosen size?”
“How do I pull a thumbnail of one image in an incoming file group?”
Tell an agent
Get image {image_id} from incoming group {file_group_id}.
Show image {image_id} of fax group {file_group_id} at size {size}.
GET /api/2.0/incoming_files/{id}/ Retrieve an incoming file group in API 2.0 · Retrieve Incoming File #
Ask an LLM
“How do I retrieve one incoming file group by ID in API 2.0?”
“Does a 2.0 incoming file show the fax sender and page count?”
Tell an agent
Retrieve API 2.0 incoming file {id}.
Get the sender and page count of 2.0 incoming file {id}.
POST /api/2.0/patients/{id}/incoming_files/ File a document into a patient's chart · Create a new incoming file #
Ask an LLM
“How do I attach an outside document directly to a patient's chart?”
“Can I flag an uploaded patient document as urgent and assign a reviewer?”
Tell an agent
Upload {files} to patient {id}'s chart as a {document_type} document.
File a {document_type} for patient {id} titled {custom_title}, urgent {urgent}, for review by {reviewer_user}.

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-incoming-files-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/json-schema/elation-health-incoming-file-group-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/json-schema/elation-health-paginated-incoming-file-group-list-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-incoming-files-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-incoming-files-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Elation Health Incoming Files API
  version: '1.0'
  description: 'Operations tagged Incoming Files across 2 of this provider''s published API definitions: elation-api-settings.json, elation-health-api-full-openapi.yaml. 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: Incoming Files
paths:
  /incoming_files/:
    get:
      summary: Find incoming files
      description: ''
      operationId: find-incoming-files
      parameters:
      - name: practice
        in: query
        schema:
          type: integer
          format: int32
      - name: practice_fax
        in: query
        schema:
          type: string
      - name: from_number
        in: query
        schema:
          type: string
      - name: created_date__lte
        in: query
        schema:
          type: string
          format: date
      - name: created_date__gte
        in: query
        schema:
          type: string
          format: date
      - name: received_date__lte
        in: query
        schema:
          type: string
          format: date
      - name: received_date__gte
        in: query
        schema:
          type: string
          format: date
      - name: process_state
        in: query
        description: The current processing state of the file. Choices = complete, error, processing
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"count\": 6,\n    \"next\": null,\n    \"previous\": null,\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/incomig_files/\",\n                    headers={'Authorization': auth_header})\n\nprint resp.status_code\nprint json.dumps(json.loads(resp.content), indent=2)"
        samples-languages:
        - python
      tags:
      - Incoming Files
      security:
      - sec0: []
    servers:
    - url: https://sandbox.elationemr.com/api/2.0
  /incoming_files/{id}:
    get:
      summary: Get incoming file
      description: ''
      operationId: get-ingoming-file
      parameters:
      - name: id
        in: path
        schema:
          type: integer
          format: int64
        required: true
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"id\": 140758830874783,\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/incoming_files/140758830874783/\",\n                    headers={'Authorization': auth_header})\n\nprint resp.status_code\nprint json.dumps(json.loads(resp.content), indent=2)"
        samples-languages:
        - python
      tags:
      - Incoming Files
      security:
      - sec0: []
    servers:
    - url: https://sandbox.elationemr.com/api/2.0
  /incoming_files:
    post:
      summary: Create Incoming Files
      description: ''
      operationId: create-incoming-files
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - practice
              - group_name
              properties:
                practice:
                  type: integer
                  format: int32
                group_name:
                  type: string
                  description: Name of the incoming file group
                images:
                  type: array
                  description: List of Images in base64 to upload
                files:
                  type: array
                  description: List of Files in base64 to upload
      responses:
        '201':
          description: '201'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n\t// see incoming file object\n}"
              schema:
                type: object
                properties: {}
        '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\ndata = {\n  \"practice\": 12345678,\n  \"group_name\": \"my group name\",\n  \"images\": [\n  \t{\n    \t\"content_type\": \"application/pdf\",  #  required\n      \"base64_content\": \"iVBORw0KGgo==\"  #  required\n    }\n  ],\n  \"files\": [\n  \t{\n    \t\"base64_content\": \"ImNvdW50KCopIgoy==\",  #  required\n      \"content_type\": \"plain/txt\",  #  required\n      \"filename\": \"my_file.txt\"  #  required\n    }\n  ]\n}"
        samples-languages:
        - python
      tags:
      - Incoming Files
      security:
      - sec0: []
    servers:
    - url: https://sandbox.elationemr.com/api/2.0
  /api/2.0/incoming_files/:
    get:
      operationId: incoming_files_list
      parameters:
      - in: query
        name: created_date__gte
        schema:
          format: date-time
          type: string
      - in: query
        name: created_date__lte
        schema:
          format: date-time
          type: string
      - in: query
        name: from_number
        schema:
          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: practice
        schema:
          items:
            format: int64
            type: integer
          type: array
        style: form
      - in: query
        name: practice_fax
        schema:
          type: string
      - description: '* `complete` - complete

          * `error` - error

          * `processing` - processing'
        in: query
        name: process_state
        schema:
          enum:
          - complete
          - error
          - processing
          type: string
      - in: query
        name: received_time__gte
        schema:
          format: date-time
          type: string
      - in: query
        name: received_time__lte
        schema:
          format: date-time
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedIncomingFileGroupList'
          description: ''
      security:
      - oauth2: []
      summary: List Incoming Files
      tags:
      - Incoming Files
      x-el8-docs-category: Patient Document API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    post:
      description: Create a new incoming file.
      operationId: incoming_files_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncomingFileGroup'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomingFileGroup'
          description: ''
      security:
      - oauth2: []
      summary: Create Incoming File
      tags:
      - Incoming Files
      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/incoming_files/{file_group_id}/files/{file_id}/:
    get:
      operationId: incoming_files_files_retrieve
      parameters:
      - in: path
        name: file_group_id
        required: true
        schema:
          pattern: ^[0-9]+$
          type: string
      - in: path
        name: file_id
        required: true
        schema:
          pattern: ^[0-9]+$
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomingFileGroup'
          description: ''
      security:
      - oauth2: []
      summary: Retrieve Incoming Files File
      tags:
      - Incoming Files
      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/incoming_files/{file_group_id}/images/{image_id}/:
    get:
      operationId: incoming_files_images_retrieve
      parameters:
      - in: path
        name: file_group_id
        required: true
        schema:
          pattern: ^[0-9]+$
          type: string
      - in: path
        name: image_id
        required: true
        schema:
          pattern: ^[0-9]+$
          type: string
      - description: The size of the image to retrieve (default is 'preview').
        in: query
        name: size
        schema:
          default: preview
          enum:
          - preview
          - print
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomingFileGroup'
          description: ''
      security:
      - oauth2: []
      summary: Retrieve Incoming Files Image
      tags:
      - Incoming Files
      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/incoming_files/{id}/:
    get:
      operationId: incoming_files_retrieve
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomingFileGroup'
          description: ''
      security:
      - oauth2: []
      summary: Retrieve Incoming File
      tags:
      - Incoming Files
      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/patients/{id}/incoming_files/:
    post:
      description: Create a new incoming file for a patient
      operationId: patients_incoming_files_create
      parameters:
      - description: The ID of the patient
        in: path
        name: id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              properties:
                custom_title:
                  description: Custom title for the document
                  type: string
                document_date:
                  description: Document date (defaults to current datetime)
                  format: date-time
                  type: string
                document_tags:
                  description: Array of document tags
                  items:
                    type: string
                  type: array
                document_type:
                  description: Type of document (cannot be 'Lab')
                  type: string
                files:
                  description: Array of file IDs
                  items:
                    type: integer
                  type: array
                import_history:
                  default: false
                  description: Whether to import history
                  type: boolean
                reviewer_user:
                  description: User ID of the reviewer
                  type: integer
                sign_off:
                  default: false
                  description: Whether to sign off the document
                  type: boolean
                urgent:
                  default: false
                  description: Whether the document is urgent
                  type: boolean
              required:
              - files
              - document_type
              type: object
      responses:
        '201':
          description: No response body
      security:
      - oauth2: []
      summary: Create a new incoming file
      tags:
      - Incoming Files
      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
components:
  schemas:
    IncomingFileGroup:
      properties:
        created_date:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        external_fax_id:
          type:
          - string
          - 'null'
        file_size:
          readOnly: true
          type:
          - integer
          - 'null'
        files:
          items:
            $ref: '#/components/schemas/File'
          type:
          - array
          - 'null'
        from_number:
          readOnly: true
          type:
          - string
          - 'null'
        group_name:
          maxLength: 200
          type: string
        id:
          readOnly: true
          type: integer
        images:
          items:
            $ref: '#/components/schemas/Image'
          type:
          - array
          - 'null'
        page_count:
          readOnly: true
          type:
          - integer
          - 'null'
        practice:
          format: int64
          type: integer
        practice_fax:
          type:
          - string
          - 'null'
        process_complete_time:
          format: date-time
          type:
          - string
          - 'null'
        process_result:
          readOnly: true
          type:
          - string
          - 'null'
        process_start_time:
          format: date-time
          type:
          - string
          - 'null'
        process_state:
          allOf:
          - $ref: '#/components/schemas/ProcessStateEnum'
          readOnly: true
        received_time:
          format: date-time
          type:
          - string
          - 'null'
        source:
          allOf:
          - $ref: '#/components/schemas/SourceEnum'
          readOnly: true
        subject:
          readOnly: true
          type:
          - string
          - 'null'
        to_company:
          readOnly: true
          type:
          - string
          - 'null'
        to_name:
          readOnly: true
          type:
          - string
          - 'null'
        to_number:
          readOnly: true
          type:
          - string
          - 'null'
        transmit_time:
          format: date-time
          type:
          - string
          - 'null'
      required:
      - group_name
      - practice
      type: object
    ProcessStateEnum:
      enum:
      - complete
      - error
      - pending
      - processing
      type: string
    File:
      properties:
        base64_content:
          type: string
          writeOnly: true
        content_type:
          maxLength: 200
          type: string
        created_date:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        deleted_date:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        file_size:
          readOnly: true
          type:
          - integer
          - 'null'
        file_url:
          readOnly: true
          type: string
        filename:
          type: string
        id:
          readOnly: true
          type: integer
        incoming_file:
          type: integer
        practice:
          format: int64
          type:
          - integer
          - 'null'
      required:
      - base64_content
      - content_type
      - filename
      type: object
    Image:
      properties:
        base64_content:
          type: string
          writeOnly: true
        content_type:
          type: string
          writeOnly: true
        created_date:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        deleted_date:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        file_size:
          readOnly: true
          type:
          - integer
          - 'null'
        height:
          readOnly: true
          type:
          - integer
          - 'null'
        id:
          readOnly: true
          type: integer
        image_url:
          readOnly: true
          type: string
        incoming_file:
          type: integer
        original_extension:
          maxLength: 10
          type: string
        original_height:
          type: integer
        original_padded:
          type: integer
        original_rotation:
          type: integer
        original_width:
          type: integer
        practice:
          format: int64
          type:
          - integer
          - 'null'
        quality_score:
          readOnly: true
          type:
          - integer
          - 'null'
        quality_score_by:
          readOnly: true
          type:
          - integer
          - 'null'
        received_date:
          format: date-time
          type: string
        rotation:
          readOnly: true
          type: integer
        sequence:
          readOnly: true
          type:
          - integer
          - 'null'
        width:
          readOnly: true
          type:
          - integer
          - 'null'
      required:
      - base64_content
      - content_type
      type: object
    SourceEnum:
      enum:
      - metrofax
      - plr
      - refile
      - softlinx
      - user
      type: string
    PaginatedIncomingFileGroupList:
      properties:
        count:
          example: 123
          type: integer
        next:
          example: http://api.example.org/accounts/?offset=400&limit=100
          format: uri
          nullable: true
          type: string
        previous:
          example: http://api.example.org/accounts/?offset=200&limit=100
          format: uri
          nullable: true
          type: string
        results:
          items:
            $ref: '#/components/schemas/IncomingFileGroup'
          type: array
      required:
      - results
      type: object
  securitySchemes:
    sec0:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://example.com/oauth2/token
          scopes: {}
    oauth2:
      flows:
        clientCredentials:
          scopes:
            act_as_user: Impersonate a provider via X-On-Behalf-Of (combinable with apiv2 or system scopes)
            apiv2: Full access to the API
            system/{resource_name}.read: Read access to a specific resource
            system/{resource_name}.write: Write access to a specific resource
          tokenUrl: /api/2.0/oauth2/token/
      type: oauth2
x-refined-from:
- elation-api-settings.json
- elation-health-api-full-openapi.yaml
x-readme:
  headers: []
x-readme-fauxas: true