NAV Navbar
Logo cerner
Ruby Shell

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

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","componentName":"cernerstandard.diabetesmellitus.org2014.clinical/ldl-poorly-controlled-ldl-gte-130"},{"name":"MostRecentObservationEffectiveDate"}],"measureDefinition":{"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 was last recorded on {{MostRecentObservationEffectiveDate}}. 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","componentName":"cernerstandard.diabetesmellitus.org2014.clinical/ldl-poorly-controlled-ldl-gte-130"},{"name":"MostRecentObservationEffectiveDate"}],"measureDefinition":{"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 was last recorded on {{MostRecentObservationEffectiveDate}}. 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

Measure Results

Measure results represent the outcomes of evaluating one or more measures against a population record.

Retrieve a List of Measure Results

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/reporting-projects/788ddaa0-1e28-4ecc-9945-e87f281b485b/patients/206d2277-827b-478e-b543-308e28d74fdc/measure-results', 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/reporting-projects/788ddaa0-1e28-4ecc-9945-e87f281b485b/patients/206d2277-827b-478e-b543-308e28d74fdc/measure-results \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "patient": {
        "id": "17d0677b-28e6-4648-9159-1e114eb7b829",
        "populationId": "5d0f9ff9-d3b8-47e0-86a1-13d500d833ce",
        "empiVersion": "4606",
        "empiPersonVersion": "2"
      },
      "event": {
        "id": "24717504-b333-382b-8934-1ff618c9590b",
        "date": "2018-01-02"
      },
      "measure": {
        "name": "action-plan-complete",
        "registry": {
          "aliases": [
            {
              "system": "synapse.clinical.programs/program-id",
              "value": "advocate.events.documentation-of-current-medications"
            }
          ]
        }
      },
      "resultOutcomeSummary": "ACHIEVED",
      "due": "true",
      "status": "MET"
    }
  ],
  "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 /reporting-projects/{reportingProjectId}/patients/{patientId}/measure-results

Retrieves a list of measure results for a patient.

Parameters

Parameter In Type Required Default Description Accepted Values
reportingProjectId path string true N/A The ID of the reporting project. -
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 measure results is retrieved. MeasureResults
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Tags

You can use the Tag resource to assign your own metadata to the Quality Measure resources. The most common reason to tag a resource is to categorize its use (for example, Use = Production or Use = Validation). You can also use tags to add issue-tracking IDs to Quality Measure resources as a reference to when and why the resource was created.

Create a Tag

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/tags', headers: headers, body: {"key":"Use","value":"Production","resource":{"type":"MEASURE","id":"a426149a-c19c-413a-8d9f-d7988aec4a91"}}.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/tags \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"key":"Use","value":"Production","resource":{"type":"MEASURE","id":"a426149a-c19c-413a-8d9f-d7988aec4a91"}}

Example response

{
  "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
  "resource": {
    "type": "MEASURE",
    "id": "a426149a-c19c-413a-8d9f-d7988aec4a91"
  },
  "key": "Use",
  "value": "Production"
}

POST /tags

Creates a tag.


The following basic restrictions apply to tags:

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created A tag object Tag
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 tag.

Retrieve a List of Tags

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/tags',
  query: {
  'resourceType' => 'string',
'key' => 'string'
}, 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/tags?resourceType=type,string,enum,MEASURE%2CREGISTRY&key=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
      "resource": {
        "type": "MEASURE",
        "id": "a426149a-c19c-413a-8d9f-d7988aec4a91"
      },
      "key": "Use",
      "value": "Production"
    },
    {
      "id": "f2c9455a-7a6e-4f9f-9241-5df093996078",
      "resource": {
        "type": "MEASURE",
        "id": "50cce9f4-1602-4479-b682-309da08e24c3"
      },
      "key": "Use",
      "value": "Staging"
    }
  ],
  "totalResults": 21,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/quality-measure/v1/tags?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/quality-measure/v1/tags?offset=20&limit=20",
  "prevLink": "https://cernerdemo.api.us.healtheintent.com/quality-measure/v1/tags?offset=0&limit=20",
  "nextLink": "https://cernerdemo.api.us.healtheintent.com/quality-measure/v1/tags?offset=20&limit=20"
}

GET /tags

Retrieves a list of tags.

Parameters

Parameter In Type Required Default Description Accepted Values
tagId query string false N/A The ID of the tag. This query parameter can be repeated multiple times to query for multiple tags at a time. -
resourceId query string false N/A The resource ID of the tag. This query parameter can be repeated multiple times to query for multiple tags at a time. The resourceType parameter should also be defined when searching by resource ID or IDs. -
resourceType query string true N/A The resource type of the tag. MEASURE, REGISTRY
key query string true N/A The tag key to search for. The search is for exact matches. -
value query string false N/A The tag value to search for. The search is for exact matches. -
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 key A comma-separated list of fields by which to sort. key, -key, value, -value, resourceType, -resourceType

Response Statuses

Status Meaning Description Schema
200 OK A collection of tag objects. Tags
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Remove a Tag

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/tags/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/tags/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /tags/{id}

Removes a tag.

Parameters

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

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 Tag

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/tags/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/tags/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /tags/{id}

Retrieves a single tag.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK A tag object. Tag
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Categorizations

Categorizations are an organizational construct that provides a first-class mechanism to organize the Quality Measure service definitional entities based on various categorization use cases.

Retrieve a List of Categorizations

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/categorizations', 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/categorizations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "8910677b-28e6-4648-9159-1e114eb7b829",
      "name": "publisher-catalog",
      "title": "Categorization based on the cataloging",
      "createdAt": "2018-07-25T17:03:14.120Z",
      "updatedAt": "2020-07-25T17:03:14.120Z"
    }
  ],
  "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 /categorizations

Retrieves a list of categorizations.

Parameters

Parameter In Type Required Default Description Accepted Values
name query string false N/A Filters the response by the specified name. -
title query string false N/A Filters the response by the specified title. -
orderBy query string false title A comma-separated list of fields by which to sort. -name, name, -title, title
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 categorizations. Categorizations
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
415 Unsupported Media Type Unsupported Media Type Error

Create a Categorization

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/categorizations', headers: headers, body: {"name":"publisher-catalog","title":"Categorization based on the cataloging"}.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/categorizations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"publisher-catalog","title":"Categorization based on the cataloging"}

Example response

{
  "id": "8910677b-28e6-4648-9159-1e114eb7b829",
  "name": "publisher-catalog",
  "title": "Categorization based on the cataloging",
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2020-07-25T17:03:14.120Z"
}

POST /categorizations

Creates a categorization.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created The categorization was created. Categorization
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
415 Unsupported Media Type Unsupported Media Type Error

Delete a Single Categorization

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/categorizations/8910677b-28e6-4648-9159-1e114eb7b829', 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/categorizations/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /categorizations/{categorizationId}

Deletes a single categorization.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content The categorization is deleted. None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
415 Unsupported Media Type Unsupported Media Type Error

Update a Single Categorization

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/quality-measure/v1/categorizations/8910677b-28e6-4648-9159-1e114eb7b829', headers: headers, body: {"name":"publisher-catalog","title":"Categorization based on the cataloging"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"publisher-catalog","title":"Categorization based on the cataloging"}

Example response

{
  "id": "8910677b-28e6-4648-9159-1e114eb7b829",
  "name": "publisher-catalog",
  "title": "Categorization based on the cataloging",
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2020-07-25T17:03:14.120Z"
}

PUT /categorizations/{categorizationId}

Updates a single categorization.

Parameters

Parameter In Type Required Default Description Accepted Values
categorizationId path string true N/A The ID of the categorization. -
body body putCategorizations true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK The categorization was updated. Categorization
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
415 Unsupported Media Type Unsupported Media Type Error

Retrieve a Single Categorization

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/categorizations/8910677b-28e6-4648-9159-1e114eb7b829', 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/categorizations/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "8910677b-28e6-4648-9159-1e114eb7b829",
  "name": "publisher-catalog",
  "title": "Categorization based on the cataloging",
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2020-07-25T17:03:14.120Z"
}

GET /categorizations/{categorizationId}

Retrieves a single categorization.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK A single categorization is retrieved. Categorization
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
415 Unsupported Media Type Unsupported Media Type Error

Categories

Categories are an organizational construct that can be used to group measures or registries.

Retrieve a List of 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/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories', 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/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "8d844faf-d158-11e8-80f4-005056a80294",
      "title": "HEDIS",
      "ranking": 1,
      "createdAt": "2018-07-25T17:03:14.120Z",
      "updatedAt": "2018-07-25T17:03:14.120Z"
    }
  ],
  "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 /categorizations/{categorizationId}/categories

Retrieves a list of categories.

Parameters

Parameter In Type Required Default Description Accepted Values
categorizationId path string true N/A The ID of the categorization. -
ranking query string false N/A Filters by the category ranking. -
title query string false N/A Filters by the category title. Partial text search is supported. -
orderBy query string false title A comma-separated list of fields by which to sort. -title, title, ranking, -ranking
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 categories. Categories
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Create a 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/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories', headers: headers, body: {"title":"HEDIS","ranking":1}.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/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":"HEDIS","ranking":1}

Example response

{
  "id": "8d844faf-d158-11e8-80f4-005056a80294",
  "title": "HEDIS",
  "ranking": 1,
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z"
}

POST /categorizations/{categorizationId}/categories

Creates a new category.

Parameters

Parameter In Type Required Default Description Accepted Values
categorizationId path string true N/A The ID of the categorization. -
body body postCategorizationsCategorizationidCategories true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created The category was successfully created. Category
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete a 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/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories/6d984963-5306-40e8-8157-c65348a2fe43', 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/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /categorizations/{categorizationId}/categories/{categoryId}

Deletes the category with the specified ID.

Parameters

Parameter In Type Required Default Description Accepted Values
categorizationId path string true N/A The ID of the categorization. -
categoryId path string true N/A The ID of the category field. -

Response Statuses

Status Meaning Description Schema
204 No Content The category 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 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/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories/6d984963-5306-40e8-8157-c65348a2fe43', 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/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "8d844faf-d158-11e8-80f4-005056a80294",
  "title": "HEDIS",
  "ranking": 1,
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z"
}

GET /categorizations/{categorizationId}/categories/{categoryId}

Retrieves the category with the specified ID.

Parameters

Parameter In Type Required Default Description Accepted Values
categorizationId path string true N/A The ID of the categorization. -
categoryId path string true N/A The ID of the category field. -

Response Statuses

Status Meaning Description Schema
200 OK A single category. Category
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a 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/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories/6d984963-5306-40e8-8157-c65348a2fe43', headers: headers, body: {"title":"HEDIS","ranking":1}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/categorizations/d1ed37db-3380-4428-91de-fe2e951ccf7/categories/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"title":"HEDIS","ranking":1}

Example response

{
  "id": "8d844faf-d158-11e8-80f4-005056a80294",
  "title": "HEDIS",
  "ranking": 1,
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z"
}

PUT /categorizations/{categorizationId}/categories/{categoryId}

Updates the category with the specified ID.

Parameters

Parameter In Type Required Default Description Accepted Values
categorizationId path string true N/A The ID of the categorization. -
categoryId path string true N/A The ID of the category field. -
body body putCategorizationsCategorizationidCategories true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK The category was successfully updated. Category
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Registries

A registry represents the set of people who match a set of qualifying criteria. You can use registries to identify people who will be participating in a Quality Reporting project for different sets of measures. You can define the registry using an automated approach that applies a logic library to a set of population records. A registry can also be curated using manual identification processes.

The registry definition resource does not represent a registry; it represents the metadata that helps describe a registry.

Retrieve a List of Registry Definitions

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/registries', 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/registries \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "8910677b-28e6-4648-9159-1e114eb7b829",
      "name": "cernerstandard.asthma.org2014.clinical",
      "title": "Asthma",
      "description": "The Asthma Care registry includes people in the population aged 5 to 65 years with a diagnosis of asthma and at least 1 outpatient encounter during the current measurement period or prior 2 measurement periods.",
      "categories": [
        {
          "id": "45b1cdd1-0584-4d06-9550-44d934597259",
          "title": "Cerner Standard",
          "categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
        }
      ],
      "aliases": [
        {
          "system": "SOMESYSTEM",
          "value": "some-value"
        }
      ],
      "tags": [
        {
          "key": "Use",
          "value": "PRODUCTION_REGISTRIES"
        }
      ],
      "type": "PERSON",
      "subjectType": "PATIENT",
      "effectivePeriod": {
        "start": "2018-07-25T17:03:14.123Z",
        "end": "2020-07-25T17:03:14.123Z"
      },
      "libraries": [
        {
          "id": "5510677b-28e6-4648-9159-1e114eb7b829",
          "name": "cerner-standard-rules",
          "title": "Cerner Standard Rules"
        }
      ],
      "createdAt": "2018-07-25T17:03:14.120Z",
      "updatedAt": "2018-07-25T17:03:14.120Z"
    }
  ],
  "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 /registries

Retrieves a list of registry definitions.

Parameters

Parameter In Type Required Default Description Accepted Values
name query string false N/A Filters the response by registry name. Partial text search is supported. -
title query string false N/A Filters the response by registry title. Partial text search is supported. -
categoryId query string false N/A Filters the response by the specified category ID or IDs. -
tag query string false N/A Filters the response by the specified tags. Each tag can be represented as a single key or a key:value pair. -
orderBy query string false title A comma-separated list of fields by which to sort. -name, name, -title, title
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 registry definitions. Registries
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
415 Unsupported Media Type Unsupported Media Type Error

Create a Registry Definition

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/registries', headers: headers, body: {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","description":"The Asthma Care registry includes people in the population aged 5 to 65 years with a diagnosis of asthma and at least 1 outpatient encounter during the current measurement period or prior 2 measurement periods.","type":"PERSON","subjectType":"PATIENT","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"effectivePeriod":{"start":"2018-07-25T17:03:14.123Z","end":"2020-07-25T17:03:14.123Z"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}]}.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/registries \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","description":"The Asthma Care registry includes people in the population aged 5 to 65 years with a diagnosis of asthma and at least 1 outpatient encounter during the current measurement period or prior 2 measurement periods.","type":"PERSON","subjectType":"PATIENT","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"effectivePeriod":{"start":"2018-07-25T17:03:14.123Z","end":"2020-07-25T17:03:14.123Z"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}]}

Example response

{
  "id": "8910677b-28e6-4648-9159-1e114eb7b829",
  "name": "cernerstandard.asthma.org2014.clinical",
  "title": "Asthma",
  "description": "The Asthma Care registry includes people in the population aged 5 to 65 years with a diagnosis of asthma and at least 1 outpatient encounter during the current measurement period or prior 2 measurement periods.",
  "categories": [
    {
      "id": "45b1cdd1-0584-4d06-9550-44d934597259",
      "title": "Cerner Standard",
      "categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
    }
  ],
  "aliases": [
    {
      "system": "SOMESYSTEM",
      "value": "some-value"
    }
  ],
  "tags": [
    {
      "key": "Use",
      "value": "PRODUCTION_REGISTRIES"
    }
  ],
  "type": "PERSON",
  "subjectType": "PATIENT",
  "effectivePeriod": {
    "start": "2018-07-25T17:03:14.123Z",
    "end": "2020-07-25T17:03:14.123Z"
  },
  "libraries": [
    {
      "id": "5510677b-28e6-4648-9159-1e114eb7b829",
      "name": "cerner-standard-rules",
      "title": "Cerner Standard Rules"
    }
  ],
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z"
}

POST /registries

Creates a registry definition.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created The registry definition was created. Registry
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
415 Unsupported Media Type Unsupported Media Type Error

Update a Single Registry Definition

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/quality-measure/v1/registries/8910677b-28e6-4648-9159-1e114eb7b829', headers: headers, body: {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","description":"The Asthma Care registry includes people in the population aged 5 to 65 years with a diagnosis of asthma and at least 1 outpatient encounter during the current measurement period or prior 2 measurement periods.","type":"PERSON","subjectType":"PATIENT","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"effectivePeriod":{"start":"2018-07-25T17:03:14.123Z","end":"2020-07-25T17:03:14.123Z"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/registries/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","description":"The Asthma Care registry includes people in the population aged 5 to 65 years with a diagnosis of asthma and at least 1 outpatient encounter during the current measurement period or prior 2 measurement periods.","type":"PERSON","subjectType":"PATIENT","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"effectivePeriod":{"start":"2018-07-25T17:03:14.123Z","end":"2020-07-25T17:03:14.123Z"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}]}

Example response

{
  "id": "8910677b-28e6-4648-9159-1e114eb7b829",
  "name": "cernerstandard.asthma.org2014.clinical",
  "title": "Asthma",
  "description": "The Asthma Care registry includes people in the population aged 5 to 65 years with a diagnosis of asthma and at least 1 outpatient encounter during the current measurement period or prior 2 measurement periods.",
  "categories": [
    {
      "id": "45b1cdd1-0584-4d06-9550-44d934597259",
      "title": "Cerner Standard",
      "categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
    }
  ],
  "aliases": [
    {
      "system": "SOMESYSTEM",
      "value": "some-value"
    }
  ],
  "tags": [
    {
      "key": "Use",
      "value": "PRODUCTION_REGISTRIES"
    }
  ],
  "type": "PERSON",
  "subjectType": "PATIENT",
  "effectivePeriod": {
    "start": "2018-07-25T17:03:14.123Z",
    "end": "2020-07-25T17:03:14.123Z"
  },
  "libraries": [
    {
      "id": "5510677b-28e6-4648-9159-1e114eb7b829",
      "name": "cerner-standard-rules",
      "title": "Cerner Standard Rules"
    }
  ],
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z"
}
{
  "id": "8910677b-28e6-4648-9159-1e114eb7b829",
  "name": "cernerstandard.asthma.org2014.clinical",
  "title": "Asthma",
  "description": "The Asthma Care registry includes people in the population aged 5 to 65 years with a diagnosis of asthma and at least 1 outpatient encounter during the current measurement period or prior 2 measurement periods.",
  "categories": [
    {
      "id": "45b1cdd1-0584-4d06-9550-44d934597259",
      "title": "Cerner Standard",
      "categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
    }
  ],
  "aliases": [
    {
      "system": "SOMESYSTEM",
      "value": "some-value"
    }
  ],
  "tags": [
    {
      "key": "Use",
      "value": "PRODUCTION_REGISTRIES"
    }
  ],
  "type": "PERSON",
  "subjectType": "PATIENT",
  "effectivePeriod": {
    "start": "2018-07-25T17:03:14.123Z",
    "end": "2020-07-25T17:03:14.123Z"
  },
  "libraries": [
    {
      "id": "5510677b-28e6-4648-9159-1e114eb7b829",
      "name": "cerner-standard-rules",
      "title": "Cerner Standard Rules"
    }
  ],
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z"
}

PUT /registries/{registryId}

Updates a single registry definition.

Parameters

Parameter In Type Required Default Description Accepted Values
registryId path string true N/A The ID of the registry. -
body body putRegistries true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK The registry definition was updated. Registry
201 Created The registry definition was created. Registry
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
415 Unsupported Media Type Unsupported Media Type Error

Retrieve a Single Registry Definition

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/registries/8910677b-28e6-4648-9159-1e114eb7b829', 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/registries/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "8910677b-28e6-4648-9159-1e114eb7b829",
  "name": "cernerstandard.asthma.org2014.clinical",
  "title": "Asthma",
  "description": "The Asthma Care registry includes people in the population aged 5 to 65 years with a diagnosis of asthma and at least 1 outpatient encounter during the current measurement period or prior 2 measurement periods.",
  "categories": [
    {
      "id": "45b1cdd1-0584-4d06-9550-44d934597259",
      "title": "Cerner Standard",
      "categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
    }
  ],
  "aliases": [
    {
      "system": "SOMESYSTEM",
      "value": "some-value"
    }
  ],
  "tags": [
    {
      "key": "Use",
      "value": "PRODUCTION_REGISTRIES"
    }
  ],
  "type": "PERSON",
  "subjectType": "PATIENT",
  "effectivePeriod": {
    "start": "2018-07-25T17:03:14.123Z",
    "end": "2020-07-25T17:03:14.123Z"
  },
  "libraries": [
    {
      "id": "5510677b-28e6-4648-9159-1e114eb7b829",
      "name": "cerner-standard-rules",
      "title": "Cerner Standard Rules"
    }
  ],
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z"
}

GET /registries/{registryId}

Retrieves a single registry definition.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK A single registry definition is retrieved. Registry
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
415 Unsupported Media Type Unsupported Media Type Error

Measures

Measures represent a structured, computable definition of a health-related measure such as a clinical quality measure, public health indicator, or population analytics measure. A quality measure is a quantitative tool used to assess the performance of an individual or organization with respect to a specified process or outcome using the measurement of actions, processes, or outcomes of clinical care. Quality measures are often derived from clinical guidelines and are designed to determine whether the appropriate care has been provided given a set of clinical criteria and an evidence base. The initial population of a measure can be indicated by referencing a registry.

Retrieve a List of Measures

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/measures', 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/measures \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "2310677b-28e6-4648-9159-1e114eb7b829",
      "name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
      "title": "Asthma Action Plan",
      "subtitle": "Asthma Action Plan",
      "description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
      "categories": [
        {
          "id": "45b1cdd1-0584-4d06-9550-44d934597259",
          "title": "Cerner Standard",
          "categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
        }
      ],
      "aliases": [
        {
          "system": "SOMESYSTEM",
          "value": "some-value"
        }
      ],
      "tags": [
        {
          "key": "Use",
          "value": "PRODUCTION_REGISTRIES"
        }
      ],
      "libraries": [
        {
          "id": "5510677b-28e6-4648-9159-1e114eb7b829",
          "name": "cerner-standard-rules",
          "title": "Cerner Standard Rules"
        }
      ],
      "registry": {
        "id": "8910677b-28e6-4648-9159-1e114eb7b829",
        "name": "cernerstandard.asthma.org2014.clinical",
        "title": "Asthma"
      },
      "improvementNotation": "INCREASE",
      "createdAt": "2018-07-25T17:03:14.120Z",
      "updatedAt": "2018-07-25T17:03:14.120Z"
    }
  ],
  "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 /measures

Retrieves a list of measures.

Parameters

Parameter In Type Required Default Description Accepted Values
name query string false N/A Filters the response by measure name. Partial text search is supported. -
title query string false N/A Filters the response by measure title. Partial text search is supported. -
categoryId query string false N/A Filters the response by the specified category ID or IDs. -
registryId query string false N/A Filters the response by the specified registry ID or IDs. -
tag query string false N/A Filters the response by the specified tags. Each tag can be represented as a single key or a key:value pair. -
orderBy query string false title A comma-separated list of fields by which to sort. -name, name, -title, title
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 measures. Measures
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
415 Unsupported Media Type Unsupported Media Type Error

Create a Measure

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/measures', headers: headers, body: {"name":"cernerstandard.asthma.org2014.clinical/action-plan-complete","title":"Asthma Action Plan","subtitle":"Asthma Action Plan","description":"The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.","improvementNotation":"INCREASE","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}],"registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}}.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/measures \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerstandard.asthma.org2014.clinical/action-plan-complete","title":"Asthma Action Plan","subtitle":"Asthma Action Plan","description":"The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.","improvementNotation":"INCREASE","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}],"registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}}

Example response

{
  "id": "2310677b-28e6-4648-9159-1e114eb7b829",
  "name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
  "title": "Asthma Action Plan",
  "subtitle": "Asthma Action Plan",
  "description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
  "categories": [
    {
      "id": "45b1cdd1-0584-4d06-9550-44d934597259",
      "title": "Cerner Standard",
      "categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
    }
  ],
  "aliases": [
    {
      "system": "SOMESYSTEM",
      "value": "some-value"
    }
  ],
  "tags": [
    {
      "key": "Use",
      "value": "PRODUCTION_REGISTRIES"
    }
  ],
  "libraries": [
    {
      "id": "5510677b-28e6-4648-9159-1e114eb7b829",
      "name": "cerner-standard-rules",
      "title": "Cerner Standard Rules"
    }
  ],
  "registry": {
    "id": "8910677b-28e6-4648-9159-1e114eb7b829",
    "name": "cernerstandard.asthma.org2014.clinical",
    "title": "Asthma"
  },
  "improvementNotation": "INCREASE",
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z"
}

POST /measures

Creates a measure.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created The measure was created. Measure
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
415 Unsupported Media Type Unsupported Media Type Error

Update a Single Measure

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/quality-measure/v1/measures/2310677b-28e6-4648-9159-1e114eb7b829', headers: headers, body: {"name":"cernerstandard.asthma.org2014.clinical/action-plan-complete","title":"Asthma Action Plan","subtitle":"Asthma Action Plan","description":"The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.","improvementNotation":"INCREASE","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}],"registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/measures/2310677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerstandard.asthma.org2014.clinical/action-plan-complete","title":"Asthma Action Plan","subtitle":"Asthma Action Plan","description":"The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.","improvementNotation":"INCREASE","categories":[{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}],"aliases":[{"system":"SOMESYSTEM","value":"some-value"}],"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829"}],"registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}}

Example response

{
  "id": "2310677b-28e6-4648-9159-1e114eb7b829",
  "name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
  "title": "Asthma Action Plan",
  "subtitle": "Asthma Action Plan",
  "description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
  "categories": [
    {
      "id": "45b1cdd1-0584-4d06-9550-44d934597259",
      "title": "Cerner Standard",
      "categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
    }
  ],
  "aliases": [
    {
      "system": "SOMESYSTEM",
      "value": "some-value"
    }
  ],
  "tags": [
    {
      "key": "Use",
      "value": "PRODUCTION_REGISTRIES"
    }
  ],
  "libraries": [
    {
      "id": "5510677b-28e6-4648-9159-1e114eb7b829",
      "name": "cerner-standard-rules",
      "title": "Cerner Standard Rules"
    }
  ],
  "registry": {
    "id": "8910677b-28e6-4648-9159-1e114eb7b829",
    "name": "cernerstandard.asthma.org2014.clinical",
    "title": "Asthma"
  },
  "improvementNotation": "INCREASE",
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z"
}
{
  "id": "2310677b-28e6-4648-9159-1e114eb7b829",
  "name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
  "title": "Asthma Action Plan",
  "subtitle": "Asthma Action Plan",
  "description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
  "categories": [
    {
      "id": "45b1cdd1-0584-4d06-9550-44d934597259",
      "title": "Cerner Standard",
      "categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
    }
  ],
  "aliases": [
    {
      "system": "SOMESYSTEM",
      "value": "some-value"
    }
  ],
  "tags": [
    {
      "key": "Use",
      "value": "PRODUCTION_REGISTRIES"
    }
  ],
  "libraries": [
    {
      "id": "5510677b-28e6-4648-9159-1e114eb7b829",
      "name": "cerner-standard-rules",
      "title": "Cerner Standard Rules"
    }
  ],
  "registry": {
    "id": "8910677b-28e6-4648-9159-1e114eb7b829",
    "name": "cernerstandard.asthma.org2014.clinical",
    "title": "Asthma"
  },
  "improvementNotation": "INCREASE",
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z"
}

PUT /measures/{measureId}

Updates a single measure.

Parameters

Parameter In Type Required Default Description Accepted Values
measureId path string true N/A The ID of the measure. -
body body putMeasures true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK The measure was updated. Measure
201 Created The measure was created. Measure
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
415 Unsupported Media Type Unsupported Media Type Error

Retrieve a Single Measure

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/measures/2310677b-28e6-4648-9159-1e114eb7b829', 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/measures/2310677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "2310677b-28e6-4648-9159-1e114eb7b829",
  "name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
  "title": "Asthma Action Plan",
  "subtitle": "Asthma Action Plan",
  "description": "The proportion of people in the Asthma Care Registry population with a documented asthma action plan during the current measurement period.",
  "categories": [
    {
      "id": "45b1cdd1-0584-4d06-9550-44d934597259",
      "title": "Cerner Standard",
      "categorizationId": "6f03e01e-5143-44ec-a726-1a9d3d720a24"
    }
  ],
  "aliases": [
    {
      "system": "SOMESYSTEM",
      "value": "some-value"
    }
  ],
  "tags": [
    {
      "key": "Use",
      "value": "PRODUCTION_REGISTRIES"
    }
  ],
  "libraries": [
    {
      "id": "5510677b-28e6-4648-9159-1e114eb7b829",
      "name": "cerner-standard-rules",
      "title": "Cerner Standard Rules"
    }
  ],
  "registry": {
    "id": "8910677b-28e6-4648-9159-1e114eb7b829",
    "name": "cernerstandard.asthma.org2014.clinical",
    "title": "Asthma"
  },
  "improvementNotation": "INCREASE",
  "createdAt": "2018-07-25T17:03:14.120Z",
  "updatedAt": "2018-07-25T17:03:14.120Z"
}

GET /measures/{measureId}

Retrieves a single measure.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK A single measure is retrieved. Measure
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
415 Unsupported Media Type Unsupported Media Type Error

Schema Definitions

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

postRecommendationPolicies

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

RecommendationPolicy

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. -
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 An array of messages that specify the formats and templates of the recommendations. -

Field

Name Type Required Description Accepted Values
name string true The unique name of the field. -
componentName string false The qualified name of the component. -

Tests

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
  • NE: Not equal to
EQ, GTE, GT, LT, LTE, NE
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. -

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 true The ID of the measure recommendation field. -
name string true The name of the measure recommendation field. -
type string true The type of the field. string, numeric, boolean, date
description string false The description of the measure recommendation field. -
dataPointType string false The supporting data point type. -
path string false The path of the supporting data type from which the values are retrieved. -

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

MeasureResults

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

MeasureResult

Name Type Required Description Accepted Values
patient Patient true The patient details. -
event Event false The event details. The event field is displayed only when the outcome is an event measure outcome. -
measure Measure true The reference to the measure that the results are for. -
resultOutcomeSummary string true

The outcomes of the measure. The following outcomes are available:

  • ACHIEVED: Indicates that the measure was performed and successfully achieved by a person.
  • NOT_ACHIEVED: Indicates that the measure is not achieved.
  • EXCLUDED: Indicates that the measure is not applicable for a person. For example, a cervical cancer screening is not applicable for someone who had a complete hysterectomy.
  • MISSING_DATA: Indicates that the data for a measure is missing.
ACHIEVED, NOT_ACHIEVED, EXCLUDED, MISSING_DATA
due string false Returns true if the measure is due within 30 days or the date is beyond the due date, false if not, or null if there is no due date. -
status string true

The status of the measure. The following states are available:

  • EXCLUDED: Indicates that the measure is not applicable for a person. For example, a cervical cancer screening is not applicable for someone who had a complete hysterectomy.
  • MET: Indicates that the measure has met the criteria.
  • EXCEPTION_EXCLUDED: Indicates that the measure is excluded because of an exception. For example,
  • NOT_MET: Indicates that the measure has not met the criteria.
EXCLUDED, MET, EXCEPTION_EXCLUDED, NOT_MET

Event

Name Type Required Description Accepted Values
id string true The ID of the event. -
date string true The date of the event. In ISO 8601 formatting with precision ranging from YYYY-MM-DD to YYYY-MM-DDThh:mm:ss.SSSZ. -

Measure

Name Type Required Description Accepted Values
name string true The unique, computer-friendly name of the measure definition. -
registry Registry true The reference to the registry with which the measure is grouped. -

Registry

Name Type Required Description Accepted Values
aliases [Alias] false The list of registry aliases. -

postTags

Name Type Required Description Accepted Values
key string true The key for the tag. -
value string false The value for the tag. -
resource object true A reference to the related resource. -
» type string true The resource type. MEASURE, REGISTRY
» id string true The resource ID. -

Tag

Name Type Required Description Accepted Values
id string true The tag ID. -
resource ResourceReference true The resource reference for the tag. -
key string true The key for the tag. -
value string false The value for the tag. -

ResourceReference

Name Type Required Description Accepted Values
type string true The resource type. MEASURE, REGISTRY
id string true The resource ID. -

Tags

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

Categorizations

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

Categorization

Name Type Required Description Accepted Values
id string true The unique ID of the categorization. -
name string true The unique name of the categorization. -
title string true The title of the categorization. -
createdAt string true The date and time when the categorization was created. -
updatedAt string true The date and time when the categorization was updated. This is defaulted to the createdAt value when the categorization is created. -

postCategorizations

Name Type Required Description Accepted Values
name string true The unique name of the categorization. -
title string true The title of the categorization. -

putCategorizations

Name Type Required Description Accepted Values
name string true The unique name of the categorization. -
title string true The title of the categorization. -

Categories

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

Category

Name Type Required Description Accepted Values
id string true The ID of the category. -
title string true A unique human-friendly display for the category. -
ranking integer(int32) false The priority of the category. -
createdAt string true The date and time when the category was created. -
updatedAt string true The date and time when the category was last updated. -

postCategorizationsCategorizationidCategories

Name Type Required Description Accepted Values
title string true A unique human-friendly display for the category. -
ranking integer(int32) false The priority of the category. -

putCategorizationsCategorizationidCategories

Name Type Required Description Accepted Values
title string true A unique human-friendly display for the category. -
ranking integer(int32) false The priority of the category. -

Registries

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

postRegistries

Name Type Required Description Accepted Values
name string true The unique, computer-friendly name of the registry definition. -
title string true The unique, human-friendly title of the registry definition. -
description string false A brief description of the registry definition. This may include Markdown-formatted text. -
type string true

The type of the registry definition. The following values are available:

  • PERSON: Registries that include measures that identify people from a population
  • EVENT: Registries that include measures that operate on events
  • OPERATIONAL: Registries that include measures that operate on nonpatient entities such as providers or organizations
PERSON, EVENT, OPERATIONAL
subjectType string true

The subject type of the registry definition. The following values are available:

  • PATIENT: The person associated with the registry is a patient.
  • PROVIDER: The person associated with the registry is a provider.
PATIENT, PROVIDER
categories object false The category of the registry. Categories are used to group registries based on various categorization concepts. -
» id string true The unique ID of the category. -
aliases object false An optional list of aliases for the registry definition. -
» system string true The authority responsible for assigning the alias value. Alias values are unique in this system namespace but not across systems. -
» value string true The unique ID of the provider in the context of the system or assigning authority. -
effectivePeriod object false The effective period details. -
» start string false The date and time when the period starts. -
» end string false The date and time when the period ends. -
libraries object false An optional list of libraries for the registry definition. -
» id string true The unique ID of the measure library. -

putRegistries

Name Type Required Description Accepted Values
name string true The unique, computer-friendly name of the registry definition. -
title string true The unique, human-friendly title of the registry definition. -
description string false A brief description of the registry definition. This may include Markdown-formatted text. -
type string true

The type of the registry definition. The following values are available:

  • PERSON: Registries that include measures that identify people from a population
  • EVENT: Registries that include measures that operate on events
  • OPERATIONAL: Registries that include measures that operate on nonpatient entities such as providers or organizations
PERSON, EVENT, OPERATIONAL
subjectType string true

The subject type of the registry definition. The following values are available:

  • PATIENT: The person associated with the registry is a patient.
  • PROVIDER: The person associated with the registry is a provider.
PATIENT, PROVIDER
categories object false The category of the registry. Categories are used to group registries based on various categorization concepts. -
» id string true The unique ID of the category. -
aliases object false An optional list of aliases for the registry definition. -
» system string true The authority responsible for assigning the alias value. Alias values are unique in this system namespace but not across systems. -
» value string true The unique ID of the provider in the context of the system or assigning authority. -
effectivePeriod object false The effective period details. -
» start string false The date and time when the period starts. -
» end string false The date and time when the period ends. -
libraries object false An optional list of libraries for the registry definition. -
» id string true The unique ID of the measure library. -

Measures

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

postMeasures

Name Type Required Description Accepted Values
name string true The unique, computer-friendly name of the measure definition. -
title string true The unique, human-friendly title of the measure definition. -
subtitle string false The shortDisplay value of the measure definition from Program Reference Services. -
description string false A brief description of the registry definition. This may include Markdown-formatted text. -
improvementNotation string true The polarity of the measure. A value of INCREASE indicates that you want a higher score for the measure (a positive polarity). A value of DECREASE indicates that you want a lower score for the measure (a negative polarity). INCREASE, DECREASE
categories object false The category of the measure. Categories are used to group like measures definitions together. -
» id string true The unique ID of the the category. -
aliases object false An optional list of aliases for the measure definition. -
» system string true The authority responsible for assigning the alias value. Alias values are unique in this system namespace but not across systems. -
» value string true The unique ID of the provider in the context of the system or assigning authority. -
libraries object false An optional list of libraries for the measure definition. -
» id string true The unique ID of the measure library. -
registry object false An optional registry definition that the measure definition is associated with. -
» id string true The unique ID of the registry definition. -

putMeasures

Name Type Required Description Accepted Values
name string true The unique, computer-friendly name of the measure definition. -
title string true The unique, human-friendly title of the measure definition. -
subtitle string false The shortDisplay value of the measure definition from Program Reference Services. -
description string false A brief description of the registry definition. This may include Markdown-formatted text. -
improvementNotation string true The polarity of the measure. A value of INCREASE indicates that you want a higher score for the measure (a positive polarity). A value of DECREASE indicates that you want a lower score for the measure (a negative polarity). INCREASE, DECREASE
categories object false The category of the measure. Categories are used to group like measures definitions together. -
» id string true The unique ID of the the category. -
aliases object false An optional list of aliases for the measure definition. -
» system string true The authority responsible for assigning the alias value. Alias values are unique in this system namespace but not across systems. -
» value string true The unique ID of the provider in the context of the system or assigning authority. -
libraries object false An optional list of libraries for the measure definition. -
» id string true The unique ID of the measure library. -
registry object false An optional registry definition that the measure definition is associated with. -
» id string true The unique ID of the registry definition. -