NAV Navbar
Logo cerner
Ruby Shell

HealtheInsights Application API v1

The HealtheIntent HealtheInsights Application API enables configuration of the HealtheInsights application.

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

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

Example Request:




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"}

Example response

{
  "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

Example Request:


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'

Example response

{
  "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-1.healtheintent.com/insights-application/v1/workbooks/?offset=0&limit=100",
  "lastLink": "https://cernerdemo.api.us-1.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

Example Request:


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

Example Request:


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'

Example response

{
  "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

Example Request:




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

Example Request:


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/12628e5e-09e2-11e8-9dc2-587234acdcbf0/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/12628e5e-09e2-11e8-9dc2-587234acdcbf0/worklists \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "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-1.healtheintent.com/insights-application/v1/workbooks/12628e5e-09e2-11e8-9dc2-587234acdcbf0/worklists/?offset=0&limit=100",
  "lastLink": "https://cernerdemo.api.us-1.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

Example Request:


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/12628e5e-09e2-11e8-9dc2-587234acdcbf0', 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/12628e5e-09e2-11e8-9dc2-587234acdcbf0 \
-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

Example Request:


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

Example Request:




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"}

Example response

{
  "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

Example Request:


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'

Example response

{
  "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-1.healtheintent.com/insights-application/v1/worklist-categories/?offset=0&limit=100",
  "lastLink": "https://cernerdemo.api.us-1.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

Example Request:


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

Example Request:


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'

Example response

{
  "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

Example Request:




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

Example Request:




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"},"name":"High Opportunity","description":"Worklist organizing patients based on identified gaps in care","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"},"name":"High Opportunity","description":"Worklist organizing patients based on identified gaps in care","worklistKey":"GapsTemplateWorklist/MemberWorklist"}

Example response

{
  "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": "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

Example Request:


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'

Example response

{
  "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 to identify patients at risk of medication nonadherence for targeted interventions.",
      "worklistKey": "MedicationManagement/HighOpportunity",
      "createdAt": "2018-01-10T15:48:32Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/insights-application/v1/worklists/?offset=0&limit=100",
  "lastLink": "https://cernerdemo.api.us-1.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

Example Request:


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

Example Request:


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'

Example response

{
  "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

Example Request:




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"},"name":"High Opportunity","description":"Worklist organizing patients based on identified gaps in care","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"},"name":"High Opportunity","description":"Worklist organizing patients based on identified gaps in care","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

Schema Definitions

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. -

postWorkbooks

Name Type Required Description Accepted Values
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. -
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. -

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. -

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 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. -
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. -
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. -

WorklistCategoryId

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

postWorklists

Name Type Required Description Accepted Values
worklistCategory WorklistCategoryId true The category of the related worklists. -
name string true The name of the worklist. -
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). -

putWorklists

Name Type Required Description Accepted Values
worklistCategory WorklistCategoryId true The category of the related worklists. -
name string true The name of the worklist. -
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). -
Ruby Shell