NAV Navbar
Logo cerner
Ruby Shell

Risk Assessment API v1

The HealtheIntent Risk Assessment API allows systems to interact with risk assessment data in HealtheIntent.

Note: The data retrieved by this API is 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.healtheintent.com/risk-assessment/v1

Risk Assessment

A risk assessment represents the quantified likelihood of certain outcomes for a patient, for example, the risk of potentially preventable encounters (PPEs) or the likelihood that a patient might suffer from cardiac arrest. In addition to the type, a risk assessment includes attributes that indicate the method used to inform the assessment and the condition if the assessment pertains to one.

Retrieve a List of Risk Assessments 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.healtheintent.com/risk-assessment/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/106824bb-a35c-4870-97fa-145c7079bc2a/risk-assessments', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/risk-assessment/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/106824bb-a35c-4870-97fa-145c7079bc2a/risk-assessments \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "2fb52376-cadd-3a98-8181-61cb77fdc3a3",
      "consumer": {
        "id": "db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"
      },
      "patient": {
        "id": "dd2cc519-caf5-4857-9f07-b12741bb5f92",
        "populationId": "1424e81d-8cea-4d6b-b140-d6630b684a58"
      },
      "type": {
        "codings": [
          {
            "code": "161168008",
            "display": "Morbidity Prediction",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "161168008",
            "display": "Morbidity Prediction",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "Morbidity Prediction"
      },
      "method": {
        "codings": [
          {
            "code": "713678009",
            "display": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "713678009",
            "display": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score"
      },
      "condition": {
        "codings": [
          {
            "code": "230690007",
            "display": "Stroke",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "230690007",
            "display": "Stroke",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "Stroke"
      },
      "value": {
        "numeric": "2"
      },
      "assessedAt": "2018-07-18T17:10:00.000Z",
      "interpretation": {
        "codings": [
          {
            "code": "15508007",
            "display": "High Risk",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "15508007",
            "display": "High Risk",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "High Risk"
      },
      "basis": [
        {
          "id": "e8f0de42-2e4b-11e9-b210-d663bd873d93",
          "kind": "observation#observation"
        },
        {
          "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
          "kind": "condition#condition"
        }
      ],
      "factors": [
        {
          "name": "bmi_last_six_months",
          "value": "26.7"
        },
        {
          "name": "comorbidity_index",
          "value": "13"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/risk-assessment/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/106824bb-a35c-4870-97fa-145c7079bc2a/risk-assessments?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/risk-assessment/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/106824bb-a35c-4870-97fa-145c7079bc2a/risk-assessments?offset=0&limit=20"
}

GET /populations/{populationId}/patients/{patientId}/risk-assessments

This endpoint retrieves a list of risk assessments for the specified patient ID. Note: Currently, this endpoint returns only risk assessments that are generated by the platform; it does not return risk assessments that were contributed using the POST request. To retrieve contributed risk assessments, use the tenant-only endpoints. In the future, Cerner will integrate these endpoints so that only one or the other is needed.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path string true N/A The ID of the population. -
patientId path string true N/A The ID of the patient in the population. -
type query string false N/A The type of system and code used for filtering risk assessments. It must be in the following format: {typeSystem}|{typeCode}. Filtering applies to both codings and source codings. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

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

Retrieve a Single Risk Assessment by Population and ID

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.healtheintent.com/risk-assessment/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/risk-assessments/2fb52376-cadd-3a98-8181-61cb77fdc3a3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/risk-assessment/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/risk-assessments/2fb52376-cadd-3a98-8181-61cb77fdc3a3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "2fb52376-cadd-3a98-8181-61cb77fdc3a3",
  "consumer": {
    "id": "db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"
  },
  "patient": {
    "id": "dd2cc519-caf5-4857-9f07-b12741bb5f92",
    "populationId": "1424e81d-8cea-4d6b-b140-d6630b684a58"
  },
  "type": {
    "codings": [
      {
        "code": "161168008",
        "display": "Morbidity Prediction",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "sourceCodings": [
      {
        "code": "161168008",
        "display": "Morbidity Prediction",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "text": "Morbidity Prediction"
  },
  "method": {
    "codings": [
      {
        "code": "713678009",
        "display": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "sourceCodings": [
      {
        "code": "713678009",
        "display": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "text": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score"
  },
  "condition": {
    "codings": [
      {
        "code": "230690007",
        "display": "Stroke",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "sourceCodings": [
      {
        "code": "230690007",
        "display": "Stroke",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "text": "Stroke"
  },
  "value": {
    "numeric": "2"
  },
  "assessedAt": "2018-07-18T17:10:00.000Z",
  "interpretation": {
    "codings": [
      {
        "code": "15508007",
        "display": "High Risk",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "sourceCodings": [
      {
        "code": "15508007",
        "display": "High Risk",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "text": "High Risk"
  },
  "basis": [
    {
      "id": "e8f0de42-2e4b-11e9-b210-d663bd873d93",
      "kind": "observation#observation"
    },
    {
      "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
      "kind": "condition#condition"
    }
  ],
  "factors": [
    {
      "name": "bmi_last_six_months",
      "value": "26.7"
    },
    {
      "name": "comorbidity_index",
      "value": "13"
    }
  ]
}

GET /populations/{populationId}/risk-assessments/{riskAssessmentId}

This endpoint retrieves a single risk assessment by population and ID. Note: Currently, this endpoint returns only risk assessments that are generated by the platform; it does not return risk assessments that were contributed using the POST request. To retrieve contributed risk assessments, use the tenant-only endpoints. In the future, Cerner will integrate these endpoints so that only one or the other is needed.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path string true N/A The ID of the population. -
riskAssessmentId path string true N/A The unique ID of the risk assessment. -

Response Statuses

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

Retrieve a List of Risk Assessments by Population

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.healtheintent.com/risk-assessment/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/risk-assessments', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/risk-assessment/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/risk-assessments \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "2fb52376-cadd-3a98-8181-61cb77fdc3a3",
      "consumer": {
        "id": "db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"
      },
      "patient": {
        "id": "dd2cc519-caf5-4857-9f07-b12741bb5f92",
        "populationId": "1424e81d-8cea-4d6b-b140-d6630b684a58"
      },
      "type": {
        "codings": [
          {
            "code": "161168008",
            "display": "Morbidity Prediction",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "161168008",
            "display": "Morbidity Prediction",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "Morbidity Prediction"
      },
      "method": {
        "codings": [
          {
            "code": "713678009",
            "display": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "713678009",
            "display": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score"
      },
      "condition": {
        "codings": [
          {
            "code": "230690007",
            "display": "Stroke",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "230690007",
            "display": "Stroke",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "Stroke"
      },
      "value": {
        "numeric": "2"
      },
      "assessedAt": "2018-07-18T17:10:00.000Z",
      "interpretation": {
        "codings": [
          {
            "code": "15508007",
            "display": "High Risk",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "15508007",
            "display": "High Risk",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "High Risk"
      },
      "basis": [
        {
          "id": "e8f0de42-2e4b-11e9-b210-d663bd873d93",
          "kind": "observation#observation"
        },
        {
          "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
          "kind": "condition#condition"
        }
      ],
      "factors": [
        {
          "name": "bmi_last_six_months",
          "value": "26.7"
        },
        {
          "name": "comorbidity_index",
          "value": "13"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/risk-assessment/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/risk-assessments?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/risk-assessment/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/risk-assessments?offset=0&limit=20"
}

GET /populations/{populationId}/risk-assessments

This endpoint retrieves a list of risk assessments by population. Note: Currently, this endpoint returns only risk assessments that are generated by the platform; it does not return risk assessments that were contributed using the POST request. To retrieve contributed risk assessments, use the tenant-only endpoints. In the future, Cerner will integrate these endpoints so that only one or the other is needed.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path string true N/A The ID of the population. -
patientId query array[string] false N/A Filters by a list of patients that risk assessments are associated with of up to 20 patients. -
type query string false N/A The type system and type code used for filtering risk assessments. This must be in the following format: {typeSystem}|{typeCode}. Filtering applies to both codings and source codings. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

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

Create a Risk Assessment

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.healtheintent.com/risk-assessment/v1/risk-assessments', headers: headers, body: {"riskAssessments":[{"consumer":{"id":"db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"},"patient":{"id":"dd2cc519-caf5-4857-9f07-b12741bb5f92","populationId":"1424e81d-8cea-4d6b-b140-d6630b684a58"},"type":{"codings":[{"code":"161168008","display":"Morbidity Prediction","system":"2.16.840.1.113883.6.96"}],"sourceCodings":[{"code":"161168008","display":"Morbidity Prediction","system":"2.16.840.1.113883.6.96"}],"text":"Morbidity Prediction"},"method":{"codings":[{"code":"713678009","display":"Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score","system":"2.16.840.1.113883.6.96"}],"sourceCodings":[{"code":"713678009","display":"Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score","system":"2.16.840.1.113883.6.96"}],"text":"Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score"},"condition":{"codings":[{"code":"230690007","display":"Stroke","system":"2.16.840.1.113883.6.96"}],"sourceCodings":[{"code":"230690007","display":"Stroke","system":"2.16.840.1.113883.6.96"}],"text":"Stroke"},"value":{"numeric":"2"},"assessedAt":"2018-07-18T17:10:00.000Z","interpretation":{"codings":[{"code":"15508007","display":"High Risk","system":"2.16.840.1.113883.6.96"}],"sourceCodings":[{"code":"15508007","display":"High Risk","system":"2.16.840.1.113883.6.96"}],"text":"High Risk"},"basis":[{"id":"e8f0de42-2e4b-11e9-b210-d663bd873d93","kind":"observation#observation"},{"id":"e8f0e126-2e4b-11e9-b210-d663bd873d93","kind":"condition#condition"}],"factors":[{"name":"bmi_last_six_months","value":"26.7"},{"name":"comorbidity_index","value":"13"}]}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/risk-assessment/v1/risk-assessments \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"riskAssessments":[{"consumer":{"id":"db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"},"patient":{"id":"dd2cc519-caf5-4857-9f07-b12741bb5f92","populationId":"1424e81d-8cea-4d6b-b140-d6630b684a58"},"type":{"codings":[{"code":"161168008","display":"Morbidity Prediction","system":"2.16.840.1.113883.6.96"}],"sourceCodings":[{"code":"161168008","display":"Morbidity Prediction","system":"2.16.840.1.113883.6.96"}],"text":"Morbidity Prediction"},"method":{"codings":[{"code":"713678009","display":"Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score","system":"2.16.840.1.113883.6.96"}],"sourceCodings":[{"code":"713678009","display":"Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score","system":"2.16.840.1.113883.6.96"}],"text":"Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score"},"condition":{"codings":[{"code":"230690007","display":"Stroke","system":"2.16.840.1.113883.6.96"}],"sourceCodings":[{"code":"230690007","display":"Stroke","system":"2.16.840.1.113883.6.96"}],"text":"Stroke"},"value":{"numeric":"2"},"assessedAt":"2018-07-18T17:10:00.000Z","interpretation":{"codings":[{"code":"15508007","display":"High Risk","system":"2.16.840.1.113883.6.96"}],"sourceCodings":[{"code":"15508007","display":"High Risk","system":"2.16.840.1.113883.6.96"}],"text":"High Risk"},"basis":[{"id":"e8f0de42-2e4b-11e9-b210-d663bd873d93","kind":"observation#observation"},{"id":"e8f0e126-2e4b-11e9-b210-d663bd873d93","kind":"condition#condition"}],"factors":[{"name":"bmi_last_six_months","value":"26.7"},{"name":"comorbidity_index","value":"13"}]}]}

POST /risk-assessments

This endpoint creates a new risk assessment for a HealtheIntent tenant.

Parameters

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

Response Statuses

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

Retrieve a List of Risk Assessments for a Tenant

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.healtheintent.com/risk-assessment/v1/risk-assessments', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "2fb52376-cadd-3a98-8181-61cb77fdc3a3",
      "consumer": {
        "id": "db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"
      },
      "patient": {
        "id": "dd2cc519-caf5-4857-9f07-b12741bb5f92",
        "populationId": "1424e81d-8cea-4d6b-b140-d6630b684a58"
      },
      "type": {
        "codings": [
          {
            "code": "161168008",
            "display": "Morbidity Prediction",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "161168008",
            "display": "Morbidity Prediction",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "Morbidity Prediction"
      },
      "method": {
        "codings": [
          {
            "code": "713678009",
            "display": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "713678009",
            "display": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score"
      },
      "condition": {
        "codings": [
          {
            "code": "230690007",
            "display": "Stroke",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "230690007",
            "display": "Stroke",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "Stroke"
      },
      "value": {
        "numeric": "2"
      },
      "assessedAt": "2018-07-18T17:10:00.000Z",
      "interpretation": {
        "codings": [
          {
            "code": "15508007",
            "display": "High Risk",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "15508007",
            "display": "High Risk",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "High Risk"
      },
      "basis": [
        {
          "id": "e8f0de42-2e4b-11e9-b210-d663bd873d93",
          "kind": "observation#observation"
        },
        {
          "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
          "kind": "condition#condition"
        }
      ],
      "factors": [
        {
          "name": "bmi_last_six_months",
          "value": "26.7"
        },
        {
          "name": "comorbidity_index",
          "value": "13"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/risk-assessment/v1/risk-assessments?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/risk-assessment/v1/risk-assessments?offset=0&limit=20"
}

GET /risk-assessments

This endpoint retrieves a list of all of the available risk assessments for a HealtheIntent tenant. Note: Currently, this endpoint returns only risk assessments that are contributed to the platform using the POST request; it does not return risk assessments that were generated by the platform itself. To retrieve those risk assessments, use the population-based endpoints. In the future, Cerner will integrate these endpoints so that only one or the other is needed.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId query array[string] false N/A The ID of the consumer associated with the risk assessment. -
patient query array[string] false N/A The patient ID and population ID used for filtering risk assessments. It must be in the following format: {patientId}|{populationId}. -
type query array[string] false N/A The type of system and code used for filtering risk assessments. It must be in the following format: {typeSystem}|{typeCode}. Filtering applies to both codings and source codings. -
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 Success RiskAssessments
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Remove a Risk Assessment for a Tenant

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.healtheintent.com/risk-assessment/v1/risk-assessments/2fb52376-cadd-3a98-8181-61cb77fdc3a3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/risk-assessment/v1/risk-assessments/2fb52376-cadd-3a98-8181-61cb77fdc3a3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /risk-assessments/{riskAssessmentId}

This endpoint removes a risk assessment for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Risk Assessment for a Tenant

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.healtheintent.com/risk-assessment/v1/risk-assessments/2fb52376-cadd-3a98-8181-61cb77fdc3a3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/risk-assessment/v1/risk-assessments/2fb52376-cadd-3a98-8181-61cb77fdc3a3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "2fb52376-cadd-3a98-8181-61cb77fdc3a3",
  "consumer": {
    "id": "db4bd317-68f5-4a2c-ba9d-cc291e2f08f1"
  },
  "patient": {
    "id": "dd2cc519-caf5-4857-9f07-b12741bb5f92",
    "populationId": "1424e81d-8cea-4d6b-b140-d6630b684a58"
  },
  "type": {
    "codings": [
      {
        "code": "161168008",
        "display": "Morbidity Prediction",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "sourceCodings": [
      {
        "code": "161168008",
        "display": "Morbidity Prediction",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "text": "Morbidity Prediction"
  },
  "method": {
    "codings": [
      {
        "code": "713678009",
        "display": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "sourceCodings": [
      {
        "code": "713678009",
        "display": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "text": "Congestive heart failure, hypertension, age 75 years or older, diabetes, previous stroke or transient ischemic attack, vascular disease, age 65-74 years, and sex category risk score"
  },
  "condition": {
    "codings": [
      {
        "code": "230690007",
        "display": "Stroke",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "sourceCodings": [
      {
        "code": "230690007",
        "display": "Stroke",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "text": "Stroke"
  },
  "value": {
    "numeric": "2"
  },
  "assessedAt": "2018-07-18T17:10:00.000Z",
  "interpretation": {
    "codings": [
      {
        "code": "15508007",
        "display": "High Risk",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "sourceCodings": [
      {
        "code": "15508007",
        "display": "High Risk",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "text": "High Risk"
  },
  "basis": [
    {
      "id": "e8f0de42-2e4b-11e9-b210-d663bd873d93",
      "kind": "observation#observation"
    },
    {
      "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
      "kind": "condition#condition"
    }
  ],
  "factors": [
    {
      "name": "bmi_last_six_months",
      "value": "26.7"
    },
    {
      "name": "comorbidity_index",
      "value": "13"
    }
  ]
}

GET /risk-assessments/{riskAssessmentId}

This endpoint retrieves a risk assessment for a HealtheIntent tenant. Note: Currently, this endpoint returns only risk assessments that are contributed to the platform using the POST request; it does not return risk assessments that were generated by the platform itself. To retrieve those risk assessments, use the population-based endpoints. In the future, the plan is to integrate these endpoints so that only one or the other is needed.

Parameters

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

Response Statuses

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

Schema Definitions

RiskAssessments

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

RiskAssessment

Name Type Required Description Accepted Values
id string true The unique ID of the risk assessment. -
consumer ConsumerReference false The consumer associated with the risk assessment. Either a patient or a consumer must be associated with a risk assessment. -
patient PatientReference false The patient associated with the risk assessment. Either a patient or a consumer must be associated with a risk assessment. -
type CodeableConcept true The type of risk assessment performed. -
method CodeableConcept false The algorithm, process, or mechanism used to evaluate the risk. -
condition CodeableConcept false The condition assessed if the assessment or prognosis is specific to a condition. -
value Value false The value of the risk assessment performed. -
assessedAt string true The date or date and time when the risk score was created or recorded, in ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
interpretation CodeableConcept false A categorization of the measurement value that indicates normalcy, for example, abnormal, normal, high, low, or critical. -
basis [Basis] false The source data considered in the assessment of the risk. -
factors [Factor] false A variable or characteristic used by the assessment method to calculate risk. It is currently necessary to consult the method (for example, HealtheIntent program algorithm) requirements to understand what factors may be returned and their meaning. For example, see Clinical Standard Registry Requirements on Cerner Wiki for the requirements for the Clinical Standard Registries program. -

ConsumerReference

Name Type Required Description Accepted Values
id string true The ID of the consumer. -

PatientReference

Name Type Required Description Accepted Values
id string false The ID of the patient within the population. -
populationId string false The ID of the population for the patient. -

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

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

Value

Name Type Required Description Accepted Values
numeric string true The raw risk score expressed as a decimal. -

Basis

Name Type Required Description Accepted Values
id string true The ID of the referenced resource. -
kind string true The type of the basis considered for the assessment. -

Factor

Name Type Required Description Accepted Values
name string true A name that represents the factor. -
value string true The string representation of the factor’s value. This string can represent a number, Boolean, string, or any other simple data type. -

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

postRiskAssessments

Name Type Required Description Accepted Values
riskAssessments [object] true A list of risk assessments to be created. -
» assessedAt string true The date or date and time when the risk score was created or recorded, in ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
» consumer [object] false The consumer associated with the risk assessment. Either a patient or a consumer must be associated with a risk assessment. -
»» id string true The ID of the consumer. -
» patient [object] false The patient associated with the risk assessment. Either a patient or a consumer must be associated with a risk assessment. -
»» id string true The ID of the patient associated with the risk assessment. -
»» populationId string true The ID of the population. -
» type [object] true The type of risk assessment performed. -
»» 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. -
»» codings [object] false A list of codified values from the standard code systems recognized by HealtheIntent. -
»»» code string true The unique ID of the code. -
»»» system string true The ID of the coding system that gives meaning to the code. -
»»» display string false A human-readable representation of the code. -
»» sourceCodings [object] false The list of codified values provided in the source data. Not all of these codes are available on the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by HealtheIntent. -
»»» code string true The unique ID of the code. -
»»» system string true The ID of the coding system that gives meaning to the code. -
»»» display string false A human-readable representation of the code. -
» method [object] false The algorithm, process, or mechanism used to evaluate the risk. -
»» 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. -
»» codings [object] false A list of codified values from standard code systems recognized by HealtheIntent. -
»»» code string true The unique ID of the code. -
»»» system string true The ID of the coding system that gives meaning to the code. -
»»» display string false A human-readable representation of the code. -
»» sourceCodings [object] false 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. -
»»» code string true The unique ID of the code. -
»»» system string true The ID of the coding system that gives meaning to the code. -
»»» display string false A human-readable representation of the code. -
» condition [object] false The condition assessed if the assessment or prognosis is specific to a condition. -
»» 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. -
»» codings [object] false A list of codified values from standard code systems recognized by HealtheIntent. -
»»» code string true The unique ID of the code. -
»»» system string true The ID of the coding system that gives meaning to the code. -
»»» display string false A human-readable representation of the code. -
»» sourceCodings [object] false 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. -
»»» code string true The unique ID of the code. -
»»» system string true The ID of the coding system that gives meaning to the code. -
»»» display string false A human-readable representation of the code. -
» interpretation [object] false A categorization of the measurement value that indicates normalcy, for example, abnormal, normal, high, low, or critical. -
»» 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. -
»» codings [object] false A list of codified values from standard code systems recognized by HealtheIntent. -
»»» code string true The unique ID of the code. -
»»» system string true The ID of the coding system that gives meaning to the code. -
»»» display string false A human-readable representation of the code. -
»» sourceCodings [object] false 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. -
»»» code string true The unique ID of the code. -
»»» system string true The ID of the coding system that gives meaning to the code. -
»»» display string false A human-readable representation of the code. -
» basis [object] false The source data considered in the assessment of the risk. -
»» id string true The ID of the referenced resource. -
»» kind string true The type of the basis considered for the assessment. -
» factors [object] false A variable or characteristic used by the assessment method to calculate risk. It is currently necessary to consult the method (for example, HealtheIntent program algorithm) requirements to understand what factors may be returned and their meaning. For example, see Clinical Standard Registry Requirements on Cerner Wiki for the requirements for the Clinical Standard Registries program. -
»» name string true The name that represents the factor. -
»» value string true The value of the factor. The value can be a string representation of a number or Boolean. -
» value [object] false The value of the risk assessment performed. -
»» numeric string true The raw risk score expressed as a decimal. -

RiskAssessmentList

Name Type Required Description Accepted Values
riskAssessments [RiskAssessment] false A list of risk assessments to be created. -