Retrieve Definition
Retrieve a specific definition.
curl --request GET \
--url https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/{definition_id}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/{definition_id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/{definition_id}/', 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/{definition_id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/{definition_id}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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/{definition_id}/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/{definition_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
Response
Successful Response
Human readable name for the definition
Indicator of the definition
info, warning, critical Source of the definition
Show child attributes
Show child attributes
Selection Behavior of the definition
any, at-most-one Start date for period
End date for period
List of suggestions to take action on with this definition that includes a uuid
Show child attributes
Show child attributes
UUID that identifies this definition
Quality program this definition is associated with.
List of closing codes.
Show child attributes
Show child attributes
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 this definition is authorized for.
Override reasons written as codings for the definition
Show child attributes
Show child attributes
Relevant links for the definition
Show child attributes
Show child attributes
Additional documentation sections for reference in the EHR. Allowed HTML tags: a, abbr, acronym
Show child attributes
Show child attributes
Identifer for linking to external systems
Was this page helpful?
curl --request GET \
--url https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/{definition_id}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/{definition_id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/{definition_id}/', 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/{definition_id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/{definition_id}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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/{definition_id}/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/{definition_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}