NAV Navbar
Logo cerner
Ruby Shell

HealtheAnalytics Application API v1

HealtheAnalytics is designed to compliment the problem-solving process of defining goals, measuring current performance, analyzing variables, initiating appropriate improvement strategies, and controlling and reevaluating the impact of those strategies. To assist with this problem-solving process, Cerner provides prestructured HealtheAnalytics content for specific analytic focuses. The prestructured content includes key performance indicators (KPIs), reports, and data models.

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

Projects

Projects include the content that best represents an organization’s data and can help the organization make meaningful changes in workflows. Content can include an organization’s standard reports, custom reports, KPIs, .PDF files, and so on. Providers and health care organizations can view predefined reports and investigate specific underlying variables using analytics visualization tools such as Tableau and SAP BusinessObjects. The project endpoints can be used to create projects and to add reports, KPIs, and widgets to a project.

Create a Project

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/healtheanalytics-application/v1/projects', headers: headers, body: {"name":"Cost and Utilization","description":"Explore cost and utilization metrics derived from payer claims and enrollment data."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Cost and Utilization","description":"Explore cost and utilization metrics derived from payer claims and enrollment data."}

Example response

{
  "id": "87d015cf-2ae3-48d4-822c-9fff4d5b8570",
  "name": "Cost and Utilization",
  "description": "Explore cost and utilization metrics derived from payer claims and enrollment data.",
  "discoverability": "PRIVATE",
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

POST /projects

Creates a project.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created Project
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a List of Projects

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/healtheanalytics-application/v1/projects', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "87d015cf-2ae3-48d4-822c-9fff4d5b8570",
      "name": "Cost and Utilization",
      "description": "Explore cost and utilization metrics derived from payer claims and enrollment data.",
      "discoverability": "PRIVATE",
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z",
      "reports": [
        {
          "id": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
          "name": "Pharmacy Utilization Summary",
          "description": "A utilization summary of all pharmacy drugs.",
          "externalSourceMnemonic": "tableau",
          "sourceApplicationId": "0a19d2c9-a37e-45a3-8cf3-4e5864512c8e",
          "kpiIndicator": "false",
          "reportDataModels": [
            {
              "id": "1b11827d-fb3b-4fa1-8870-82923c17fd2a",
              "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
              "dataModelId": "05fafbf5-69a4-42a0-9c12-4ed177372837",
              "createdAt": "2019-03-25T10:49:07.000Z",
              "updatedAt": "2019-03-25T10:49:07.000Z"
            }
          ],
          "createdAt": "2019-03-25T10:49:07.000Z",
          "updatedAt": "2019-03-25T10:49:07.000Z"
        }
      ],
      "kpis": [
        {
          "id": "02a1443e-8312-4ab6-94b7-07c1921ce40e",
          "name": "Visits",
          "description": "The Visits KPI displays the number of encounters based on the arrival date.\n",
          "title": "Average Outpatient Visits (OP Visits)",
          "valueField": "value",
          "xAxis": "grain",
          "yAxis": "value",
          "target": 1,
          "polarity": 1,
          "primary": true,
          "reportId": "8abb592a-55c4-4868-8653-854604e10502",
          "organization": "Revenue Cycle",
          "dashboardReportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
          "createdAt": "2019-03-25T10:49:07.000Z",
          "updatedAt": "2019-03-25T10:49:07.000Z"
        }
      ],
      "widgets": [
        {
          "id": "38a03244-cc06-4acd-a16b-a07a351bcbe1",
          "sizeX": 1,
          "sizeY": 1,
          "row": 1,
          "col": 1,
          "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
          "contentUrl": "test/sheets/Sheet1",
          "createdAt": "2019-03-25T10:49:07.000Z",
          "updatedAt": "2019-03-25T10:49:07.000Z"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects?offset=0&limit=20"
}

GET /projects

Retrieves a list of projects, filtered by the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
name query string false N/A Filters the response by the project name. -
authorizedPersonnelId query string false N/A Filters the response based on the ID of the personnel who should be authorized to access the projects.
Note: The response includes only the projects for which the user has access.
-
projectIds query array[string] false N/A Filters the response to include a specific list of projects based on their IDs. -
discoverability query string false PRIVATE Discoverability controls who can discover a project of which they are not already a member. PUBLIC, PRIVATE, HIDDEN
projectIds query array[string] false N/A Filters the response to include a specific list of projects based on their IDs. -
orderBy query string false name A comma-separated list of fields by which to sort. -name, name, -createdAt, createdAt, -updatedAt, updatedAt
associatedEntities query boolean false false Indicates whether the retrieved list of projects should include associated reports, widgets, and KPIs. -
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 OK ProjectDetails
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete a Project

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /projects/{projectId}

Deletes a project, including all child reports, widgets, and project KPIs.

Parameters

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

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

Update a Project

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570', headers: headers, body: {"name":"Cost and Utilization","description":"Explore cost and utilization metrics derived from payer claims and enrollment data.","discoverability":"public"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Cost and Utilization","description":"Explore cost and utilization metrics derived from payer claims and enrollment data.","discoverability":"public"}

PUT /projects/{projectId}

Updates a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project. -
body body putProjects 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

Retrieve a Single Project

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "87d015cf-2ae3-48d4-822c-9fff4d5b8570",
  "name": "Cost and Utilization",
  "description": "Explore cost and utilization metrics derived from payer claims and enrollment data.",
  "discoverability": "PRIVATE",
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z",
  "reports": [
    {
      "id": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
      "name": "Pharmacy Utilization Summary",
      "description": "A utilization summary of all pharmacy drugs.",
      "externalSourceMnemonic": "tableau",
      "sourceApplicationId": "0a19d2c9-a37e-45a3-8cf3-4e5864512c8e",
      "kpiIndicator": "false",
      "reportDataModels": [
        {
          "id": "1b11827d-fb3b-4fa1-8870-82923c17fd2a",
          "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
          "dataModelId": "05fafbf5-69a4-42a0-9c12-4ed177372837",
          "createdAt": "2019-03-25T10:49:07.000Z",
          "updatedAt": "2019-03-25T10:49:07.000Z"
        }
      ],
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z"
    }
  ],
  "kpis": [
    {
      "id": "02a1443e-8312-4ab6-94b7-07c1921ce40e",
      "name": "Visits",
      "description": "The Visits KPI displays the number of encounters based on the arrival date.\n",
      "title": "Average Outpatient Visits (OP Visits)",
      "valueField": "value",
      "xAxis": "grain",
      "yAxis": "value",
      "target": 1,
      "polarity": 1,
      "primary": true,
      "reportId": "8abb592a-55c4-4868-8653-854604e10502",
      "organization": "Revenue Cycle",
      "dashboardReportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z"
    }
  ],
  "widgets": [
    {
      "id": "38a03244-cc06-4acd-a16b-a07a351bcbe1",
      "sizeX": 1,
      "sizeY": 1,
      "row": 1,
      "col": 1,
      "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
      "contentUrl": "test/sheets/Sheet1",
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z"
    }
  ]
}

GET /projects/{projectId}

Retrieves a single project by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project. -
associatedEntities query boolean false false Indicates whether the retrieved list of projects should include associated reports, widgets, and KPIs. -

Response Statuses

Status Meaning Description Schema
200 OK OK ProjectDetail
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Reports

A report is a document created in SAP BusinessObjects or Tableau.

Add a Report

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports', headers: headers, body: {"name":"Pharmacy Utilization Summary","description":"A utilization summary of all pharmacy drugs.","externalSourceMnemonic":"tableau","sourceApplicationId":"0a19d2c9-a37e-45a3-8cf3-4e5864512c8e","kpiIndicator":"false","dataModelIds":["05fafbf5-69a4-42a0-9c12-4ed177372837"]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Pharmacy Utilization Summary","description":"A utilization summary of all pharmacy drugs.","externalSourceMnemonic":"tableau","sourceApplicationId":"0a19d2c9-a37e-45a3-8cf3-4e5864512c8e","kpiIndicator":"false","dataModelIds":["05fafbf5-69a4-42a0-9c12-4ed177372837"]}

Example response

{
  "id": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
  "name": "Pharmacy Utilization Summary",
  "description": "A utilization summary of all pharmacy drugs.",
  "externalSourceMnemonic": "tableau",
  "sourceApplicationId": "0a19d2c9-a37e-45a3-8cf3-4e5864512c8e",
  "kpiIndicator": "false",
  "reportDataModels": [
    {
      "id": "1b11827d-fb3b-4fa1-8870-82923c17fd2a",
      "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
      "dataModelId": "05fafbf5-69a4-42a0-9c12-4ed177372837",
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z"
    }
  ],
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

POST /projects/{projectId}/reports

Adds a report to a project.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created Report
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a List of Reports

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
      "name": "Pharmacy Utilization Summary",
      "description": "A utilization summary of all pharmacy drugs.",
      "externalSourceMnemonic": "tableau",
      "sourceApplicationId": "0a19d2c9-a37e-45a3-8cf3-4e5864512c8e",
      "kpiIndicator": "false",
      "reportDataModels": [
        {
          "id": "1b11827d-fb3b-4fa1-8870-82923c17fd2a",
          "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
          "dataModelId": "05fafbf5-69a4-42a0-9c12-4ed177372837",
          "createdAt": "2019-03-25T10:49:07.000Z",
          "updatedAt": "2019-03-25T10:49:07.000Z"
        }
      ],
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports?offset=0&limit=20"
}

GET /projects/{projectId}/reports

Retrieves a list of reports filtered by the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project. -
name query string false N/A Filters the response by the name of the report. -
externalSourceMnemonic query string false N/A Filters the response by the external source mnemonic. -
orderBy query string false name A comma-separated list of fields by which to sort. -name, name, -createdAt, createdAt, -updatedAt, updatedAt
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 OK Reports
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete a Report

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /projects/{projectId}/reports/{reportId}

Removes a report from a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project. -
reportId path string true N/A The unique ID of the report. -

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

Update a Report

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c', headers: headers, body: {"name":"Pharmacy Utilization Summary","description":"A utilization summary of all pharmacy drugs","externalSourceMnemonic":"tableau","sourceApplicationId":"0a19d2c9-a37e-45a3-8cf3-4e5864512c8e","dataModelIds":["05fafbf5-69a4-42a0-9c12-4ed177372837"]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Pharmacy Utilization Summary","description":"A utilization summary of all pharmacy drugs","externalSourceMnemonic":"tableau","sourceApplicationId":"0a19d2c9-a37e-45a3-8cf3-4e5864512c8e","dataModelIds":["05fafbf5-69a4-42a0-9c12-4ed177372837"]}

PUT /projects/{projectId}/reports/{reportId}

Updates a report of a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project. -
reportId path string true N/A The unique ID of the report. -
body body putProjectsProjectidReports 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

Retrieve a Single Report

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
  "name": "Pharmacy Utilization Summary",
  "description": "A utilization summary of all pharmacy drugs.",
  "externalSourceMnemonic": "tableau",
  "sourceApplicationId": "0a19d2c9-a37e-45a3-8cf3-4e5864512c8e",
  "kpiIndicator": "false",
  "reportDataModels": [
    {
      "id": "1b11827d-fb3b-4fa1-8870-82923c17fd2a",
      "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
      "dataModelId": "05fafbf5-69a4-42a0-9c12-4ed177372837",
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z"
    }
  ],
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

GET /projects/{projectId}/reports/{reportId}

Retrieves a single report by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project. -
reportId path string true N/A The unique ID of the report. -

Response Statuses

Status Meaning Description Schema
200 OK OK Report
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Widgets

Widgets are report views that can be embedded in an application to display a quick view of the reports.

Add a Widget

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

Example response

{
  "id": "38a03244-cc06-4acd-a16b-a07a351bcbe1",
  "sizeX": 1,
  "sizeY": 1,
  "row": 1,
  "col": 1,
  "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
  "contentUrl": "test/sheets/Sheet1",
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

POST /projects/{projectId}/widgets

Adds a widget to a project.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created Widget
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a List of Widgets

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "38a03244-cc06-4acd-a16b-a07a351bcbe1",
      "sizeX": 1,
      "sizeY": 1,
      "row": 1,
      "col": 1,
      "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
      "contentUrl": "test/sheets/Sheet1",
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets?offset=0&limit=20"
}

GET /projects/{projectId}/widgets

Retrieves a list of widgets filtered by the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project. -
reportId query string false N/A The unique ID of the report. -
contentUrl query string false N/A The URL of the report’s source application. -
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 OK Widgets
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete a Widget

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets/38a03244-cc06-4acd-a16b-a07a351bcbe1', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets/38a03244-cc06-4acd-a16b-a07a351bcbe1 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /projects/{projectId}/widgets/{widgetId}

Deletes a widget from the project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project. -
widgetId path string true N/A The unique ID of the widget. -

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

Update a Widget

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets/38a03244-cc06-4acd-a16b-a07a351bcbe1', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets/38a03244-cc06-4acd-a16b-a07a351bcbe1 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /projects/{projectId}/widgets/{widgetId}

Updates a widget by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project. -
widgetId path string true N/A The unique ID of the widget. -
body body putProjectsProjectidWidgets 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

Retrieve a Single Widget

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets/38a03244-cc06-4acd-a16b-a07a351bcbe1', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets/38a03244-cc06-4acd-a16b-a07a351bcbe1 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "38a03244-cc06-4acd-a16b-a07a351bcbe1",
  "sizeX": 1,
  "sizeY": 1,
  "row": 1,
  "col": 1,
  "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
  "contentUrl": "test/sheets/Sheet1",
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

GET /projects/{projectId}/widgets/{widgetId}

Retrieves a single widget by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project. -
widgetId path string true N/A The unique ID of the widget. -

Response Statuses

Status Meaning Description Schema
200 OK OK Widget
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

KPIs

KPIs are business metrics that are used to evaluate factors that are crucial to the success of an organization.

Add a KPI

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

Example response

{
  "id": "02a1443e-8312-4ab6-94b7-07c1921ce40e",
  "name": "Visits",
  "description": "The Visits KPI displays the number of encounters based on the arrival date.\n",
  "title": "Average Outpatient Visits (OP Visits)",
  "valueField": "value",
  "xAxis": "grain",
  "yAxis": "value",
  "target": 1,
  "polarity": 1,
  "primary": true,
  "reportId": "8abb592a-55c4-4868-8653-854604e10502",
  "organization": "Revenue Cycle",
  "dashboardReportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

POST /projects/{projectId}/kpis

Adds a KPI to a project.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created Kpi
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a List of Project KPIs

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "02a1443e-8312-4ab6-94b7-07c1921ce40e",
      "name": "Visits",
      "description": "The Visits KPI displays the number of encounters based on the arrival date.\n",
      "title": "Average Outpatient Visits (OP Visits)",
      "valueField": "value",
      "xAxis": "grain",
      "yAxis": "value",
      "target": 1,
      "polarity": 1,
      "primary": true,
      "reportId": "8abb592a-55c4-4868-8653-854604e10502",
      "organization": "Revenue Cycle",
      "dashboardReportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis?offset=0&limit=20"
}

GET /projects/{projectId}/kpis

Retrieves a list of KPIs associated with projects filtered by the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project. -
orderBy query string false createdAt A comma-separated list of fields by which to sort. -createdAt, createdAt, -updatedAt, updatedAt
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 OK Kpis
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete a Project KPI

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis/22c99668-95d8-4fa4-99e2-8eb9a63257ed', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis/22c99668-95d8-4fa4-99e2-8eb9a63257ed \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /projects/{projectId}/kpis/{kpiId}

Removes a KPI from the project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project. -
kpiId path string true N/A The unique ID of the KPI. -

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

Update a Project KPI

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis/22c99668-95d8-4fa4-99e2-8eb9a63257ed', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis/22c99668-95d8-4fa4-99e2-8eb9a63257ed \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /projects/{projectId}/kpis/{kpiId}

Updates a KPI of a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project. -
kpiId path string true N/A The unique ID of the KPI. -
body body putProjectsProjectidKpis 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

Retrieve a Single Project KPI

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis/22c99668-95d8-4fa4-99e2-8eb9a63257ed', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis/22c99668-95d8-4fa4-99e2-8eb9a63257ed \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "02a1443e-8312-4ab6-94b7-07c1921ce40e",
  "name": "Visits",
  "description": "The Visits KPI displays the number of encounters based on the arrival date.\n",
  "title": "Average Outpatient Visits (OP Visits)",
  "valueField": "value",
  "xAxis": "grain",
  "yAxis": "value",
  "target": 1,
  "polarity": 1,
  "primary": true,
  "reportId": "8abb592a-55c4-4868-8653-854604e10502",
  "organization": "Revenue Cycle",
  "dashboardReportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

GET /projects/{projectId}/kpis/{kpiId}

Retrieves a single KPI that is associated with a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project. -
kpiId path string true N/A The unique ID of the KPI. -

Response Statuses

Status Meaning Description Schema
200 OK OK Kpi
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Project Authorizations

Project authorizations indicate the personnel and personnel groups who are authorized to access a project and their level of access.

Retrieve a List of Authorizations

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/authorizations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/authorizations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "12f015gh-4bd6-78d5-092f-0eee5s67891",
      "member": {
        "id": "d197260b-e1b2-4e9f-ac8e-d5ed6ada2b37",
        "type": "PERSONNEL"
      },
      "role": "CONSUMER"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/project_authorizations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/project_authorizations?offset=0&limit=20"
}

GET /projects/{projectId}/authorizations

Retrieves a list of authorizations for the project, filtered by the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project to which these authorizations apply. -
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 OK Authorization
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Add Authorizations

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/authorizations', headers: headers, body: {"authorizations":[{"member":{"id":"87d015cf-2ae3-48d4-822c-9fff4d5b8570","type":"PERSONNEL"},"role":"CONSUMER"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/authorizations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"authorizations":[{"member":{"id":"87d015cf-2ae3-48d4-822c-9fff4d5b8570","type":"PERSONNEL"},"role":"CONSUMER"}]}

Example response

{
  "authorizations": [
    {
      "id": "12f015gh-4bd6-78d5-092f-0eee5s67891",
      "member": {
        "id": "d197260b-e1b2-4e9f-ac8e-d5ed6ada2b37",
        "type": "PERSONNEL"
      },
      "role": "CONSUMER"
    }
  ]
}

POST /projects/{projectId}/authorizations

Adds authorizations to the project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project to which these authorizations apply. -
body body postProjectsProjectidAuthorizations true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created OK ProjectAuthorization
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete an Authorization of a Project

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/authorizations/63b35ec7-6c96-4655-aaf1-3f5e3a4c44bb', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/authorizations/63b35ec7-6c96-4655-aaf1-3f5e3a4c44bb \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /projects/{projectId}/authorizations/{authorizationId}

Removes an authorization from a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project to which these authorizations apply. -
authorizationId path string true N/A The unique ID of the authorization. -

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

Update an Authorization of a Project

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/authorizations/63b35ec7-6c96-4655-aaf1-3f5e3a4c44bb', headers: headers, body: {"role":"CONSUMER"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/authorizations/63b35ec7-6c96-4655-aaf1-3f5e3a4c44bb \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"role":"CONSUMER"}

PUT /projects/{projectId}/authorizations/{authorizationId}

Updates an authorization of a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project to which these authorizations apply. -
authorizationId path string true N/A The unique ID of the authorization. -
body body putProjectsProjectidAuthorizations 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

Report Authorizations

Report authorizations indicate the personnel and personnel groups who are authorized to access a report and their level of access.

Retrieve a List of Authorizations

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c/authorizations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c/authorizations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "12f015gh-4bd6-78d5-092f-0eee5s67891",
      "member": {
        "id": "d197260b-e1b2-4e9f-ac8e-d5ed6ada2b37",
        "type": "PERSONNEL"
      },
      "role": "CONSUMER"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /projects/{projectId}/reports/{reportId}/authorizations

Retrieves a list of authorizations for the report, filtered by the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project to which these authorizations apply. -
reportId path string true N/A The unique ID of the report to which these authorizations apply. -
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 OK ReportAuthorization
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Add Authorizations

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c/authorizations', headers: headers, body: {"authorizations":[{"member":{"id":"87d015cf-2ae3-48d4-822c-9fff4d5b8570","type":"PERSONNEL"},"role":"CONSUMER"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c/authorizations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"authorizations":[{"member":{"id":"87d015cf-2ae3-48d4-822c-9fff4d5b8570","type":"PERSONNEL"},"role":"CONSUMER"}]}

Example response

{
  "authorizations": [
    {
      "id": "12f015gh-4bd6-78d5-092f-0eee5s67891",
      "member": {
        "id": "d197260b-e1b2-4e9f-ac8e-d5ed6ada2b37",
        "type": "PERSONNEL"
      },
      "role": "CONSUMER"
    }
  ]
}

POST /projects/{projectId}/reports/{reportId}/authorizations

Adds authorizations to a report.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project to which these authorizations apply. -
reportId path string true N/A The unique ID of the report to which these authorizations apply. -
body body postProjectsProjectidReportsReportidAuthorizations true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created OK ReportAuthorizations
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete an Authorization of a Report

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c/authorizations/63b35ec7-6c96-4655-aaf1-3f5e3a4c44bb', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c/authorizations/63b35ec7-6c96-4655-aaf1-3f5e3a4c44bb \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /projects/{projectId}/reports/{reportId}/authorizations/{authorizationId}

Removes an authorization from a report.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project to which these authorizations apply. -
reportId path string true N/A The unique ID of the report to which these authorizations apply. -
authorizationId path string true N/A The unique ID of the authorization. -

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

Update the Authorization of a Report

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/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c/authorizations/63b35ec7-6c96-4655-aaf1-3f5e3a4c44bb', headers: headers, body: {"role":"CONSUMER"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c/authorizations/63b35ec7-6c96-4655-aaf1-3f5e3a4c44bb \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"role":"CONSUMER"}

PUT /projects/{projectId}/reports/{reportId}/authorizations/{authorizationId}

Updates the authorization of a report.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The unique ID of the project to which these authorizations apply. -
reportId path string true N/A The unique ID of the report to which these authorizations apply. -
authorizationId path string true N/A The unique ID of the authorization. -
body body putProjectsProjectidReportsReportidAuthorizations 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

Schema Definitions

postProjects

Name Type Required Description Accepted Values
name string true The display name of the project. -
description string false The description of the project. -

Project

Name Type Required Description Accepted Values
id string false The unique ID of the project. -
name string false The display name of the project. -
description string false The description of the project. -
discoverability string false Discoverability controls who can discover a project of which they are not already a member. The following values are possible:
  • PUBLIC: Indicates that the project is visible to all users and anyone can join to have access.
  • PRIVATE: Indicates that the project is visible to all users but the users cannot join unless a project member explicitly adds them.
  • HIDDEN: Indicates that the project is hidden from anyone who does not have access to the project.
PUBLIC, PRIVATE, HIDDEN
createdAt string false The date and time when the project was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string false The date and time when the project was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ 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. -

ProjectDetails

Name Type Required Description Accepted Values
items [ProjectDetail] 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. -

ProjectDetail

Name Type Required Description Accepted Values
id string false The unique ID of the project. -
name string false The display name of the project. -
description string false The description of the project. -
discoverability string false Discoverability controls who can discover a project of which they are not already a member. The following values are possible:
  • PUBLIC: Indicates that the project is visible to all users and anyone can join to have access.
  • PRIVATE: Indicates that the project is visible to all users but the users cannot join unless a project member explicitly adds them.
  • HIDDEN: Indicates that the project is hidden from anyone who does not have access to the project.
PUBLIC, PRIVATE, HIDDEN
createdAt string false The date and time when the project was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string false The date and time when the project was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
reports [Report] false [Retrieves a single report by ID.] -
kpis [Kpi] false [Retrieves a single KPI that is associated with a project.] -
widgets [Widget] false [Retrieves a single widget by ID.] -

Report

Name Type Required Description Accepted Values
id string false The unique ID of the report. -
name string false The display name of the report. -
description string false The description of the report. -
externalSourceMnemonic string false The type of external source. -
sourceApplicationId string false The ID of the report in the source application. -
kpiIndicator boolean false Indicates whether the report is a KPI report. -
reportDataModels ReportDataModel false The data models from which the report is created. -
createdAt string false The date and time when the report was added to a project, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string false The date and time when the report was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

ReportDataModel

Name Type Required Description Accepted Values
id string false The unique ID of the report data model. -
reportId string false The ID of the report. -
dataModelId string false The ID of the data model. -
createdAt string false The date and time when the report data model was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string false The date and time when the report data model was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

Kpi

Name Type Required Description Accepted Values
id string false The unique ID of the KPI. -
name string false The name of the standard KPI. -
description string false The detailed description of the standard KPI. -
title string false The display title of the standard KPI. -
valueField string false The display value of KPI. -
xAxis string false The x-axis specifies the grain of the dimension of the KPI.
Example: Time axis
  • Day:
  • Month:
-
yAxis string false The y-axis specifies the expression to use to calculate the KPI.
Example: Formula for OP visit
  • Average of outpatient visits
  • Sum of outpatient visits
-
target integer(int32) false The data threshold that corresponds to a set of data points. -
polarity integer(int32) false Indicates whether a higher or lower current value is desirable with respect to the user-defined target. -
primary boolean false Indicates whether the KPI is displayed on the project dashboard page; true indicates that it is. -
reportId string false The ID of the report. -
organization string false The name of the organization to which the KPI belongs. -
dashboardReportId string false The ID of the dashboard report. -
createdAt string false The date and time when the KPI was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string false The date and time when the KPI was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

Widget

Name Type Required Description Accepted Values
id string false The unique ID of the widget. -
sizeX integer(int32) false The width of the widget. -
sizeY integer(int32) false The height of the widget. -
row integer(int32) false The x-axis coordinate of the widget. -
col integer(int32) false The y-axis coordinate of the widget. -
reportId string false The ID of the report. -
contentUrl string false The URL of the report’s source application. -
createdAt string false The date and time when the widget was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string false The date and time when the widget was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

putProjects

Name Type Required Description Accepted Values
name string false The display name of the project. -
description string false The description of the project. -
discoverability string false The discoverability of the project. -

Authorization

Name Type Required Description Accepted Values
id string false The unique ID of the authorization. -
member Member false The personnel or personnel group who should be authorized to access the content. -
role string false A content member’s role defines what actions they are authorized to perform for the content. The following roles are available:
  • CONSUMER:: Consumers can only view the content.
  • COLLABORATOR: Collaborators can view and edit the content but not delete it.
  • OWNER: Owners have all privileges for the content, including changing the members and viewing, editing, and deleting it.
  • ,
OWNER, CONSUMER, COLLABORATOR

Member

Name Type Required Description Accepted Values
id string true The ID of the personnel or personnel group who should be authorized to access the content.
For more information about personnel and personnel groups, see Personnel API.
See the following examples:
  • PERSONNEL: member: { 'id': 'd197260b-e1b2-4e9f-ac8e-d5ed6ada2b37', 'type': 'PERSONNEL' }
  • PERSONNEL_GROUP: member: { 'id': '0246c1a7-374c-426f-9ab0-6e65c51aca2', 'type': 'PERSONNEL_GROUP' }
-
type string true An enumerated list that describes the role that the individual plays in relation to the entity. Currently, the following types are possible:
  • PERSONNEL: A personnel is an employee or affiliate of the tenant organization.
  • PERSONNEL_GROUP: A personnel group is a set of personnel for the tenant organization who are grouped together to give them access to the same features or information.
PERSONNEL, PERSONNEL_GROUP

postProjectsProjectidAuthorizations

Name Type Required Description Accepted Values
authorizations string true The list of members to be authorized to access the content. -

ProjectAuthorization

Name Type Required Description Accepted Values
authorizations Authorization false The members of the project. -

putProjectsProjectidAuthorizations

Name Type Required Description Accepted Values
role string false The authorization role of the content. -

postProjectsProjectidReports

Name Type Required Description Accepted Values
name string true The display name of the report. -
description string false The description of the report. -
externalSourceMnemonic string true The type of external source. -
sourceApplicationId string true The ID of the report in the source application. -
kpiIndicator boolean false Indicates whether the report is a KPI report. -
dataModelIds [string] false A comma-separated list of data model IDs. -

Reports

Name Type Required Description Accepted Values
items [Report] 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. -

putProjectsProjectidReports

Name Type Required Description Accepted Values
name string false The display name of the report. -
description string false The description of the report. -
externalSourceMnemonic string false The type of external source. -
sourceApplicationId string false The ID of the report in the source application. -
dataModelIds [string] false A comma-separated list of data model IDs. -

ReportAuthorization

Name Type Required Description Accepted Values
authorizations Authorization false The members of the report. -

postProjectsProjectidReportsReportidAuthorizations

Name Type Required Description Accepted Values
authorizations string true The list of members to be authorized to access the content. -

ReportAuthorizations

Name Type Required Description Accepted Values
items [ReportAuthorization] 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. -

putProjectsProjectidReportsReportidAuthorizations

Name Type Required Description Accepted Values
role string false The authorization role of the content. -

postProjectsProjectidWidgets

Name Type Required Description Accepted Values
row integer(int32) true The x-axis coordinate of the widget. -
col integer(int32) true The y-axis coordinate of the widget. -
reportId string true The ID of the report. -
sizeX integer(int32) false The width of the widget. -
sizeY integer(int32) false The height of the widget. -
contentUrl string false The URL of the report’s source application. -

Widgets

Name Type Required Description Accepted Values
items [Widget] 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. -

putProjectsProjectidWidgets

Name Type Required Description Accepted Values
sizeX integer(int32) false The width of the widget. -
sizeY integer(int32) false The height of the widget. -
row integer(int32) false The x-axis coordinate of the widget. -
col integer(int32) false The y-axis coordinate of the widget. -
reportId string false The ID of the report. -
contentUrl string false The URL of the report’s source application. -

postProjectsProjectidKpis

Name Type Required Description Accepted Values
name string true The name of the standard KPI. -
description string true The detailed description of the standard KPI. -
title string true The display title of the standard KPI. -
valueField string true The display value of KPI. -
xAxis string true The x-axis specifies the grain of the dimension of the KPI.
Example: Time axis
  • Day:
  • Month:
-
yAxis string true The y-axis specifies the expression to use to calculate the KPI.
Example: Formula for OP visit
  • Average of outpatient visits
  • Sum of outpatient visits
-
reportId string true The ID of the report. -
organization string true The name of the organization to which the KPI belongs. -
dashboardReportId string true The ID of the dashboard report. -
target integer(int32) false The data threshold that corresponds to a set of data points. -
polarity integer(int32) false Indicates whether a higher or lower current value is desirable with respect to the user-defined target. -
primary boolean false Indicates whether the KPI is displayed on the project dashboard page; true indicates that it is. -

Kpis

Name Type Required Description Accepted Values
items [Kpi] 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. -

putProjectsProjectidKpis

Name Type Required Description Accepted Values
name string false The name of the standard KPI. -
description string false The detailed description of the standard KPI. -
title string false The display title of the standard KPI. -
valueField string false The display value of KPI. -
xAxis string false The x-axis specifies the grain of the dimension of the KPI.
Example: Time axis
  • Day:
  • Month:
-
yAxis string false The y-axis specifies the expression to use to calculate the KPI.
Example: Formula for OP visit
  • Average of outpatient visits
  • Sum of outpatient visits
-
target integer(int32) false The data threshold that corresponds to a set of data points. -
polarity integer(int32) false Indicates whether a higher or lower current value is desirable with respect to the user-defined target. -
primary boolean false Indicates whether the KPI is displayed on the project dashboard page; true indicates that it is. -
reportId string false The ID of the report. -
organization string false The name of the organization to which the KPI belongs. -
dashboardReportId string false The ID of the dashboard report. -