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 Care Gaps API

Retrieve care gap definitions and quality-program care-gap data for value-based care workflows. Served from a dedicated care-gaps service host.

Elation Care Gaps 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 Care Gaps, Value-Based Care, Quality, and Healthcare. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 9 operations across 4 paths, organized into 2 resource areas, and defines 35 schemas. It is described by OpenAPI 3.0.2, at version 0.0.1.

Requests are made against a single base URL, https://caregaps.sandbox.elationemr.com/.

9 operations 4 paths 35 schemas 2 DELETE4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
0.0.1
Base URL
https://caregaps.sandbox.elationemr.com
Authentication
OAuth 2.0
Resource Areas
2

Authentication & Security 1

Elation Care Gaps API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2PasswordBearer) using the password flow.

Paths & Operations 9

Across 4 paths, the API surfaces 9 operations — 2 DELETE, 4 GET, 1 PATCH, 2 POST. They span 2 resource areas: Definitions, Caregaps. Each is listed below with its method, path, parameters, and response codes.

Definitions 4
GET
/caregaps/api/{quality_program}/definition/
Retrieve a filtered page of definitions
definitions_get_page_caregaps_api__quality_program__definition__get 9 params body → 200422
POST
/caregaps/api/{quality_program}/definition/
Create a new definition.
definitions_post_caregaps_api__quality_program__definition__post 1 param body → 200422
GET
/caregaps/api/{quality_program}/definition/{definition_id}/
Retrieve an existing definition.
definitions_get_caregaps_api__quality_program__definition__definition_id___get 3 params → 200422
DELETE
/caregaps/api/{quality_program}/definition/{definition_id}/
Delete an existing definition.
definitions_delete_caregaps_api__quality_program__definition__definition_id___delete 2 params → 200422
Caregaps 5
GET
/caregaps/api/{quality_program}/caregap/
Retrieve a list of existing caregap.
caregaps_list_caregaps_api__quality_program__caregap__get 9 params body → 200422
POST
/caregaps/api/{quality_program}/caregap/
Create a new caregap.
caregaps_post_caregaps_api__quality_program__caregap__post 1 param body → 200422
GET
/caregaps/api/{quality_program}/caregap/{caregap_id}/
Retrieve an existing caregap.
caregaps_get_caregaps_api__quality_program__caregap__caregap_id___get 3 params → 200422
DELETE
/caregaps/api/{quality_program}/caregap/{caregap_id}/
Delete an existing caregap.
caregaps_delete_caregaps_api__quality_program__caregap__caregap_id___delete 3 params → 200422
PATCH
/caregaps/api/{quality_program}/caregap/{caregap_id}/
Modifies an existing caregap's closed status.
caregaps_modify_caregaps_api__quality_program__caregap__caregap_id___patch 3 params body → 200422

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are ServiceRequest (61 properties), Observation (59 properties), Immunization (50 properties), ValueSet (43 properties). Each schema is shown below with its type and property counts.

Action
object
4 properties 2 required
ActionEnum
string
An enumeration.
AllergyIntolerance
object
Disclaimer: Any field name ends with ext does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Type…
40 properties 1 required
Body_definitions_get_page_caregaps_api__quality_program__definition__get
object
2 properties
CaregapAPI
object
10 properties 7 required
CaregapAPIModel
object
8 properties 5 required
CaregapAPIPaginatedResponse
object
3 properties 1 required
CaregapPatchAPI
object
1 property 1 required
ClosedByEnum
string
An enumeration.
Coding
object
4 properties
CodingContext
object
1 property
Communication
object
Disclaimer: Any field name ends with ext does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Type…
42 properties
Condition
object
Disclaimer: Any field name ends with ext does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Type…
43 properties 1 required
DefinitionAPI
object
16 properties 8 required
DefinitionAPIModel
object
15 properties 7 required
DefinitionAPIPaginatedResponse
object
3 properties 1 required
DocSection
object
4 properties 2 required
DocumentReference
object
Disclaimer: Any field name ends with ext does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Type…
33 properties 1 required
Endpoint
object
Disclaimer: Any field name ends with ext does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Type…
29 properties 2 required
ExistingSuggestion
object
4 properties 3 required
HTTPValidationError
object
1 property
Immunization
object
Disclaimer: Any field name ends with ext does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Type…
50 properties 2 required
IndicatorEnum
string
An enumeration.
Link
object
4 properties 3 required
Observation
object
Disclaimer: Any field name ends with ext does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Type…
59 properties 1 required
SectionType
string
An enumeration.
SelectionBehaviorEnum
string
An enumeration.
ServiceRequest
object
Disclaimer: Any field name ends with ext does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Type…
61 properties 1 required
Source
object
4 properties 1 required
StatusEnum
string
An enumeration.
SubSection
object
2 properties 2 required
Suggestion
object
3 properties 2 required
TargetEnum
string
An enumeration.
ValidationError
object
3 properties 3 required
ValueSet
object
Disclaimer: Any field name ends with ext does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Type…
43 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elation-care-gaps-api-1.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