Elation Health

Elation Health Caregaps API

The Caregaps API from Elation Health — 2 operation(s) for caregaps.

GitHub OpenAPI
Business capability
Risk Stratification & Identification BC-2880.10

Operations 5

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 /caregaps/api/{quality_program}/caregap/ List care gaps in a quality program · Retrieve a list of existing caregap #
Ask an LLM
“Which patients have open care gaps in a quality program?”
“Can I filter care gaps by status or the date they were closed?”
Tell an agent
List care gaps in quality program {quality_program}.
List care gaps in {quality_program} for patient {patient_id} with status {status}.
POST /caregaps/api/{quality_program}/caregap/ Open a care gap for a patient · Create a new caregap #
Ask an LLM
“How do I open a new care gap for a patient under a quality measure?”
“What do I need to create a care gap in Elation?”
Tell an agent
Create a care gap in {quality_program} for patient {patient_id}, practice {practice_id}, definition {definition_id}, {status}, {created_date}.
Open gap {definition_id} in {quality_program} for {patient_id}, practice {practice_id}, {status}, {created_date}, detail {detail}.
GET /caregaps/api/{quality_program}/caregap/{caregap_id}/ Get one care gap · Retrieve an existing caregap #
Ask an LLM
“Can I look up the details of a specific care gap?”
“Who closed a particular care gap and when?”
Tell an agent
Get care gap {caregap_id} in quality program {quality_program}.
Show care gap {caregap_id} from {quality_program} for practice {practice_id}.
DELETE /caregaps/api/{quality_program}/caregap/{caregap_id}/ Delete a care gap · Delete an existing caregap #
Ask an LLM
“How do I delete a care gap that was opened in error?”
“Can I remove a care gap from a quality program entirely?”
Tell an agent destructive · confirm first
Delete care gap {caregap_id} in {quality_program}.
Remove erroneous gap {caregap_id} from program {quality_program} for practice {practice_id}.
PATCH /caregaps/api/{quality_program}/caregap/{caregap_id}/ Close or reopen a care gap · Modifies an existing caregap's closed status #
Ask an LLM
“How do I mark a care gap as closed once the patient gets the screening?”
“Can I change a care gap's closed status?”
Tell an agent
Set care gap {caregap_id} in {quality_program} to status {status}.
Close care gap {caregap_id} in program {quality_program} by setting {status}.

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/json-schema/elation-health-caregap-api-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/json-schema/elation-health-caregap-apimodel-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/json-schema/elation-health-caregap-apipaginated-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/json-schema/elation-health-caregap-patch-api-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-caregaps-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-caregaps-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Care Gaps Caregaps API
  description: This API supports the management of definitions, gaps, and webhook notifications.
  version: 0.0.1
servers:
- url: https://caregaps.sandbox.elationemr.com/
  description: CareGaps API - Sandbox Environment
tags:
- name: Caregaps
paths:
  /caregaps/api/{quality_program}/caregap/:
    get:
      tags:
      - Caregaps
      summary: Retrieve a list of existing caregap
      description: Retrieve a list of Care Gaps with filters specified by query parameters.
      operationId: caregaps_list_caregaps_api__quality_program__caregap__get
      parameters:
      - required: true
        schema:
          title: Quality Program
          type: string
        name: quality_program
        in: path
      - required: false
        schema:
          title: Practice Id
          type: string
        name: practice_id
        in: query
      - required: false
        schema:
          title: Page Size
          maximum: 50
          minimum: 1
          type: integer
          default: 5
        name: page_size
        in: query
      - required: false
        schema:
          title: Cursor
          type: string
        name: cursor
        in: query
      - required: false
        schema:
          title: Patient Id
          type: string
        name: patient_id
        in: query
      - required: false
        schema:
          title: Definition Id
          type: string
        name: definition_id
        in: query
      - required: false
        schema:
          $ref: '#/components/schemas/StatusEnum'
        name: status
        in: query
      - required: false
        schema:
          title: Closed Date Begin
          type: string
          format: date
        name: closed_date_begin
        in: query
      - required: false
        schema:
          title: Closed Date End
          type: string
          format: date
        name: closed_date_end
        in: query
      requestBody:
        content:
          application/json:
            schema:
              title: Closing Code
              type: array
              items:
                type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaregapAPIPaginatedResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer: []
    post:
      tags:
      - Caregaps
      summary: Create a new caregap
      description: Create a new caregap.
      operationId: caregaps_post_caregaps_api__quality_program__caregap__post
      parameters:
      - required: true
        schema:
          title: Quality Program
          type: string
        name: quality_program
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CaregapAPIModel'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaregapAPI'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer: []
  /caregaps/api/{quality_program}/caregap/{caregap_id}/:
    get:
      tags:
      - Caregaps
      summary: Retrieve an existing caregap
      description: Retrieve a specific Care Gap.
      operationId: caregaps_get_caregaps_api__quality_program__caregap__caregap_id___get
      parameters:
      - required: true
        schema:
          title: Quality Program
          type: string
        name: quality_program
        in: path
      - required: true
        schema:
          title: Caregap Id
          type: string
        name: caregap_id
        in: path
      - required: false
        schema:
          title: Practice Id
          type: string
        name: practice_id
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaregapAPI'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer: []
    delete:
      tags:
      - Caregaps
      summary: Delete an existing caregap
      description: Delete a specific Care Gap.
      operationId: caregaps_delete_caregaps_api__quality_program__caregap__caregap_id___delete
      parameters:
      - required: true
        schema:
          title: Quality Program
          type: string
        name: quality_program
        in: path
      - required: true
        schema:
          title: Caregap Id
          type: string
        name: caregap_id
        in: path
      - required: false
        schema:
          title: Practice Id
          type: string
        name: practice_id
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer: []
    patch:
      tags:
      - Caregaps
      summary: Modifies an existing caregap's closed status
      operationId: caregaps_modify_caregaps_api__quality_program__caregap__caregap_id___patch
      parameters:
      - required: true
        schema:
          title: Quality Program
          type: string
        name: quality_program
        in: path
      - required: true
        schema:
          title: Caregap Id
          type: string
        name: caregap_id
        in: path
      - required: false
        schema:
          title: Practice Id
          type: string
        name: practice_id
        in: query
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CaregapPatchAPI'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaregapAPI'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer: []
components:
  schemas:
    CaregapAPIModel:
      title: CaregapAPIModel
      required:
      - definition_id
      - patient_id
      - practice_id
      - created_date
      - status
      type: object
      properties:
        definition_id:
          title: Definition Id
          type: string
          description: Definition id this caregap is associated with.
        patient_id:
          title: Patient Id
          type: string
          description: Patient id this caregap is associated with.
        practice_id:
          title: Practice Id
          type: string
          description: Practice id this caregap is associated with.
        created_date:
          title: Created Date
          type: string
          description: ISO timestamp for when this caregap was created.
          format: date
        status:
          allOf:
          - $ref: '#/components/schemas/StatusEnum'
          description: Current status of the caregap
        detail:
          title: Detail
          type: string
          description: Extra detail about the caregap.
        closed_date:
          title: Closed Date
          type: string
          description: ISO timestamp for when the caregap was closed.
          format: date
        closed_by:
          allOf:
          - $ref: '#/components/schemas/ClosedByEnum'
          description: Who or what action closed the caregap.
    ValidationError:
      title: ValidationError
      required:
      - loc
      - msg
      - type
      type: object
      properties:
        loc:
          title: Location
          type: array
          items:
            type: string
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
    StatusEnum:
      title: StatusEnum
      enum:
      - open
      - closed
      type: string
      description: An enumeration.
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    ClosedByEnum:
      title: ClosedByEnum
      enum:
      - API
      - condition-saved
      - feedback
      type: string
      description: An enumeration.
    CaregapPatchAPI:
      title: CaregapPatchAPI
      required:
      - status
      type: object
      properties:
        status:
          allOf:
          - $ref: '#/components/schemas/StatusEnum'
          description: Current status of the caregap
    CaregapAPIPaginatedResponse:
      title: CaregapAPIPaginatedResponse
      required:
      - results
      type: object
      properties:
        results:
          title: Results
          type: array
          items:
            $ref: '#/components/schemas/CaregapAPI'
          description: Page of results requested
        cursor:
          title: Cursor
          type: string
          description: Cursor to query for the next page
        next_page_url:
          title: Next Page Url
          type: string
          description: Full URL to query for the next page
    CaregapAPI:
      title: CaregapAPI
      required:
      - definition_id
      - patient_id
      - practice_id
      - created_date
      - status
      - id
      - quality_program
      type: object
      properties:
        definition_id:
          title: Definition Id
          type: string
          description: Definition id this caregap is associated with.
        patient_id:
          title: Patient Id
          type: string
          description: Patient id this caregap is associated with.
        practice_id:
          title: Practice Id
          type: string
          description: Practice id this caregap is associated with.
        created_date:
          title: Created Date
          type: string
          description: ISO timestamp for when this caregap was created.
          format: date
        status:
          allOf:
          - $ref: '#/components/schemas/StatusEnum'
          description: Current status of the caregap
        detail:
          title: Detail
          type: string
          description: Extra detail about the caregap.
        closed_date:
          title: Closed Date
          type: string
          description: ISO timestamp for when the caregap was closed.
          format: date
        closed_by:
          allOf:
          - $ref: '#/components/schemas/ClosedByEnum'
          description: Who or what action closed the caregap.
        id:
          title: Id
          type: string
          description: UUID to identify the caregap
        quality_program:
          title: Quality Program
          type: string
          description: Quality program this caregap is associated with.
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: token