Skip to main content
GET
/
caregaps
/
api
/
{quality_program}
/
definition
Retrieve a filtered page of definitions
curl --request GET \
  --url https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "definition_id": [
    "<string>"
  ],
  "closing_code": [
    "<string>"
  ]
}
'
{
  "results": [
    {
      "name": "<string>",
      "source": {
        "label": "<string>",
        "url": "<string>",
        "icon": "<string>",
        "topic": {
          "code": "<string>",
          "display": "<string>",
          "system": "<string>",
          "context": {}
        }
      },
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "suggestions": [
        {
          "label": "<string>",
          "is_recommended": true,
          "uuid": "<string>",
          "actions": [
            {
              "description": "<string>",
              "resource": {
                "resource_type": "<string>",
                "fhir_comments": "<string>",
                "id": "<string>",
                "_id": "<string>",
                "implicitRules": "<string>",
                "_implicitRules": "<string>",
                "language": "<string>",
                "_language": "<string>",
                "meta": "<string>",
                "contained": [
                  "<string>"
                ],
                "extension": [
                  "<string>"
                ],
                "modifierExtension": [
                  "<string>"
                ],
                "text": "<string>",
                "compose": "<string>",
                "contact": [
                  "<string>"
                ],
                "copyright": "<string>",
                "_copyright": "<string>",
                "date": "2023-11-07T05:31:56Z",
                "_date": "<string>",
                "description": "<string>",
                "_description": "<string>",
                "expansion": "<string>",
                "experimental": true,
                "_experimental": "<string>",
                "identifier": [
                  123
                ],
                "immutable": true,
                "_immutable": "<string>",
                "jurisdiction": [
                  "<string>"
                ],
                "name": "<string>",
                "_name": "<string>",
                "publisher": "<string>",
                "_publisher": "<string>",
                "purpose": "<string>",
                "_purpose": "<string>",
                "status": "<string>",
                "_status": "<string>",
                "title": "<string>",
                "_title": "<string>",
                "url": "<string>",
                "_url": "<string>",
                "useContext": [
                  "<string>"
                ],
                "version": "<string>",
                "_version": "<string>"
              },
              "resourceId": "<string>"
            }
          ]
        }
      ],
      "id": "<string>",
      "quality_program": "<string>",
      "closing_codes": [
        {
          "code": "<string>",
          "display": "<string>",
          "system": "<string>",
          "context": {}
        }
      ],
      "description": "<string>",
      "practice_id": "<string>",
      "override_reasons": [
        {
          "code": "<string>",
          "display": "<string>",
          "system": "<string>",
          "context": {}
        }
      ],
      "links": [
        {
          "label": "<string>",
          "url": "<string>",
          "type": "<string>",
          "app_context": "<string>"
        }
      ],
      "additional_documentation": [
        {
          "subtitle": "<string>",
          "paragraphs": [
            "<string>"
          ],
          "subsections": [
            {
              "label": "<string>",
              "text": "<string>"
            }
          ]
        }
      ],
      "external_id": "<string>"
    }
  ],
  "cursor": "<string>",
  "next_page_url": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://help.elationhealth.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
quality_program
string
required

Query Parameters

​
page_size
integer
default:5
Required range: x >= 1
​
page_num
integer
default:1
Required range: x >= 1
​
closing_code
string[]
​
definition_id
string[]
​
external_id
string
​
cursor
string
​
name
string
​
indicator
enum<string>

An enumeration.

Available options:
info,
warning,
critical

Body

application/json
​
definition_id
string[]
​
closing_code
string[]

Response

Successful Response

​
results
DefinitionAPI · object[]
required

Page of results requested

​
cursor
string

Cursor to query for the next page

​
next_page_url
string

Full URL to query for the next page