HealtheInsights Application API v1

The Oracle Health Data Intelligence HealtheInsights Application API enables configuration of the HealtheInsights application.

URL: https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1

Configurable Features

Configurable features represent features that can be used in the HealtheInsights application. You can retrieve a list of the configurable features that are defined for your tenant.

Retrieve a List of Configurable Features


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/configurable-features', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/configurable-features \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "title": "Feature Quality Measure API",
      "name": "FEATURE_QUALITY_MEASURE_API"
    },
    {
      "title": "Feature Authorize Associates",
      "name": "FEATURE_AUTHORIZE_ASSOCIATES"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/insights-application/v1/configurable_feature/?offset=0&limit=100",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/insights-application/v1/configurable_feature/?offset=0&limit=100"
}

GET /configurable-features

Retrieves a list of configurable feature toggles for the specified tenant.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of configurable features defined.	ConfigurableFeatures
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Configurable Items

Configurable items represent configuration items that can be used in the HealtheInsights application. You can retrieve a list of the configurable items that are defined for your tenant.

Retrieve a List of Configurable Items


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/configurable-items', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/configurable-items \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "title": "Program group Id",
      "name": "PROGRAM_GROUP_ID",
      "type": "STRING",
      "min": 1,
      "max": 1
    },
    {
      "title": "Patient Summary Tableau URI",
      "name": "PATIENT_SUMMARY_TABLEAU_URI",
      "type": "URI",
      "min": 1,
      "max": 1
    },
    {
      "title": "Recent Ontological Category Codes",
      "name": "RECENT_ONTOLOGICAL_CATEGORY_CODES",
      "type": "REFERENCE",
      "referenceKind": "ontology#context",
      "min": 1,
      "max": 9999
    }
  ],
  "totalResults": 3,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/insights-application/v1/configurable_items/?offset=0&limit=100",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/insights-application/v1/configurable_items/?offset=0&limit=100"
}

GET /configurable-items

Retrieves a catalog of client viewable configuration items.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of configuration reports	ConfigurableItems
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Sites

A site contains the metadata required to configure a HealtheInsights application. Sites are feature-agnostic. They can be configured to embed features and behavior from multiple Health Data Intelligence applications, such as Diagnosis Insights and HealtheRecord. Additionally, sites allow you to embed HealtheInsights in other applications as a Substitutable Medical Applications and Reusable Technology (SMART) application. A single tenant can be associated with multiple sites. For example, a tenant might choose to have a site for production and another site to stage configuration changes.

Create a Site




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/sites', headers: headers, body: {"isDefault":"true","title":"Default Application Profile","name":"Default Application Profile","configuredItems":[{"name":"PROGRAM_GROUP_ID","value":{"text":"0746a78d-f918-46d5-a2b0-97fcd3521cbf"}},{"name":"DEFAULT_WORKBOOK_ID","value":{"text":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"}},{"name":"EMBEDDED_DOMAIN_WHITELIST","value":{"uri":"http://*.healtheintent.com"}},{"name":"EMBEDDED_DOMAIN_WHITELIST","value":{"uri":"https://*.cerner.com"}},{"name":"EMBEDDED_DOMAIN_WHITELIST","value":{"uri":"https://*.healtheintent.com"}},{"name":"RECENT_ONTOLOGICAL_CATEGORY_CODES","value":{"reference":{"id":"42AB3068AE8F4EDE88951SC142CBBF4AC"}}},{"name":"RECENT_ONTOLOGICAL_CATEGORY_CODES","value":{"reference":{"id":"53EF3068AE8F4EDE9951DC170CBBE6DA"}}},{"name":"PATIENT_SUMMARY_TABLEAU_URI","value":{"uri":"https://cerner.bi.us-1.healtheintent.com/t/CERNERDEMO/views/PatientProfileSummary/PatientProfileCombined"}}],"configuredFeatures":[{"name":"FEATURE_QUALITY_MEASURE_API","on":true},{"name":"FEATURE_AUTHORIZE_ASSOCIATES","on":true}],"createdBy":"FZ063958"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/sites \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"isDefault":"true","title":"Default Application Profile","name":"Default Application Profile","configuredItems":[{"name":"PROGRAM_GROUP_ID","value":{"text":"0746a78d-f918-46d5-a2b0-97fcd3521cbf"}},{"name":"DEFAULT_WORKBOOK_ID","value":{"text":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"}},{"name":"EMBEDDED_DOMAIN_WHITELIST","value":{"uri":"http://*.healtheintent.com"}},{"name":"EMBEDDED_DOMAIN_WHITELIST","value":{"uri":"https://*.cerner.com"}},{"name":"EMBEDDED_DOMAIN_WHITELIST","value":{"uri":"https://*.healtheintent.com"}},{"name":"RECENT_ONTOLOGICAL_CATEGORY_CODES","value":{"reference":{"id":"42AB3068AE8F4EDE88951SC142CBBF4AC"}}},{"name":"RECENT_ONTOLOGICAL_CATEGORY_CODES","value":{"reference":{"id":"53EF3068AE8F4EDE9951DC170CBBE6DA"}}},{"name":"PATIENT_SUMMARY_TABLEAU_URI","value":{"uri":"https://cerner.bi.us-1.healtheintent.com/t/CERNERDEMO/views/PatientProfileSummary/PatientProfileCombined"}}],"configuredFeatures":[{"name":"FEATURE_QUALITY_MEASURE_API","on":true},{"name":"FEATURE_AUTHORIZE_ASSOCIATES","on":true}],"createdBy":"FZ063958"}

{
  "id": "15646b80-3666-441a-9e14-e0f9f0bd4342",
  "isDefault": true,
  "title": "Default Application Profile",
  "name": "Default Application Profile",
  "configuredItems": [
    {
      "name": "PROGRAM_GROUP_ID",
      "value": {
        "text": "0746a78d-f918-46d5-a2b0-97fcd3521cbf"
      }
    },
    {
      "name": "RECENT_ONTOLOGICAL_CATEGORY_CODES",
      "value": {
        "reference": {
          "id": "42AB3068AE8F4EDE88951SC142CBBF4AC"
        }
      }
    },
    {
      "name": "RECENT_ONTOLOGICAL_CATEGORY_CODES",
      "value": {
        "reference": {
          "id": "53EF3068AE8F4EDE9951DC170CBBE6DA"
        }
      }
    },
    {
      "name": "PATIENT_SUMMARY_TABLEAU_URI",
      "value": {
        "uri": "https://cerner.bi.us-1.healtheintent.com/t/CERNERDEMO/views/PatientProfileSummary/PatientProfileCombined"
      }
    }
  ],
  "configuredFeatures": [
    {
      "name": "FEATURE_QUALITY_MEASURE_API",
      "on": true
    }
  ],
  "createdAt": "2021-03-05T15:39:36.288Z",
  "updatedAt": "2021-03-05T15:39:36.288Z",
  "createdBy": "FZ063958",
  "updatedBy": "FZ063958"
}

POST /sites

Creates a site.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
body	body	postSites	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	Site
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
409	Conflict	Conflict	Error

Retrieve a List of Sites


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/sites', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/sites \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "d5dae62a-fc5d-41dd-b539-71e5fe7c1127",
      "isDefault": false,
      "title": "Default Application Profile",
      "name": "Default Application Profile",
      "configuredItems": [
        {
          "name": "RECENT_ONTOLOGICAL_CATEGORY_CODES",
          "value": {
            "reference": {
              "id": "42AB3068AE8F4EDE88951SC142CBBF4AG"
            }
          }
        },
        {
          "name": "RECENT_ONTOLOGICAL_CATEGORY_CODES",
          "value": {
            "reference": {
              "id": "53EF3068AE8F4EDE9951DC170CBBE6DAAG"
            }
          }
        },
        {
          "name": "PROGRAM_GROUP_ID",
          "value": {
            "text": "0746a78d-f918-46d5-a2b0-97fcd3521cbfxx"
          }
        },
        {
          "name": "RECENT_ONTOLOGICAL_CATEGORY_CODES",
          "value": {
            "reference": {
              "id": "42AB3068AE8F4EDE88951SC142CBBF4ACxx"
            }
          }
        },
        {
          "name": "RECENT_ONTOLOGICAL_CATEGORY_CODES",
          "value": {
            "reference": {
              "id": "53EF3068AE8F4EDE9951DC170CBBE6DA"
            }
          }
        },
        {
          "name": "PATIENT_SUMMARY_TABLEAU_URI",
          "value": {
            "uri": "https://cerner.bi.us-1.healtheintent.com/t/CERNERDEMO/views/PatientProfileSummary/PatientProfileCombined"
          }
        }
      ],
      "configuredFeatures": [
        {
          "name": "FEATURE_QUALITY_MEASURE_API",
          "on": true
        }
      ],
      "createdAt": "2021-03-04T20:20:50.588Z",
      "updatedAt": "2021-03-04T20:37:22.564Z",
      "createdBy": "FZ063958",
      "updatedBy": "FZ063958"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/insights-application/v1/sites?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/insights-application/v1/sites?offset=0&limit=20"
}

GET /sites

Retrieves a list of available sites.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of site reports	Sites
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Remove a Site


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/sites/365087f9-5d48-4917-84a0-a8ced73cb143', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/sites/365087f9-5d48-4917-84a0-a8ced73cb143 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /sites/{siteId}

Removes a site from the collection of available sites.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
siteId	path	string	true	N/A	The unique ID of the site.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single site


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/sites/d5dae62a-fc5d-41dd-b539-71e5fe7c1127', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/sites/{siteId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "d5dae62a-fc5d-41dd-b539-71e5fe7c1127",
  "isDefault": false,
  "title": "Default Application Profile",
  "name": "Default Application Profile",
  "configuredItems": [
    {
      "name": "RECENT_ONTOLOGICAL_CATEGORY_CODES",
      "value": {
        "reference": {
          "id": "42AB3068AE8F4EDE88951SC142CBBF4AG"
        }
      }
    },
    {
      "name": "RECENT_ONTOLOGICAL_CATEGORY_CODES",
      "value": {
        "reference": {
          "id": "53EF3068AE8F4EDE9951DC170CBBE6DAAG"
        }
      }
    },
    {
      "name": "PROGRAM_GROUP_ID",
      "value": {
        "text": "0746a78d-f918-46d5-a2b0-97fcd3521cbfxx"
      }
    },
    {
      "name": "RECENT_ONTOLOGICAL_CATEGORY_CODES",
      "value": {
        "reference": {
          "id": "42AB3068AE8F4EDE88951SC142CBBF4ACxx"
        }
      }
    },
    {
      "name": "RECENT_ONTOLOGICAL_CATEGORY_CODES",
      "value": {
        "reference": {
          "id": "53EF3068AE8F4EDE9951DC170CBBE6DA"
        }
      }
    },
    {
      "name": "PATIENT_SUMMARY_TABLEAU_URI",
      "value": {
        "uri": "https://cerner.bi.us-1.healtheintent.com/t/CERNERDEMO/views/PatientProfileSummary/PatientProfileCombined"
      }
    }
  ],
  "configuredFeatures": [
    {
      "name": "FEATURE_QUALITY_MEASURE_API",
      "on": true
    }
  ],
  "createdAt": "2021-03-04T20:20:50.588Z",
  "updatedAt": "2021-03-04T20:37:22.564Z",
  "createdBy": "FZ063958",
  "updatedBy": "FZ063958"
}

GET /sites/{siteId}

Retrieves a single HealtheInsights site by its ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
siteId	path	string	true	N/A	The unique ID of the site.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single HealtheInsights site	Site
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Site




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/sites/365087f9-5d48-4917-84a0-a8ced73cb143', headers: headers, body: {"isDefault":"true","title":"Default Application Profile","name":"Default Application Profile","configuredItems":[{"name":"PROGRAM_GROUP_ID","value":{"text":"0746a78d-f918-46d5-a2b0-97fcd3521cbf"}},{"name":"DEFAULT_WORKBOOK_ID","value":{"text":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"}},{"name":"EMBEDDED_DOMAIN_WHITELIST","value":{"uri":"http://*.healtheintent.com"}},{"name":"EMBEDDED_DOMAIN_WHITELIST","value":{"uri":"https://*.cerner.com"}},{"name":"EMBEDDED_DOMAIN_WHITELIST","value":{"uri":"https://*.healtheintent.com"}},{"name":"RECENT_ONTOLOGICAL_CATEGORY_CODES","value":{"reference":{"id":"42AB3068AE8F4EDE88951SC142CBBF4AC"}}},{"name":"RECENT_ONTOLOGICAL_CATEGORY_CODES","value":{"reference":{"id":"53EF3068AE8F4EDE9951DC170CBBE6DA"}}},{"name":"PATIENT_SUMMARY_TABLEAU_URI","value":{"uri":"https://cerner.bi.us-1.healtheintent.com/t/CERNERDEMO/views/PatientProfileSummary/PatientProfileCombined"}}],"configuredFeatures":[{"name":"FEATURE_QUALITY_MEASURE_API","on":true},{"name":"FEATURE_AUTHORIZE_ASSOCIATES","on":true}],"updatedBy":"FZ063958"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/sites/365087f9-5d48-4917-84a0-a8ced73cb143 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"isDefault":"true","title":"Default Application Profile","name":"Default Application Profile","configuredItems":[{"name":"PROGRAM_GROUP_ID","value":{"text":"0746a78d-f918-46d5-a2b0-97fcd3521cbf"}},{"name":"DEFAULT_WORKBOOK_ID","value":{"text":"12628e5e-09e2-11e8-9dc2-587234acdcbf0"}},{"name":"EMBEDDED_DOMAIN_WHITELIST","value":{"uri":"http://*.healtheintent.com"}},{"name":"EMBEDDED_DOMAIN_WHITELIST","value":{"uri":"https://*.cerner.com"}},{"name":"EMBEDDED_DOMAIN_WHITELIST","value":{"uri":"https://*.healtheintent.com"}},{"name":"RECENT_ONTOLOGICAL_CATEGORY_CODES","value":{"reference":{"id":"42AB3068AE8F4EDE88951SC142CBBF4AC"}}},{"name":"RECENT_ONTOLOGICAL_CATEGORY_CODES","value":{"reference":{"id":"53EF3068AE8F4EDE9951DC170CBBE6DA"}}},{"name":"PATIENT_SUMMARY_TABLEAU_URI","value":{"uri":"https://cerner.bi.us-1.healtheintent.com/t/CERNERDEMO/views/PatientProfileSummary/PatientProfileCombined"}}],"configuredFeatures":[{"name":"FEATURE_QUALITY_MEASURE_API","on":true},{"name":"FEATURE_AUTHORIZE_ASSOCIATES","on":true}],"updatedBy":"FZ063958"}

PUT /sites/{siteId}

Updates a site in the HealtheInsights site collection.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
siteId	path	string	true	N/A	The unique ID of the site.	-
body	body	putSites	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Workbooks

A workbook represents a collection or grouping of categorized worklists made available to an authorized set of users. It also provides the context and configuration details that influence what the user sees when moving through HealtheInsights application workflows. When interacting with the application, this context must be selected or specified. Otherwise, a default workbook for the tenant is used to set context.

Create a Workbook




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks', headers: headers, body: {"name":"Default Workbook","defaultPopulation":{"id":"7cd017ef-7d31-390e-b4fe-52d9f86e517e","subpopulationId":"c4784eb5-e546-45c3-8735-61c489fbd9da"},"personSearchIdentifierType":"MEMBER_ID","personSummaryReportKey":"PatientProfile/PatientSummary"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Default Workbook","defaultPopulation":{"id":"7cd017ef-7d31-390e-b4fe-52d9f86e517e","subpopulationId":"c4784eb5-e546-45c3-8735-61c489fbd9da"},"personSearchIdentifierType":"MEMBER_ID","personSummaryReportKey":"PatientProfile/PatientSummary"}

{
  "id": "12628e5e-09e2-11e8-9dc2-587234acdcbf0",
  "name": "Default workbook",
  "defaultPopulation": {
    "id": "7cd017ef-7d31-390e-b4fe-52d9f86e517e",
    "subpopulationId": "c4784eb5-e546-45c3-8735-61c489fbd9da"
  },
  "personSearchIdentifierType": "MEMBER_ID",
  "personSummaryReportKey": "PatientProfile/PatientSummary",
  "createdAt": "2018-01-10T15:48:32Z",
  "updatedAt": "2019-04-15T11:03:15Z"
}

POST /workbooks

Creates a workbook.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
body	body	postWorkbooks	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	Workbook
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
409	Conflict	Conflict	Error

Retrieve a List of Workbooks


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "12628e5e-09e2-11e8-9dc2-587234acdcbf0",
      "name": "Default workbook",
      "defaultPopulation": {
        "id": "7cd017ef-7d31-390e-b4fe-52d9f86e517e",
        "subpopulationId": "c4784eb5-e546-45c3-8735-61c489fbd9da"
      },
      "personSearchIdentifierType": "MEMBER_ID",
      "personSummaryReportKey": "PatientProfile/PatientSummary",
      "createdAt": "2018-01-10T15:48:32Z",
      "updatedAt": "2019-04-15T11:03:15Z"
    },
    {
      "id": "c4784eb5-e546-45c3-8735-61c489fbd9dx",
      "name": "Test workbook",
      "defaultPopulation": {
        "id": "7cd017ef-7d31-390e-b4fe-52d9f86e517e",
        "subpopulationId": "a4723eb5-e546-45c3-8735-61c489fbgf6c"
      },
      "personSearchIdentifierType": "MEMBER_ID",
      "personSummaryReportKey": "PatientProfile/PatientSummary",
      "createdAt": "2018-01-10T15:48:32Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/insights-application/v1/workbooks/?offset=0&limit=100",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/insights-application/v1/workbooks/?offset=0&limit=100"
}

GET /workbooks

Retrieves a list of HealtheInsights workbooks.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort.	name

Response Statuses

Status	Meaning	Description	Schema
200	OK	A list of HealtheInsights workbooks	Workbooks
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Remove a Workbook


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks/g89fa3dd-0000-494b-1111-4640ccc081e3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks/g89fa3dd-0000-494b-1111-4640ccc081e3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /workbooks/{workbookId}

Removes a workbook from the collection of available workbooks.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
workbookId	path	string	true	N/A	The unique ID of the workbook.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Workbook


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks/g89fa3dd-0000-494b-1111-4640ccc081e3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks/g89fa3dd-0000-494b-1111-4640ccc081e3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "12628e5e-09e2-11e8-9dc2-587234acdcbf0",
  "name": "Default workbook",
  "defaultPopulation": {
    "id": "7cd017ef-7d31-390e-b4fe-52d9f86e517e",
    "subpopulationId": "c4784eb5-e546-45c3-8735-61c489fbd9da"
  },
  "personSearchIdentifierType": "MEMBER_ID",
  "personSummaryReportKey": "PatientProfile/PatientSummary",
  "createdAt": "2018-01-10T15:48:32Z"
}

GET /workbooks/{workbookId}

Retrieves a HealtheInsights workbook by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
workbookId	path	string	true	N/A	The unique ID of the workbook.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single HealtheInsights workbook	Workbook
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Workbook




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks/e5f34c23-e572-44c3-a2cd-7ca358dcec9f', headers: headers, body: {"name":"Default Workbook","defaultPopulation":{"id":"7cd017ef-7d31-390e-b4fe-52d9f86e517e","subpopulationId":"c4784eb5-e546-45c3-8735-61c489fbd9da"},"personSearchIdentifierType":"MEMBER_ID","personSummaryReportKey":"PatientProfile/PatientSummary"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks/e5f34c23-e572-44c3-a2cd-7ca358dcec9f \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Default Workbook","defaultPopulation":{"id":"7cd017ef-7d31-390e-b4fe-52d9f86e517e","subpopulationId":"c4784eb5-e546-45c3-8735-61c489fbd9da"},"personSearchIdentifierType":"MEMBER_ID","personSummaryReportKey":"PatientProfile/PatientSummary"}

PUT /workbooks/{workbookId}

Updates a workbook.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
workbookId	path	string	true	N/A	The unique ID of the workbook.	-
body	body	putWorkbooks	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Retrieve a List of Worklists Assigned to the Workbook


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks/g89fa3dd-0000-494b-1111-4640ccc081e3/worklists', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks/g89fa3dd-0000-494b-1111-4640ccc081e3/worklists \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "g89fa3dd-0000-494b-1111-4640ccc081e3",
      "worklistCategory": {
        "id": "581433f4-b179-3df4-9bb2-9768ef76493c",
        "name": "Gaps in Care"
      },
      "name": "High Opportunity",
      "description": "Worklist organizing patients based on identified gaps in care.",
      "worklistKey": "GapsTemplateWorklist/MemberWorklist",
      "createdAt": "2018-01-10T15:48:32Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    },
    {
      "id": "a68a1daa-bd3f-468d-ae16-543d7c369dbd",
      "worklistCategory": {
        "id": "e5f34c23-e572-44c3-a2cd-7ca358dcec9f",
        "name": "Med Management"
      },
      "name": "90-Day Fill Opportunities to Improve Adherence to Statins",
      "description": "Worklist focused on patients requiring medication management assistance.",
      "worklistKey": "GapsTemplateWorklist/MemberWorklist",
      "createdAt": "2018-01-10T15:48:32Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/insights-application/v1/workbooks/12628e5e-09e2-11e8-9dc2-587234acdcbf0/worklists/?offset=0&limit=100",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/insights-application/v1/workbooks/12628e5e-09e2-11e8-9dc2-587234acdcbf0/worklists/?offset=0&limit=100"
}

GET /workbooks/{workbookId}/worklists

Retrieves a list of HealtheInsights worklists that are assigned to the workbook.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
workbookId	path	string	true	N/A	The unique ID of the workbook.	-
worklistCategoryId	query	string	false	N/A	The ID of the worklist category to which the worklist is assigned.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort.	name

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of worklist reports	Worklists
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Remove a Worklist From the Workbook


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks/e5f34c23-e572-44c3-a2cd-7ca358dcec9f/worklists/7209f9fb-3a5d-44c1-8dbb-123f340a9850', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks/e5f34c23-e572-44c3-a2cd-7ca358dcec9f/worklists/7209f9fb-3a5d-44c1-8dbb-123f340a9850 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /workbooks/{workbookId}/worklists/{worklistId}

Removes a worklist from the workbook.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
workbookId	path	string	true	N/A	The unique ID of the workbook.	-
worklistId	path	string	true	N/A	The unique ID of the worklist.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Add a Worklist to the Workbook


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks/e5f34c23-e572-44c3-a2cd-7ca358dcec9f/worklists/7209f9fb-3a5d-44c1-8dbb-123f340a9850', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/workbooks/e5f34c23-e572-44c3-a2cd-7ca358dcec9f/worklists/7209f9fb-3a5d-44c1-8dbb-123f340a9850 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /workbooks/{workbookId}/worklists/{worklistId}

Adds a worklist to the workbook.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
workbookId	path	string	true	N/A	The unique ID of the workbook.	-
worklistId	path	string	true	N/A	The unique ID of the worklist.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Worklists

On the home page of the HealtheInsights application, users can select from a collection of categorized worklists. Each worklist represents a different perspective on patient populations with a focus on attributes such as gaps in care, medication management, or admissions. The purpose of the worklist is to drive subsequent tasks such as patient outreach or scheduling for the subset of prioritized patients requiring attention.

Create a Worklist Category




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklist-categories', headers: headers, body: {"name":"Gaps in Care"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklist-categories \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Gaps in Care"}

{
  "id": "581433f4-b179-3df4-9bb2-9768ef76493c",
  "name": "Gaps in Care",
  "createdAt": "2018-09-18T19:07:33Z",
  "updatedAt": "2018-09-18T19:07:33Z"
}

POST /worklist-categories

Creates a worklist category.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
body	body	postWorklistCategories	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	WorklistCategory
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
409	Conflict	Conflict	Error

Retrieve a List of Worklist Categories


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklist-categories', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklist-categories \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "e5f34c23-e572-44c3-a2cd-7ca358dcec9f",
      "name": "Med Management",
      "createdAt": "2018-01-10T15:48:32Z",
      "updatedAt": "2019-01-12T10:25:18Z"
    },
    {
      "id": "581433f4-b179-3df4-9bb2-9768ef76493c",
      "name": "Gaps in Care",
      "createdAt": "2018-01-10T15:48:32Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/insights-application/v1/worklist-categories/?offset=0&limit=100",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/insights-application/v1/worklist-categories/?offset=0&limit=100"
}

GET /worklist-categories

Retrieves a list of HealtheInsights worklist categories.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort.	name

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of worklist categories	WorklistCategories
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Remove a Worklist Category


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklist-categories/e5f34c23-e572-44c3-a2cd-7ca358dcec9f', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklist-categories/e5f34c23-e572-44c3-a2cd-7ca358dcec9f \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /worklist-categories/{worklistCategoryId}

Removes a worklist category from the collection of available worklist categories.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
worklistCategoryId	path	string	true	N/A	The ID of the worklist category.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Retrieve a Single Worklist Category


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklist-categories/581433f4-b179-3df4-9bb2-9768ef76493c', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklist-categories/581433f4-b179-3df4-9bb2-9768ef76493c \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "581433f4-b179-3df4-9bb2-9768ef76493c",
  "name": "Gaps in Care",
  "createdAt": "2018-09-18T19:07:33Z",
  "updatedAt": "2018-09-18T19:07:33Z"
}

GET /worklist-categories/{worklistCategoryId}

Retrieves a HealtheInsights worklist category by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
worklistCategoryId	path	string	true	N/A	The ID of the worklist category.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single HealtheInsights worklist category	Worklist
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Worklist Category




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklist-categories/e5f34c23-e572-44c3-a2cd-7ca358dcec9f', headers: headers, body: {"name":"Gaps in Care"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklist-categories/e5f34c23-e572-44c3-a2cd-7ca358dcec9f \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Gaps in Care"}

PUT /worklist-categories/{worklistCategoryId}

Updates a worklist category.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
worklistCategoryId	path	string	true	N/A	The ID of the worklist category.	-
body	body	putWorklistCategories	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Create a Worklist




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklists', headers: headers, body: {"worklistCategory":{"id":"581433f4-b179-3df4-9bb2-9768ef76493c"},"id":"7cd017ef-7d31-390e-b4fe-52d9f86e517e","name":"High Opportunity","description":"Worklist organizing patients based on identified gaps in care","additionalParameters":"refresh=true","worklistKey":"GapsTemplateWorklist/MemberWorklist"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklists \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"worklistCategory":{"id":"581433f4-b179-3df4-9bb2-9768ef76493c"},"id":"7cd017ef-7d31-390e-b4fe-52d9f86e517e","name":"High Opportunity","description":"Worklist organizing patients based on identified gaps in care","additionalParameters":"refresh=true","worklistKey":"GapsTemplateWorklist/MemberWorklist"}

{
  "id": "g89fa3dd-0000-494b-1111-4640ccc081e3",
  "worklistCategory": {
    "id": "581433f4-b179-3df4-9bb2-9768ef76493c",
    "name": "Gaps in Care"
  },
  "additionalParameters": "refresh=true",
  "name": "High Opportunity",
  "description": "Worklist organizing patients based on identified gaps in care.",
  "worklistKey": "GapsTemplateWorklist/MemberWorklist",
  "createdAt": "2019-03-19T16:50:12Z",
  "updatedAt": "2019-03-19T17:08:25Z"
}

POST /worklists

Creates a worklist.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
body	body	postWorklists	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	Worklist
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
409	Conflict	Conflict	Error

Retrieve a List of Worklists


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklists', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklists \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "g89fa3dd-0000-494b-1111-4640ccc081e3",
      "worklistCategory": {
        "id": "581433f4-b179-3df4-9bb2-9768ef76493c",
        "name": "Gaps in Care"
      },
      "name": "High Opportunity",
      "description": "Worklist organizing patients based on identified gaps in care.",
      "additionalParameters": "refresh=true",
      "worklistKey": "GapsTemplateWorklist/MemberWorklist",
      "createdAt": "2018-01-10T15:48:32Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    },
    {
      "id": "a68a1daa-bd3f-468d-ae16-543d7c369dbd",
      "worklistCategory": {
        "id": "e5f34c23-e572-44c3-a2cd-7ca358dcec9f",
        "name": "Med Management"
      },
      "name": "90-Day Fill Opportunities to Improve Adherence to Statins",
      "description": "Worklist to identify patients at risk of medication nonadherence for targeted interventions.",
      "additionalParameters": "refresh=true",
      "worklistKey": "MedicationManagement/HighOpportunity",
      "createdAt": "2018-01-10T15:48:32Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/insights-application/v1/worklists/?offset=0&limit=100",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/insights-application/v1/worklists/?offset=0&limit=100"
}

GET /worklists

Retrieves a list of HealtheInsights worklists.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
worklistCategoryId	query	string	false	N/A	The ID of the worklist category.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort.	name

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of worklist reports	Worklists
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Remove a Worklist


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklists/g89fa3dd-0000-494b-1111-4640ccc081e3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklists/g89fa3dd-0000-494b-1111-4640ccc081e3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /worklists/{worklistId}

Removes a worklist from the collection of available worklists.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
worklistId	path	string	true	N/A	The ID of the worklist that belongs to a HealtheInsights worklist category.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Worklist


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklists/g89fa3dd-0000-494b-1111-4640ccc081e3, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklists/g89fa3dd-0000-494b-1111-4640ccc081e3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "g89fa3dd-0000-494b-1111-4640ccc081e3",
  "worklistCategory": {
    "id": "581433f4-b179-3df4-9bb2-9768ef76493c",
    "name": "Gaps in Care"
  },
  "name": "High Opportunity",
  "description": "Worklist organizing patients based on identified gaps in care.",
  "worklistKey": "GapsTemplateWorklist/MemberWorklist",
  "createdAt": "2018-01-10T15:48:32Z",
  "updatedAt": "2018-05-15T12:23:12Z"
}

GET /worklists/{worklistId}

Retrieves a HealtheInsights worklist by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
worklistId	path	string	true	N/A	The ID of the worklist that belongs to a HealtheInsights worklist category.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single HealtheInsights worklist	Worklist
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Worklist




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklists/g89fa3dd-0000-494b-1111-4640ccc081e3', headers: headers, body: {"worklistCategory":{"id":"581433f4-b179-3df4-9bb2-9768ef76493c"},"id":"7cd017ef-7d31-390e-b4fe-52d9f86e517e","name":"High Opportunity","description":"Worklist organizing patients based on identified gaps in care","additionalParameters":"refresh=true","worklistKey":"GapsTemplateWorklist/MemberWorklist"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklists/g89fa3dd-0000-494b-1111-4640ccc081e3 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"worklistCategory":{"id":"581433f4-b179-3df4-9bb2-9768ef76493c"},"id":"7cd017ef-7d31-390e-b4fe-52d9f86e517e","name":"High Opportunity","description":"Worklist organizing patients based on identified gaps in care","additionalParameters":"refresh=true","worklistKey":"GapsTemplateWorklist/MemberWorklist"}

PUT /worklists/{worklistId}

Updates a worklist in the collection of HealtheInsights worklists.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
worklistId	path	string	true	N/A	The ID of the worklist that belongs to a HealtheInsights worklist category.	-
body	body	putWorklists	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Insights Patient Summary

The Insights Patient Summary represents a Team Huddle report view of a patient. The data being retrieved by this service will populate Demographics, Additional Demographics and other relevant sections of the report.

Retrieve a Patient Care Summary


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/populations/0fa79ed3-1413-4d40-ab71-d9d5e6c4babe/patients/0e62e9f6-16a0-4f24-9326-a2c2d2d56429/patient-care-summary', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/populations/0fa79ed3-1413-4d40-ab71-d9d5e6c4babe/patients/0e62e9f6-16a0-4f24-9326-a2c2d2d56429/patient-care-summary \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "c2daa46-ed91-3ee1-15d4-2cd6ba7d7627",
  "demographicSummary": {
    "name": [
      {
        "fullName": "Ms Analisa Roberson",
        "givenNames": [
          "Analisa",
          "Elizabeth"
        ],
        "familyNames": [
          "Roberson"
        ]
      }
    ],
    "birthDate": "1980-08-02",
    "dateOfDeath": "2011-05-10",
    "deceased": "false",
    "administrativeGender": {
      "sourceCodings": [
        {
          "system": "urn:cerner:coding:codingsystem:codeset:57",
          "code": "362",
          "display": "Female"
        }
      ],
      "codings": [
        {
          "system": "2.16.840.1.113883.6.96",
          "code": "248152002",
          "display": "Female"
        }
      ],
      "text": "Female"
    },
    "birthSex": {
      "sourceCodings": [
        {
          "system": "urn:cerner:coding:codingsystem:codeset:57",
          "code": "362",
          "display": "Female"
        }
      ],
      "codings": [
        {
          "system": "2.16.840.1.113883.6.96",
          "code": "248152002",
          "display": "Female"
        }
      ],
      "text": "Female"
    },
    "address": {
      "lines": [
        "1924 Schiller Plains",
        "Apartment 19"
      ],
      "city": "Los Angeles",
      "state": {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.6.92",
            "code": "CA",
            "display": "California"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.92",
            "code": "CA",
            "display": "California"
          }
        ],
        "text": "California"
      },
      "postalCode": "90717",
      "country": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:15",
            "code": "309221",
            "display": "US"
          }
        ],
        "text": "US"
      }
    },
    "ethnicities": [
      {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:27",
            "code": "312507",
            "display": "Non-Hispanic"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.5.50",
            "code": "2186-5",
            "display": "Not Hispanic or Latino"
          }
        ],
        "text": "Non-Hispanic"
      }
    ],
    "races": [
      {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:27",
            "code": "312508",
            "display": "american-indian-or-alaska-native"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.5.45",
            "code": "2186-5",
            "display": "American Indian or Alaska Native"
          }
        ],
        "text": "american-indian-or-alaska-native"
      }
    ],
    "languages": [
      {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "297487008",
            "display": "English language"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "297487008",
            "display": "English language"
          }
        ],
        "text": "English language"
      }
    ],
    "telecoms": [
      {
        "value": "555-203-1314",
        "countryCode": "001"
      }
    ],
    "parentGuardian": [
      {
        "name": "Test, Patient",
        "telecoms": [
          "000-000-0000",
          "000-000-0000"
        ],
        "email": "test.patient@example.com",
        "relationshipType": "MOTHER"
      }
    ]
  },
  "benefitCoverageSummaries": [
    {
      "memberId": "10-10101010",
      "planName": "UHC Choice EPO Select",
      "payerName": "XYZ Advantage (HMO) Medical",
      "policyOrGroupNumber": "12344321",
      "policyOrGroupName": "Group A",
      "benefitType": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:354",
            "code": "634773",
            "display": "Private Health Insurance"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.3.221.5",
            "code": "5",
            "display": "Commercial Insurance"
          }
        ],
        "text": "Commercial Insurance"
      },
      "lineOfBusiness": "Medicare Advantage",
      "planEffectiveDate": "2019-08-02",
      "planEndDate": "2020-01-15",
      "contractPlanBenefitPackage": "H7971 001 Horizon Medicare Blue (PPO)",
      "employerGroup": "APPNEXUS INC",
      "sourceType": "CLAIM"
    }
  ],
  "vitalSignsSummary": {
    "bmi": {
      "value": "37",
      "effectiveDate": "2020-03-02"
    },
    "height": {
      "value": "37",
      "effectiveDate": "2020-03-02"
    },
    "weight": {
      "value": "37",
      "effectiveDate": "2020-03-02"
    }
  },
  "visitSummary": {
    "acuteAdmissions": 12,
    "acuteAdmissionsYearToDate": 8,
    "emergencyRoomVisits": 2,
    "emergencyRoomVisitsYearToDate": 1,
    "nonSpecialistVisits": 1,
    "specialistVisits": 4
  },
  "pcpSummary": {
    "organization": {
      "name": "XYZ Advantage (HMO) Medical"
    },
    "primaryCareProvider": {
      "prefix": "Dr.",
      "given": [
        "Jane",
        "Susannah"
      ],
      "family": [
        "Smith"
      ],
      "suffix": "MD.",
      "formatted": "Dr. Jane Susannah Smith MD."
    },
    "organizations": [
      {
        "name": "XYZ Advantage (HMO) Medical"
      }
    ],
    "primaryCareProviders": [
      {
        "prefix": "Dr.",
        "given": [
          "Test 1",
          "Test 2"
        ],
        "family": [
          "Provider"
        ],
        "suffix": "MD.",
        "formatted": "Dr. Test 1 Test 2 Provider MD."
      }
    ],
    "lastAccountableProviderVisit": "2020-05-02",
    "providerGroupEffectiveDate": "2019-08-02"
  },
  "careManagers": [
    {
      "prefix": "Dr.",
      "given": [
        "Test",
        "Care"
      ],
      "family": [
        "Manager"
      ],
      "suffix": "MD.",
      "formatted": "Dr. Test Care Manager MD."
    }
  ],
  "scoringSummary": {
    "partCRafScore": "79",
    "partDRafScore": "1.10",
    "maraRiskScore": {
      "totalScore": "0.17",
      "model": "MCCONLAG0"
    }
  },
  "riskAdjustmentConditionSummary": {
    "esrd": "false",
    "hospiceCare": "false",
    "longTermCare": "false"
  },
  "estimatedCostsSummary": {
    "prescriptionCost": 5677.12,
    "prescriptionCostYearToDate": 2388.05,
    "medicalCost": 425.98,
    "medicalCostYearToDate": 124.03,
    "memberCost": 2388.77,
    "memberCostYearToDate": 769.11
  }
}

GET /populations/{populationId}/patients/{patientId}/patient-care-summary

Retrieves a patient care summary for a given patient.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
populationId	path	string	true	N/A	The ID of the population.	-
patientId	path	string	true	N/A	The unique ID of a patient in a population.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Single patient care summary for a given patient.	PatientCareSummary
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Schema Definitions

postSites

Name	Type	Required	Description	Accepted Values
isDefault	boolean	true	The default site used by the HealtheInsights application when multiple sites are defined for a tenant.	-
title	string	true	The display title for the defined site.	-
name	string	true	The name for the defined site.	-
configuredItems	[object]	false	The configured items that are set for the site.	-
configuredFeatures	[object]	false	The configured features that are set for the site.	-
createdBy	string	true	The ID of the personnel member who created the site configuration.	-

Site

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the site.	-
isDefault	boolean	true	The default site used by the HealtheInsights application when multiple sites are defined for a tenant.	-
title	string	true	The display title for the defined site.	-
name	string	true	The name for the defined site.	-
configuredItems	[string]	true	The configured items that are set for the site.	-
configuredFeatures	[string]	false	The configured features that are set for the site.	-
createdAt	string(date-time)	true	The date and time when this resource was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
updatedAt	string(date-time)	true	The date and time of the most recent update to this location, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
createdBy	string	true	The ID of the personnel member who created the site configuration.	-
updatedBy	string	true	The ID of the personnel member who updated the site configuration.	-

Error

Name	Type	Required	Description	Accepted Values
code	integer(int32)	true	The HTTP response status code that represents the error.	-
message	string	true	A human-readable description of the error.	-
errorDetails	[ErrorDetail]	false	A list of additional error details.	-

ErrorDetail

Name	Type	Required	Description	Accepted Values
domain	string	false	A subsystem or context where an error occurred.	-
reason	string	false	A codified value that represents the specific error that caused the current error status.	-
message	string	false	A human-readable description of an error.	-
locationType	string	false	The location or type of the field that caused an error.	query, header, path, formData, body
location	string	false	The name of the field that caused an error.	-

Sites

Name	Type	Required	Description	Accepted Values
items	[Site]	true	An array containing the current page of results.	-
totalResults	integer(int32)	false	The total number of results for the specified parameters.	-
firstLink	string	true	The first page of results.	-
lastLink	string	false	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-

putSites

Name	Type	Required	Description	Accepted Values
isDefault	boolean	true	The default site used by the HealtheInsights application when multiple sites are defined for a tenant.	-
title	string	true	The display title for the defined site.	-
name	string	true	The name for the defined site.	-
configuredItems	[object]	false	The configured items that are set for the site.	-
configuredFeatures	[object]	false	The configured features that are set for the site.	-
updatedBy	string	true	The ID of the personnel member who updated the site configuration.	-

ConfigurableItems

Name	Type	Required	Description	Accepted Values
items	[ConfigurableItem]	true	An array containing the current page of results.	-
totalResults	integer(int32)	false	The total number of results for the specified parameters.	-
firstLink	string	true	The first page of results.	-
lastLink	string	false	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-

ConfigurableItem

Name	Type	Required	Description	Accepted Values
title	string	true	The display name of the defined configuration.	-
name	string	true	The unique key that identifies a defined configuration.	-
type	string	true	The type of configuration value. The following types are possible: STRING, URI, REFERENCE.	STRING, URI, REFERENCE
referenceKind	string	false	The kind of reference. This value is required when the configuration type is REFERENCE.	-
min	integer(int64)	true	The minimum number of values that must be defined for the configuration.	-
max	integer(int64)	false	The maximum number of values that the specified configuration supports.	-

ConfigurableFeatures

Name	Type	Required	Description	Accepted Values
items	[ConfigurableFeature]	true	An array containing the current page of results.	-
totalResults	integer(int32)	false	The total number of results for the specified parameters.	-
firstLink	string	true	The first page of results.	-
lastLink	string	false	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-

ConfigurableFeature

Name	Type	Required	Description	Accepted Values
title	string	true	The display name of the defined feature.	-
name	string	true	The unique name that identifies a feature defined for the system.	-

postWorkbooks

Name	Type	Required	Description	Accepted Values
name	string	true	The unique name of the workbook.	-
defaultPopulation	object	true	The unique ID of the default population used for patient longitudinal record context in the scope of this workbook.	-
» id	string	true	The unique ID of the default population used for patient longitudinal record context in the scope of this workbook.	-
» subpopulationId	string	false	The unique ID of the subpopulation used for patient longitudinal record context in the scope of this workbook.	-
personSearchIdentifierType	string	false	The type of identifier used to filter person search results.	-
personSummaryReportKey	string	true	The key or unique path value used to reference the person summary report that is displayed in the Summary tab in Patient Care Profile (for example, the {TableauWorkbook}/{TableauWorksheet} values for the report built to provide this display).	-

Workbook

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the workbook.	-
name	string	true	The unique name of the workbook.	-
defaultPopulation	Population	true	The unique ID of the default population used for patient longitudinal record context in the scope of this workbook.	-
personSearchIdentifierType	string	false	The type of identifier used to filter person search results.	MRN, NATIONAL_HEALTH_PLAN_ID, MEMBER_ID, SUBSCRIBER_NUMBER
personSummaryReportKey	string	true	The key or unique path value used to reference the person summary report that is displayed in the Summary tab of Patient Care Profile (for example, the {TableauWorkbook}/{TableauWorksheet} values for the report built to provide this display).	-
createdAt	string(date-time)	false	The date and time when this resource was created, in International Organization for Standardization (ISO) 8601 YYYY-MM-DDThh:mm:ssZ format.	-
updatedAt	string(date-time)	false	The date and time of the most recent update to this location, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-

Population

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the default population used for patient longitudinal record context in the scope of this workbook.	-
subpopulationId	string	false	The unique ID of the subpopulation used for patient longitudinal record context in the scope of this workbook.	-

Workbooks

Name	Type	Required	Description	Accepted Values
items	[Workbook]	true	An array containing the current page of results.	-
totalResults	integer(int32)	false	The total number of results for the specified parameters.	-
firstLink	string	true	The first page of results.	-
lastLink	string	false	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-

putWorkbooks

Name	Type	Required	Description	Accepted Values
name	string	true	The unique name of the workbook.	-
defaultPopulation	object	true	The unique ID of the default population used for patient longitudinal record context in the scope of this workbook.	-
» id	string	true	The unique ID of the default population used for patient longitudinal record context in the scope of this workbook.	-
» subpopulationId	string	false	The unique ID of the subpopulation used for patient longitudinal record context in the scope of this workbook.	-
personSearchIdentifierType	string	false	The type of identifier used to filter person search results.	-
personSummaryReportKey	string	true	The key or unique path value used to reference the person summary report that is displayed in the Summary tab in Patient Care Profile (for example, the {TableauWorkbook}/{TableauWorksheet} values for the report built to provide this display).	-

Worklists

Name	Type	Required	Description	Accepted Values
items	[Worklist]	true	An array containing the current page of results.	-
totalResults	integer(int32)	false	The total number of results for the specified parameters.	-
firstLink	string	true	The first page of results.	-
lastLink	string	false	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-

Worklist

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the worklist.	-
worklistCategory	WorklistCategoryResponse	true	The category used to classify a set of related worklists.	-
name	string	true	The name of the worklist.	-
additionalParameters	string	false	The additional parameters added to the worklist URL.	-
description	string	false	An explanation of the worklist’s intended use or purpose.	-
worklistKey	string	true	The key or unique path value used to reference the worklist report (for example, the {TableauWorkbook}/{TableauWorksheet} values for the report built to provide this display).	-
createdAt	string(date-time)	true	The date and time when this resource was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
updatedAt	string(date-time)	true	The date and time of the most recent update to this location, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-

WorklistCategoryResponse

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the worklist category.	-
name	string	true	The unique name of the worklist category.	-

postWorklistCategories

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the worklist category.	-

WorklistCategory

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the worklist category.	-
name	string	true	The unique name of the worklist category.	-
createdAt	string(date-time)	false	The date and time when this resource was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
updatedAt	string(date-time)	false	The date and time of the most recent update to this location, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-

WorklistCategories

Name	Type	Required	Description	Accepted Values
items	[WorklistCategory]	true	An array containing the current page of results.	-
totalResults	integer(int32)	false	The total number of results for the specified parameters.	-
firstLink	string	true	The first page of results.	-
lastLink	string	false	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-

putWorklistCategories

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the worklist category.	-

postWorklists

Name	Type	Required	Description	Accepted Values
worklistCategory	object	true	The category of the related worklists.	-
» id	string	true	The unique ID of the worklist category.	-
name	string	true	The name of the worklist.	-
description	string	false	An explanation of the worklist’s intended use or purpose.	-
additionalParameters	string	false	The additional parameters added to the worklist URL.	-
worklistKey	string	true	The key or unique path value used to reference the worklist report (for example, the {TableauWorkbook}/{TableauWorksheet} values for the report built to provide this display).	-

putWorklists

Name	Type	Required	Description	Accepted Values
worklistCategory	object	true	The category of the related worklists.	-
» id	string	true	The unique ID of the worklist category.	-
name	string	true	The name of the worklist.	-
description	string	false	An explanation of the worklist’s intended use or purpose.	-
additionalParameters	string	false	The additional parameters added to the worklist URL.	-
worklistKey	string	true	The key or unique path value used to reference the worklist report (for example, the {TableauWorkbook}/{TableauWorksheet} values for the report built to provide this display).	-

PatientCareSummary

Name	Type	Required	Description	Accepted Values
id	string	true	An ID that uniquely identifies the patient care summary in the context of the patient.	-
demographicSummary	PatientDemographic	false	The demographic summary for a patient. When applicable, preferred demographic data is used.	-
benefitCoverageSummaries	[BenefitCoverageSummary]	false	The benefit coverage summary for a patient.	-
vitalSignsSummary	VitalSignsSummary	false	The result of the observation or measurement. The data type of the result value is either numeric, codified, text, or a date.	-
visitSummary	VisitSummary	false	The visit summary for a patient.	-
pcpSummary	PcpSummary	false	The primary care provider summary for a patient.	-
careManagers	[ProviderName]	false	The names of the care managers.	-
scoringSummary	ScoringSummary	false	The scoring summary for a patient.	-
riskAdjustmentConditionSummary	RiskAdjustmentConditionSummary	false	The risk adjustment condition summary for a patient.	-
estimatedCostsSummary	EstimatedCostsSummary	false	The estimated cost summary for a patient.	-

PatientDemographic

Name	Type	Required	Description	Accepted Values
name	Name	true	The name of the patient.	-
birthDate	string	false	The date of birth of the patient. In International Organization for Standardization (ISO) 8601 formatting with precision ranging from YYYY to YYYY-MM-DD. The date of birth does not designate a time zone.	-
dateOfDeath	string	false	The date of death of the patient. In International Organization for Standardization (ISO) 8601 formatting with precision ranging from YYYY to YYYY-MM-DD. The date of death does not designate a time zone.	-
deceased	boolean	false	Indicates whether a patient is deceased.	-
administrativeGender	CodeableConcept	false	The administrative gender code of the patient. The administrative gender can differ from the patient’s clinical sex, preferred gender identity, legal sex, and birth sex.	-
birthSex	CodeableConcept	false	Patient Sex (at birth), or Assigned Sex, is the sex (male or female) given to a child at birth, most often based on the child’s external anatomy.	-
address	Address	false	A current address for the patient.	-
ethnicities	[CodeableConcept]	false	A list of ethnicities pertaining to the patient. In the U.S., the constructs of race and ethnicity are largely based on sociopolitical established practice and self-identification as opposed to anthropological or scientific classification.	-
races	[CodeableConcept]	false	A list of races pertaining to the patient. In the U.S., the constructs of race and ethnicity are largely based on sociopolitical established practice and self-identification as opposed to anthropological or scientific classification.	-
languages	[CodeableConcept]	false	A list of languages that a patient can use to communicate.	-
telecoms	[Telecom]	false	A list of contact details for a patient. These contact details may include current or previous email addresses and contact numbers.	-
parentGuardian	[ParentGuardian]	false	A list of parent or guardian details for a patient. These contact details may include current or previous email addresses and contact numbers.	-

Name

Name	Type	Required	Description	Accepted Values
fullName	string	false	The fully formatted representation of the person’s name.	-
givenNames	[string]	true	An ordered list of given names (first and middle names).	-
familyNames	[string]	true	An ordered list of family names.	-
suffix	string	false	The parts that come after the name such as MD, III, or Jr.	-

CodeableConcept

Name	Type	Required	Description	Accepted Values
codings	[Code]	true	A list of codified values from standard code systems recognized by Health Data Intelligence.	-
sourceCodings	[Code]	true	The list of codified values provided in the source data. Not all of these codes are available in the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by Health Data Intelligence.	-
concepts	[Concept]	false	The list of ontological concepts derived from the codified values from standard code systems recognized by Health Data Intelligence.	-
text	string	false	This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list.	-

Code

Name	Type	Required	Description	Accepted Values
code	string	true	The unique ID of the code.	-
display	string	false	A human-readable representation of the code.	-
system	string	true	The ID of the coding system that gives meaning to the code.	-

Concept

Name	Type	Required	Description	Accepted Values
alias	string	true	The unique ID of the concept in a context.	-
contextId	string	true	The unique ID of the context. IDs are in all caps and do not include dashes.	-

Address

Name	Type	Required	Description	Accepted Values
lines	[string]	true	An ordered list of address lines indicating the house number, apartment number, street name, street direction, P.O. Box number, and similar address information.	-
city	string	false	The name of the city, town, or village.	-
state	CodeableConcept	false	The state or other subunit of a country.	-
postalCode	string	false	The region defined by the postal service for this address.	-
country	CodeableConcept	false	The nation specified for this address.	-

Telecom

Name	Type	Required	Description	Accepted Values
systemCategory	string	false	The type of communication medium.	EMAIL, Note: For telecom values that are email addresses, the corresponding system category is EMAIL. For other communication mediums, the system category is not provided due to ambiguity among representations of phone, fax, and other mediums.
value	string	true	The contact information such as email address or phone number. The formatting of the value is determined by the data source.	-
extension	string	false	A number that is dialed after successfully connecting to a private phone network to further route the connection to an internal destination.	-
countryCode	string	false	The country code of the telecom.	-

ParentGuardian

Name	Type	Required	Description	Accepted Values
name	string	true	Name of the parent or guardian.	-
telecoms	[string]	true	A list of contact information, such as phone number, of the parent or guardian.	-
email	string	false	Email address of parent or guardian.	-
relationshipType	string	false	Relationship to the patient.	MOTHER, FATHER, STEP-MOTHER, STEP-FATHER, LEGAL GUARDIAN, OTHER

BenefitCoverageSummary

Name	Type	Required	Description	Accepted Values
memberId	string	false	The patient’s benefit provider ID.	-
planName	string	false	The name of the plan.	-
payerName	string	false	The name of the payer organization or entity that administers the plan.	-
policyOrGroupNumber	string	false	The policy or group number assigned to the subscribed plan member. The group number is the number found on a health insurance ID card that is unique to a company or employer through which the subscriber obtains coverage. Otherwise, a unique policy number may be assigned to an individual subscriber.	-
policyOrGroupName	string	false	The policy or group name if a policy or group number is not available.	-
benefitType	CodeableConcept	false	The code that represents the insurance line or benefit type associated with the benefit plan.	-
lineOfBusiness	string	false	Distinguishes the subplan or population in a health plan.	-
planEffectiveDate	string	false	The effective date of the patient’s benefit plan. In ISO 8601 formatting with precision ranging from YYYY-MM to YYYY-MM-DDThh:mm:ss.SSSZ.	-
planEndDate	string	false	The end date of the patient’s benefit plan. In ISO 8601 formatting with precision ranging from YYYY-MM to YYYY-MM-DDThh:mm:ss.SSSZ.	-
contractPlanBenefitPackage	string	false	The contracted plan benefit package for the patient.	-
employerGroup	string	false	The employer group on the patient’s benefit plan.	-
sourceType	string	false	The type of the data source.	CLAIM, EMR, ENROLLMENT, BILLING, OTHER

VitalSignsSummary

Name	Type	Required	Description	Accepted Values
bmi	VitalSignsValue	false	The BMI value of the patient.	-
height	VitalSignsValue	false	The height of the patient in centimeters.	-
weight	VitalSignsValue	false	The weight of the patient in kilograms.	-

VitalSignsValue

Name	Type	Required	Description	Accepted Values
modifier	string	false	A comparator that indicates how to interpret the numeric value, for example, >, <, >=, or <=. Often present due to limitations in measurement precision.	-
value	string	true	The low or high reference range value, expressed as a numeric value that can be a positive or negative whole number or decimal value.	-
effectiveDate	string	false	The date when the vital signs were taken. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ.	-

VisitSummary

Name	Type	Required	Description	Accepted Values
acuteAdmissions	integer(int64)	false	The number of acute care facility admissions in the previous 12 months.	-
acuteAdmissionsYearToDate	integer(int64)	false	The number of acute care facility admissions from January 1 of this year until the present day.	-
emergencyRoomVisits	integer(int64)	false	The number of emergency room visits in the previous 12 months.	-
emergencyRoomVisitsYearToDate	integer(int64)	false	The number of emergency room visits from January 1 of this year until the present day.	-
nonSpecialistVisits	integer(int64)	false	The number of nonspecialist provider visits in the previous 12 months.	-
specialistVisits	integer(int64)	false	The number of specialist provider visits in the previous 12 months.	-

PcpSummary

Name	Type	Required	Description	Accepted Values
organization	Organization	false	This attribute is deprecated. Use the `organizations` attribute instead.	-
primaryCareProvider	ProviderName	false	This attribute is deprecated. Use the `primaryCareProviders` attribute instead.	-
organizations	[Organization]	false	The organizations that the primary care provider belongs to.	-
primaryCareProviders	[ProviderName]	false	The names of the primary care providers.	-
lastAccountableProviderVisit	string	false	The date of the patient’s last visit with their primary care physician (PCP) or another provider in the PCP group, in ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ.	-
providerGroupEffectiveDate	string	false	The effective date of the patient’s provider group, in ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ.	-

Organization

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the organization that the provider belongs to.	-

ProviderName

Name	Type	Required	Description	Accepted Values
prefix	string	false	The parts that come before the name such as Dr., Mr., or Mrs.	-
given	[string]	true	A list of given name portions of the person’s name. For example, if a person has a first name and a middle name, the first name should be the first item on the list and the middle name should be the second item on the list.	-
family	[string]	true	A list of family (last) name portions of the person’s name. Some people have multiple family names.	-
suffix	string	false	The parts that come after the name such as MD, III, or Jr.	-
formatted	string	false	The person’s fully-formatted name.	-

ScoringSummary

Name	Type	Required	Description	Accepted Values
partCRafScore	string	false	The Medicare Advantage (Part C) benefit calculated risk adjustment factor (RAF) score.	-
partDRafScore	string	false	The Medicare Advantage (Part D) benefit calculated RAF score.	-
maraRiskScore	MaraRiskScore	false	A Milliman Advanced Risk Adjusters (MARA) risk score that represents the expected total annual resource use.	-

MaraRiskScore

Name	Type	Required	Description	Accepted Values
totalScore	string	false	The risk score that represents the expected total annual resource use.	-
model	string	false	The abbreviated name of the model that relates to the risk scores on the record.	-

RiskAdjustmentConditionSummary

Name	Type	Required	Description	Accepted Values
esrd	boolean	false	CMS Medicare Advantage identification of End Stage Renal Disease (ESRD).	-
hospiceCare	boolean	false	CMS Medicare Advantage identification of hospice care.	-
longTermCare	boolean	false	CMS Medicare Advantage identification of Long Term Care.	-

EstimatedCostsSummary

Name	Type	Required	Description	Accepted Values
prescriptionCost	number(float)	false	The estimated cost of all prescriptions over the preceding 12 months	-
prescriptionCostYearToDate	number(float)	false	The estimated cost of all prescriptions from January 1 of this year until the present day.	-
medicalCost	number(float)	false	The estimated cost of all medical care over the preceding 12 months	-
medicalCostYearToDate	number(float)	false	The estimated cost of all medical care from January 1 of this year until the present day.	-
memberCost	number(float)	false	The estimated all member cost over the preceding 12 months.	-
memberCostYearToDate	number(float)	false	The estimated all member cost from January 1 of this year until the present day.	-