Skip to main content
POST
/
caregaps
/
api
/
{quality_program}
/
definition
Create a new definition.
curl --request POST \
  --url https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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,
      "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>"
        }
      ]
    }
  ],
  "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>"
}
'
{
  "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>"
}

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

Body

application/json
​
name
string
required

Human readable name for the definition

​
indicator
enum<string>
required

Indicator of the definition

Available options:
info,
warning,
critical
​
source
Source · object
required

Source of the definition

​
selection_behavior
enum<string>
required

Selection Behavior of the definition

Available options:
any,
at-most-one
​
start_date
string<date>
required

Start date for period

​
end_date
string<date>
required

End date for period

​
suggestions
Suggestion · object[]
required

List of suggestions to take action on with this definition

​
quality_program
string

Quality program this definition is associated with.

​
closing_codes
Coding · object[]

List of closing codes.

​
description
string

Sentence that describes the definition. Allowed HTML tags: a, abbr, acronym, b, blockquote, br, code, div, em, h1, h2, h3, h4, h5, h6, i, li, ol, p, strong, u, ul

​
practice_id
string

Practice id this definition is authorized for.

​
override_reasons
Coding · object[]

Override reasons written as codings for the definition

​
links
Link · object[]

Relevant links for the definition

​
additional_documentation
DocSection · object[]

Additional documentation sections for reference in the EHR. Allowed HTML tags: a, abbr, acronym

​
external_id
string

Identifer for linking to external systems

Response

Successful Response

​
name
string
required

Human readable name for the definition

​
indicator
enum<string>
required

Indicator of the definition

Available options:
info,
warning,
critical
​
source
Source · object
required

Source of the definition

​
selection_behavior
enum<string>
required

Selection Behavior of the definition

Available options:
any,
at-most-one
​
start_date
string<date>
required

Start date for period

​
end_date
string<date>
required

End date for period

​
suggestions
ExistingSuggestion · object[]
required

List of suggestions to take action on with this definition that includes a uuid

​
id
string
required

UUID that identifies this definition

​
quality_program
string

Quality program this definition is associated with.

​
closing_codes
Coding · object[]

List of closing codes.

​
description
string

Sentence that describes the definition. Allowed HTML tags: a, abbr, acronym, b, blockquote, br, code, div, em, h1, h2, h3, h4, h5, h6, i, li, ol, p, strong, u, ul

​
practice_id
string

Practice id this definition is authorized for.

​
override_reasons
Coding · object[]

Override reasons written as codings for the definition

​
links
Link · object[]

Relevant links for the definition

​
additional_documentation
DocSection · object[]

Additional documentation sections for reference in the EHR. Allowed HTML tags: a, abbr, acronym

​
external_id
string

Identifer for linking to external systems