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 fields. | RecommendationFields |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_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 two 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 two 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 is created. | RecommendationPolicy |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_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 policies. | RecommendationPolicies |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_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. | RecommendationPolicy |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_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. | RecommendationPolicy |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_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. | - |
includeTrumped | query | boolean | false | N/A | Filters recommendation messages for the measure. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of recommendations. | RecommendationPeople |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_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 | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_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:
- For each resource, each tag key must be unique and can have only one value.
- The maximum key length is 128 characters.
- The maximum value length is 256 characters.
- The tag keys and values are case-sensitive.
- Letters, numbers, and the following characters are allowed: # $ & - . / + : = ? @ _
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 | QualityMeasurePublicApi_Entities_V1_Tags_Tag |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_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%2CREPORTING_PROJECT_CONFIGURATION&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 | array[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 | array[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, REPORTING_PROJECT_CONFIGURATION |
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 | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_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 | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_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. | QualityMeasurePublicApi_Entities_V1_Tags_Tag |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_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 | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_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 is created. | QualityMeasurePublicApi_Entities_V1_Categorizations_Categorization |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_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 | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_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 is updated. | QualityMeasurePublicApi_Entities_V1_Categorizations_Categorization |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_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. | QualityMeasurePublicApi_Entities_V1_Categorizations_Categorization |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_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 | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_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 is successfully created. | QualityMeasurePublicApi_Entities_V1_Category |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_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 | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_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. | QualityMeasurePublicApi_Entities_V1_Category |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_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 is successfully updated. | QualityMeasurePublicApi_Entities_V1_Category |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_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",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two 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 | array[string] | false | N/A | Filters the response by the specified category ID or IDs. | - |
tag | query | array[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 | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_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 five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two 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 five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two 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",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two 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 is created. | QualityMeasurePublicApi_Entities_V1_Registries_Registry |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_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 five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two 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 five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two 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",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two 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",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two 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 is updated. | QualityMeasurePublicApi_Entities_V1_Registries_Registry |
201 | Created | The registry definition is created. | QualityMeasurePublicApi_Entities_V1_Registries_Registry |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_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",
"version": 1,
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"description": "The Asthma Care registry includes people in the population aged five to 65 years with a diagnosis of asthma and at least one outpatient encounter during the current measurement period or prior two 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. | QualityMeasurePublicApi_Entities_V1_Registries_Registry |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_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",
"version": 1,
"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 | array[string] | false | N/A | Filters the response by the specified category ID or IDs. | - |
registryId | query | array[string] | false | N/A | Filters the response by the specified registry ID or IDs. | - |
tag | query | array[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 | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_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",
"version": 1,
"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 is created. | QualityMeasurePublicApi_Entities_V1_Measures_Measure |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_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: {"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 {"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",
"version": 1,
"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",
"version": 1,
"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 is updated. | QualityMeasurePublicApi_Entities_V1_Measures_Measure |
201 | Created | The measure is created. | QualityMeasurePublicApi_Entities_V1_Measures_Measure |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_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",
"version": 1,
"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. | QualityMeasurePublicApi_Entities_V1_Measures_Measure |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Measure Configurations
The measure configuration represents an configuration scenario for a measure by specifying the version of the libraries to use as well as the values for the input parameters. A single measure can have many different configuration scenarios that are created to facilitate different use cases for measure evaluations.
Retrieve a List of Measure Configuration
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/measure-configurations', 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/measure-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "cernerstandard.asthma.org2014.clinical",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"measure": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"version": 1,
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"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 /measure-configurations
Retrieves a list of measure configuration.
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. | - |
name | query | string | false | N/A | Filters the response by measure configuration name. Partial text search is supported. | - |
title | query | string | false | N/A | Filters the response by measure configuration title. Partial text search is supported. | - |
orderBy | query | string | false | title | A comma-separated list of fields by which to sort. | -name, name, -title, title |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of measure configuration. | MeasureConfigurations |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Create a Measure Configuration
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/measure-configurations', headers: headers, body: {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829","name":"diabetes-treatment-period","title":"Diabetes Treatment Period","start":"2020-11-04","end":"2020-12-04"},"measure":{"id":"8910677b-28e6-4648-9159-1e114eb7b829","name":"cernerstandard.asthma.org2014.clinical/action-plan-complete","title":"Asthma Action Plan"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","name":"hedis-lsc","title":"Hedis Diabetes","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"createdBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}.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/measure-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829","name":"diabetes-treatment-period","title":"Diabetes Treatment Period","start":"2020-11-04","end":"2020-12-04"},"measure":{"id":"8910677b-28e6-4648-9159-1e114eb7b829","name":"cernerstandard.asthma.org2014.clinical/action-plan-complete","title":"Asthma Action Plan"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","name":"hedis-lsc","title":"Hedis Diabetes","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"createdBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}
Example response
{
"id": "cernerstandard.asthma.org2014.clinical",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"measure": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"version": 1,
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
POST /measure-configurations
Creates a measure configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postMeasureConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | The measure configuration is created. | QualityMeasurePublicApi_Entities_V1_MeasureConfigurations_MeasureConfiguration |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Retrieve a Single Measure Configuration
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/measure-configurations/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/measure-configurations/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "cernerstandard.asthma.org2014.clinical",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"measure": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"version": 1,
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
GET /measure-configurations/{measureConfigurationId}
Retrieves the measure configuration with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
measureConfigurationId | path | string | true | N/A | The ID of the measure configuration. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single measure configuration. | QualityMeasurePublicApi_Entities_V1_MeasureConfigurations_MeasureConfiguration |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Update a Measure Configuration
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/measure-configurations/6d984963-5306-40e8-8157-c65348a2fe43', headers: headers, body: {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829","name":"diabetes-treatment-period","title":"Diabetes Treatment Period","start":"2020-11-04","end":"2020-12-04"},"measure":{"id":"8910677b-28e6-4648-9159-1e114eb7b829","name":"cernerstandard.asthma.org2014.clinical/action-plan-complete","title":"Asthma Action Plan"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","name":"hedis-lsc","title":"Hedis Diabetes","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"updatedBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}.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/measure-configurations/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerstandard.asthma.org2014.clinical","title":"Asthma","measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829","name":"diabetes-treatment-period","title":"Diabetes Treatment Period","start":"2020-11-04","end":"2020-12-04"},"measure":{"id":"8910677b-28e6-4648-9159-1e114eb7b829","name":"cernerstandard.asthma.org2014.clinical/action-plan-complete","title":"Asthma Action Plan"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","name":"hedis-lsc","title":"Hedis Diabetes","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"updatedBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}
Example response
{
"id": "cernerstandard.asthma.org2014.clinical",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"measure": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"version": 1,
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
{
"id": "cernerstandard.asthma.org2014.clinical",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"measure": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"version": 1,
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
PUT /measure-configurations/{measureConfigurationId}
Updates the measure configuration with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
measureConfigurationId | path | string | true | N/A | The ID of the measure configuration. | - |
body | body | putMeasureConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The measure configuration is successfully updated. | QualityMeasurePublicApi_Entities_V1_MeasureConfigurations_MeasureConfiguration |
201 | Created | The measure configuration is successfully created. | QualityMeasurePublicApi_Entities_V1_MeasureConfigurations_MeasureConfiguration |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Retrieve a List of Measure Configuration Versions
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/measure-configurations/{measureConfigurationId}/versions', 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/measure-configurations/{measureConfigurationId}/versions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "cernerstandard.asthma.org2014.clinical",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"measure": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"version": 1,
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"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 /measure-configurations/{measureConfigurationId}/versions
Retrieves a list of measure configuration versions.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
measureConfigurationId | path | string | true | N/A | The ID of the measure configuration. | - |
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 | -version | A comma-separated list of fields by which to sort. | version, -version |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of measure configuration versions. | MeasureConfigurations |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Retrieve a Version of Single Measure Configuration
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/measure-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions/1', 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/measure-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions/1 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "cernerstandard.asthma.org2014.clinical",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma",
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"measure": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical/action-plan-complete",
"title": "Asthma Action Plan"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"version": 1,
"createdBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"updatedBy": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2018-07-25T17:03:14.120Z"
}
GET /measure-configurations/{measureConfigurationId}/versions/{versionNumber}
Retrieves the version of measure configuration with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
measureConfigurationId | path | string | true | N/A | The ID of the measure configuration. | - |
versionNumber | path | string | true | N/A | The version number. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single measure configuration. | QualityMeasurePublicApi_Entities_V1_MeasureConfigurations_MeasureConfiguration |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Measurement Periods
The measurement period represents a structure that provides a single point of reference for all library parameters, such as the start and end of the measurement period that should be applied. The measurement period structure supports both a fixed set of dates and also a relative date definition.
Retrieve a List of MeasurementPeriods
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/measurement-periods', 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/measurement-periods \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment",
"title": "Period of Diabetes Treatment",
"start": "2018-07-25",
"end": "2018-07-25",
"startRelativeTimeModifier": "-1day",
"endRelativeTimeModifier": "1month",
"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 /measurement-periods
Retrieves a list of measurement periods.
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 measurement periods. | MeasurementPeriods |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Create a MeasurementPeriod
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/measurement-periods', headers: headers, body: {"name":"diabetes-treatment","title":"Period of Diabetes Treatment","start":"2018-07-25","end":"2018-07-25","startRelativeTimeModifier":"-1day","endRelativeTimeModifier":"-1day"}.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/measurement-periods \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"diabetes-treatment","title":"Period of Diabetes Treatment","start":"2018-07-25","end":"2018-07-25","startRelativeTimeModifier":"-1day","endRelativeTimeModifier":"-1day"}
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment",
"title": "Period of Diabetes Treatment",
"start": "2018-07-25",
"end": "2018-07-25",
"startRelativeTimeModifier": "-1day",
"endRelativeTimeModifier": "1month",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
POST /measurement-periods
Creates a measurement period.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postMeasurementPeriods | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | The measurement period is created. | QualityMeasurePublicApi_Entities_V1_MeasurementPeriods_MeasurementPeriod |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Delete a MeasurementPeriod
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/measurement-periods/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/measurement-periods/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /measurement-periods/{measurementPeriodId}
Deletes a measurement period.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
measurementPeriodId | path | string | true | N/A | The ID of the measurement period. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | The measurement period is deleted. | None |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Update a MeasurementPeriod
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/measurement-periods/8910677b-28e6-4648-9159-1e114eb7b829', headers: headers, body: {"name":"diabetes-treatment","title":"Period of Diabetes Treatment","start":"2018-07-25","end":"2018-07-25","startRelativeTimeModifier":"-1day","endRelativeTimeModifier":"-1day"}.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/measurement-periods/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"diabetes-treatment","title":"Period of Diabetes Treatment","start":"2018-07-25","end":"2018-07-25","startRelativeTimeModifier":"-1day","endRelativeTimeModifier":"-1day"}
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment",
"title": "Period of Diabetes Treatment",
"start": "2018-07-25",
"end": "2018-07-25",
"startRelativeTimeModifier": "-1day",
"endRelativeTimeModifier": "1month",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
PUT /measurement-periods/{measurementPeriodId}
Updates a measurement period.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
measurementPeriodId | path | string | true | N/A | The ID of the measurement period. | - |
body | body | putMeasurementPeriods | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The measurement period is updated. | QualityMeasurePublicApi_Entities_V1_MeasurementPeriods_MeasurementPeriod |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Retrieve a MeasurementPeriod
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/measurement-periods/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/measurement-periods/8910677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment",
"title": "Period of Diabetes Treatment",
"start": "2018-07-25",
"end": "2018-07-25",
"startRelativeTimeModifier": "-1day",
"endRelativeTimeModifier": "1month",
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
GET /measurement-periods/{measurementPeriodId}
Retrieves a measurement period.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
measurementPeriodId | path | string | true | N/A | The ID of the measurement period. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single measurement period. | QualityMeasurePublicApi_Entities_V1_MeasurementPeriods_MeasurementPeriod |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Registry Configurations
The registry configuration represents an configuration scenario for a registry by specifying the version of the libraries to use as well as the values for the input parameters. A single registry can have many different configuration scenarios that are created to facilitate different use cases for registry evaluations and the associated measures evaluations.
Retrieve a List of Registry Configurations
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/registry-configurations', 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/registry-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical",
"version": 1,
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2020-07-25T17:03:14.120Z",
"updatedAt": "2020-07-26T17:08:21.000Z"
}
],
"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 /registry-configurations
Retrieves a list of registry configurations.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
name | query | string | false | N/A | Filters the response by registry configuration name. Partial text search is supported. | - |
title | query | string | false | N/A | Filters the response by registry configuration title. Partial text search is supported. | - |
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 | title | A comma-separated list of fields by which to sort. | -name, name, -title, title |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of registry configurations. | RegistryConfigurations |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Create a Registry Configuration
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/registry-configurations', headers: headers, body: {"name":"cernerdemo.asthma.org2020.clinical","title":"Cernerdemo Asthma Org2020 Clinical","registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829"},"createdBy":{"id":"e2025ca9-a137-4309-adef-08cda086eefe"}}.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/registry-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerdemo.asthma.org2020.clinical","title":"Cernerdemo Asthma Org2020 Clinical","registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829"},"createdBy":{"id":"e2025ca9-a137-4309-adef-08cda086eefe"}}
Example response
{
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical",
"version": 1,
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2020-07-25T17:03:14.120Z",
"updatedAt": "2020-07-26T17:08:21.000Z"
}
POST /registry-configurations
Creates a registry configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postRegistryConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | The registry configuration is created. | QualityMeasurePublicApi_Entities_V1_RegistryConfigurations_RegistryConfiguration |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Retrieve a Single Registry Configuration
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/registry-configurations/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/registry-configurations/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical",
"version": 1,
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2020-07-25T17:03:14.120Z",
"updatedAt": "2020-07-26T17:08:21.000Z"
}
GET /registry-configurations/{registryConfigurationId}
Retrieves the registry configuration with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
registryConfigurationId | path | string | true | N/A | The ID of the registry configuration. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single registry configuration. | QualityMeasurePublicApi_Entities_V1_RegistryConfigurations_RegistryConfiguration |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Update a Registry Configuration
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/registry-configurations/6d984963-5306-40e8-8157-c65348a2fe43', headers: headers, body: {"name":"cernerdemo.asthma.org2020.clinical","title":"Cernerdemo Asthma Org2020 Clinical","registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829"},"updatedBy":{"id":"368cde2d-760e-4ceb-978b-20f16102891c"}}.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/registry-configurations/6d984963-5306-40e8-8157-c65348a2fe43 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"cernerdemo.asthma.org2020.clinical","title":"Cernerdemo Asthma Org2020 Clinical","registry":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"libraries":[{"id":"5510677b-28e6-4648-9159-1e114eb7b829","versionedContent":{"releaseNumber":2,"parameters":[{"name":"lookback-years-lsc","value":"-5y"}]}}],"measurementPeriod":{"id":"4310677b-28e6-4648-9159-1e114eb7b829"},"updatedBy":{"id":"368cde2d-760e-4ceb-978b-20f16102891c"}}
Example response
{
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical",
"version": 1,
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2020-07-25T17:03:14.120Z",
"updatedAt": "2020-07-26T17:08:21.000Z"
}
{
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical",
"version": 1,
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2020-07-25T17:03:14.120Z",
"updatedAt": "2020-07-26T17:08:21.000Z"
}
PUT /registry-configurations/{registryConfigurationId}
Updates the registry configuration with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
registryConfigurationId | path | string | true | N/A | The ID of the registry configuration. | - |
body | body | putRegistryConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The registry configuration is successfully updated. | QualityMeasurePublicApi_Entities_V1_RegistryConfigurations_RegistryConfiguration |
201 | Created | The registry configuration is created. | QualityMeasurePublicApi_Entities_V1_RegistryConfigurations_RegistryConfiguration |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Retrieve a List of Registry Configuration Versions
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/registry-configurations/{registryConfigurationId}/versions', 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/registry-configurations/{registryConfigurationId}/versions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical",
"version": 1,
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2020-07-25T17:03:14.120Z",
"updatedAt": "2020-07-26T17:08:21.000Z"
}
],
"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 /registry-configurations/{registryConfigurationId}/versions
Retrieves a list of registry configuration versions.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
registryConfigurationId | path | string | true | N/A | The ID of the registry configuration. | - |
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 | -version | A comma-separated list of fields by which to sort. | -version, version |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of registry configuration versions. | RegistryConfigurations |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Retrieve a Single Version of a Registry Configuration
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/registry-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions/1', 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/registry-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions/1 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "9320677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerdemo.asthma.org2020.clinical",
"title": "Cernerdemo Asthma Org2020 Clinical",
"version": 1,
"registry": {
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "cernerstandard.asthma.org2014.clinical",
"title": "Asthma"
},
"libraries": [
{
"id": "5510677b-28e6-4648-9159-1e114eb7b829",
"name": "hedis-lsc",
"title": "Hedis Diabetes",
"versionedContent": {
"releaseNumber": 2,
"parameters": [
{
"name": "lookback-years-lsc",
"value": "-5y"
}
]
}
}
],
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2020-07-25T17:03:14.120Z",
"updatedAt": "2020-07-26T17:08:21.000Z"
}
GET /registry-configurations/{registryConfigurationId}/versions/{versionNumber}
Retrieves the specified version of a registry configuration with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
registryConfigurationId | path | string | true | N/A | The ID of the registry configuration. | - |
versionNumber | path | string | true | N/A | The version number of the registry configuration. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single registry configuration. | QualityMeasurePublicApi_Entities_V1_RegistryConfigurations_RegistryConfiguration |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Reporting Project Configurations
The reporting project configuration represents an configuration scenario for a reporting project. The configuration is used as the input instructions to run the quality measure reporting project configuration.
Retrieve a List of ReportingProjectConfigurations
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-project-configurations', 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-project-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "2021-configuration",
"title": "2021 Configuration",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"subpopulation": {
"id": "3caed5b0-ae02-449b-a3c6-7583df11d6e7"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"registryConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"registry": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "aco_mssp_2019_plus_quality_measures",
"title": "ACO MSSP 2019 Plus Quality Measures"
}
}
],
"measureConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"measure": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "advocate.events.ambulatory-urgent-care-2018/acute-otitis-externa-topical-therapy",
"title": "Acute Otitis Externa Topical Therapy"
}
}
],
"measureHierarchyIndex": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "maestro-measure-hierarchy"
},
"tags": [
[
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
]
],
"version": 1,
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"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 /reporting-project-configurations
Retrieves a list of reporting project configurations.
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. | - |
tag | query | array[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. |
- |
population | query | array[string] | false | N/A | Filters the response by population ID. | - |
registryConfigurationId | query | array[string] | false | N/A | Filters the response by the specified IDs. | - |
measureConfigurationId | query | array[string] | false | N/A | Filters the response by the specified IDs. | - |
measureHierarchyIndexId | query | array[string] | false | N/A | Filters the response by the specified IDs. | - |
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 | title | A comma-separated list of fields by which to sort. | -name, name, -title, title |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of reporting project configurations. | ReportingProjectConfigurations |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Create a ReportingProjectConfiguration
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/reporting-project-configurations', headers: headers, body: {"name":"Asthma Action Plan","title":"Asthma Action Plan","population":{"id":"45b1cdd1-0584-4d06-9550-44d934597259","subpopulation":{"id":"3caed5b0-ae02-449b-a3c6-7583df11d6e7"}},"subpopulation":{"id":"3caed5b0-ae02-449b-a3c6-7583df11d6e7"},"measurementPeriod":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"registryConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureHierarchyIndex":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"createdBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}.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/reporting-project-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Asthma Action Plan","title":"Asthma Action Plan","population":{"id":"45b1cdd1-0584-4d06-9550-44d934597259","subpopulation":{"id":"3caed5b0-ae02-449b-a3c6-7583df11d6e7"}},"subpopulation":{"id":"3caed5b0-ae02-449b-a3c6-7583df11d6e7"},"measurementPeriod":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"registryConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureHierarchyIndex":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"createdBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "2021-configuration",
"title": "2021 Configuration",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"subpopulation": {
"id": "3caed5b0-ae02-449b-a3c6-7583df11d6e7"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"registryConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"registry": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "aco_mssp_2019_plus_quality_measures",
"title": "ACO MSSP 2019 Plus Quality Measures"
}
}
],
"measureConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"measure": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "advocate.events.ambulatory-urgent-care-2018/acute-otitis-externa-topical-therapy",
"title": "Acute Otitis Externa Topical Therapy"
}
}
],
"measureHierarchyIndex": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "maestro-measure-hierarchy"
},
"tags": [
[
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
]
],
"version": 1,
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
POST /reporting-project-configurations
Creates a new reporting project configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postReportingProjectConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | The reporting project configuration is successfully created. | QualityMeasurePublicApi_Entities_V1_ReportingProjectConfigurations_ReportingProjectConfiguration |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Retrieve a Single ReportingProjectConfiguration
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-project-configurations/d1ed37db-3380-4428-91de-fe2e951ccf7', 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-project-configurations/d1ed37db-3380-4428-91de-fe2e951ccf7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "2021-configuration",
"title": "2021 Configuration",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"subpopulation": {
"id": "3caed5b0-ae02-449b-a3c6-7583df11d6e7"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"registryConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"registry": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "aco_mssp_2019_plus_quality_measures",
"title": "ACO MSSP 2019 Plus Quality Measures"
}
}
],
"measureConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"measure": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "advocate.events.ambulatory-urgent-care-2018/acute-otitis-externa-topical-therapy",
"title": "Acute Otitis Externa Topical Therapy"
}
}
],
"measureHierarchyIndex": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "maestro-measure-hierarchy"
},
"tags": [
[
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
]
],
"version": 1,
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
GET /reporting-project-configurations/{reportingProjectConfigurationId}
Retrieves the reporting project configuration with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
reportingProjectConfigurationId | path | string | true | N/A | The ID of the reporting project configuration. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single reporting project configuration. | QualityMeasurePublicApi_Entities_V1_ReportingProjectConfigurations_ReportingProjectConfiguration |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Update a ReportingProjectConfiguration
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/reporting-project-configurations/d1ed37db-3380-4428-91de-fe2e951ccf7', headers: headers, body: {"name":"Asthma Action Plan","title":"Asthma Action Plan","population":{"id":"45b1cdd1-0584-4d06-9550-44d934597259","subpopulation":{"id":"3caed5b0-ae02-449b-a3c6-7583df11d6e7"}},"subpopulation":{"id":"3caed5b0-ae02-449b-a3c6-7583df11d6e7"},"measurementPeriod":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"registryConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureHierarchyIndex":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"updatedBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}.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/reporting-project-configurations/d1ed37db-3380-4428-91de-fe2e951ccf7 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Asthma Action Plan","title":"Asthma Action Plan","population":{"id":"45b1cdd1-0584-4d06-9550-44d934597259","subpopulation":{"id":"3caed5b0-ae02-449b-a3c6-7583df11d6e7"}},"subpopulation":{"id":"3caed5b0-ae02-449b-a3c6-7583df11d6e7"},"measurementPeriod":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"registryConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureConfigurations":[{"id":"8910677b-28e6-4648-9159-1e114eb7b829"}],"measureHierarchyIndex":{"id":"8910677b-28e6-4648-9159-1e114eb7b829"},"updatedBy":{"id":"45b1cdd1-0584-4d06-9550-44d934597259"}}
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "2021-configuration",
"title": "2021 Configuration",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"subpopulation": {
"id": "3caed5b0-ae02-449b-a3c6-7583df11d6e7"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"registryConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"registry": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "aco_mssp_2019_plus_quality_measures",
"title": "ACO MSSP 2019 Plus Quality Measures"
}
}
],
"measureConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"measure": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "advocate.events.ambulatory-urgent-care-2018/acute-otitis-externa-topical-therapy",
"title": "Acute Otitis Externa Topical Therapy"
}
}
],
"measureHierarchyIndex": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "maestro-measure-hierarchy"
},
"tags": [
[
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
]
],
"version": 1,
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "2021-configuration",
"title": "2021 Configuration",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"subpopulation": {
"id": "3caed5b0-ae02-449b-a3c6-7583df11d6e7"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"registryConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"registry": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "aco_mssp_2019_plus_quality_measures",
"title": "ACO MSSP 2019 Plus Quality Measures"
}
}
],
"measureConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"measure": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "advocate.events.ambulatory-urgent-care-2018/acute-otitis-externa-topical-therapy",
"title": "Acute Otitis Externa Topical Therapy"
}
}
],
"measureHierarchyIndex": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "maestro-measure-hierarchy"
},
"tags": [
[
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
]
],
"version": 1,
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
PUT /reporting-project-configurations/{reportingProjectConfigurationId}
Updates the reporting project configuration with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
reportingProjectConfigurationId | path | string | true | N/A | The ID of the reporting project configuration. | - |
body | body | putReportingProjectConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The reporting project configuration is successfully updated. | QualityMeasurePublicApi_Entities_V1_ReportingProjectConfigurations_ReportingProjectConfiguration |
201 | Created | The reporting project configuration is created. | QualityMeasurePublicApi_Entities_V1_ReportingProjectConfigurations_ReportingProjectConfiguration |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Retrieve a List of Reporting Project Configuration Versions
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-project-configurations/{reportingProjectConfigurationId}/versions', 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-project-configurations/{reportingProjectConfigurationId}/versions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "2021-configuration",
"title": "2021 Configuration",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"subpopulation": {
"id": "3caed5b0-ae02-449b-a3c6-7583df11d6e7"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"registryConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"registry": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "aco_mssp_2019_plus_quality_measures",
"title": "ACO MSSP 2019 Plus Quality Measures"
}
}
],
"measureConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"measure": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "advocate.events.ambulatory-urgent-care-2018/acute-otitis-externa-topical-therapy",
"title": "Acute Otitis Externa Topical Therapy"
}
}
],
"measureHierarchyIndex": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "maestro-measure-hierarchy"
},
"tags": [
[
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
]
],
"version": 1,
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"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 /reporting-project-configurations/{reportingProjectConfigurationId}/versions
Retrieves a list of reporting project configuration versions.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
reportingProjectConfigurationId | path | string | true | N/A | The ID of the reporting project configuration. | - |
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 | -version | A comma-separated list of fields by which to sort. | -version, version |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of reporting project configuration versions. | ReportingProjectConfigurations |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Retrieve a Single Version of a Reporting Project Configuration
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-project-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions/1', 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-project-configurations/6d984963-5306-40e8-8157-c65348a2fe43/versions/1 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "8910677b-28e6-4648-9159-1e114eb7b829",
"name": "2021-configuration",
"title": "2021 Configuration",
"population": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"subpopulation": {
"id": "3caed5b0-ae02-449b-a3c6-7583df11d6e7"
}
},
"measurementPeriod": {
"id": "4310677b-28e6-4648-9159-1e114eb7b829",
"name": "diabetes-treatment-period",
"title": "Diabetes Treatment Period",
"start": "2020-11-04",
"end": "2020-12-04"
},
"registryConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"registry": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "aco_mssp_2019_plus_quality_measures",
"title": "ACO MSSP 2019 Plus Quality Measures"
}
}
],
"measureConfigurations": [
{
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"measure": {
"id": "55dde022-3ab1-494b-ab19-0582036c75f3",
"name": "advocate.events.ambulatory-urgent-care-2018/acute-otitis-externa-topical-therapy",
"title": "Acute Otitis Externa Topical Therapy"
}
}
],
"measureHierarchyIndex": {
"id": "45b1cdd1-0584-4d06-9550-44d934597259",
"name": "maestro-measure-hierarchy"
},
"tags": [
[
{
"key": "Use",
"value": "PRODUCTION_REGISTRIES"
}
]
],
"version": 1,
"createdBy": {
"id": "e2025ca9-a137-4309-adef-08cda086eefe"
},
"updatedBy": {
"id": "368cde2d-760e-4ceb-978b-20f16102891c"
},
"createdAt": "2018-07-25T17:03:14.120Z",
"updatedAt": "2020-07-25T17:03:14.120Z"
}
GET /reporting-project-configurations/{reportingProjectConfigurationId}/versions/{versionNumber}
Retrieves the specified version of a reporting project configuration with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
reportingProjectConfigurationId | path | string | true | N/A | The ID of the reporting project configuration. | - |
versionNumber | path | string | true | N/A | The version number. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single reporting project configuration. | QualityMeasurePublicApi_Entities_V1_ReportingProjectConfigurations_ReportingProjectConfiguration |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Hierarchy Indexes
Hierarchy indexes indicate related measures that have prioritization relationships.
Create a Hierarchy Index
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/hierarchy-indexes', headers: headers, body: {"name":"maestro-measure-hierarchy","title":"Measure Hierarchy Definition for Maestro Product"}.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/hierarchy-indexes \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"maestro-measure-hierarchy","title":"Measure Hierarchy Definition for Maestro Product"}
POST /hierarchy-indexes
Creates a hierarchy index.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postHierarchyIndexes | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | The hierarchy index is created. | QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyIndex |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
201 | Location | string | The URL of the created definition. |
Retrieve a List of Hierarchy Indexes
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/hierarchy-indexes', 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/hierarchy-indexes \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /hierarchy-indexes
Retrieves a list of hierarchy indexes.
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 | The collection of hierarchy indexes is retrieved. | HierarchyIndices |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
Update a Hierarchy Index
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/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829', headers: headers, body: {"name":"maestro-measure-hierarchy","title":"Measure Hierarchy Definition for Maestro Product"}.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/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"maestro-measure-hierarchy","title":"Measure Hierarchy Definition for Maestro Product"}
PUT /hierarchy-indexes/{indexId}
Updates a hierarchy index.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
body | body | putHierarchyIndexes | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | The hierarchy index is updated. | QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyIndex |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Delete a Hierarchy Index
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/hierarchy-indexes/5780677b-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/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /hierarchy-indexes/{indexId}
Deletes a hierarchy index. When a hierarchy index is deleted, all the hierarchy groups associated with the index are also deleted.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | The hierarchy index is deleted. | None |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
Retrieve a Single Hierarchy Index
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/hierarchy-indexes/5780677b-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/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /hierarchy-indexes/{indexId}
Retrieves a single hierarchy index.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single hierarchy index is retrieved. | QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyIndex |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
Hierarchy Indexes - Groups
Hierarchy groups are defined under hierarchy indexes and indicate which collections of measures have the same priorities.
Create a Hierarchy Group
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
POST /hierarchy-indexes/{indexId}/groups
Creates a hierarchy group.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | The hierarchy group is created. | QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyGroup |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
201 | Location | string | The URL of the created definition. |
Retrieve a List of Hierarchy Groups
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/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups', 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/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /hierarchy-indexes/{indexId}/groups
Retrieves a list of the hierarchy groups associated with the specified index ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
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 | The collection of hierarchy groups is retrieved. | HierarchyGroups |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
Update a Hierarchy Group
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups/2310677b-28e6-4648-9159-1e114eb7b829', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/quality-measure/v1/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups/2310677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
PUT /hierarchy-indexes/{indexId}/groups/{groupId}
Updates a hierarchy group.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
groupId | path | string | true | N/A | The ID of the hierarchy group. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | The hierarchy group is updated. | QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyGroup |
400 | Bad Request | Bad Request | HealtheintentApi_Common_Models_Error |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
415 | Unsupported Media Type | Unsupported Media Type | HealtheintentApi_Common_Models_Error |
Delete a Hierarchy Group
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/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups/2310677b-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/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups/2310677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /hierarchy-indexes/{indexId}/groups/{groupId}
Deletes a hierarchy group.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
groupId | path | string | true | N/A | The ID of the hierarchy group. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | The hierarchy group is deleted. | None |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
Retrieve a Single Hierarchy Group
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/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups/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/hierarchy-indexes/5780677b-28e6-4648-9159-1e114eb7b829/groups/2310677b-28e6-4648-9159-1e114eb7b829 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /hierarchy-indexes/{indexId}/groups/{groupId}
Retrieves a single hierarchy group.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
indexId | path | string | true | N/A | The ID of the hierarchy index. | - |
groupId | path | string | true | N/A | The ID of the hierarchy group. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single hierarchy group is retrieved. | QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyGroup |
401 | Unauthorized | Unauthorized | HealtheintentApi_Common_Models_Error |
403 | Forbidden | Forbidden | HealtheintentApi_Common_Models_Error |
404 | Not Found | Not Found | HealtheintentApi_Common_Models_Error |
Schema Definitions
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. | - |
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 | HealtheintentApi_Common_Models_Alias | false | The alias details of the measure definition. This alias is required if an ID is not specified. | - |
HealtheintentApi_Common_Models_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 | The relational operator that is used to perform the operations on two operands. The following operators are available:
|
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. | - |
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 | [Field] | false | No description | - |
measureDefinition | 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 the 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. | - |
HealtheintentApi_Common_Models_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 | [HealtheintentApi_Common_Models_ErrorDetail] | false | A list of additional error details. | - |
HealtheintentApi_Common_Models_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 | MeasureResultsMeasure | 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, 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, 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. | - |
MeasureResultsMeasure
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The unique, computer-friendly name of the measure definition. | - |
registry | MeasureResultsRegistry | true | The reference to the registry with which the measure is grouped. | - |
MeasureResultsRegistry
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
aliases | [HealtheintentApi_Common_Models_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, REPORTING_PROJECT_CONFIGURATION |
» id | string | true | The resource ID. | - |
QualityMeasurePublicApi_Entities_V1_Tags_Tag
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The tag ID. | - |
resource | QualityMeasurePublicApi_Entities_V1_Tags_ResourceReference | true | The resource reference for the tag. | - |
key | string | true | The key for the tag. | - |
value | string | false | The value for the tag. | - |
QualityMeasurePublicApi_Entities_V1_Tags_ResourceReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
type | string | true | The resource type. | MEASURE, REGISTRY, REPORTING_PROJECT_CONFIGURATION |
id | string | true | The resource ID. | - |
Tags
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [QualityMeasurePublicApi_Entities_V1_Tags_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 | [QualityMeasurePublicApi_Entities_V1_Categorizations_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. | - |
QualityMeasurePublicApi_Entities_V1_Categorizations_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 | [QualityMeasurePublicApi_Entities_V1_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. | - |
QualityMeasurePublicApi_Entities_V1_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 | [QualityMeasurePublicApi_Entities_V1_Registries_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. | - |
QualityMeasurePublicApi_Entities_V1_Registries_Registry
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the registry definition. | - |
version | integer(int32) | true | The version of the registry definition. | - |
name | string | true | The unique, computer-friendly name of the registry definition. | - |
title | string | true | The human-friendly title of the registry definition. | - |
description | string | false | A brief description of the registry definition. This may include Markdown-formatted text. | - |
categories | [QualityMeasurePublicApi_Entities_V1_Common_CategoryReference] | false | The categories of the registry. Categories are used to categorize registries based on various categorization concepts. | - |
aliases | [HealtheintentApi_Common_Models_Alias] | false | An optional list of aliases for the registry definition. | - |
tags | [QualityMeasurePublicApi_Entities_V1_Common_TagReference] | false | An optional list of tags for the registry definition. | - |
type | string | true | The type of the registry definition. The following values are available:
|
PERSON, EVENT, OPERATIONAL |
subjectType | string | true | The subject type of the registry definition. The following values are available:
|
PATIENT, PROVIDER |
effectivePeriod | QualityMeasurePublicApi_Entities_V1_Registries_EffectivePeriod | false | The effective period details. | - |
libraries | [QualityMeasurePublicApi_Entities_V1_Common_MeasureLibraryReference] | false | An optional list of libraries for the registry definition. | - |
createdAt | string | true | The date and time when the registry definition was created. | - |
updatedAt | string | true | The date and time when the registry definition was updated. This defaults to the createdAt value when the registry definition is created. |
- |
QualityMeasurePublicApi_Entities_V1_Common_CategoryReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the category. | - |
title | string | false | A human-friendly display for the category. | - |
categorizationId | string | true | The unique ID for the categorization that the category belongs to. | - |
QualityMeasurePublicApi_Entities_V1_Common_TagReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
key | string | true | The key name of the tag. | - |
value | string | false | The value of the tag. | - |
QualityMeasurePublicApi_Entities_V1_Registries_EffectivePeriod
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
start | string | false | The date and time when the period starts. | - |
end | string | false | The date and time when the period ends. | - |
QualityMeasurePublicApi_Entities_V1_Common_MeasureLibraryReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the measure library. | - |
name | string | false | The unique, computer-friendly display for the measure library. | - |
title | string | false | The human-friendly display for the measure library. | - |
postRegistries
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The unique, computer-friendly name of the registry definition. | - |
title | string | true | The 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, EVENT, OPERATIONAL |
subjectType | string | true | The subject type of the registry definition. The following values are available:
|
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 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, EVENT, OPERATIONAL |
subjectType | string | true | The subject type of the registry definition. The following values are available:
|
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 | [QualityMeasurePublicApi_Entities_V1_Measures_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. | - |
QualityMeasurePublicApi_Entities_V1_Measures_Measure
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the measure definition. | - |
version | integer(int32) | true | The version of the measure definition. | - |
name | string | true | The unique, computer-friendly name of the measure definition. | - |
title | string | true | The human-friendly title of the measure definition. | - |
subtitle | string | false | An explanatory or alternate title for the measure giving additional information about its content. | - |
description | string | false | A brief description of the registry definition. This may include Markdown-formatted text. | - |
categories | [QualityMeasurePublicApi_Entities_V1_Common_CategoryReference] | false | The categories of the measure. Categories are used to group like measures together. | - |
aliases | [HealtheintentApi_Common_Models_Alias] | false | An optional list of aliases for the measure definition. | - |
tags | [QualityMeasurePublicApi_Entities_V1_Common_TagReference] | false | An optional list of tags for the measure definition. | - |
libraries | [QualityMeasurePublicApi_Entities_V1_Common_MeasureLibraryReference] | false | An optional list of libraries for the measure definition. | - |
registry | QualityMeasurePublicApi_Entities_V1_Measures_RegistryReference | false | An optional registry definition that the measure definition is associated with. | - |
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 |
createdAt | string | true | The date and time when the measure definition was created. | - |
updatedAt | string | true | The date and time when the measure definition was udpated. This is defaulted to the createdAt value when the measure definition is created. |
- |
QualityMeasurePublicApi_Entities_V1_Measures_RegistryReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the registry definition. | - |
name | string | true | The unique, computer-friendly display for the registry definition. | - |
title | string | true | The unique, human-friendly display for the registry definition. | - |
postMeasures
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The unique, computer-friendly name of the measure definition. | - |
title | string | true | The human-friendly title of the measure definition. | - |
subtitle | string | false | An explanatory or alternate title for the measure giving additional information about its content. | - |
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 similar measure definitions together. | - |
» id | string | true | The unique ID of 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 |
---|---|---|---|---|
title | string | true | The human-friendly title of the measure definition. | - |
subtitle | string | false | An explanatory or alternate title for the measure giving additional information about its content. | - |
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 similar measure definitions together. | - |
» id | string | true | The unique ID of 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. | - |
MeasureConfigurations
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [QualityMeasurePublicApi_Entities_V1_MeasureConfigurations_MeasureConfiguration] | 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. | - |
QualityMeasurePublicApi_Entities_V1_MeasureConfigurations_MeasureConfiguration
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | false | The unique, computer-friendly name of the measure configuration. | - |
name | string | false | The unique, computer-friendly name of the measure configuration. | - |
title | string | false | The human-friendly title of the measure configuration. | - |
measurementPeriod | CommonMeasurementPeriod | false | An optional reference to a Measurement Period that can be utilized in the configurations | - |
measure | MeasureConfigurationsMeasure | false | The measure definition that is being configured | - |
libraries | [QualityMeasurePublicApi_Entities_V1_Common_ConfigurationLibrary] | false | The libraries the are configured as part of this measure configuration.Note: This list should match the libraries that are defined as part of the measure-definition. | - |
version | integer(int32) | true | The version of the registry configuration. | - |
createdBy | QualityMeasurePublicApi_Entities_V1_Common_UpdatedBy | false | The individual who created the measure configuration. | - |
updatedBy | QualityMeasurePublicApi_Entities_V1_Common_CreatedBy | false | The individual who updated the measure configuration.This is defaulted to the createdBy value when the registry configuration is created. |
- |
createdAt | string | false | The date and time when the measure configuration was created. | - |
updatedAt | string | false | The date and time when the measure configuration was udpated. This is defaulted to the createdAt value when the measure definition is created. |
- |
CommonMeasurementPeriod
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | Unique identifier for the measurement period. | - |
name | string | true | The unique, computer-friendly name of the measurement period. | - |
title | string | true | The unique, human-friendly title of the measurement period. | - |
start | string | false | The start of the measurement period. This value will either be static and provided by a consumer as part of a POST/PUT request or will be dynamically calculated on the response (and not saved in the database) if startRelativeTimeModifier and endRelativeTimeModifier were provided in a POST/PUT request. | - |
end | string | false | The end of the measurement period. This value will either be static and provided by a consumer as part of a POST/PUT request or will be dynamically calculated on the response (and not saved in the database) if startRelativeTimeModifier and endRelativeTimeModifier were provided in a POST/PUT request. | - |
MeasureConfigurationsMeasure
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | false | The unique, computer-friendly name of the measure definition. | - |
title | string | false | The human-friendly title of the measure definition. | - |
id | string | false | The unique ID of the measure definition. | - |
QualityMeasurePublicApi_Entities_V1_Common_ConfigurationLibrary
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the measure library. | - |
name | string | false | The unique, computer-friendly display for the measure library. | - |
title | string | false | The human-friendly display for the measure library. | - |
versionedContent | CommonVersionedContent | true | The versioned content of the measure library. | - |
CommonVersionedContent
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
releaseNumber | integer(int32) | true | The version/release number for the given measure library. | - |
parameters | [CommonVersionedContentParameter] | false | The parameters for the given version of the measure library. | - |
CommonVersionedContentParameter
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The name for the parameter being configured. Note: The name should match a parameter configured in the measure library. | - |
value | string | false | The value for the parameter being configured. Note: Value type should match the expected type configured in the measure library. | - |
valueRef | string | false | The value reference for the parameter being configured. | - |
QualityMeasurePublicApi_Entities_V1_Common_UpdatedBy
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the individual who updated the resource. | - |
QualityMeasurePublicApi_Entities_V1_Common_CreatedBy
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the individual who created the resource. | - |
postMeasureConfigurations
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The unique, computer-friendly name of the measure configuration. | - |
title | string | true | The human-friendly title of the measure configuration. | - |
measurementPeriod | object | false | An optional reference to a Measurement Period that can be used in the configurations. | - |
» id | string | true | The unique ID of the Measurement Period. | - |
measure | object | true | The measure definition that is being configured. | - |
» id | string | true | The unique ID for the measure being configured. | - |
libraries | [object] | false | The libraries that are configured as part of this measure configuration. Note: This list should only include the libraries that are referenced as part of the measure definition. | - |
» id | string | true | The unique ID of the measure library. | - |
» versionedContent | object | true | An optional reference to a Measurement Period that can be used in the configurations. | - |
»» releaseNumber | integer(int32) | true | The version or release number for the given library. | - |
»» parameters | [object] | false | The parameters for the given version of the measure library. | - |
»»» name | string | true | The name of the parameter being configured. Note: Validations should be done to ensure that the name matches the parameters that are configured in the measure library. | - |
»»» value | string | false | The value of the parameter being configured. Note: Validations should be done to ensure that the value type matches the parameters that are configured in the measure library. | - |
»»» valueRef | string | false | The value reference for the parameter being configured. | - |
createdBy | object | false | An optional reference to a Measurement Period that can be used in the configurations. | - |
» id | string | true | The ID of the individual who created the configuration. | - |
putMeasureConfigurations
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The unique, computer-friendly name of the measure configuration. | - |
title | string | true | The human-friendly title of the measure configuration. | - |
measurementPeriod | object | false | An optional reference to a Measurement Period that can be used in the configurations. | - |
» id | string | true | The unique ID of the Measurement Period. | - |
measure | object | true | The measure definition that is being configured. | - |
» id | string | true | The unique ID for the measure being configured. | - |
libraries | [object] | false | The libraries that are configured as part of this measure configuration. Note: This list should only include the libraries that are referenced as part of the measure definition. | - |
» id | string | true | The unique ID of the measure library. | - |
» versionedContent | object | true | An optional reference to a Measurement Period that can be used in the configurations. | - |
»» releaseNumber | integer(int32) | true | The version or release number for the given library. | - |
»» parameters | [object] | false | The parameters for the given version of the measure library. | - |
»»» name | string | true | The name of the parameter being configured. Note: Validations should be done to ensure that the name matches the parameters that are configured in the measure library. | - |
»»» value | string | false | The value of the parameter being configured. Note: Validations should be done to ensure that the value type matches the parameters that are configured in the measure library. | - |
»»» valueRef | string | false | The value reference for the parameter being configured. | - |
updatedBy | object | false | An optional reference to a Measurement Period that can be used in the configurations. | - |
» id | string | true | The ID of the individual who updated the configuration. | - |
MeasurementPeriods
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [QualityMeasurePublicApi_Entities_V1_MeasurementPeriods_MeasurementPeriod] | 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. | - |
QualityMeasurePublicApi_Entities_V1_MeasurementPeriods_MeasurementPeriod
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the measurement period. | - |
name | string | true | The unique name of the measurement period. | - |
title | string | true | The unique title of the measurement period. | - |
start | string | false | The start of the measurement period. Mutually exclusive with startRelativeTimeModifier. | - |
end | string | false | The end of the measurement period. Mutually exclusive with endRelativeTimeModifier. | - |
startRelativeTimeModifier | string | false | Alias for start relative to the time of the request. Mutually exclusive with start. | - |
endRelativeTimeModifier | string | false | Alias for end relative to the time of the request. Mutually exclusive with end. | - |
createdAt | string | true | The date and time when the measurement period was created. | - |
updatedAt | string | true | The date and time when the measurement period was updated. This is defaulted to the createdAt value when the measurement period is created. |
- |
postMeasurementPeriods
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The unique name of the measurement period. | - |
title | string | true | The unqiue title of the measurement period. | - |
start | string | false | The start of the measurement period. Mutually exclusive with startRelativeTimeModifier . |
- |
end | string | false | The end of the measurement period. Mutually exclusive with endRelativeTimeModifier . Valid time units are: now, day, month, year. |
- |
startRelativeTimeModifier | string | false | Alias for the start time relative to the time of the request. Mutually exclusive with start . Valid time units are: now, day, month, year. |
- |
endRelativeTimeModifier | string | false | Alias for the end time relative to the time of the request. Mutually exclusive with end . |
- |
putMeasurementPeriods
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The unique name of the measurement period. | - |
title | string | true | The unqiue title of the measurement period. | - |
start | string | false | The start of the measurement period. Mutually exclusive with startRelativeTimeModifier . |
- |
end | string | false | The end of the measurement period. Mutually exclusive with endRelativeTimeModifier . Valid time units are: now, day, month, year. |
- |
startRelativeTimeModifier | string | false | Alias for the start time relative to the time of the request. Mutually exclusive with start . Valid time units are: now, day, month, year. |
- |
endRelativeTimeModifier | string | false | Alias for the end time relative to the time of the request. Mutually exclusive with end . |
- |
RegistryConfigurations
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [QualityMeasurePublicApi_Entities_V1_RegistryConfigurations_RegistryConfiguration] | 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. | - |
QualityMeasurePublicApi_Entities_V1_RegistryConfigurations_RegistryConfiguration
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique identifier for the registry configuration. | - |
name | string | true | The unique, computer-friendly name of the registry configuration. | - |
title | string | true | The human-friendly title of the registry configuration. | - |
version | integer(int32) | true | The version of the registry configuration. | - |
registry | RegistryConfigurationsRegistry | true | The registry definition that is being configured. | - |
libraries | [QualityMeasurePublicApi_Entities_V1_Common_ConfigurationLibrary] | false | The libraries that are configured as part of this registry configuration. Note: This list should only include the libraries that are referenced as part of the registry definition. | - |
measurementPeriod | CommonMeasurementPeriod | false | An optional reference to a Measurement Period that can be used in the configurations. | - |
createdBy | QualityMeasurePublicApi_Entities_V1_Common_CreatedBy | false | The individual who created the registry configuration. | - |
updatedBy | QualityMeasurePublicApi_Entities_V1_Common_UpdatedBy | false | The individual who updated the registry configuration.This defaults to the createdBy value when the registry configuration is created. |
- |
createdAt | string | true | The date and time when the registry configuration was created. | - |
updatedAt | string | true | The date and time when the registry configuration was udpated. This defaults to the createdAt value when the registry configuration is created. |
- |
RegistryConfigurationsRegistry
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique identifier for the registry being configured. | - |
name | string | false | The unique, computer-friendly name of the registry being configured. | - |
title | string | false | The human-friendly title of the registry being configured. | - |
postRegistryConfigurations
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The unique, computer-friendly name of the registry configuration. | - |
title | string | true | The human-friendly title of the registry configuration. | - |
registry | object | true | The registry definition that is being configured. | - |
» id | string | true | The unique ID of the registry being configured. | - |
libraries | [object] | false | The libraries that are configured as part of this registry configuration. Note: This list should only include the libraries that are referenced as part of the registry definition. | - |
» id | string | true | The unique ID of the measure library. | - |
» versionedContent | object | true | The versioned content of the measure library. | - |
»» releaseNumber | integer(int32) | true | The version or release number for the given library. | - |
»» parameters | [object] | false | The parameters for the given version of the measure library. | - |
»»» name | string | true | The name for the parameter being configured. Note: Validations should be done to ensure that the name matches the parameters that are configured in the measure library. | - |
»»» value | string | false | The value for the parameter being configured. Note: Validations should be done to ensure that the value type matches the parameters that are configured in the measure library. | - |
»»» valueRef | string | false | The value reference for the parameter being configured. | - |
measurementPeriod | object | false | An optional reference to a Measurement Period that can be used in the configurations. | - |
» id | string | true | The unique ID of the Measurement Period. | - |
createdBy | object | false | The individual who created the registry configuration. | - |
» id | string | true | The ID of the individual who created the resource. | - |
putRegistryConfigurations
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The unique, computer-friendly name of the registry configuration. | - |
title | string | true | The human-friendly title of the registry configuration. | - |
registry | object | true | The registry definition that is being configured. | - |
» id | string | true | The unique ID of the registry being configured. | - |
libraries | [object] | false | The libraries that are configured as part of this registry configuration. Note: This list should only include the libraries that are referenced as part of the registry definition. | - |
» id | string | true | The unique ID of the measure library. | - |
» versionedContent | object | true | The versioned content of the measure library. | - |
»» releaseNumber | integer(int32) | true | The version or release number for the given library. | - |
»» parameters | [object] | false | The parameters for the given version of the measure library. | - |
»»» name | string | true | The name for the parameter being configured. Note: Validations should be done to ensure that the name matches the parameters that are configured in the measure library. | - |
»»» value | string | false | The value for the parameter being configured. Note: Validations should be done to ensure that the value type matches the parameters that are configured in the measure library. | - |
»»» valueRef | string | false | The value reference for the parameter being configured. | - |
measurementPeriod | object | false | An optional reference to a Measurement Period that can be used in the configurations. | - |
» id | string | true | The unique ID of the Measurement Period. | - |
updatedBy | object | false | The individual who updated the registry configuration.This defaults to the createdBy value when the registry configuration is created. |
- |
» id | string | true | The ID of the individual who updated the resource. | - |
ReportingProjectConfigurations
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [QualityMeasurePublicApi_Entities_V1_ReportingProjectConfigurations_ReportingProjectConfiguration] | 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. | - |
QualityMeasurePublicApi_Entities_V1_ReportingProjectConfigurations_ReportingProjectConfiguration
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the reporting project configuration. | - |
name | string | true | The unique name of the reporting project configuration. | - |
title | string | true | The title of the reporting project configuration. | - |
population | ReportingProjectConfigurationsPopulation | false | The population that identifies the longitudinal records used to process the quality measures. | - |
measurementPeriod | CommonMeasurementPeriod | false | An optional reference to a Measurement Period that can be used in the configurations. | - |
registryConfigurations | ReportingProjectConfigurationsRegistryConfiguration | false | An optional collection of references to registry configurations. | - |
measureConfigurations | ReportingProjectConfigurationsMeasureConfiguration | false | An optional collection of references to measure configurations. | - |
measureHierarchyIndex | ReportingProjectConfigurationsMeasureHierarchyIndex | true | Ranking in the measure hierarchy. | - |
tags | [QualityMeasurePublicApi_Entities_V1_Common_TagReference] | false | An optional list of tags for the reporting project configuration. | - |
version | integer(int32) | true | The version of the reporting project configuration. | - |
createdBy | QualityMeasurePublicApi_Entities_V1_Common_CreatedBy | false | The individual who created the reporting project configuration. | - |
updatedBy | QualityMeasurePublicApi_Entities_V1_Common_UpdatedBy | false | The individual who updated the reporting project configuration.This defaults to the createdBy value when the reporting project configuration is created. |
- |
createdAt | string | true | The date and time when the reporting project configuration is created. | - |
updatedAt | string | true | The date and time when the reporting project configuration is updated. This defaults to the createdAt value when the reporting project configuration is created. |
- |
ReportingProjectConfigurationsPopulation
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | false | The unique ID of the population. | - |
subpopulation | ReportingProjectConfigurationsSubpopulation | false | The subpopulation that is being configured | - |
ReportingProjectConfigurationsSubpopulation
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | false | The unique ID of the subpopulation. | - |
ReportingProjectConfigurationsRegistryConfiguration
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique identifier for the registry configuration. | - |
registry | CommonRegistry | true | The registry definition that is being configured. | - |
CommonRegistry
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique identifier for the registry being configured. | - |
name | string | false | The unique, computer-friendly name of the registry being configured. | - |
title | string | false | The human-friendly title of the registry being configured. | - |
ReportingProjectConfigurationsMeasureConfiguration
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique identifier for the measure configuration. | - |
measure | CommonMeasure | true | The measure definition that is being configured. | - |
CommonMeasure
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | false | The unique, computer-friendly name of the measure definition. | - |
title | string | false | The human-friendly title of the measure definition. | - |
id | string | true | The unique ID of the measure definition. | - |
ReportingProjectConfigurationsMeasureHierarchyIndex
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | false | The unique ID of the measure hierarchy index. | - |
name | string | false | The unique, computer-friendly name of the measure hierarchy index. | - |
postReportingProjectConfigurations
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The unique name of the reporting project configuration. | - |
title | string | true | The title of the reporting project configuration. | - |
population | object | true | The population and, optionally, subpopulation ID associated with the reporting project configuration. | - |
» id | string | true | The unique ID for the measure hierarchy index. | - |
» subpopulation | object | false | The object containing the unique ID of the subpopulation. | - |
»» id | string | true | The unique ID of the subpopulation. | - |
measurementPeriod | object | false | The measurement period ID associated with the reporting project configuration. | - |
» id | string | true | The unique ID of the measurement period. | - |
registryConfigurations | [object] | false | The registry configurations associated with the reporting project configuration. | - |
» id | string | true | The unique ID of the registry configuration. | - |
measureConfigurations | [object] | false | The measure configurations associated with the reporting project configuration. | - |
» id | string | true | The unique ID of the registry configuration. | - |
measureHierarchyIndex | object | false | The measure hierarchy index ID associated with the reporting project configuration. | - |
» id | string | true | The unique ID of the measure hierarchy index. | - |
createdBy | object | false | An optional reference to the user that created the configuration. | - |
» id | string | true | The ID of the individual who created the configuration. | - |
putReportingProjectConfigurations
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The unique name of the reporting project configuration. | - |
title | string | true | The title of the reporting project configuration. | - |
population | object | true | The population and, optionally, subpopulation ID associated with the reporting project configuration. | - |
» id | string | true | The unique ID for the measure hierarchy index. | - |
» subpopulation | object | false | The object containing the unique ID of the subpopulation. | - |
»» id | string | true | The unique ID of the subpopulation. | - |
measurementPeriod | object | false | The measurement period ID associated with the reporting project configuration. | - |
» id | string | true | The unique ID of the measurement period. | - |
registryConfigurations | [object] | false | The registry configurations associated with the reporting project configuration. | - |
» id | string | true | The unique ID of the registry configuration. | - |
measureConfigurations | [object] | false | The measure configurations associated with the reporting project configuration. | - |
» id | string | true | The unique ID of the registry configuration. | - |
measureHierarchyIndex | object | false | The measure hierarchy index ID associated with the reporting project configuration. | - |
» id | string | true | The unique ID of the measure hierarchy index. | - |
updatedBy | object | false | An optional reference to the user that updated the configuration. | - |
» id | string | true | The ID of the individual who updated the configuration. | - |
postHierarchyIndexes
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The name of the hierarchy index. | - |
title | string | true | The title of the hierarchy index. | - |
QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyIndex
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the measure hierarchy index. | - |
name | string | true | The name of the measure hierarchy index. | - |
title | string | true | The title of the hierarchy index. | - |
createdAt | string(date-time) | false | The date and time when the hierarchy index was created. | - |
updatedAt | string(date-time) | false | The date and time when the hierarchy index was most recently updated. | - |
HierarchyIndices
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyIndex] | 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. | - |
putHierarchyIndexes
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The name of the hierarchy index. | - |
title | string | true | The title of the hierarchy index. | - |
QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyGroup
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the measure hierarchy group. | - |
name | string | true | The name of the measure hierarchy group. | - |
title | string | true | The title of the hierarchy group. | - |
rankedMeasures | [QualityMeasurePublicApi_Entities_V1_Hierarchies_RankedMeasure] | false | The list of measures ranked based on priority. | - |
createdAt | string(date-time) | false | The date and time when the hierarchy group was created. | - |
updatedAt | string(date-time) | false | The date and time when the hierarchy group was most recently updated. | - |
QualityMeasurePublicApi_Entities_V1_Hierarchies_RankedMeasure
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
measure | QualityMeasurePublicApi_Entities_V1_Hierarchies_Measure | true | A reference to the measure being ranked. | - |
rank | integer(int32) | true | The rank of the hierarchy group. | - |
QualityMeasurePublicApi_Entities_V1_Hierarchies_Measure
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the measure. | - |
name | string | true | The unique, computer-friendly name of the measure definition. | - |
HierarchyGroups
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [QualityMeasurePublicApi_Entities_V1_Hierarchies_HierarchyGroup] | 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. | - |