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>"
}
'
import requests

url = "https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/"

payload = {
"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>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};

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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
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 \"name\": \"<string>\",\n \"source\": {\n \"label\": \"<string>\",\n \"url\": \"<string>\",\n \"icon\": \"<string>\",\n \"topic\": {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\",\n \"context\": {}\n }\n },\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"suggestions\": [\n {\n \"label\": \"<string>\",\n \"is_recommended\": true,\n \"actions\": [\n {\n \"description\": \"<string>\",\n \"resource\": {\n \"resource_type\": \"<string>\",\n \"fhir_comments\": \"<string>\",\n \"id\": \"<string>\",\n \"_id\": \"<string>\",\n \"implicitRules\": \"<string>\",\n \"_implicitRules\": \"<string>\",\n \"language\": \"<string>\",\n \"_language\": \"<string>\",\n \"meta\": \"<string>\",\n \"contained\": [\n \"<string>\"\n ],\n \"extension\": [\n \"<string>\"\n ],\n \"modifierExtension\": [\n \"<string>\"\n ],\n \"text\": \"<string>\",\n \"compose\": \"<string>\",\n \"contact\": [\n \"<string>\"\n ],\n \"copyright\": \"<string>\",\n \"_copyright\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"_date\": \"<string>\",\n \"description\": \"<string>\",\n \"_description\": \"<string>\",\n \"expansion\": \"<string>\",\n \"experimental\": true,\n \"_experimental\": \"<string>\",\n \"identifier\": [\n 123\n ],\n \"immutable\": true,\n \"_immutable\": \"<string>\",\n \"jurisdiction\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"_name\": \"<string>\",\n \"publisher\": \"<string>\",\n \"_publisher\": \"<string>\",\n \"purpose\": \"<string>\",\n \"_purpose\": \"<string>\",\n \"status\": \"<string>\",\n \"_status\": \"<string>\",\n \"title\": \"<string>\",\n \"_title\": \"<string>\",\n \"url\": \"<string>\",\n \"_url\": \"<string>\",\n \"useContext\": [\n \"<string>\"\n ],\n \"version\": \"<string>\",\n \"_version\": \"<string>\"\n },\n \"resourceId\": \"<string>\"\n }\n ]\n }\n ],\n \"quality_program\": \"<string>\",\n \"closing_codes\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\",\n \"context\": {}\n }\n ],\n \"description\": \"<string>\",\n \"practice_id\": \"<string>\",\n \"override_reasons\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\",\n \"context\": {}\n }\n ],\n \"links\": [\n {\n \"label\": \"<string>\",\n \"url\": \"<string>\",\n \"type\": \"<string>\",\n \"app_context\": \"<string>\"\n }\n ],\n \"additional_documentation\": [\n {\n \"subtitle\": \"<string>\",\n \"paragraphs\": [\n \"<string>\"\n ],\n \"subsections\": [\n {\n \"label\": \"<string>\",\n \"text\": \"<string>\"\n }\n ]\n }\n ],\n \"external_id\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", 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.post("https://caregaps.sandbox.elationemr.com/caregaps/api/{quality_program}/definition/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"source\": {\n \"label\": \"<string>\",\n \"url\": \"<string>\",\n \"icon\": \"<string>\",\n \"topic\": {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\",\n \"context\": {}\n }\n },\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"suggestions\": [\n {\n \"label\": \"<string>\",\n \"is_recommended\": true,\n \"actions\": [\n {\n \"description\": \"<string>\",\n \"resource\": {\n \"resource_type\": \"<string>\",\n \"fhir_comments\": \"<string>\",\n \"id\": \"<string>\",\n \"_id\": \"<string>\",\n \"implicitRules\": \"<string>\",\n \"_implicitRules\": \"<string>\",\n \"language\": \"<string>\",\n \"_language\": \"<string>\",\n \"meta\": \"<string>\",\n \"contained\": [\n \"<string>\"\n ],\n \"extension\": [\n \"<string>\"\n ],\n \"modifierExtension\": [\n \"<string>\"\n ],\n \"text\": \"<string>\",\n \"compose\": \"<string>\",\n \"contact\": [\n \"<string>\"\n ],\n \"copyright\": \"<string>\",\n \"_copyright\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"_date\": \"<string>\",\n \"description\": \"<string>\",\n \"_description\": \"<string>\",\n \"expansion\": \"<string>\",\n \"experimental\": true,\n \"_experimental\": \"<string>\",\n \"identifier\": [\n 123\n ],\n \"immutable\": true,\n \"_immutable\": \"<string>\",\n \"jurisdiction\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"_name\": \"<string>\",\n \"publisher\": \"<string>\",\n \"_publisher\": \"<string>\",\n \"purpose\": \"<string>\",\n \"_purpose\": \"<string>\",\n \"status\": \"<string>\",\n \"_status\": \"<string>\",\n \"title\": \"<string>\",\n \"_title\": \"<string>\",\n \"url\": \"<string>\",\n \"_url\": \"<string>\",\n \"useContext\": [\n \"<string>\"\n ],\n \"version\": \"<string>\",\n \"_version\": \"<string>\"\n },\n \"resourceId\": \"<string>\"\n }\n ]\n }\n ],\n \"quality_program\": \"<string>\",\n \"closing_codes\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\",\n \"context\": {}\n }\n ],\n \"description\": \"<string>\",\n \"practice_id\": \"<string>\",\n \"override_reasons\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\",\n \"context\": {}\n }\n ],\n \"links\": [\n {\n \"label\": \"<string>\",\n \"url\": \"<string>\",\n \"type\": \"<string>\",\n \"app_context\": \"<string>\"\n }\n ],\n \"additional_documentation\": [\n {\n \"subtitle\": \"<string>\",\n \"paragraphs\": [\n \"<string>\"\n ],\n \"subsections\": [\n {\n \"label\": \"<string>\",\n \"text\": \"<string>\"\n }\n ]\n }\n ],\n \"external_id\": \"<string>\"\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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"source\": {\n \"label\": \"<string>\",\n \"url\": \"<string>\",\n \"icon\": \"<string>\",\n \"topic\": {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\",\n \"context\": {}\n }\n },\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"suggestions\": [\n {\n \"label\": \"<string>\",\n \"is_recommended\": true,\n \"actions\": [\n {\n \"description\": \"<string>\",\n \"resource\": {\n \"resource_type\": \"<string>\",\n \"fhir_comments\": \"<string>\",\n \"id\": \"<string>\",\n \"_id\": \"<string>\",\n \"implicitRules\": \"<string>\",\n \"_implicitRules\": \"<string>\",\n \"language\": \"<string>\",\n \"_language\": \"<string>\",\n \"meta\": \"<string>\",\n \"contained\": [\n \"<string>\"\n ],\n \"extension\": [\n \"<string>\"\n ],\n \"modifierExtension\": [\n \"<string>\"\n ],\n \"text\": \"<string>\",\n \"compose\": \"<string>\",\n \"contact\": [\n \"<string>\"\n ],\n \"copyright\": \"<string>\",\n \"_copyright\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"_date\": \"<string>\",\n \"description\": \"<string>\",\n \"_description\": \"<string>\",\n \"expansion\": \"<string>\",\n \"experimental\": true,\n \"_experimental\": \"<string>\",\n \"identifier\": [\n 123\n ],\n \"immutable\": true,\n \"_immutable\": \"<string>\",\n \"jurisdiction\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"_name\": \"<string>\",\n \"publisher\": \"<string>\",\n \"_publisher\": \"<string>\",\n \"purpose\": \"<string>\",\n \"_purpose\": \"<string>\",\n \"status\": \"<string>\",\n \"_status\": \"<string>\",\n \"title\": \"<string>\",\n \"_title\": \"<string>\",\n \"url\": \"<string>\",\n \"_url\": \"<string>\",\n \"useContext\": [\n \"<string>\"\n ],\n \"version\": \"<string>\",\n \"_version\": \"<string>\"\n },\n \"resourceId\": \"<string>\"\n }\n ]\n }\n ],\n \"quality_program\": \"<string>\",\n \"closing_codes\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\",\n \"context\": {}\n }\n ],\n \"description\": \"<string>\",\n \"practice_id\": \"<string>\",\n \"override_reasons\": [\n {\n \"code\": \"<string>\",\n \"display\": \"<string>\",\n \"system\": \"<string>\",\n \"context\": {}\n }\n ],\n \"links\": [\n {\n \"label\": \"<string>\",\n \"url\": \"<string>\",\n \"type\": \"<string>\",\n \"app_context\": \"<string>\"\n }\n ],\n \"additional_documentation\": [\n {\n \"subtitle\": \"<string>\",\n \"paragraphs\": [\n \"<string>\"\n ],\n \"subsections\": [\n {\n \"label\": \"<string>\",\n \"text\": \"<string>\"\n }\n ]\n }\n ],\n \"external_id\": \"<string>\"\n}"

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

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

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

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