Quality Measure API v1

The Quality Measure API enables assessing performance related to a specific clinical process, structure, or outcome using measures. Measure recommendations are conditional intervention or reminder messages that can help providers know what actions to perform to ensure that a measure is achieved on time.

Note: The data retrieved by this API is filtered based on the sensitive data filters for HealtheIntent. Ensure that your implementations of this API are designed with this in mind, and if you integrate data from HealtheIntent into a clinical workflow using this API, ensure that your users are informed of your sensitive data filters. See Understand Sensitive Data in HealtheIntent in the Reference Pages on Cerner Wiki for more information.

URL: https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1

Recommendation Fields

Recommendation fields are the fields that can be referenced in recommendation policies and that allow systems to retrieve a measure outcome’s attributes and supporting data.

Retrieve a List of Recommendation Fields

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/quality-measure/v1/recommendation-fields', headers: headers)

print JSON.pretty_generate(result)


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

GET /recommendation-fields

Retrieves a list of recommendation fields.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of recommendation field objects is retrieved.	RecommendationFields
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a Recommendation Field

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/quality-measure/v1/recommendation-fields/a426149a-c19c-413a-8d9f-d7988aec4a91', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/recommendation-fields/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /recommendation-fields/{recommendationFieldId}

Deletes a recommendation field.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
recommendationFieldId	path	string	true	N/A	The ID of the recommendation field.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	The recommendation policy is deleted.	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Recommendation Policies

A recommendation policy is the collection of recommendation messages that can be displayed to users. The policy determines what messages are generated. Each measure can have only one recommendation policy.

Create a Recommendation Policy.

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/quality-measure/v1/recommendation-policies', headers: headers, body: {"name":"adult-bmi-assessment-not-current","title":"BMI Not Current","fields":[{"name":"IsMeasureMissingInMeasurementPeriod","type":"Boolean"},{"name":"MostRecentObservationEffectiveDate","type":"Boolean"}],"measure_definition":{"id":"49d0677b-28e6-4648-9159-1e114eb7b829","alias":{"system":"CERNER Standard","value":"cernerstandard.adultwellness.org2014.clinical/body-mass-index"}},"tests":[{"field":"IsMeasureMissingInMeasurementPeriod","operator":"EQ","value":"true"}],"messages":[{"format":"TEXT","template":"BMI Not Current. Assess BMI at least once every 2 years."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/recommendation-policies \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"adult-bmi-assessment-not-current","title":"BMI Not Current","fields":[{"name":"IsMeasureMissingInMeasurementPeriod","type":"Boolean"},{"name":"MostRecentObservationEffectiveDate","type":"Boolean"}],"measure_definition":{"id":"49d0677b-28e6-4648-9159-1e114eb7b829","alias":{"system":"CERNER Standard","value":"cernerstandard.adultwellness.org2014.clinical/body-mass-index"}},"tests":[{"field":"IsMeasureMissingInMeasurementPeriod","operator":"EQ","value":"true"}],"messages":[{"format":"TEXT","template":"BMI Not Current. Assess BMI at least once every 2 years."}]}

POST /recommendation-policies

Creates a recommendation policy.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The recommendation policy object is created.	RecommendationPolicy
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Response Headers

Status	Header	Type	Format	Description
201	Location	string		The URL of the created definition.

Retrieve a List of Recommendation Policies

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/quality-measure/v1/recommendation-policies', headers: headers)

print JSON.pretty_generate(result)


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

GET /recommendation-policies

Retrieves a list of recommendation policies for a measure.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of recommendation policy objects.	RecommendationPolicies
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a Recommendation Policy

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/quality-measure/v1/recommendation-policies/a426149a-c19c-413a-8d9f-d7988aec4a91', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/recommendation-policies/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /recommendation-policies/{recommendationPolicyId}

Deletes a recommendation policy.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
recommendationPolicyId	path	string	true	N/A	The ID of the recommendation policy.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	The recommendation policy is deleted.	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Recommendation Policy

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/quality-measure/v1/recommendation-policies/a426149a-c19c-413a-8d9f-d7988aec4a91', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/recommendation-policies/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /recommendation-policies/{recommendationPolicyId}

Retrieves a single recommendation policy.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
recommendationPolicyId	path	string	true	N/A	The ID of the recommendation policy.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single recommendation policy is retrieved.	RecommendationPolicy
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Recommendations

Recommendations are the conditional intervention or reminder messages that can help providers know what actions to perform to ensure that measures are achieved on time for a patient.

Retrieve a List of Recommendations

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/quality-measure/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/patients/206d2277-827b-478e-b543-308e28d74fdc/recommendations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/patients/206d2277-827b-478e-b543-308e28d74fdc/recommendations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "pipeline": {
        "id": "80da2056-a86a-11e7-abc4-cec278b6b50a"
      },
      "patient": {
        "id": "49d0677b-28e6-4648-9159-1e114eb7b829",
        "population": {
          "id": "49d0677b-28e6-4648-9159-1e114eb7b829"
        }
      },
      "measureDefinition": {
        "id": "49d0677b-28e6-4648-9159-1e114eb7b829",
        "alias": {
          "system": "CERNER Standard",
          "value": "cernerstandard.adultwellness.org2014.clinical/body-mass-index"
        }
      },
      "recommendationPolicy": {
        "id": "49d0677b-28e6-4648-9159-1e114eb7b829",
        "name": "adult-bmi-assessment-recommendations",
        "title": "Adult BMI Assessment"
      },
      "messages": [
        {
          "format": "TEXT",
          "message": "BMI Not Current. Assess BMI at least once every 2 years."
        }
      ]
    }
  ],
  "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 /pipelines/{pipelineId}/patients/{patientId}/recommendations

Retrieves a list of recommendations for a patient.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of recommendations is retrieved.	RecommendationPeople
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Schema Definitions

Field

Name	Type	Required	Description	Accepted Values
name	string	true	The unique name of the field.	-
type	string	true	The types of the fields.	STRING, NUMBER, BOOLEAN

MeasureDefReference

Name	Type	Required	Description	Accepted Values
id	string	false	The ID of the measure definition. This ID is required if an alias is not specified.	-
alias	Alias	false	The alias details of the measure definition. This alias is required if an ID is not specified.	-

Alias

Name	Type	Required	Description	Accepted Values
system	string	false	The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.	-
value	string	false	The unique ID of the provider in the context of the system or assigning authority.	-

Tests

Name Type Required Description Accepted Values

field string true The name of the field to be used in the test. -

operator

string

true

Name	Type	Required	Description	Accepted Values
field	string	true	The name of the field to be used in the test.	-
operator	string	true	The relational operator that is used to perform the operations on two operands. The following operators are available: `EQ`: Equal to `GT`: Greater than `GTE`: Greater than or equal to `LT`: Less than `LTE`: Less than or equal to `NEQ`: Not equal to	EQ, GTE, GT, LT, LTE, NEQ
value	string	true	The value to compare to the field using the operator.	-

The relational operator that is used to perform the operations on two operands. The following operators are available:

EQ: Equal to
GT: Greater than
GTE: Greater than or equal to
LT: Less than
LTE: Less than or equal to
NEQ: Not equal to

EQ, GTE, GT, LT, LTE, NEQ

value string true The value to compare to the field using the operator. -

Messages

Name	Type	Required	Description	Accepted Values
format	string	true	The format of the message.	TEXT, MARKDOWN
template	string	true	The message template that is displayed for the measure if the test is successful.	-

postRecommendationPolicies

Name	Type	Required	Description	Accepted Values
name	string	false	The name of the recommendation policy.	-
title	string	true	The title of the recommendation policy.	-
fields	[Field]	false	No description	-
measure_definition	MeasureDefReference	true	A reference to the measure definition.	-
tests	[Tests]	false	The tests that contain the fields, operators, and values.	-
messages	[Messages]	true	The messages that specify the formats and templates of the messages.	-

RecommendationPolicy

Name	Type	Required	Description	Accepted Values
id	string	false	The ID of the recommendation policy.	-
name	string	false	The name of the recommendation policy.	-
title	string	true	The title of the recommendation policy.	-
fields	[Field]	false	The recommendation names and types.	-
measureDefinition	MeasureDefReference	true	The reference to a measure definition.	-
tests	[Tests]	false	The tests that contain the fields, operators, and values.	-
messages	[Messages]	true	The messages that specify the formats and templates of the messages.	-

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

RecommendationPolicies

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

RecommendationFields

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

RecommendationField

Name	Type	Required	Description	Accepted Values
id	string	false	The ID of the measure recommendation field.	-
name	string	false	The name of the measure recommendation field.	-
description	string	false	The description of the measure recommendation field.	-

RecommendationPeople

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

RecommendationPerson

Name	Type	Required	Description	Accepted Values
pipeline	object	true	A reference to the pipeline.	-
» id	string	true	The ID of the pipeline.	-
patient	Patient	true	The patient details.	-
measureDefinition	MeasureDefReference	true	A reference to the measure definition.	-
recommendationPolicy	RecommendationPolicyPerson	true	A reference to the recommendation policy.	-
messages	MessagesPerson	true	The messages that specify the format and message.	-

Patient

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the person.	-
population	object	true	A reference to the population.	-
» id	string	true	The ID of the population.	-

RecommendationPolicyPerson

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the recommendation policy.	-
name	string	true	The name of the recommendation policy.	-
title	string	true	The title of the recommendation policy, which is most useful for display purposes.	-

MessagesPerson

Name	Type	Required	Description	Accepted Values
format	string	true	The format of the message.	-
message	string	true	The message that is displayed to indicate required values.	-