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",
      "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"
      }
    }
  ],
  "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

Retrieves a list of risk assessments for the specified patient identifier.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path string true N/A The identifier of the population. -
patientId path string true N/A The identifier of the patient within the population. -
type query string false N/A The type system and type code used for filtering risk assessments. Must be in the 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 RiskAssessmentSummaries
400 Bad Request Bad request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Resource not found Error

Retrieve a Single Risk Assessment

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",
  "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}

Retrieves a single risk assessment.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path string true N/A The identifier of the population. -
riskAssessmentId path string true N/A The unique identifier for 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 Resource not found Error

Retrieve a List of Risk Assessments

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",
      "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"
      }
    }
  ],
  "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

Retrieves a list of risk assessments.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path string true N/A The identifier of the population. -
patientId query array[string] false N/A Filters by a list of patients that risk assessments are associated with, up to a limit of 20 patients. -
type query string false N/A The type system and type code used for filtering risk assessments. Must be in the 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 RiskAssessmentSummaries
400 Bad Request Bad request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Resource not found Error

Schema Definitions

RiskAssessmentSummaries

Name Type Required Description Accepted Values
items [RiskAssessmentSummary] true No description -
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. -

RiskAssessmentSummary

Name Type Required Description Accepted Values
id string true An ID that uniquely identifies the risk assessment. -
patient PatientReference true The patient associated with the 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, such as abnormal, normal, high, low, or critical. -

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

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

RiskAssessment

Name Type Required Description Accepted Values
id string true An ID that uniquely identifies the risk assessment. -
patient PatientReference true The patient associated with the 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, such as abnormal, normal, high, low, or critical. -
basis [Basis] false Source data considered in the assessment of the risk. -
factors [Factor] false The factor is a variable or characteristic used by the assessment method to calculate risk. It is currently necessary to consult the method (for example, synapse algorithm) requirements to understand what factors may be returned and their meaning. For example, see Clinical Standard Registry Requirements on the uCern Wiki for more information. -

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 It is a name which represents the factor. -
value string true The string representation of the factor’s value. This value string can represent a number, boolean, string, or any other simple data type. -
Ruby Shell