Hierarchical Condition Category API v1
The HealtheIntent Hierarchical Condition Category API provides information about the quality of the clinical documentation in a patient’s record that is used for risk adjustment. This information can be used to fill gaps in documentation, which may make patients’ risk scores more accurate.
The purpose of risk adjustment is to reduce the influence of risk selection on the premiums that insurance plans charge, and risk score values are used to adjust capitated payments made to insurance plans. There are a number of risk-adjustment models in the health care industry, several of which use the Hierarchical Condition Category (HCC) methodology. The risk score values associated with risk-adjustment models using HCCs are referred to as risk adjustment factor (RAF) scores.
HCCs are derived from ICD codes through retrospective review of claims data. An ICD code maps to exactly one HCC, but not all ICD codes map to an HCC. HCCs are termed hierarchical because multiple HCCs capture differing severity of illness for some conditions. In an HCC grouping, a patient is assigned only the HCC that corresponds to the most severe documented manifestation of the condition. For example, if review of a beneficiary’s claims data finds ICD codes mapping to both HCC 17 Diabetes With Acute Complications (such as ICD-10 code E0811) and HCC 19 Diabetes Without Complication (such as ICD-10 code E089), the model assigns only HCC 17, because it is the more severe manifestation of diabetes.
Note: The supporting and competing data and related diagnosis code information retrieved by this API are filtered based on your 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/hcc/v1
Reference
The HCC reference content defines the specifications for the risk-adjustment models that use the HCC methodology.
Retrieve a List of Condition Category Codes
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/hcc/v1/condition-category-codes', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/condition-category-codes \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"hierarchicalConditionCategory": {
"id": "b5965131-3b98-4f35-bd27-54c771c8a03e"
},
"code": {
"code": "E11.649",
"display": "Type 2 diabetes mellitus with hypoglycemia without coma",
"system": "2.16.840.1.113883.6.90"
},
"recommended": false
},
{
"hierarchicalConditionCategory": {
"id": "b5965131-3b98-4f35-bd27-54c771c8a03e"
},
"code": {
"code": "E09.638",
"display": "Drug or chemical induced diabetes mellitus with other oral complications",
"system": "2.16.840.1.113883.6.90"
},
"recommended": false
}
],
"totalResults": 21,
"firstLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/condition-category-codes?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/condition-category-codes?offset=20&limit=20",
"prevLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/condition-category-codes?offset=0&limit=20",
"nextLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/condition-category-codes?offset=20&limit=20"
}
GET /condition-category-codes
Retrieves a list of condition category codes.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
hierarchicalConditionCategoryId | query | string | false | N/A | The ID of the HCC that all returned codes should be related to. | - |
codeSystem | query | string | false | N/A | The code system. Requires code. | - |
code | query | string | false | N/A | The code. Requires codeSystem. | - |
recommended | query | string | false | N/A | Filters the codes by whether they are recommended. If true, only recommended codes are returned. If the parameter is not specified, both recommended and not recommended codes are returned. | true, false |
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 | codeDisplay | A comma-separated list of fields by which to sort. | codeDisplay, -codeDisplay, recommended, -recommended |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of condition category code objects | ConditionCategoryCodes |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Retrieve a List of Condition Options
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/hcc/v1/condition-options', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/condition-options \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "49d0677b-28e6-4648-9159-1e114eb7b829",
"name": "HCC-17-Diabetes mellitus with other specified complication.",
"title": "Type 2 diabetes mellitus with other specified complication",
"default": "true",
"ranking": 2,
"riskAdjustmentPrograms": [
{
"hccRiskAdjustmentModel": {
"id": "b923179c-9617-4ac5-8601-8054755a2a5c",
"type": "CMS-HCC",
"hierarchicalConditionCategory": {
"id": "0b424e9d-b74a-4b78-9dde-22685ae9cdec",
"categoryNumber": 96,
"name": "Specified Heart Arrhythmias"
}
}
}
],
"codes": [
{
"code": "E11.69",
"display": "Type 2 diabetes mellitus with other specified complication.",
"system": "2.16.840.1.113883.6.90 - ICD-10-CM, 2.16.840.1.113883.6.96 - SNOMED",
"preferred": "false"
}
],
"createdAt": "2021-05-14T12:23:12.653Z",
"updatedAt": "2021-05-14T12:23:12.019Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/condition-options?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/condition-options?offset=0&limit=20"
}
GET /condition-options
Retrieves a list of condition options.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | query | array[string] | false | N/A | The ID of the condition option. This query parameter can be repeated multiple times to query for multiple condition options at a time. | - |
hierarchicalConditionCategoryId | query | array[string] | false | N/A | The ID of the hierarchical condition category. This query parameter can be repeated multiple times to query for multiple condition options at a time. | - |
title | query | string | false | N/A | The user-friendly name of the condition option. This filter is case-insensitive. | - |
updatedAt | query | string | false | N/A | The date and time when the condition option was updated. This filter is case-insensitive. | - |
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 | updatedAt | A comma-separated list of fields by which to sort. | title, -title, updatedAt, -updatedAt, ranking, -ranking |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of condition option objects | ConditionOptions |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Retrieve a Single Condition Option
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/hcc/v1/condition-options/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/hcc/v1/condition-options/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "49d0677b-28e6-4648-9159-1e114eb7b829",
"name": "HCC-17-Diabetes mellitus with other specified complication.",
"title": "Type 2 diabetes mellitus with other specified complication",
"default": "true",
"ranking": 2,
"riskAdjustmentPrograms": [
{
"hccRiskAdjustmentModel": {
"id": "b923179c-9617-4ac5-8601-8054755a2a5c",
"type": "CMS-HCC",
"hierarchicalConditionCategory": {
"id": "0b424e9d-b74a-4b78-9dde-22685ae9cdec",
"categoryNumber": 96,
"name": "Specified Heart Arrhythmias"
}
}
}
],
"codes": [
{
"code": "E11.69",
"display": "Type 2 diabetes mellitus with other specified complication.",
"system": "2.16.840.1.113883.6.90 - ICD-10-CM, 2.16.840.1.113883.6.96 - SNOMED",
"preferred": "false"
}
],
"createdAt": "2021-05-14T12:23:12.653Z",
"updatedAt": "2021-05-14T12:23:12.019Z"
}
GET /condition-options/{conditionOptionId}
Retrieves a single condition option.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
conditionOptionId | path | string | true | N/A | The unique ID of the condition option. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single condition option object | HccPublicApi_Entities_V1_Reference_ConditionOption |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a List of Hierarchical Condition 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/hcc/v1/hierarchical-condition-categories', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/hierarchical-condition-categories \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "0b424e9d-b74a-4b78-9dde-22685ae9cdec",
"riskAdjustmentModel": {
"id": "b923179c-9617-4ac5-8601-8054755a2a5c"
},
"categoryNumber": 17,
"categoryNumberString": "17.1",
"name": "Diabetes with Acute Complications",
"concept": {
"contextId": "4FAFA7EED0F148519CAA4107304765CF",
"name": "HCC17 Diabetes with Acute Complication",
"alias": "HCC_17_DIABETES_WITH_ACUTE_COMPLICATIONS_CLIN"
},
"hierarchy": [
"b5965131-3b98-4f35-bd27-54c771c8a03e",
"c2ca59de-1978-4561-8c40-b4769b9939db"
],
"createdAt": "2018-06-30T06:25:13Z",
"updatedAt": "2018-07-30T06:25:13Z"
},
{
"id": "b5965131-3b98-4f35-bd27-54c771c8a03e",
"riskAdjustmentModel": {
"id": "b923179c-9617-4ac5-8601-8054755a2a5c"
},
"categoryNumber": 18,
"categoryNumberString": "18.1",
"name": "Diabetes with Chronic Complications",
"concept": {
"contextId": "4FAFA7EED0F148519CAA4107304765CF",
"name": "HCC18 Diabetes with Chronic Complication",
"alias": "HCC_18_DIABETES_WITH_CHRONIC_COMPLICATIONS_CLIN"
},
"hierarchy": [
"c2ca59de-1978-4561-8c40-b4769b9939db"
],
"createdAt": "2018-06-30T06:25:13Z",
"updatedAt": "2018-07-30T06:25:13Z"
}
],
"totalResults": 21,
"firstLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/suspected-hcc-definitions?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/suspected-hcc-definitions?offset=20&limit=20",
"prevLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/suspected-hcc-definitions?offset=0&limit=20",
"nextLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/suspected-hcc-definitions?offset=20&limit=20"
}
GET /hierarchical-condition-categories
Retrieves a list of HCCs.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
riskAdjustmentModelId | query | string | false | N/A | The ID of the HCC risk adjustment model that all returned HCCs should be related to. This parameter will be ignored if one or more ID parameter values are also specified. | - |
id | query | array[string] | false | N/A | The IDs of the HCCs. This query parameter can be repeated multiple times to query for multiple IDs at a time. | - |
conceptAlias | query | array[string] | false | N/A | The concept aliases used by the HCCs. This query parameter can be repeated multiple times to query for multiple concept aliases at a time. This parameter will be ignored if one or more ID parameter values are also specified. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
orderBy | query | string | false | name | A comma-separated list of fields by which to sort. | name, -name, categoryNumber, -categoryNumber, createdAt, -createdAt, updatedAt, -updatedAt |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of HCC objects | HierarchicalConditionCategories |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Retrieve a Single Hierarchical Condition 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/hcc/v1/hierarchical-condition-categories/206d2277-827b-478e-b543-308e28d74fdc', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/hierarchical-condition-categories/206d2277-827b-478e-b543-308e28d74fdc \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "0b424e9d-b74a-4b78-9dde-22685ae9cdec",
"riskAdjustmentModel": {
"id": "b923179c-9617-4ac5-8601-8054755a2a5c"
},
"categoryNumber": 17,
"categoryNumberString": "17.1",
"name": "Diabetes with Acute Complications",
"concept": {
"contextId": "4FAFA7EED0F148519CAA4107304765CF",
"name": "HCC17 Diabetes with Acute Complication",
"alias": "HCC_17_DIABETES_WITH_ACUTE_COMPLICATIONS_CLIN"
},
"hierarchy": [
"b5965131-3b98-4f35-bd27-54c771c8a03e",
"c2ca59de-1978-4561-8c40-b4769b9939db"
],
"createdAt": "2018-06-30T06:25:13Z",
"updatedAt": "2018-07-30T06:25:13Z"
}
GET /hierarchical-condition-categories/{hierarchicalConditionCategoryId}
Retrieves a single HCC.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
hierarchicalConditionCategoryId | path | string | true | N/A | The ID of the HCC. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single HCC object | HccPublicApi_Entities_V1_Reference_HierarchicalConditionCategory |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Resource not found | Error |
Retrieve a List of Risk Adjustment Models
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/hcc/v1/risk-adjustment-models', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/risk-adjustment-models \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "b923179c-9617-4ac5-8601-8054755a2a5c",
"type": "CMS-HCC",
"name": "CMS HCC version 22, Payment Year 2018",
"version": "22",
"year": 2018,
"createdAt": "2018-06-29T06:25:13Z",
"updatedAt": "2018-06-30T06:25:13Z"
},
{
"id": "08d00984-c012-4578-b526-5959fdc17dcd",
"type": "CMS-HCC",
"name": "CMS HCC version 23, Payment Year 2019",
"version": "23",
"year": 2019,
"createdAt": "2018-06-30T06:25:13Z",
"updatedAt": "2018-07-30T06:25:13Z"
}
],
"totalResults": 21,
"firstLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/risk-adjustment-models?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/risk-adjustment-models?offset=20&limit=20",
"prevLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/risk-adjustment-models?offset=0&limit=20",
"nextLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/risk-adjustment-models?offset=20&limit=20"
}
GET /risk-adjustment-models
Retrieves a list of risk adjustment models.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
type | query | string | false | N/A | The type of HCC risk adjustment model being used. If this parameter is not specified, then risk models from all supported model types are returned. | CMS-HCC, HHS-HCC, ESRD-HCC |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
orderBy | query | string | false | name | A comma-separated list of fields by which to sort. | name, -name, createdAt, -createdAt, updatedAt, -updatedAt |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of risk adjustment model objects | RiskAdjustmentModels |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Retrieve a Single Risk Adjustment Model
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/hcc/v1/risk-adjustment-models/206d2277-827b-478e-b543-308e28d74fdc', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/risk-adjustment-models/206d2277-827b-478e-b543-308e28d74fdc \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "b923179c-9617-4ac5-8601-8054755a2a5c",
"type": "CMS-HCC",
"name": "CMS HCC version 22, Payment Year 2018",
"version": "22",
"year": 2018,
"createdAt": "2018-06-29T06:25:13Z",
"updatedAt": "2018-06-30T06:25:13Z"
}
GET /risk-adjustment-models/{riskAdjustmentModelId}
Retrieves a single risk adjustment model.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
riskAdjustmentModelId | path | string | true | N/A | The ID of the risk adjustment model. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single risk adjustment model object | HccPublicApi_Entities_V1_Reference_RiskAdjustmentModel |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Resource not found | Error |
Configuration
An HCC configuration defines how the HCC outcomes are produced and is used as the input instructions to the HCC pipelines.
Each change to the HCC configuration is uniquely recorded as an HCC configuration instance with an instance ID. Every time an HCC pipeline executes, the pipeline records the specific instance of the configuration being used, which provides traceability to the configuration input. This configuration traceability makes it easier to understand observed changes in the outputs of the HCC pipeline executions.
You can use the Tag resource to assign your own metadata to the HCC resources. The most common reason to tag a resource is to categorize its use (for example, Use = Production or Use = Validation). Another use case for tags is to add issue-tracking IDs to HCC resources as a reference to when and why the resource was created.
Retrieve a List of 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/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91/versions', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91/versions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
"instanceId": "b556149a-c19c-413a-8d9f-d7988aec4a91",
"population": {
"id": "5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"
},
"name": "CMS HCC v.23 Production Configuration",
"riskAdjustmentModel": {
"id": "b923179c-9617-4ac5-8601-8054755a2a5c"
},
"tags": [
{
"key": "Use",
"value": "Production"
}
],
"status": "ACTIVE",
"createdAt": "2018-05-14T12:23:12Z",
"createdBy": {
"id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
}
},
{
"id": "90ffbddc-ddce-4abd-816d-879c0e808d9a",
"instanceId": "7194dc92-72fb-4301-a8bf-4dc3e97cfcc8",
"population": {
"id": "33e2b005-f782-41cf-a761-ca60a3d18fec"
},
"name": "CMS HCC v.22 Production Configuration",
"riskAdjustmentModel": {
"id": "81bf5f9a-c1f1-4c6b-939e-1b2a08cb4624"
},
"tags": [
{
"key": "Use",
"value": "Production"
}
],
"status": "INACTIVE",
"createdAt": "2018-05-14T12:23:12Z",
"createdBy": {
"id": "090721a8-4d9a-4096-b061-e8d6726b19dd"
}
}
],
"totalResults": 21,
"firstLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/configurations&offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/configurations&offset=20&limit=20",
"prevLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/configurations&offset=0&limit=20",
"nextLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/configurations&offset=20&limit=20"
}
GET /configurations/{configurationId}/versions
Retrieves a list of all versions of a configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
configurationId | path | string | true | N/A | The ID of the 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 | -createdAt | A comma-separated list of fields by which to sort. | createdAt, -createdAt, name, -name |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of configuration version objects | Configurations |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Retrieve a Single Configuration Version
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/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91/versions/3', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91/versions/3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /configurations/{configurationId}/versions/{versionNumber}
Retrieves a single configuration version.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
configurationId | path | string | true | N/A | The ID of the configuration. | - |
versionNumber | path | string | true | N/A | The version of the configuration. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single configuration object | HccPublicApi_Entities_V1_Configuration_Configuration |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Create a 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/hcc/v1/configurations', headers: headers, body: {"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"name":"CMS HCC v.23 Production Configuration","population":{"id":"5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"},"riskAdjustmentModel":{"id":"b923179c-9617-4ac5-8601-8054755a2a5c"},"status":"ACTIVE"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"name":"CMS HCC v.23 Production Configuration","population":{"id":"5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"},"riskAdjustmentModel":{"id":"b923179c-9617-4ac5-8601-8054755a2a5c"},"status":"ACTIVE"}
Example response
{
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
"instanceId": "b556149a-c19c-413a-8d9f-d7988aec4a91",
"population": {
"id": "5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"
},
"name": "CMS HCC v.23 Production Configuration",
"riskAdjustmentModel": {
"id": "b923179c-9617-4ac5-8601-8054755a2a5c"
},
"status": "ACTIVE",
"createdAt": "2018-05-14T12:23:12Z",
"createdBy": {
"id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
}
}
POST /configurations
Creates a configuration. The configuration created here is the first and most recent version of this configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | A configuration object | HccPublicApi_Entities_V1_Configuration_Configuration |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
201 | Location | string | The URL of the created configuration. |
Retrieve a List of 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/hcc/v1/configurations', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
"instanceId": "b556149a-c19c-413a-8d9f-d7988aec4a91",
"population": {
"id": "5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"
},
"name": "CMS HCC v.23 Production Configuration",
"riskAdjustmentModel": {
"id": "b923179c-9617-4ac5-8601-8054755a2a5c"
},
"tags": [
{
"key": "Use",
"value": "Production"
}
],
"status": "ACTIVE",
"createdAt": "2018-05-14T12:23:12Z",
"createdBy": {
"id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
}
},
{
"id": "90ffbddc-ddce-4abd-816d-879c0e808d9a",
"instanceId": "7194dc92-72fb-4301-a8bf-4dc3e97cfcc8",
"population": {
"id": "33e2b005-f782-41cf-a761-ca60a3d18fec"
},
"name": "CMS HCC v.22 Production Configuration",
"riskAdjustmentModel": {
"id": "81bf5f9a-c1f1-4c6b-939e-1b2a08cb4624"
},
"tags": [
{
"key": "Use",
"value": "Production"
}
],
"status": "INACTIVE",
"createdAt": "2018-05-14T12:23:12Z",
"createdBy": {
"id": "090721a8-4d9a-4096-b061-e8d6726b19dd"
}
}
],
"totalResults": 21,
"firstLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/configurations&offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/configurations&offset=20&limit=20",
"prevLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/configurations&offset=0&limit=20",
"nextLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/configurations&offset=20&limit=20"
}
GET /configurations
Retrieves a list of configurations. Each configuration item retrieved is the most recently created version of the configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | query | array[string] | false | N/A | The ID of the configuration. This query parameter can be repeated multiple times to query for multiple configurations at a time. | - |
tag | query | array[string] | false | N/A | The colon-delimited combination of the key and value of a tag (for example, Use:Production). This query parameter can be repeated multiple times to query for configurations that contain a combination of more than one tag. When multiple tags are provided, the results must include all of the tags provided. | - |
populationId | query | string | false | N/A | The ID of the population. | - |
name | query | string | false | N/A | The name or partial name of a configuration. | - |
status | query | array[string] | false | N/A | The status of the configuration. This query parameter can be repeated multiple times to query for multiple statuses at a time. The default behavior is to return configurations from all statuses. | ACTIVE, INACTIVE |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
orderBy | query | string | false | name | A comma-separated list of fields by which to sort. | name, -name, createdAt, -createdAt |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of configuration objects | Configurations |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Delete a Configuration
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/hcc/v1/configurations/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/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /configurations/{configurationId}
Deletes a configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
configurationId | path | integer(int32) | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No content | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a 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/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91', headers: headers, body: {"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"name":"CMS HCC v.23 Production Configuration","population":{"id":"5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"},"riskAdjustmentModel":{"id":"b923179c-9617-4ac5-8601-8054755a2a5c"},"status":"ACTIVE"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"name":"CMS HCC v.23 Production Configuration","population":{"id":"5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"},"riskAdjustmentModel":{"id":"b923179c-9617-4ac5-8601-8054755a2a5c"},"status":"ACTIVE"}
PUT /configurations/{configurationId}
Updates a single configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
configurationId | path | integer(int32) | true | N/A | No description | - |
body | body | putConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | A single configuration object | HccPublicApi_Entities_V1_Configuration_Configuration |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Resource not found | Error |
Retrieve a Single 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/hcc/v1/configurations/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/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /configurations/{configurationId}
Retrieves a single configuration. The configuration retrieved is the most recently created version of the configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
configurationId | path | string | true | N/A | The ID of the configuration. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single configuration object | HccPublicApi_Entities_V1_Configuration_Configuration |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Resource not found | Error |
Retrieve a List of Suspected HCCs on the 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/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91/suspected-hccs', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91/suspected-hccs \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"hierarchicalConditionCategory": {
"id": "0b424e9d-b74a-4b78-9dde-22685ae9cdec"
},
"addedAt": "2018-05-14T12:23:12Z",
"addedBy": {
"id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
}
},
{
"hierarchicalConditionCategory": {
"id": "62fcd53f-156d-42d9-a806-7e9b48fec376"
},
"addedAt": "2018-05-14T12:23:12Z",
"addedBy": {
"id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
}
}
],
"totalResults": 21,
"firstLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91/suspected-hccs&offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91/suspected-hccs&offset=20&limit=20",
"prevLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91/suspected-hccs&offset=0&limit=20",
"nextLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91/suspected-hccs&offset=20&limit=20"
}
GET /configurations/{configurationId}/suspected-hccs
Retrieves a list of suspected HCCs that have been included for processing.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
configurationId | path | string | true | N/A | The ID of the 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 | -addedAt | A comma-separated list of fields by which to sort. | addedAt, -addedAt |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of suspected HCCs | SuspectedHccItems |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Remove a Suspected HCC
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/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91/suspected-hccs/0b424e9d-b74a-4b78-9dde-22685ae9cdec', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91/suspected-hccs/0b424e9d-b74a-4b78-9dde-22685ae9cdec \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /configurations/{configurationId}/suspected-hccs/{suspectedHccId}
Removes a suspected HCC from the configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
configurationId | path | string | true | N/A | The ID of the configuration. | - |
suspectedHccId | path | string | true | N/A | The ID of the HCC intended for suspected HCC processing. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No content | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Add or Update a Suspected HCC
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/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91/suspected-hccs/f426149a-c19c-413a-8d9f-d7988aec4a91', headers: headers, body: {"addedBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91/suspected-hccs/f426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"addedBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}
Example response
{
"hierarchicalConditionCategory": {
"id": "0b424e9d-b74a-4b78-9dde-22685ae9cdec"
},
"addedAt": "2018-05-14T12:23:12Z",
"addedBy": {
"id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
}
}
PUT /configurations/{configurationId}/suspected-hccs/{suspectedHccId}
Adds a suspected HCC to the configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
configurationId | path | string | true | N/A | The ID of the configuration. | - |
suspectedHccId | path | string | true | N/A | The ID of the HCC intended for suspected HCC processing. | - |
body | body | putConfigurationsConfigurationidSuspectedHccs | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A suspected HCC object | HccPublicApi_Entities_V1_Configuration_SuspectedHccItem |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | Location | string | The URL of the created suspected HCC. |
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/hcc/v1/tags', headers: headers, body: {"resource":{"type":"PIPELINE","id":"a426149a-c19c-413a-8d9f-d7988aec4a91"},"key":"Use","value":"Production"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/tags \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"resource":{"type":"PIPELINE","id":"a426149a-c19c-413a-8d9f-d7988aec4a91"},"key":"Use","value":"Production"}
Example response
{
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
"resource": {
"type": "PIPELINE",
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91"
},
"key": "Use",
"value": "Production"
}
POST /tags
Creates a tag.
The following basic restrictions apply to tags:
- The maximum number of tags per resource is 10.
- 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 | HccPublicApi_Entities_V1_Configuration_Tag |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
201 | Location | string | The URL of the created tag. |
Retrieve a List of Tags
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/tags',
query: {
'resourceType' => 'string'
}, headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/tags?resourceType=type,string,enum,CONFIGURATION%2CCONFIGURATION_INSTANCE%2CPIPELINE \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
"resource": {
"type": "PIPELINE",
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91"
},
"key": "Use",
"value": "Production"
},
{
"id": "f2c9455a-7a6e-4f9f-9241-5df093996078",
"resource": {
"type": "CONFIGURATION",
"id": "50cce9f4-1602-4479-b682-309da08e24c3"
},
"key": "Use",
"value": "Staging"
}
],
"totalResults": 21,
"firstLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/tags&offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/tags&offset=20&limit=20",
"prevLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/tags&offset=0&limit=20",
"nextLink": "https://cernerdemo.api.us.healtheintent.com/hcc/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. | CONFIGURATION, CONFIGURATION_INSTANCE, PIPELINE |
key | query | string | false | N/A | The tag key to search for. The search is on exact matches. | - |
value | query | string | false | N/A | The tag value to search for. The search is on exact matches. | - |
tag | query | string | false | N/A | The colon-delimited combination of the key and value of a tag (for example, Use:Production). If the tag query parameter is defined, then the key and value query parameters are ignored. | - |
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 |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of tag objects | Tags |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Remove a Tag
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/hcc/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/hcc/v1/tags/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /tags/{id}
Removes a tag.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The ID of the tag. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No content | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a Single Tag
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/hcc/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/hcc/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 | HccPublicApi_Entities_V1_Configuration_Tag |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Resource not found | Error |
Pipeline
The resources for managing HCC pipelines.
An HCC pipeline represents the concept of an isolated execution environment for processing HCC-related outcomes. The pipeline is required before being able to generate and access patient-level HCC data.
Note: A limit of one pipeline per tenant is currently available. Future development is planned to enable additional pipelines per tenant to facilitate validation or using multiple HCC risk-adjustment models simultaneously.
Retrieve All Versions of a Pipeline
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/hcc/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/versions', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/versions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
"instanceId": "3d3cc121-31f3-4472-81e3-5983254d44f6",
"name": "HCC production pipeline",
"configuration": {
"id": "b87dc60a-e421-4264-9da4-ad49854e6f69"
},
"status": "DRAFT",
"executionSettings": {
"frequencyValue": 8,
"frequencyUnit": "HOURS"
},
"createdAt": "2018-05-14T12:23:12Z",
"createdBy": {
"id": "d7edf791-7ef6-433c-a6f9-49dbc09f24a3"
}
}
],
"totalResults": 21,
"firstLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines?offset=20&limit=20",
"prevLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines?offset=0&limit=20",
"nextLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines?offset=20&limit=20"
}
GET /pipelines/{pipelineId}/versions
Retrieves all versions of a pipeline.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
pipelineId | path | string | true | N/A | The unique ID of the pipeline. | - |
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 | versionId | A comma-separated list of fields by which to sort. | name, -name, tenantId, -tenantId, createdAt, -createdAt, updatedAt, -updatedAt, versionId, -versionId |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of pipeline version objects | HccPipelines |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Retrieve a Single Version of a Pipeline
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/hcc/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/versions/1', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/versions/1 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /pipelines/{pipelineId}/versions/{versionId}
Retrieves a single version of a pipeline.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
pipelineId | path | string | true | N/A | The unique ID of the pipeline. | - |
versionId | path | integer(int32) | true | N/A | The version of the HCC pipeline. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieves a single version of a pipeline. | HccPublicApi_Entities_V1_Pipeline_HccPipeline |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Create a Pipeline
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/hcc/v1/pipelines', headers: headers, body: {"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"name":"HCC production pipeline","configuration":{"id":"a426149a-c19c-413a-8d9f-d7988aec4a91"},"status":"DRAFT","executionSettings":{"frequencyValue":1,"frequencyUnit":"MONTHS","dayOfMonth":15,"startTime":"2019-05-01T12:00:00.000Z"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"name":"HCC production pipeline","configuration":{"id":"a426149a-c19c-413a-8d9f-d7988aec4a91"},"status":"DRAFT","executionSettings":{"frequencyValue":1,"frequencyUnit":"MONTHS","dayOfMonth":15,"startTime":"2019-05-01T12:00:00.000Z"}}
Example response
{
"id": "09caa9f6-c384-4ad4-a4e2-203e1acee6db",
"instanceId": "3d3cc121-31f3-4472-81e3-5983254d44f6",
"name": "HCC production pipeline",
"configuration": {
"id": "b87dc60a-e421-4264-9da4-ad49854e6f69"
},
"status": "DRAFT",
"executionSettings": {
"frequencyValue": 8,
"frequencyUnit": "HOURS"
},
"createdAt": "2018-05-14T12:23:12Z",
"createdBy": {
"id": "d7edf791-7ef6-433c-a6f9-49dbc09f24a3"
}
}
POST /pipelines
Creates a pipeline.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postPipelines | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | A pipeline object | HccPublicApi_Entities_V1_Pipeline_HccPipeline |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
201 | Location | string | The URL of the created pipeline. |
Retrieve a List of Pipelines
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/hcc/v1/pipelines', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
"instanceId": "3d3cc121-31f3-4472-81e3-5983254d44f6",
"name": "HCC production pipeline",
"configuration": {
"id": "b87dc60a-e421-4264-9da4-ad49854e6f69"
},
"status": "DRAFT",
"executionSettings": {
"frequencyValue": 8,
"frequencyUnit": "HOURS"
},
"createdAt": "2018-05-14T12:23:12Z",
"createdBy": {
"id": "d7edf791-7ef6-433c-a6f9-49dbc09f24a3"
}
}
],
"totalResults": 21,
"firstLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines?offset=20&limit=20",
"prevLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines?offset=0&limit=20",
"nextLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines?offset=20&limit=20"
}
GET /pipelines
Retrieves a list of pipelines.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
configurationId | query | array[string] | false | N/A | The configuration ID of the pipeline. This query parameter can be repeated multiple times to query for multiple configurations at a time. | - |
status | query | array[string] | false | N/A | The status of the pipeline. This query parameter can be repeated multiple times to query for multiple statuses at a time. The default behavior is to return pipelines from all statuses. | DRAFT, PUBLISHED, SUSPENDED |
tag | query | array[string] | false | N/A | The colon-delimited combination of the key and value of a tag (for example, Use:Production). This query parameter can be repeated multiple times to query for pipelines that contain a combination of more than one tag. When multiple tags are provided, the results must include all of the tags provided. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
orderBy | query | string | false | name | A comma-separated list of fields by which to sort. | name, -name, createdAt, -createdAt |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of pipeline objects | HccPipelines |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Delete a Pipeline
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/hcc/v1/pipelines/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/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /pipelines/{pipelineId}
Deletes a pipeline.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
pipelineId | path | string | true | N/A | The unique ID of the pipeline. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No content | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a Pipeline
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/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91', headers: headers, body: {"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"name":"HCC production pipeline","configuration":{"id":"a426149a-c19c-413a-8d9f-d7988aec4a91"},"status":"DRAFT","executionSettings":{"frequencyValue":1,"frequencyUnit":"MONTHS","dayOfMonth":15,"startTime":"2019-05-01T12:00:00.000Z"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"name":"HCC production pipeline","configuration":{"id":"a426149a-c19c-413a-8d9f-d7988aec4a91"},"status":"DRAFT","executionSettings":{"frequencyValue":1,"frequencyUnit":"MONTHS","dayOfMonth":15,"startTime":"2019-05-01T12:00:00.000Z"}}
PUT /pipelines/{pipelineId}
Updates a pipeline.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
pipelineId | path | string | true | N/A | The unique ID of the pipeline. | - |
body | body | putPipelines | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single pipeline object | HccPublicApi_Entities_V1_Pipeline_HccPipeline |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a Single Pipeline
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/hcc/v1/pipelines/206d2277-827b-478e-b543-308e28d74fdc', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines/206d2277-827b-478e-b543-308e28d74fdc \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /pipelines/{pipelineId}
Retrieves a single pipeline.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
pipelineId | path | string | true | N/A | The unique ID of the pipeline. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieves a single pipeline. | HccPublicApi_Entities_V1_Pipeline_HccPipeline |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Resource not found | Error |
Suppression
The resources for managing the suppression of HCC outcomes.
A personnel- or system-initiated HCC suppression is created when a recommended HCC is disputed in your electronic health record (EHR). Each suppression requires a suppression-reason value to explain why the outcome is disputed, and a free-text comment can also be provided to give additional clarification for why the suppression is needed.
Create an HCC Suppression
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/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/patients/65752b39-78ed-496d-983e-64b361ad7891/hcc-suppressions', headers: headers, body: {"comment":"This patient does not appear to have the condition.","endEffective":"2019-05-14T12:23:12Z","hierarchicalConditionCategory":{"id":"b5965131-3b98-4f35-bd27-54c771c8a03e"},"suppressionReason":{"id":"5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"},"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"type":"SUSPECTED"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/patients/65752b39-78ed-496d-983e-64b361ad7891/hcc-suppressions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"comment":"This patient does not appear to have the condition.","endEffective":"2019-05-14T12:23:12Z","hierarchicalConditionCategory":{"id":"b5965131-3b98-4f35-bd27-54c771c8a03e"},"suppressionReason":{"id":"5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"},"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"type":"SUSPECTED"}
POST /pipelines/{pipelineId}/patients/{patientId}/hcc-suppressions
Creates an HCC suppression.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
pipelineId | path | string | true | N/A | The ID of the HCC pipeline. | - |
patientId | path | string | true | N/A | The ID of the patient within the population. | - |
body | body | postPipelinesPipelineidPatientsPatientidHccSuppressions | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | An HCC suppression object | HccPublicApi_Entities_V1_Suppression_HccSuppression |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
201 | Location | string | The URL of the created HCC suppression. |
Retrieve a List of HCC Suppressions
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/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/patients/65752b39-78ed-496d-983e-64b361ad7891/hcc-suppressions', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/patients/65752b39-78ed-496d-983e-64b361ad7891/hcc-suppressions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "65752b39-78ed-496d-983e-64b361ad7890",
"patient": {
"id": "17d0677b-28e6-4648-9159-1e114eb7b829",
"population": {
"id": "5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"
}
},
"hierarchicalConditionCategory": {
"id": "0b424e9d-b74a-4b78-9dde-22685ae9cdec"
},
"suppressionReason": {
"id": "5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"
},
"comment": "This patient does not appear to have the condition.",
"endEffective": "2019-05-14T12:23:12Z",
"pipeline": {
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91"
},
"createdAt": "2018-05-14T12:23:12Z",
"createdBy": {
"id": "d7edf791-7ef6-433c-a6f9-49dbc09f24a3"
},
"updatedAt": "2018-05-15T12:23:12Z",
"updatedBy": {
"id": "d7edf791-7ef6-433c-a6f9-49dbc09f24a3"
},
"type": "SUSPECTED"
}
],
"totalResults": 21,
"firstLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/hcc-suppressions?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/hcc-suppressions?offset=20&limit=20",
"prevLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/hcc-suppressions?offset=0&limit=20",
"nextLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/hcc-suppressions?offset=20&limit=20"
}
GET /pipelines/{pipelineId}/patients/{patientId}/hcc-suppressions
Retrieves a list of HCC suppressions.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
pipelineId | path | string | true | N/A | The ID of the HCC pipeline. | - |
patientId | path | string | true | N/A | The ID of the patient within the population. | - |
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 | createdAt | A comma-separated list of fields by which to sort. | createdAt, -createdAt, updatedAt, -updatedAt |
active | query | boolean | false | N/A | If true, active reasons are returned; if false, inactive reasons are returned. If the value is not provided, active reasons are returned. | - |
type | query | string | false | N/A | The type of HCC being suppressed. | PERSISTENT, SUSPECTED |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of HCC suppression objects | HccSuppressions |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Remove an HCC Suppression
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/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/patients/65752b39-78ed-496d-983e-64b361ad7891/hcc-suppressions/206d2277-827b-478e-b543-308e28d74fdc', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/patients/65752b39-78ed-496d-983e-64b361ad7891/hcc-suppressions/206d2277-827b-478e-b543-308e28d74fdc \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /pipelines/{pipelineId}/patients/{patientId}/hcc-suppressions/{hccSuppressionId}
Removes an HCC suppression.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
pipelineId | path | string | true | N/A | The ID of the HCC pipeline. | - |
patientId | path | string | true | N/A | The ID of the patient within the population. | - |
hccSuppressionId | path | string | true | N/A | The unique ID of the HCC suppression. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No content | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update an HCC Suppression
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/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/patients/65752b39-78ed-496d-983e-64b361ad7891/hcc-suppressions/206d2277-827b-478e-b543-308e28d74fdc', headers: headers, body: {"comment":"This patient does not appear to have the condition.","endEffective":"2019-05-14T12:23:12Z","hierarchicalConditionCategory":{"id":"b5965131-3b98-4f35-bd27-54c771c8a03e"},"suppressionReason":{"id":"5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"},"updatedBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"type":"SUSPECTED"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/patients/65752b39-78ed-496d-983e-64b361ad7891/hcc-suppressions/206d2277-827b-478e-b543-308e28d74fdc \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"comment":"This patient does not appear to have the condition.","endEffective":"2019-05-14T12:23:12Z","hierarchicalConditionCategory":{"id":"b5965131-3b98-4f35-bd27-54c771c8a03e"},"suppressionReason":{"id":"5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"},"updatedBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"type":"SUSPECTED"}
PUT /pipelines/{pipelineId}/patients/{patientId}/hcc-suppressions/{hccSuppressionId}
Updates an HCC suppression.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
pipelineId | path | string | true | N/A | The ID of the HCC pipeline. | - |
patientId | path | string | true | N/A | The ID of the patient within the population. | - |
hccSuppressionId | path | string | true | N/A | The unique ID of the HCC suppression. | - |
body | body | putPipelinesPipelineidPatientsPatientidHccSuppressions | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No content | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a Single HCC Suppression
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/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/patients/65752b39-78ed-496d-983e-64b361ad7891/hcc-suppressions/206d2277-827b-478e-b543-308e28d74fdc', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/patients/65752b39-78ed-496d-983e-64b361ad7891/hcc-suppressions/206d2277-827b-478e-b543-308e28d74fdc \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /pipelines/{pipelineId}/patients/{patientId}/hcc-suppressions/{hccSuppressionId}
Retrieves a single HCC suppression.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
pipelineId | path | string | true | N/A | The ID of the HCC pipeline. | - |
patientId | path | string | true | N/A | The ID of the patient within the population. | - |
hccSuppressionId | path | string | true | N/A | The unique ID of the HCC suppression. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieves a single HCC suppression. | HccPublicApi_Entities_V1_Suppression_HccSuppression |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Resource not found | Error |
Create a Suppression Reason
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/hcc/v1/suppression-reasons', headers: headers, body: {"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"display":"No longer applicable"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/suppression-reasons \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"display":"No longer applicable"}
Example response
{
"id": "5d0f9ff9-d3b8-47e0-86a1-13d500d833ce",
"display": "No longer applicable",
"status": "ACTIVE",
"createdAt": "2018-05-14T12:23:12Z",
"createdBy": {
"id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
},
"updatedAt": "2018-05-14T12:23:12Z",
"updatedBy": {
"id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
}
}
POST /suppression-reasons
Creates a suppression reason.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postSuppressionReasons | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | A suppression reason object | HccPublicApi_Entities_V1_Suppression_SuppressionReason |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
201 | Location | string | The URL of the created suppression reason. |
Retrieve a List of Suppression Reasons
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/hcc/v1/suppression-reasons', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/suppression-reasons \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "5d0f9ff9-d3b8-47e0-86a1-13d500d833ce",
"display": "No longer applicable",
"status": "ACTIVE",
"createdAt": "2018-05-14T12:23:12Z",
"createdBy": {
"id": "d7edf791-7ef6-433c-a6f9-49dbc09f24a3"
},
"updatedAt": "2018-05-15T12:23:12Z",
"updatedBy": {
"id": "d7edf791-7ef6-433c-a6f9-49dbc09f24a3"
}
}
],
"totalResults": 21,
"firstLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/suppression-reasons?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/suppression-reasons?offset=20&limit=20",
"prevLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/suppression-reasons?offset=0&limit=20",
"nextLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/suppression-reasons?offset=20&limit=20"
}
GET /suppression-reasons
Retrieves a list of suppression reasons.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
status | query | array[string] | false | N/A | The status of the suppression reason. This query parameter can be repeated multiple times to query for multiple statuses at a time. If this parameter is not specified, reasons from all statuses are returned. | ACTIVE, INACTIVE |
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 | display | A comma-separated list of fields by which to sort. | display, -display, createdAt, -createdAt, updatedAt, -updatedAt |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of suppression reason objects | SuppressionReasons |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Update a Suppression Reason
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/hcc/v1/suppression-reasons/206d2277-827b-478e-b543-308e28d74fdc', headers: headers, body: {"updatedBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"display":"No longer applicable still","status":"ACTIVE"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/suppression-reasons/206d2277-827b-478e-b543-308e28d74fdc \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"updatedBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"display":"No longer applicable still","status":"ACTIVE"}
PUT /suppression-reasons/{reasonId}
Updates a suppression reason.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
reasonId | path | string | true | N/A | The unique ID for the suppression reason. | - |
body | body | putSuppressionReasons | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No content | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a Single Suppression Reason
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/hcc/v1/suppression-reasons/206d2277-827b-478e-b543-308e28d74fdc', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/suppression-reasons/206d2277-827b-478e-b543-308e28d74fdc \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /suppression-reasons/{reasonId}
Retrieves a single suppression reason.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
reasonId | path | string | true | N/A | The unique ID for the suppression reason. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieves a single suppression reason. | HccPublicApi_Entities_V1_Suppression_SuppressionReason |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Resource not found | Error |
Suspected HCC
A suspected HCC is an HCC that is likely to be present for a patient but is not supported by a documented condition in the patient’s longitudinal record. Suspected HCCs are based on laboratory results, medications, and procedures. Both supporting and possible competing clinical facts are provided to help a provider decide whether to document an HCC-related problem or diagnosis for the patient.
Retrieve a List of Suspected HCCs
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/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/suspected-hccs',
query: {
'patientId' => 'string'
}, headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/suspected-hccs?patientId=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"patient": {
"id": "17d0677b-28e6-4648-9159-1e114eb7b829",
"population": {
"id": "5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"
}
},
"hierarchicalConditionCategory": {
"id": "0b424e9d-b74a-4b78-9dde-22685ae9cdec",
"categoryNumber": 96,
"name": "Specified Heart Arrhythmias"
},
"riskAdjustmentModel": {
"id": "b923179c-9617-4ac5-8601-8054755a2a5c",
"type": "CMS-HCC"
},
"stratification": "HIGH",
"supportingData": [
{
"name": "hba1c",
"textValue": "6.8",
"serviceDate": "2017-08-15T19:20:00.000Z",
"sourceIdentifier": {
"dataPartition": {
"id": "54dd3f9e-7c45-413d-88bc-3bafcee8b7ab",
"name": "Cerner - Millennium P23213",
"description": "Cerner - Millennium P23213 description",
"dataSource": {
"id": "12312",
"name": "Feed 12334123"
}
},
"id": "12345"
}
}
],
"competingData": [
{
"name": "gestational_diabetes_present",
"textValue": "false",
"sourceIdentifier": {
"dataPartition": {
"id": "54dd3f9e-7c45-413d-88bc-3bafcee8b7ab",
"name": "Cerner - Millennium P23213",
"description": "Cerner - Millennium P23213 description",
"dataSource": {
"id": "12312",
"name": "Feed 12334123"
}
},
"id": "12345"
}
}
],
"suppressed": true,
"suppression": {
"id": "65752b39-78ed-496d-983e-64b361ad7890",
"comment": "comment for the suppression",
"reason": {
"id": "6a33aaee-b991-416d-a874-a9c2c2079730"
},
"createdAt": "2020-03-20T12:14:31-0500",
"createdBy": {
"id": "27d0677b-28e6-4648-9159-1e114eb7b829",
"display": "Service Account - Prod"
},
"updatedAt": "2020-03-20T12:14:31-0500",
"updatedBy": {
"id": "27d0677b-28e6-4648-9159-1e114eb7b829",
"display": "Service Account - Prod"
}
},
"pipeline": {
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91"
}
}
],
"totalResults": 21,
"firstLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/suspected-hccs?patientId=17d0677b-28e6-4648-9159-1e114eb7b829&offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/suspected-hccs?patientId=17d0677b-28e6-4648-9159-1e114eb7b829&offset=20&limit=20",
"prevLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/suspected-hccs?patientId=17d0677b-28e6-4648-9159-1e114eb7b829&offset=0&limit=20",
"nextLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/suspected-hccs?patientId=17d0677b-28e6-4648-9159-1e114eb7b829&offset=20&limit=20"
}
GET /pipelines/{pipelineId}/suspected-hccs
Retrieves a list of suspected HCCs.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
pipelineId | path | string | true | N/A | The ID of the HCC pipeline. | - |
patientId | query | string | true | N/A | The ID of the patient within the population. | - |
includeSuppressed | query | string | false | N/A | Determines whether suspected HCC suppression is considered when filtering suspected HCCs in the response. A suspected HCC will be suppressed when someone has proactively disputed the validity of the suspected HCC for the patient in context. |
true, false |
riskAdjustmentModelType | query | array[string] | false | N/A | The type of the risk-adjustment model. If this parameter is not specified, then records are | CMS-HCC, HHS-HCC, ESRD-HCC |
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 | stratification | A comma-separated list of fields by which to sort. | stratification, -stratification |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of suspected HCC objects | SuspectedHccs |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Resource not found | Error |
Persistent HCC
A persistent HCC is an HCC that was present for the patient in the past, based on a condition that was documented before the start of the current calendar year, but no condition associated with a persistent HCC has yet been documented for the patient during the current calendar year.
Retrieve a List of Persistent HCCs
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/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/persistent-hccs',
query: {
'patientId' => 'string'
}, headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/persistent-hccs?patientId=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"patient": {
"id": "17d0677b-28e6-4648-9159-1e114eb7b829",
"population": {
"id": "5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"
}
},
"hierarchicalConditionCategory": {
"id": "0b424e9d-b74a-4b78-9dde-22685ae9cdec",
"categoryNumber": 96,
"name": "Specified Heart Arrhythmias"
},
"riskAdjustmentModel": {
"id": "b923179c-9617-4ac5-8601-8054755a2a5c",
"type": "CMS-HCC"
},
"status": "SATISFIED",
"pastPeriodSupportingData": [
{
"condition": {
"id": "0001f5f1328aab3bdb67a6ca32d025bdfaceda230268357dff364d93366b6412",
"sourceIdentifier": {
"dataPartition": {
"id": "54dd3f9e-7c45-413d-88bc-3bafcee8b7ab",
"name": "Cerner - Millennium P23213",
"description": "Cerner - Millennium P23213 description",
"dataSource": {
"id": "12312",
"name": "Feed 12334123"
}
},
"id": "12345"
},
"code": {
"sourceCodings": [
{
"system": "urn:oid:2.16.840.1.113883.6.103",
"code": "715.90",
"display": "DA (degenerative arthritis)"
}
],
"codings": [
{
"system": "2.16.840.1.113883.6.103",
"code": "715.90",
"display": "Osteoarthrosis, unspecified whether generalized or localized, site unspecified"
},
{
"system": "53EF3068AE8F4EDE9951DC170CBBE6DA",
"code": "OSTEOARTHRITIS_CLIN",
"display": "Osteoarthritis"
}
]
}
},
"effectiveDate": "2017-04-24"
}
],
"currentPeriodSupportingData": [
{
"condition": {
"id": "0001f5f1328aab3bdb67a6ca32d025bdfaceda230268357dff364d93366b64c2",
"sourceIdentifier": {
"dataPartition": {
"id": "54dd3f9e-7c45-413d-88bc-3bafcee8b7ab",
"name": "Cerner - Millennium P23213",
"description": "Cerner - Millennium P23213 description",
"dataSource": {
"id": "12312",
"name": "Feed 12334123"
}
},
"id": "12345"
},
"code": {
"sourceCodings": [
{
"system": "urn:oid:2.16.840.1.113883.6.103",
"code": "715.90",
"display": "DA (degenerative arthritis)"
}
],
"codings": [
{
"system": "2.16.840.1.113883.6.103",
"code": "715.90",
"display": "Osteoarthrosis, unspecified whether generalized or localized, site unspecified"
},
{
"system": "53EF3068AE8F4EDE9951DC170CBBE6DA",
"code": "OSTEOARTHRITIS_CLIN",
"display": "Osteoarthritis"
}
]
}
},
"effectiveDate": "2018-04-24"
}
],
"suppression": {
"id": "65752b39-78ed-496d-983e-64b361ad7890",
"comment": "This patient does not appear to have the condition.",
"reason": {
"id": "6a33aaee-b991-416d-a874-a9c2c2079730"
},
"createdAt": "2020-03-20T12:14:31-0500",
"createdBy": {
"id": "27d0677b-28e6-4648-9159-1e114eb7b829",
"display": "Service Account - Prod"
},
"updatedAt": "2020-03-20T12:14:31-0500",
"updatedBy": {
"id": "27d0677b-28e6-4648-9159-1e114eb7b829",
"display": "Service Account - Prod"
}
},
"pipeline": {
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91"
}
}
],
"totalResults": 21,
"firstLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/persistent-hccs?patientId=17d0677b-28e6-4648-9159-1e114eb7b829&offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/persistent-hccs?patientId=17d0677b-28e6-4648-9159-1e114eb7b829&offset=20&limit=20",
"prevLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/persistent-hccs?patientId=17d0677b-28e6-4648-9159-1e114eb7b829&offset=0&limit=20",
"nextLink": "https://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/persistent-hccs?patientId=17d0677b-28e6-4648-9159-1e114eb7b829&offset=20&limit=20"
}
GET /pipelines/{pipelineId}/persistent-hccs
Retrieves a list of persistent HCCs.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
pipelineId | path | string | true | N/A | The ID of the HCC pipeline. | - |
patientId | query | string | true | N/A | The ID of the patient within the population. | - |
status | query | string | false | N/A | The status of the persistent HCC. If this parameter is not specified, then persistent HCCs from all statuses are returned. | PENDING, SATISFIED |
includeSuppressed | query | string | false | N/A | Determines whether persistent HCC suppression is considered when filtering persistent HCCs in the response. A persistent HCC is suppressed when someone proactively disputes the validity of the persistent HCC for the patient in context. |
true, false |
riskAdjustmentModelType | query | array[string] | false | N/A | The type of the risk-adjustment model. If this parameter is not specified, then records are | CMS-HCC, HHS-HCC, ESRD-HCC |
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 | status | A comma-separated list of fields by which to sort. | status, -status |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of persistent HCC objects | PersistentHccs |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
RAF Scores
The risk adjustment factor (RAF) scores are produced according to the HCC risk-adjustment models that are configured. A patient’s RAF scores are based on multiple factors, including documented conditions that are included in one of the condition categories and demographic factors, such as benefit coverage, age, sex, and disability status.
Multiple RAF score values are produced for each risk-adjustment model. The most commonly used score is the clinically validated score for the documented conditions of the current year. Scores are also based on potential opportunities to capture additional conditions that appear relevant from either past condition documentation or suspected conditions.
Retrieve a List of RAF Scores for a Patient
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/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/patients/17d0677b-28e6-4648-9159-1e114eb7b829/risk-adjustment-factor-scores', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/patients/17d0677b-28e6-4648-9159-1e114eb7b829/risk-adjustment-factor-scores \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"patient": {
"id": "17d0677b-28e6-4648-9159-1e114eb7b829",
"population": {
"id": "5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"
}
},
"pipeline": {
"id": "a426149a-c19c-413a-8d9f-d7988aec4a91"
},
"riskAdjustmentModel": {
"id": "b923179c-9617-4ac5-8601-8054755a2a5c",
"type": "CMS-HCC"
},
"types": [
{
"name": "CLINICALLY_VALIDATED_ACTUAL_CMS_RAF",
"title": "Clinically validated RAF",
"description": "RAF score for CMS HCC using conditions that are clinically validated to determine\n applicable HCC coefficients",
"value": "0.35",
"modelSegment": {
"codings": [
{
"code": "string",
"display": "string",
"system": "string"
}
],
"text": "New Enrollee - Non-Medicaid and Originally Disabled"
},
"factors": [
{
"name": "hcc_17",
"value": "26.7",
"basis": [
{
"id": "e8f0de42-2e4b-11e9-b210-d663bd873d93",
"kind": "condition#condition"
}
]
}
]
}
]
}
],
"totalResults": 2,
"firstLink": "http://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/patients/17d0677b-28e6-4648-9159-1e114eb7b829/risk-adjustment-factor-scores?offset=0&limit=1",
"lastLink": "http://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/patients/17d0677b-28e6-4648-9159-1e114eb7b829/risk-adjustment-factor-scores?offset=1&limit=1",
"prevLink": "http://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/patients/17d0677b-28e6-4648-9159-1e114eb7b829/risk-adjustment-factor-scores?offset=0&limit=1",
"nextLink": "http://cernerdemo.api.us.healtheintent.com/hcc/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/patients/17d0677b-28e6-4648-9159-1e114eb7b829/risk-adjustment-factor-scores?offset=1&limit=1"
}
GET /pipelines/{pipelineId}/patients/{patientId}/risk-adjustment-factor-scores
Retrieves a list of RAF scores for a patient.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
pipelineId | path | string | true | N/A | The ID of the HCC pipeline. | - |
patientId | path | string | true | N/A | The ID of the patient within the population. | - |
riskAdjustmentModelType | query | array[string] | false | N/A | The type of the risk-adjustment model. If this parameter is not specified, then records are | CMS-HCC, HHS-HCC, ESRD-HCC |
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 RAF scores for a patient | RiskAdjustmentFactorScores |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
HCC Results
HCC results allow you to retrieve collections of persistent HCCs, suspected HCCs, and RAF scores.
- A persistent HCC is an HCC that was present for the patient in the past, based on a condition that was documented before the start of the current calendar year, but no condition associated with a persistent HCC has yet been documented for the patient during the current calendar year.
- A suspected HCC is an HCC that is likely to be present for a patient but is not supported by a documented condition in the patient’s longitudinal record. Suspected HCCs are based on laboratory results, medications, and procedures. Both supporting and possible competing clinical facts are provided to help a provider decide whether to document an HCC-related problem or diagnosis for the patient.
- The risk adjustment factor (RAF) scores are produced according to the HCC risk-adjustment models that are configured. A patient’s RAF scores are based on multiple factors, including documented conditions that are included in one of the condition categories and demographic factors, such as benefit coverage, age, sex, and disability status.
Multiple RAF score values are produced for each risk-adjustment model. The most commonly used score is the clinically validated score for the documented conditions of the current year. Scores are also based on potential opportunities to capture additional conditions that appear relevant from either past condition documentation or suspected conditions.
Retrieve a Collection of HCC 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/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/patients/{patientId}/hcc-results', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/pipelines/65752b39-78ed-496d-983e-64b361ad7890/patients/{patientId}/hcc-results \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
GET /pipelines/{pipelineId}/patients/{patientId}/hcc-results
Retrieves all persistent HCCs, suspected HCCs, and RAF Scores.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
pipelineId | path | string | true | N/A | The ID of the HCC pipeline. | - |
patientId | path | string | true | N/A | The ID of the patient within the population. | - |
riskAdjustmentModelType | query | array[string] | false | N/A | The type of the risk-adjustment model. If this parameter is not specified, then records are | CMS-HCC, HHS-HCC, ESRD-HCC |
status | query | string | false | N/A | The status of the persistent HCC. If this parameter is not specified, then persistent HCCs from all statuses are returned. | PENDING, SATISFIED |
includeSuppressed | query | string | false | N/A | Determines whether persistent HCC suppression is considered when filtering persistent HCCs in the response. A persistent HCC is suppressed when someone proactively disputes the validity of the persistent HCC for the patient in context. |
true, false |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Collections of persistent HCC objects, suspected HCC objects, and RAF Score objects. | HccPublicApi_Entities_V1_Outcomes_HccResult |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Resource not found | Error |
External Data
The resources for managing external HCC data confirmed by the Centers for Medicare & Medicaid Services (CMS).
Upload MOR Data File
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json'
}
result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/mor-data-uploads', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/mor-data-uploads \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json'
POST /mor-data-uploads
Creates a Model Output Report (MOR) data file upload record that represents data contained in the file.
You can use this resource to upload MOR files with payment date of 2016 or later from CMS for processing HCC outcomes. Include a MOR header record that contains metadata that describes the content of the data file. The following is the composition for an example header record of 1H991120180512201809:
Header | Char Size | Position | Example Value |
---|---|---|---|
Record Type Code | 1 | 1 | 1 |
Contract Number | 5 | 2-6 | H9911 |
Run Date | 8 | 7-14 | 20180512 |
Payment Year & Month | 6 | 15-20 | 201809 |
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postMorDataUploads | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
409 | Conflict | Conflict | Error |
Upload MMR Data File
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json'
}
result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/mmr-data-uploads', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/hcc/v1/mmr-data-uploads \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json'
POST /mmr-data-uploads
Creates a Monthly Membership Report (MMR) data file upload record that represents data contained in the file.
You can use this resource to upload MMR files with payment dates of 2016 or later from CMS to HealtheIntent for further processing. The file must be under 50 MB in size. Otherwise, compress it into the .GZIP or .ZIP format and upload. The upload record includes the MMR records’ metadata, which describe the data file’s content.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postMmrDataUploads | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
409 | Conflict | Conflict | Error |
Schema Definitions
ConditionCategoryCodes
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [HccPublicApi_Entities_V1_Reference_ConditionCategoryCode] | 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. | - |
HccPublicApi_Entities_V1_Reference_ConditionCategoryCode
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
hierarchicalConditionCategory | HccPublicApi_Entities_V1_Reference_HierarchicalConditionCategoryIdReference | true | The HCC. | - |
code | Code | true | The standard code that is part of a condition category. | - |
recommended | boolean | true | Indicates whether the code is a recommended value for creating a new condition within the HCC in context. | - |
HccPublicApi_Entities_V1_Reference_HierarchicalConditionCategoryIdReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the HCC. | - |
Code
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
code | string | true | The unique ID of the code. | - |
display | string | false | A human-readable representation of the code. | - |
system | string | true | The ID of the coding system that gives meaning to the code. | - |
Error
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
code | integer(int32) | true | The HTTP response status code that represents the error. | - |
message | string | true | A human-readable description of the error. | - |
errorDetails | [ErrorDetail] | false | A list of additional error details. | - |
ErrorDetail
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
domain | string | false | A subsystem or context where an error occurred. | - |
reason | string | false | A codified value that represents the specific error that caused the current error status. | - |
message | string | false | A human-readable description of an error. | - |
locationType | string | false | The location or type of the field that caused an error. | query, header, path, formData, body |
location | string | false | The name of the field that caused an error. | - |
ConditionOptions
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [HccPublicApi_Entities_V1_Reference_ConditionOption] | 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. | - |
HccPublicApi_Entities_V1_Reference_ConditionOption
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the condition option. | - |
name | string | true | The name of the condition option. | - |
title | string | true | The user-friendly display name of the condition option. | - |
default | boolean | false | Indicates whether this condition option is the default selection. | - |
ranking | integer(int32) | false | The relative priority of the condition option across all condition options evaluated in the population. You can use ‘ranking’ as a sort order preference in application workflows. | - |
riskAdjustmentPrograms | [HccPublicApi_Entities_V1_Reference_RiskAdjustmentProgram] | true | The list of hierarchical condition category risk adjustment programs. | - |
codes | [HccPublicApi_Entities_V1_Reference_Code] | true | The system representation of the medical code, for example, ICD or SNOMED. | - |
createdAt | string | true | The date and time when the condition option was initially entered into the system, in ISO 8601 formatting with precision to YYYY-MM-DDThh:mm:ss.SSSZ, such as 2018-02-13T20:41:18.181Z. The time is set automatically when the condition option is first created. Therefore, the field does not need to be set explicitly. | - |
updatedAt | string | true | The date and time when the condition option was updated in the system, in ISO 8601 formatting with precision to YYYY-MM-DDThh:mm:ss.SSSZ, such as 2018-02-13T20:41:18.181Z. The time is set automatically when the condition option is updated. Therefore, the field does not need to be set explicitly. | - |
HccPublicApi_Entities_V1_Reference_RiskAdjustmentProgram
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
hccRiskAdjustmentModel | HccPublicApi_Entities_V1_Reference_HccRiskAdjustmentModel | true | The hierarchical condition category risk adjustment model. | - |
HccPublicApi_Entities_V1_Reference_HccRiskAdjustmentModel
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the risk adjustment model. | - |
type | string | true | The HCC risk adjustment model type, which includes the following models:
|
CMS-HCC, HHS-HCC, ESRD-HCC |
hierarchicalConditionCategory | HccPublicApi_Entities_V1_Reference_HierarchicalConditionCategoryReference | true | The HCC that the risk adjustment model is based on. | - |
HccPublicApi_Entities_V1_Reference_HierarchicalConditionCategoryReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The HCC’s ID. | - |
categoryNumber | integer(int32) | true | The number that uniquely represents a condition category in a risk-adjustment model. | - |
name | string | true | The user-friendly HCC name specific to the risk-adjustment model. | - |
HccPublicApi_Entities_V1_Reference_Code
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
code | string | true | The unique ID of the code. | - |
display | string | false | A human-readable representation of the code. | - |
system | string | true | The ISO object ID (OID) of the coding system that gives meaning to the code, for example, ICD-10-CM or SNOMED. | - |
preferred | boolean | false | The preferred condition code when more than one code is available. | - |
Configurations
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [HccPublicApi_Entities_V1_Configuration_Configuration] | 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. | - |
HccPublicApi_Entities_V1_Configuration_Configuration
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The configuration ID. | - |
instanceId | string | true | The configuration instance ID. This is the version ID for the current configuration. | - |
population | HccPublicApi_Entities_V1_Outcomes_PopulationReference | true | The population reference for the configuration. | - |
name | string | true | The name of the configuration. The name must be unique. | - |
version | string | true | The version number of the configuration. | - |
riskAdjustmentModel | HccPublicApi_Entities_V1_Reference_RiskAdjustmentModelReference | true | The HCC risk-adjustment model specification that this configuration is associated with. | - |
riskAdjustmentPrograms | [HccPublicApi_Entities_V1_Configuration_RiskAdjustmentProgramReference] | false | The risk-adjustment programs associated with this configuration. | - |
tags | [HccPublicApi_Entities_V1_Configuration_TagReference] | false | The tags associated with this configuration. This array includes tags created for the parent configuration ID plus any tags created specifically for this version of the configuration. | - |
status | string | true | The status of the configuration. | ACTIVE, INACTIVE |
createdAt | string | true | The date and time when the version of the configuration was initially entered into the system. In ISO 8601 formatting with precision down to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2018-02-13T20:41:18.181Z. The time in this field is set automatically when the suppression reason is first created; therefore, the field does not need to be set explicitly. | - |
createdBy | HccPublicApi_Entities_V1_Configuration_PersonnelReference | true | The individual who entered the configuration version into the system. | - |
updatedAt | string | false | No description | - |
updatedBy | HccPublicApi_Entities_V1_Configuration_PersonnelReference | false | No description | - |
HccPublicApi_Entities_V1_Outcomes_PopulationReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the population. | - |
HccPublicApi_Entities_V1_Reference_RiskAdjustmentModelReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the risk adjustment model. | - |
HccPublicApi_Entities_V1_Configuration_RiskAdjustmentProgramReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
riskAdjustmentModelId | string | true | The ID of the risk-adjustment model. | - |
riskAdjustmentModelType | string | true | The type of the risk-adjustment model. | - |
ranking | integer(int32) | false | The ranking of the risk-adjustment program. | - |
HccPublicApi_Entities_V1_Configuration_TagReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
key | string | true | The key for a tag. | - |
value | string | false | The value for a tag. | - |
HccPublicApi_Entities_V1_Configuration_PersonnelReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the personnel within the tenant. | - |
postConfigurations
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
createdBy | object | true | A representation of the individual who entered the configuration into the system. | - |
» id | string | true | The unique ID of the individual who entered the configuration into the system. | - |
name | string | true | The name of the HCC configuration. | - |
population | object | true | A population. | - |
» id | string | true | The population ID. | - |
riskAdjustmentModel | object | true | A risk adjustment model. | - |
» id | string | true | The ID of the risk-adjustment model. | - |
riskAdjustmentPrograms | [object] | false | The risk-adjustment programs for a configuration | - |
» riskAdjustmentModelId | string | true | The ID of the risk-adjustment model. | - |
» riskAdjustmentModelType | string | true | The type of the risk-adjustment model. | - |
» ranking | integer(int32) | false | The ranking of the risk-adjustment program. | - |
status | string | true | The status of the configuration. | ACTIVE, INACTIVE |
putConfigurations
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
createdBy | object | true | A representation of the individual who entered the configuration into the system. | - |
» id | string | true | The unique ID of the individual who entered the configuration into the system. | - |
name | string | true | The name of the HCC configuration. | - |
population | object | true | A population. | - |
» id | string | true | The population ID. | - |
riskAdjustmentModel | object | true | A risk adjustment model. | - |
» id | string | true | The ID of the risk-adjustment model. | - |
riskAdjustmentPrograms | [object] | false | The risk-adjustment programs for a configuration | - |
» riskAdjustmentModelId | string | true | The ID of the risk-adjustment model. | - |
» riskAdjustmentModelType | string | true | The type of the risk-adjustment model. | - |
» ranking | integer(int32) | false | The ranking of the risk-adjustment program. | - |
status | string | true | The status of the configuration. | ACTIVE, INACTIVE |
SuspectedHccItems
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [HccPublicApi_Entities_V1_Configuration_SuspectedHccItem] | 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. | - |
HccPublicApi_Entities_V1_Configuration_SuspectedHccItem
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
hierarchicalConditionCategory | HccPublicApi_Entities_V1_Reference_HierarchicalConditionCategoryIdReference | true | The suspected HCC that is included for processing. | - |
addedAt | string | true | The date and time when the instance of the suspected HCC was added to a configuration. In ISO 8601 formatting with precision down to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2018-02-13T20:41:18.181Z. The time in this field is set automatically when the suppression reason is first created; therefore, the field does not need to be set explicitly. | - |
addedBy | HccPublicApi_Entities_V1_Configuration_PersonnelReference | false | The individual who added the suspected HCC for processing. | - |
putConfigurationsConfigurationidSuspectedHccs
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
addedBy | object | true | The individual who added the suspected HCC for processing. | - |
» id | string | true | The unique ID of the individual who added the suspected HCC. | - |
postPipelinesPipelineidPatientsPatientidHccSuppressions
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
comment | string | false | The reason for the suppression. The maximum length is 256 characters. | - |
endEffective | string(date-time) | false | The date and time when the HCC suppression is no longer effective. In ISO 8601 formatting with precision down to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ). | - |
hierarchicalConditionCategory | object | true | The HCC of the suppressed condition. | - |
» id | string | true | The unique ID of the HCC. | - |
suppressionReason | object | true | The reason for the suppression. | - |
» id | string | true | The unique ID of the suppression reason. | - |
createdBy | object | false | The individual who entered the suppression into the system. | - |
» id | string | false | No description | - |
type | string | false | The type of HCC suppression. Available values are PERSISTENT and SUSPECTED. | - |
HccPublicApi_Entities_V1_Suppression_HccSuppression
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | false | The ID of the HCC suppression. | - |
patient | HccPublicApi_Entities_V1_Outcomes_PatientReference | false | The patient associated with the HCC. | - |
hierarchicalConditionCategory | HccPublicApi_Entities_V1_Reference_HierarchicalConditionCategoryIdReference | false | The HCC of the suppressed condition. | - |
suppressionReason | HccPublicApi_Entities_V1_Suppression_SuppressionReasonReference | false | The reason for the suppression. | - |
comment | string | false | The free-text comment describing the suppression reason. The maximum length is 256 characters. | - |
endEffective | string(date-time) | false | The date and time when the HCC suppression is no longer effective. In ISO 8601 formatting with precision down to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ). | - |
pipeline | HccPublicApi_Entities_V1_Pipeline_HccPipelineReference | true | The HCC pipeline that uses this suppression to alter outcomes handling. | - |
createdAt | string | false | The date and time when the suppression was initially entered into the system. In ISO 8601 formatting with precision down to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2018-02-13T20:41:18.181Z. The time in this field is set automatically when the suppression is first created; therefore, the field does not need to be set explicitly. | - |
createdBy | HccPublicApi_Entities_V1_Configuration_PersonnelReference | false | The individual who entered the suppression into the system. | - |
updatedAt | string | false | The date and time when the suppression was last modified. In ISO 8601 formatting with precision down to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2018-02-13T20:41:18.181Z. The time in this field is set automatically every time the suppression is modified; therefore, the field does not need to be set explicitly. When the suppression is first created, the value of the updatedAt field is set by the service and matches the value in the createdAt field. | - |
updatedBy | HccPublicApi_Entities_V1_Configuration_PersonnelReference | false | The individual who last modified the suppression in the system. When the suppression is first created, the value in the updatedBy field is set by the service and matches the createdBy field. | - |
type | string | false | The type of the HCC being suppressed. | - |
HccPublicApi_Entities_V1_Outcomes_PatientReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the patient within the population. | - |
population | HccPublicApi_Entities_V1_Outcomes_PopulationReference | true | The population that this patient belongs to. | - |
HccPublicApi_Entities_V1_Suppression_SuppressionReasonReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the suppression reason. | - |
HccPublicApi_Entities_V1_Pipeline_HccPipelineReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the HCC pipeline. | - |
HccSuppressions
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [HccPublicApi_Entities_V1_Suppression_HccSuppression] | 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. | - |
putPipelinesPipelineidPatientsPatientidHccSuppressions
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
comment | string | false | The reason for the suppression. The maximum length is 256 characters. | - |
endEffective | string(date-time) | false | The date and time when the HCC suppression is no longer effective. In ISO 8601 formatting down to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ). | - |
hierarchicalConditionCategory | object | true | The HCC of the suppressed condition. | - |
» id | string | true | The unique ID of the HCC. | - |
suppressionReason | object | true | The reason for the suppression. | - |
» id | string | true | The unique ID of the suppression reason. | - |
updatedBy | object | false | The individual who last modified the suppression in the system. | - |
» id | string | false | No description | - |
type | string | false | The type of the HCC being suppressed. Available values are PERSISTENT and SUSPECTED. | - |
RiskAdjustmentFactorScores
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [HccPublicApi_Entities_V1_Outcomes_RiskAdjustmentFactorScore] | 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. | - |
HccPublicApi_Entities_V1_Outcomes_RiskAdjustmentFactorScore
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
patient | HccPublicApi_Entities_V1_Outcomes_PatientReference | true | The patient associated with the suspected HCC. | - |
pipeline | HccPublicApi_Entities_V1_Pipeline_HccPipelineReference | true | The HCC pipeline that generated this suspected HCC outcome. | - |
riskAdjustmentModel | HccPublicApi_Entities_V1_Outcomes_RiskAdjustmentModelTypeReference | true | The risk-adjustment model associated with this score. | - |
types | [HccPublicApi_Entities_V1_Outcomes_RafScoreType] | true | The RAF scores based on different methodologies. | - |
HccPublicApi_Entities_V1_Outcomes_RiskAdjustmentModelTypeReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the risk-adjustment model. | - |
type | string | true | The type of the risk-adjustment model. | - |
HccPublicApi_Entities_V1_Outcomes_RafScoreType
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The system-identified name of the type of RAF score methodology. | - |
title | string | true | The user-friendly name of the type of RAF score methodology. | - |
description | string | false | The description of the type of RAF score methodology. | - |
value | string | true | The numeric representation of the RAF score value. | - |
modelSegment | HccPublicApi_Entities_V1_Outcomes_RafScoreModelSegment | false | The numeric representation of the RAF score model segment. | - |
factors | [HccPublicApi_Entities_V1_Outcomes_RafFactors] | false | The supporting data that was used in the calculation of the RAF score. | - |
HccPublicApi_Entities_V1_Outcomes_RafScoreModelSegment
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
codings | [Code] | false | The algorithm, process, or mechanism used to evaluate the risk, for example, All-Cause Readmission v2, All-Cause Readmission v3, Clinical Standard, and so on. | - |
text | string | false | The user-friendly text for the RAF score methodology. | - |
HccPublicApi_Entities_V1_Outcomes_RafFactors
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | false | The name of the supporting fact. | - |
value | string | false | The value of the supporting fact. | - |
basis | [HccPublicApi_Entities_V1_Outcomes_Basis] | false | The basis upon which the factor was included. | - |
HccPublicApi_Entities_V1_Outcomes_Basis
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | false | The ID of the referenced resource. | - |
kind | string | false | The type of the basis that was considered for the identification logic. | - |
PersistentHccs
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [HccPublicApi_Entities_V1_Outcomes_PersistentHcc] | 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. | - |
HccPublicApi_Entities_V1_Outcomes_PersistentHcc
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
patient | HccPublicApi_Entities_V1_Outcomes_PatientReference | true | The patient associated with the persistent HCC. | - |
hierarchicalConditionCategory | HccPublicApi_Entities_V1_Reference_HierarchicalConditionCategoryReference | true | The HCC that the persistent HCC is based upon. | - |
riskAdjustmentModel | HccPublicApi_Entities_V1_Outcomes_RiskAdjustmentModelTypeReference | true | The risk-adjustment model associated with the persistent HCC. | - |
status | string | true | The status of the persistence of the HCC outcome. This status field provides a summary of the documentation of conditions categorized in an HCC for the current year.
|
PENDING, SATISFIED |
pastPeriodSupportingData | [HccPublicApi_Entities_V1_Outcomes_PersistentConditionSupport] | false | The supporting data that indicates an HCC was documented in the previous period. Note: This supporting data is not available for conditions that are being documented for the first time. | - |
currentPeriodSupportingData | [HccPublicApi_Entities_V1_Outcomes_PersistentConditionSupport] | false | The supporting data that indicates an HCC was documented in the current period. | - |
suppressed | boolean | false | True if the persistent HCC has been suppressed and false otherwise. | - |
suppression | HccPublicApi_Entities_V1_Suppression_HccSuppressionReference | false | The suppression that has been created based on feedback from a user. | - |
pipeline | HccPublicApi_Entities_V1_Pipeline_HccPipelineReference | true | The HCC pipeline that generated this persistent HCC outcome. | - |
HccPublicApi_Entities_V1_Outcomes_PersistentConditionSupport
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
condition | HccPublicApi_Entities_V1_Outcomes_ConditionReference | true | The condition that was used as support for the identification of an HCC. | - |
effectiveDate | string | false | The effective date of the condition used for determining the qualifying period. For conditions that are linked to encounters, the encounter service date is used as the effective date. For conditions that are not linked to encounters, the condition onset date is used for the effective date. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. | - |
HccPublicApi_Entities_V1_Outcomes_ConditionReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the condition record. This ID can be used to retrieve details of the condition from the HealtheIntent Condition API. | - |
sourceIdentifier | HccPublicApi_Entities_V1_Outcomes_SourceIdentifierReference | false | The source identifier information. | - |
code | CodeableConcept | false | The code information. | - |
HccPublicApi_Entities_V1_Outcomes_SourceIdentifierReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique ID of the source identifier. | - |
dataPartition | HccPublicApi_Entities_V1_Outcomes_DataPartitionReference | false | The data partition information. | - |
HccPublicApi_Entities_V1_Outcomes_DataPartitionReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | false | The unique ID of the data partition. | - |
name | string | false | The name of the data partition. | - |
description | string | false | The description of the data partition. | - |
dataSource | HccPublicApi_Entities_V1_Outcomes_DataSourceReference | true | The data source of the data that produced the data partition. | - |
HccPublicApi_Entities_V1_Outcomes_DataSourceReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | false | The ID of the data source. | - |
name | string | false | The name of the data source. | - |
CodeableConcept
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
codings | [Code] | true | A list of codified values from standard code systems recognized by HealtheIntent. | - |
sourceCodings | [Code] | true | The list of codified values provided in the source data. Not all of these codes are available in the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by HealtheIntent. | - |
concepts | [Concept] | false | The list of ontological concepts derived from the codified values from standard code systems recognized by HealtheIntent. | - |
text | string | false | This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. | - |
Concept
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
alias | string | true | The unique ID of the concept in a context. | - |
contextId | string | true | The unique ID of the context. IDs are in all caps and do not include dashes. | - |
HccPublicApi_Entities_V1_Suppression_HccSuppressionReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the HCC suppression. | - |
comment | string | false | The free-text comment that describes the suppression. | - |
reason | HccPublicApi_Entities_V1_Suppression_SuppressionReasonReference | false | The ID of the HCC suppression. | - |
createdAt | string | false | The date and time when the suppression was created, in ISO 8601 format with precision to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2020-02-13T20:41:18.181Z. The time in this field is set automatically when a suppression is created. You do not need to manually set this value. | - |
createdBy | HccPublicApi_Entities_V1_Suppression_CreatedByReference | false | The person who created the suppression in the system. | - |
updatedAt | string | true | The date and time when the suppression was last modified, in ISO 8601 format with precision to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2020-02-13T20:41:18.181Z. The time in this field is set automatically every time the suppression is modified. You do not need to manually set this value. When the suppression is first created, the value of the UpdatedAt field is set by the service and matches the value in the CreatedAt field. | - |
updatedBy | HccPublicApi_Entities_V1_Suppression_UpdatedByReference | false | The person who last modified the suppression in the system. | - |
HccPublicApi_Entities_V1_Suppression_CreatedByReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the personnel member in the tenant. | - |
display | string | false | The name of the personnel member in the tenant. | - |
HccPublicApi_Entities_V1_Suppression_UpdatedByReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the personnel member within the tenant. | - |
display | string | false | The name of the personnel member within the tenant. | - |
HccPipelines
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [HccPublicApi_Entities_V1_Pipeline_HccPipeline] | 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. | - |
HccPublicApi_Entities_V1_Pipeline_HccPipeline
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the HCC pipeline. | - |
instanceId | string | true | The ID of the HCC pipeline instance. | - |
versionId | integer(int32) | true | The automatically incremented version ID of the pipeline. | - |
name | string | true | The name of the HCC pipeline. | - |
createdAt | string | false | The date and time when the pipeline was initially entered into the system. In ISO 8601 formatting with precision to YYYY-MM-DDThh:mm:ss.SSSZ, such as 2018-02-13T20:41:18.181Z. The time is set automatically when the pipeline is first created. Therefore, the field does not need to be set explicitly. | - |
createdBy | HccPublicApi_Entities_V1_Configuration_PersonnelReference | false | The ID of the individual who entered the pipeline into the system. | - |
updatedAt | string | false | No description | - |
updatedBy | HccPublicApi_Entities_V1_Configuration_PersonnelReference | false | No description | - |
configuration | HccPublicApi_Entities_V1_Configuration_ConfigurationReference | false | The configuration ID of the HCC pipeline. | - |
status | string | true | The status of the HCC pipeline. | DRAFT, PUBLISHED, SUSPENDED |
tags | [HccPublicApi_Entities_V1_Configuration_TagReference] | false | The tags associated to the HCC pipeline. | - |
executionSettings | HccPublicApi_Entities_V1_Pipeline_ExecutionSettings | false | The execution settings for the HCC pipeline. | - |
HccPublicApi_Entities_V1_Configuration_ConfigurationReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the configuration. | - |
HccPublicApi_Entities_V1_Pipeline_ExecutionSettings
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
frequencyValue | integer(int32) | true | The numeric value of the frequency of the HCC pipeline. The combination of frequencyValue and frequencyUnit must result in a minimum frequency of eight hours. | - |
frequencyUnit | string | true | The unit of time of the frequency of the HCC pipeline. The combination of frequencyValue and frequencyUnit must result in a minimum frequency of eight hours. | MINUTES, HOURS, DAYS, MONTHS |
dayOfMonth | integer(int32) | false | The day of the month when the HCC pipeline should run. This is required if the frequencyUnit parameter is set to MONTHS. | - |
timeOfDay | string | false | The time of day in Coordinated Universal Time (UTC) when the HCC pipeline should run. | - |
startTime | string(date-time) | false | The start time of the HCC pipeline. | - |
postPipelines
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
createdBy | object | false | A representation of the individual who entered the pipeline into the system. | - |
» id | string | true | The unique ID for the individual who entered the pipeline into the system. | - |
name | string | true | The name of the HCC pipeline. | - |
configuration | object | false | The configuration of the HCC pipeline. | - |
» id | string | true | The configuration ID of the HCC pipeline. | - |
status | string | false | The status of the HCC pipeline. | DRAFT, PUBLISHED, SUSPENDED |
executionSettings | object | false | The execution settings for the HCC pipeline. | - |
» frequencyValue | integer(int32) | false | The numeric value of the frequency of the HCC pipeline. The combination of frequencyValue and frequencyUnit must result in a minimum frequency of eight hours. | - |
» frequencyUnit | string | false | The unit of time of the frequency of the HCC pipeline. The combination of frequencyValue and frequencyUnit must result in a minimum frequency of eight hours. | MINUTES, HOURS, DAYS, MONTHS |
» dayOfMonth | integer(int32) | false | The day of the month when the HCC pipeline should run. This is required if the frequencyUnit parameter is set to MONTHS. | - |
» timeOfDay | string | false | The time of day in Coordinated Universal Time (UTC) when the HCC pipeline should run. | - |
» startTime | string(date-time) | false | The start time of the HCC pipeline. | - |
putPipelines
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
createdBy | object | false | A representation of the individual who entered the pipeline into the system. | - |
» id | string | true | The unique ID for the individual who entered the pipeline into the system. | - |
name | string | true | The name of the HCC pipeline. | - |
configuration | object | false | The configuration of the HCC pipeline. | - |
» id | string | true | The configuration ID of the HCC pipeline. | - |
status | string | false | The status of the HCC pipeline. | DRAFT, PUBLISHED, SUSPENDED |
executionSettings | object | false | The execution settings for the HCC pipeline. | - |
» frequencyValue | integer(int32) | false | The numeric value of the frequency of the HCC pipeline. The combination of frequencyValue and frequencyUnit must result in a minimum frequency of eight hours. | - |
» frequencyUnit | string | false | The unit of time of the frequency of the HCC pipeline. The combination of frequencyValue and frequencyUnit must result in a minimum frequency of eight hours. | MINUTES, HOURS, DAYS, MONTHS |
» dayOfMonth | integer(int32) | false | The day of the month when the HCC pipeline should run. This is required if the frequencyUnit parameter is set to MONTHS. | - |
» timeOfDay | string | false | The time of day in Coordinated Universal Time (UTC) when the HCC pipeline should run. | - |
» startTime | string(date-time) | false | The start time of the HCC pipeline. | - |
SuspectedHccs
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [HccPublicApi_Entities_V1_Outcomes_SuspectedHcc] | 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. | - |
HccPublicApi_Entities_V1_Outcomes_SuspectedHcc
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
patient | HccPublicApi_Entities_V1_Outcomes_PatientReference | true | The patient associated with the suspected HCC. | - |
riskAdjustmentModel | HccPublicApi_Entities_V1_Outcomes_RiskAdjustmentModelTypeReference | true | The risk-adjustment model associated with the suspected HCC. | - |
hierarchicalConditionCategory | HccPublicApi_Entities_V1_Reference_HierarchicalConditionCategoryReference | true | The HCC that the suspected HCC is based upon. | - |
stratification | string | true | Indicates the confidence in the suspected HCC recommendation using the following stratification values:
|
HIGH, MODERATE, NONE |
supportingData | [HccPublicApi_Entities_V1_Outcomes_SuspectedHccCovariate] | false | The covariate variables that support the positive identification of the suspected HCC. | - |
competingData | [HccPublicApi_Entities_V1_Outcomes_SuspectedHccCovariate] | false | The covariate variables that dispute the positive identification of the suspected HCC. | - |
suppressed | boolean | false | True if the suspected HCC has been suppressed and false otherwise. | - |
suppression | HccPublicApi_Entities_V1_Suppression_HccSuppressionReference | false | The suppression that has been created based on feedback from a user. | - |
pipeline | HccPublicApi_Entities_V1_Pipeline_HccPipelineReference | true | The HCC pipeline that generated this suspected HCC outcome. | - |
HccPublicApi_Entities_V1_Outcomes_SuspectedHccCovariate
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
name | string | true | The display name for the covariate. A covariate represents an independent variable value used in the suspected HCC algorithm. | - |
textValue | string | false | Text value | - |
serviceDate | string | false | The service date of the clinical data point used for this covariate. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. The following clinical data types define how this date is populated:
|
- |
sourceIdentifier | HccPublicApi_Entities_V1_Outcomes_SourceIdentifierReference | false | The source identifier information. | - |
HccPublicApi_Entities_V1_Outcomes_HccResult
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
persistentHccs | [HccPublicApi_Entities_V1_Outcomes_PersistentHcc] | true | The collection of persistent HCCs. | - |
suspectedHccs | [HccPublicApi_Entities_V1_Outcomes_SuspectedHcc] | true | The collection of suspected HCCs. | - |
rafScores | [HccPublicApi_Entities_V1_Outcomes_RiskAdjustmentFactorScore] | true | The collection of RAF scores. | - |
HierarchicalConditionCategories
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [HccPublicApi_Entities_V1_Reference_HierarchicalConditionCategory] | 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. | - |
HccPublicApi_Entities_V1_Reference_HierarchicalConditionCategory
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the HCC. | - |
riskAdjustmentModel | HccPublicApi_Entities_V1_Reference_RiskAdjustmentModelReference | true | The HCC risk adjustment model specification that this HCC is defined for. | - |
categoryNumber | integer(int32) | true | The number used to uniquely represent a condition category in a risk-adjustment model. | - |
categoryNumberString | string | true | The string identifier used to uniquely represent a condition category in a risk-adjustment model. This attribute is added as the string format of the category number, while the category number is an Integer type. The category number string is added to support the category number in decimal format, such as “35.2”. | - |
name | string | true | The user-friendly name of the HCC specific to the risk-adjustment model. | - |
concept | HccPublicApi_Entities_V1_Reference_ConceptReference | true | The ontology concept that is used to identify the diagnosis codes that make up this HCC. | - |
hierarchy | [string] | false | The ordered list of HCC IDs that form the trumping hierarchy. | - |
createdAt | string(date-time) | true | The International Organization for Standardization (ISO) 8601 date and time when the HCC was created. | - |
updatedAt | string(date-time) | true | The ISO 8601 date and time when the HCC was updated. | - |
HccPublicApi_Entities_V1_Reference_ConceptReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
contextId | string | true | The ID of the context. | - |
name | string | false | A human-readable description of the concept. | - |
alias | string | true | The string that is unique in the scope of a context that identifies this concept. | - |
RiskAdjustmentModels
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [HccPublicApi_Entities_V1_Reference_RiskAdjustmentModel] | 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. | - |
HccPublicApi_Entities_V1_Reference_RiskAdjustmentModel
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the risk adjustment model. | - |
type | string | true | The type of HCC risk adjustment model, which includes the following models:
|
CMS-HCC, HHS-HCC, ESRD-HCC |
name | string | true | The user-friendly name for the risk adjustment model. | - |
version | string | true | The version of the risk adjustment model’s specification. | - |
year | integer(int32) | true | The year that is the target of the risk adjustment model’s specification. | - |
createdAt | string(date-time) | true | The International Organization for Standardization (ISO) 8601 date and time when the risk adjustment model was created. | - |
updatedAt | string(date-time) | true | The ISO 8601 date and time when the risk adjustment model was updated. | - |
postSuppressionReasons
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
createdBy | object | false | A representation of the individual who entered the suppression into the system. | - |
» id | string | true | The unique ID for the individual who entered the suppression reason into the system. | - |
display | string | true | The reason for the suppression. The maximum length is 256 characters. | - |
HccPublicApi_Entities_V1_Suppression_SuppressionReason
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | false | The ID of the suppression reason. | - |
display | string | false | The display value of the suppression reason. The maximum length is 256 characters. | - |
status | string | true | The status of the suppression reason. | ACTIVE, INACTIVE |
createdAt | string | false | The date and time when the suppression reason was initially entered into the system. In ISO 8601 formatting with precision down to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2018-02-13T20:41:18.181Z. The time in this field is set automatically when the suppression reason is first created; therefore, the field does not need to be set explicitly. | - |
createdBy | HccPublicApi_Entities_V1_Suppression_PersonnelReference | false | The individual who entered the suppression reason into the system. | - |
updatedAt | string | false | The date and time when the suppression reason was last modified. In ISO 8601 formatting with precision down to the millisecond (YYYY-MM-DDTHH:mm:ss.sssZ), for example, 2018-02-13T20:41:18.181Z. The time in this field is set automatically every time the suppression reason is modified; therefore, the field does not need to be set explicitly. When the suppression reason is first created, the value of the updatedAt field is set by the service and matches the value in the createdAt field. | - |
updatedBy | HccPublicApi_Entities_V1_Suppression_PersonnelReference | false | The individual who last modified the suppression in the system. When the suppression reason is first created, the value in the updatedBy field is set by the service and matches the createdBy field. | - |
HccPublicApi_Entities_V1_Suppression_PersonnelReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The ID of the personnel member within the tenant. | - |
SuppressionReasons
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [HccPublicApi_Entities_V1_Suppression_SuppressionReason] | 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. | - |
putSuppressionReasons
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
updatedBy | object | false | A representation of the individual who entered the suppression into the system. | - |
» id | string | true | The unique ID for the individual who entered the suppression reason into the system. | - |
display | string | true | The reason for the suppression. The maximum length is 256 characters. | - |
active | string | false | The status of the suppression reason. Note: This field is deprecated in favor of the status field. The active field is ignored if the status field is included. | ACTIVE, INACTIVE |
status | string | true | The status of the suppression reason. Required if the active field is not included. | ACTIVE, INACTIVE |
postTags
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
resource | object | true | A resource in the HCC service that is the focus of the tag. | - |
» type | string | true | The resource type. | CONFIGURATION, CONFIGURATION_INSTANCE, PIPELINE |
» id | string | true | The resource ID. | - |
key | string | true | The key value of the tag. The maximum length is 128 characters. | - |
value | string | false | The value of the tag. The maximum length is 256 characters. | - |
HccPublicApi_Entities_V1_Configuration_Tag
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The tag ID. | - |
resource | HccPublicApi_Entities_V1_Configuration_ResourceReference | true | The resource reference for a tag. | - |
key | string | true | The key for a tag. | - |
value | string | false | The value for a tag. | - |
HccPublicApi_Entities_V1_Configuration_ResourceReference
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
type | string | true | The resource type. | SUPPRESSION_REASON, PIPELINE |
id | string | true | The resource ID. | - |
Tags
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [HccPublicApi_Entities_V1_Configuration_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. | - |
postMorDataUploads
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
morFile | string | true | The file containing the MOR data. The file must be formatted according to CMS specifications. See section 7.1 of the Plan Communication User Guide for more information. Note: Cerner currently supports versions 10.0 through 14.0 of the CMS specifications. | - |
createdBy | string | false | The ID of the personnel who is uploading the MOR data file. | - |
postMmrDataUploads
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
mmrFile | string | true | The file containing the MMR data. The file must be formatted according to CMS specifications. See section 6.6.1 of the Plan Communication User Guide for more information. Note: Cerner currently supports versions 10.0 through 14.0 of the CMS specifications. | - |
createdBy | string | false | The ID of the personnel who is uploading the MMR data file. | - |