Definitions
List Definitions
Retrieve a list of definitions.
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>"
]
}
'import requests
url = "https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/"
payload = {
"definition_id": ["<string>"],
"closing_code": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({definition_id: ['<string>'], closing_code: ['<string>']})
};
fetch('https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'definition_id' => [
'<string>'
],
'closing_code' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/"
payload := strings.NewReader("{\n \"definition_id\": [\n \"<string>\"\n ],\n \"closing_code\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition_id\": [\n \"<string>\"\n ],\n \"closing_code\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"definition_id\": [\n \"<string>\"\n ],\n \"closing_code\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Query Parameters
Required range:
x >= 1Required range:
x >= 1An enumeration.
Available options:
info, warning, critical Was this page helpful?
⌘I
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>"
]
}
'import requests
url = "https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/"
payload = {
"definition_id": ["<string>"],
"closing_code": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({definition_id: ['<string>'], closing_code: ['<string>']})
};
fetch('https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'definition_id' => [
'<string>'
],
'closing_code' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/"
payload := strings.NewReader("{\n \"definition_id\": [\n \"<string>\"\n ],\n \"closing_code\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition_id\": [\n \"<string>\"\n ],\n \"closing_code\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"definition_id\": [\n \"<string>\"\n ],\n \"closing_code\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}