NAV
Ruby Shell

Risk Assessment API v1

The Oracle Health Data Intelligence Risk Assessment API allows systems to interact with risk assessment data in Health Data Intelligence.

Notes:

URL: https://cernerdemo.api.us-1.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-1.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-1.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",
          "contribution": 0.12,
          "basis": [
            {
              "id": "52d69013-5b75-46b1-831a-4f0416806095",
              "kind": "encounter#encounter",
              "sourceId": "115012fd-9a33-4a44-80bf-86b8e1ed2dc0",
              "codings": [],
              "sourceCodings": []
            },
            {
              "id": "d9219057-a7aa-4614-8e62-2d31eb364d2b",
              "kind": "condition#condition",
              "sourceId": "",
              "codings": [
                {
                  "code": "84114007",
                  "display": "Heart failure",
                  "system": "2.16.840.1.113883.6.96"
                }
              ],
              "sourceCodings": [
                {
                  "code": "",
                  "display": "Heart failure",
                  "system": ""
                }
              ]
            }
          ]
        },
        {
          "name": "comorbidity_index",
          "value": "13",
          "contribution": 0.15,
          "basis": [
            {
              "id": "94465bf9-9216-488e-b381-a60daaa4fb69",
              "kind": "observation#observation",
              "sourceId": "ccf5f3e5-7db4-4935-b0af-fffc924285b4",
              "codings": [],
              "sourceCodings": []
            },
            {
              "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
              "kind": "condition#condition",
              "sourceId": "778e6de4-2b9d-4060-9ac2-b4a04b4ee034",
              "codings": [
                {
                  "code": "84114007",
                  "display": "Heart failure",
                  "system": "2.16.840.1.113883.6.96"
                }
              ],
              "sourceCodings": [
                {
                  "code": "",
                  "display": "Heart failure",
                  "system": ""
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.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-1.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 the platform generates; 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, Oracle plans to 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 Not applicable The ID of the population. -
patientId path string true Not applicable The ID of the patient in the population. -
type query string false Not applicable 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 paging). The minimum offset is 0. No maximum offset is applicable. -
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-1.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-1.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",
      "contribution": 0.12,
      "basis": [
        {
          "id": "52d69013-5b75-46b1-831a-4f0416806095",
          "kind": "encounter#encounter",
          "sourceId": "115012fd-9a33-4a44-80bf-86b8e1ed2dc0",
          "codings": [],
          "sourceCodings": []
        },
        {
          "id": "d9219057-a7aa-4614-8e62-2d31eb364d2b",
          "kind": "condition#condition",
          "sourceId": "",
          "codings": [
            {
              "code": "84114007",
              "display": "Heart failure",
              "system": "2.16.840.1.113883.6.96"
            }
          ],
          "sourceCodings": [
            {
              "code": "",
              "display": "Heart failure",
              "system": ""
            }
          ]
        }
      ]
    },
    {
      "name": "comorbidity_index",
      "value": "13",
      "contribution": 0.15,
      "basis": [
        {
          "id": "94465bf9-9216-488e-b381-a60daaa4fb69",
          "kind": "observation#observation",
          "sourceId": "ccf5f3e5-7db4-4935-b0af-fffc924285b4",
          "codings": [],
          "sourceCodings": []
        },
        {
          "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
          "kind": "condition#condition",
          "sourceId": "778e6de4-2b9d-4060-9ac2-b4a04b4ee034",
          "codings": [
            {
              "code": "84114007",
              "display": "Heart failure",
              "system": "2.16.840.1.113883.6.96"
            }
          ],
          "sourceCodings": [
            {
              "code": "",
              "display": "Heart failure",
              "system": ""
            }
          ]
        }
      ]
    }
  ]
}

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 the platform generates; 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, Oracle plans to 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 Not applicable The ID of the population. -
riskAssessmentId path string true Not applicable 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 Detailed 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-1.healtheintent.com/risk-assessment/v1/populations/{populationId}/risk-assessments/full', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/risk-assessment/v1/populations/{populationId}/risk-assessments/full \
-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",
          "contribution": 0.12,
          "basis": [
            {
              "id": "52d69013-5b75-46b1-831a-4f0416806095",
              "kind": "encounter#encounter",
              "sourceId": "115012fd-9a33-4a44-80bf-86b8e1ed2dc0",
              "codings": [],
              "sourceCodings": []
            },
            {
              "id": "d9219057-a7aa-4614-8e62-2d31eb364d2b",
              "kind": "condition#condition",
              "sourceId": "",
              "codings": [
                {
                  "code": "84114007",
                  "display": "Heart failure",
                  "system": "2.16.840.1.113883.6.96"
                }
              ],
              "sourceCodings": [
                {
                  "code": "",
                  "display": "Heart failure",
                  "system": ""
                }
              ]
            }
          ],
          "supportingDataPoints": {
            "conditions": [
              {
                "id": "condition_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "date": "2018-07-18T17:10:00.000Z"
              }
            ],
            "encounters": [
              {
                "id": "encounters_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "startDate": "2018-07-18T17:10:00.000Z",
                "endDate": "2018-07-18T17:10:00.000Z"
              }
            ],
            "inferredEncounters": [
              {
                "id": "inferred_encounters_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "startDate": "2018-07-18T17:10:00.000Z",
                "endDate": "2018-07-18T17:10:00.000Z"
              }
            ],
            "results": [
              {
                "id": "results_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "date": "2018-07-18T17:10:00.000Z"
              }
            ],
            "allergies": [
              {
                "id": "allergies_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "startDate": "2018-07-18T17:10:00.000Z",
                "endDate": "2018-07-18T17:10:00.000Z"
              }
            ],
            "medications": [
              {
                "id": "medications_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "startDate": "2018-07-18T17:10:00.000Z",
                "endDate": "2018-07-18T17:10:00.000Z"
              }
            ],
            "immunizations": [
              {
                "id": "immunizations_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "date": "2018-07-18T17:10:00.000Z"
              }
            ],
            "questionnaireQuestions": [
              {
                "id": "questionnaire_question_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "date": "2018-07-18T17:10:00.000Z"
              }
            ],
            "documentReferences": [
              {
                "id": "document_reference_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "date": "2018-07-18T17:10:00.000Z"
              }
            ],
            "procedures": [
              {
                "id": "procedures_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "startDate": "2018-07-18T17:10:00.000Z",
                "endDate": "2018-07-18T17:10:00.000Z"
              }
            ]
          }
        },
        {
          "name": "comorbidity_index",
          "value": "13",
          "contribution": 0.15,
          "basis": [
            {
              "id": "94465bf9-9216-488e-b381-a60daaa4fb69",
              "kind": "observation#observation",
              "sourceId": "ccf5f3e5-7db4-4935-b0af-fffc924285b4",
              "codings": [],
              "sourceCodings": []
            },
            {
              "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
              "kind": "condition#condition",
              "sourceId": "778e6de4-2b9d-4060-9ac2-b4a04b4ee034",
              "codings": [
                {
                  "code": "84114007",
                  "display": "Heart failure",
                  "system": "2.16.840.1.113883.6.96"
                }
              ],
              "sourceCodings": [
                {
                  "code": "",
                  "display": "Heart failure",
                  "system": ""
                }
              ]
            }
          ],
          "supportingDataPoints": {
            "conditions": [
              {
                "id": "condition_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "date": "2018-07-18T17:10:00.000Z"
              }
            ],
            "encounters": [
              {
                "id": "encounters_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "startDate": "2018-07-18T17:10:00.000Z",
                "endDate": "2018-07-18T17:10:00.000Z"
              }
            ],
            "inferred_encounters": [
              {
                "id": "inferred_encounters_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "startDate": "2018-07-18T17:10:00.000Z",
                "endDate": "2018-07-18T17:10:00.000Z"
              }
            ],
            "results": [
              {
                "id": "results_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "date": "2018-07-18T17:10:00.000Z"
              }
            ],
            "allergies": [
              {
                "id": "allergies_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "startDate": "2018-07-18T17:10:00.000Z",
                "endDate": "2018-07-18T17:10:00.000Z"
              }
            ],
            "medications": [
              {
                "id": "medications_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "startDate": "2018-07-18T17:10:00.000Z",
                "endDate": "2018-07-18T17:10:00.000Z"
              }
            ],
            "immunizations": [
              {
                "id": "immunizations_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "date": "2018-07-18T17:10:00.000Z"
              }
            ],
            "questionnaire_question": [
              {
                "id": "questionnaire_question_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "date": "2018-07-18T17:10:00.000Z"
              }
            ],
            "document_reference": [
              {
                "id": "document_reference_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "date": "2018-07-18T17:10:00.000Z"
              }
            ],
            "procedures": [
              {
                "id": "procedures_uuid_1",
                "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"
                  }
                ],
                "source": {
                  "id": "sample-source-id",
                  "type": "SOURCE_TYPE",
                  "organizationName": "ORGANIZATION_NAME"
                },
                "startDate": "2018-07-18T17:10:00.000Z",
                "endDate": "2018-07-18T17:10:00.000Z"
              }
            ]
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/risk-assessment/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/risk-assessments/full?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/risk-assessment/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/risk-assessments/full?offset=0&limit=20"
}

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

This endpoint retrieves a detailed list of risk assessments by population.

Note: Currently, this endpoint returns only risk assessments that the platform generates; 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, Oracle plans to 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 Not applicable The ID of the population. -
patientId query array[string] false Not applicable Filters by a list of patients that risk assessments are associated with of up to 20 patients. -
type query string false Not applicable The type system and type code used for filtering risk assessments. This value 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 paging). The minimum offset is 0. No maximum offset is applicable. -
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 RiskAssessmentFull
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-1.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-1.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",
          "contribution": 0.12,
          "basis": [
            {
              "id": "52d69013-5b75-46b1-831a-4f0416806095",
              "kind": "encounter#encounter",
              "sourceId": "115012fd-9a33-4a44-80bf-86b8e1ed2dc0",
              "codings": [],
              "sourceCodings": []
            },
            {
              "id": "d9219057-a7aa-4614-8e62-2d31eb364d2b",
              "kind": "condition#condition",
              "sourceId": "",
              "codings": [
                {
                  "code": "84114007",
                  "display": "Heart failure",
                  "system": "2.16.840.1.113883.6.96"
                }
              ],
              "sourceCodings": [
                {
                  "code": "",
                  "display": "Heart failure",
                  "system": ""
                }
              ]
            }
          ]
        },
        {
          "name": "comorbidity_index",
          "value": "13",
          "contribution": 0.15,
          "basis": [
            {
              "id": "94465bf9-9216-488e-b381-a60daaa4fb69",
              "kind": "observation#observation",
              "sourceId": "ccf5f3e5-7db4-4935-b0af-fffc924285b4",
              "codings": [],
              "sourceCodings": []
            },
            {
              "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
              "kind": "condition#condition",
              "sourceId": "778e6de4-2b9d-4060-9ac2-b4a04b4ee034",
              "codings": [
                {
                  "code": "84114007",
                  "display": "Heart failure",
                  "system": "2.16.840.1.113883.6.96"
                }
              ],
              "sourceCodings": [
                {
                  "code": "",
                  "display": "Heart failure",
                  "system": ""
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/risk-assessment/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/risk-assessments?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.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 the platform generates; 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, Oracle plans to 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 Not applicable The ID of the population. -
patientId query array[string] false Not applicable Filters by a list of patients that risk assessments are associated with of up to 20 patients. -
type query string false Not applicable The type system and type code used for filtering risk assessments. This value 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 paging). The minimum offset is 0. No maximum offset is applicable. -
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-1.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","contribution":0.12},{"name":"comorbidity_index","value":"13","contribution":0.15}]}]}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us-1.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","contribution":0.12},{"name":"comorbidity_index","value":"13","contribution":0.15}]}]}

POST /risk-assessments

This endpoint creates a new risk assessment for a Health Data Intelligence tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postRiskAssessments true Not applicable 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-1.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-1.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",
          "contribution": 0.12,
          "basis": [
            {
              "id": "52d69013-5b75-46b1-831a-4f0416806095",
              "kind": "encounter#encounter",
              "sourceId": "115012fd-9a33-4a44-80bf-86b8e1ed2dc0",
              "codings": [],
              "sourceCodings": []
            },
            {
              "id": "d9219057-a7aa-4614-8e62-2d31eb364d2b",
              "kind": "condition#condition",
              "sourceId": "",
              "codings": [
                {
                  "code": "84114007",
                  "display": "Heart failure",
                  "system": "2.16.840.1.113883.6.96"
                }
              ],
              "sourceCodings": [
                {
                  "code": "",
                  "display": "Heart failure",
                  "system": ""
                }
              ]
            }
          ]
        },
        {
          "name": "comorbidity_index",
          "value": "13",
          "contribution": 0.15,
          "basis": [
            {
              "id": "94465bf9-9216-488e-b381-a60daaa4fb69",
              "kind": "observation#observation",
              "sourceId": "ccf5f3e5-7db4-4935-b0af-fffc924285b4",
              "codings": [],
              "sourceCodings": []
            },
            {
              "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
              "kind": "condition#condition",
              "sourceId": "778e6de4-2b9d-4060-9ac2-b4a04b4ee034",
              "codings": [
                {
                  "code": "84114007",
                  "display": "Heart failure",
                  "system": "2.16.840.1.113883.6.96"
                }
              ],
              "sourceCodings": [
                {
                  "code": "",
                  "display": "Heart failure",
                  "system": ""
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/risk-assessment/v1/risk-assessments?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/risk-assessment/v1/risk-assessments?offset=0&limit=20"
}

GET /risk-assessments

This endpoint retrieves a list of all available risk assessments for a Health Data Intelligence 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 the platform generated. To retrieve those risk assessments, use the population-based endpoints. In the future, Oracle plans to 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 Not applicable The ID of the consumer associated with the risk assessment. -
patient query array[string] false Not applicable The patient ID and population ID used for filtering risk assessments. This value must be in the following format: {populationId}|{patientId}. -
type query array[string] false Not applicable The type of system and code used for filtering risk assessments. This value 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 paging). The minimum offset is 0. No maximum offset is applicable. -
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-1.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-1.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 Health Data Intelligence tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content No Content RiskAssessment
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-1.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-1.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",
      "contribution": 0.12,
      "basis": [
        {
          "id": "52d69013-5b75-46b1-831a-4f0416806095",
          "kind": "encounter#encounter",
          "sourceId": "115012fd-9a33-4a44-80bf-86b8e1ed2dc0",
          "codings": [],
          "sourceCodings": []
        },
        {
          "id": "d9219057-a7aa-4614-8e62-2d31eb364d2b",
          "kind": "condition#condition",
          "sourceId": "",
          "codings": [
            {
              "code": "84114007",
              "display": "Heart failure",
              "system": "2.16.840.1.113883.6.96"
            }
          ],
          "sourceCodings": [
            {
              "code": "",
              "display": "Heart failure",
              "system": ""
            }
          ]
        }
      ]
    },
    {
      "name": "comorbidity_index",
      "value": "13",
      "contribution": 0.15,
      "basis": [
        {
          "id": "94465bf9-9216-488e-b381-a60daaa4fb69",
          "kind": "observation#observation",
          "sourceId": "ccf5f3e5-7db4-4935-b0af-fffc924285b4",
          "codings": [],
          "sourceCodings": []
        },
        {
          "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
          "kind": "condition#condition",
          "sourceId": "778e6de4-2b9d-4060-9ac2-b4a04b4ee034",
          "codings": [
            {
              "code": "84114007",
              "display": "Heart failure",
              "system": "2.16.840.1.113883.6.96"
            }
          ],
          "sourceCodings": [
            {
              "code": "",
              "display": "Heart failure",
              "system": ""
            }
          ]
        }
      ]
    }
  ]
}

GET /risk-assessments/{riskAssessmentId}

This endpoint retrieves a risk assessment for a Health Data Intelligence 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 the platform generated. To retrieve those risk assessments, use the population-based endpoints. In the future, Oracle plans 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 Not applicable 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

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 and time when the risk score was created or recorded, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
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, Health Data Intelligence program algorithm) requirements to understand what factors may be returned and their meaning. For example, see Clinical Standard Registry Requirements on Oracle Health 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 in 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 Health Data Intelligence. -
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 Health Data Intelligence does not recognize them. -
concepts [Concept] false The list of ontological concepts derived from the codified values from standard code systems recognized by Health Data Intelligence. -
text string false This value may be a localized or annotated description of the element provided by a source system. This value can also be 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. -

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

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. -
contribution number(float) false The weight of this factor’s contribution to the risk score value. -
basis [FactorBasis] false The list of bases supporting the factor. -

FactorBasis

Name Type Required Description Accepted Values
id string true The identification (ID) of the referenced resource. -
kind string true The type of the basis considered for the assessment. -
sourceId string false An ID that uniquely identifies the source data for the risk assessment factor. -
codings [Code] false A list of codified values from standard code systems recognized by Health Data Intelligence. -
sourceCodings [Code] 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 Health Data Intelligence does not recognize them. -

RiskAssessmentFull

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 and time when the risk score was created or recorded, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
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 [FactorFull] false A variable or characteristic used by the assessment method to calculate risk. It is currently necessary to consult the method (for example, Health Data Intelligence program algorithm) requirements to understand what factors may be returned and their meaning. For example, see Clinical Standard Registry Requirements on Oracle Health Wiki for the requirements for the Clinical Standard Registries program. -

FactorFull

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. -
contribution number(float) false The weight of this factor’s contribution to the risk score value. -
basis [FactorBasis] false The list of bases supporting the factor. -
supportingDataPoints SupportingDataPoints false One or more supporting data points that caused a factor to be aligned with a risk assessment. -
childFactors [ChildFactorFull] false Child factors contributing to this parent factor value. A factor with one or more child factors represents a factor category. -

SupportingDataPoints

Name Type Required Description Accepted Values
conditions [SupportingDataPoint] false A list of conditions. -
encounters [SupportingDataPoint] false A list of encounters. -
inferredEncounters [SupportingDataPoint] false A list of inferred encounters. -
results [SupportingDataPoint] false A list of results. -
allergies [SupportingDataPoint] false A list of allergies. -
medications [SupportingDataPoint] false A list of medications. -
immunizations [SupportingDataPoint] false A list of immunizations. -
questionnaireQuestions [SupportingDataPoint] false A list of questionnaire questions. -
documentReferences [SupportingDataPoint] false A list of document references. -
procedures [SupportingDataPoint] false A list of procedures. -

SupportingDataPoint

Name Type Required Description Accepted Values
id string true The unique ID of the supporting factor. -
value TypedValue false The result value. -
codings [Code] false A list of codified values from standard code systems recognized by Health Data Intelligence. -
sourceCodings [Code] 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 Health Data Intelligence does not recognize them. -
questionnaireName CodeableConceptLite false Questionnaire name. -
questionName CodeableConceptLite false Question name. -
questionAnswers [TypedValue] false Question answers. -
source [Source] false A source. -
date string false An ISO 8601 formatted date. -
startDate string false An ISO 8601 formatted date. -
endDate string false An ISO 8601 formatted date. -

TypedValue

Name Type Required Description Accepted Values
type string true Identifies the type of the value. For type NUMERIC, only originalNumericValue, normalizedNumericValue, or both are populated. For type CODIFIED, only codifiedValues is populated. For type DATE, only dateValue is populated. For type TEXT, only textValue is populated. -
originalNumericValue NumericValue false Original numeric value. -
normalizedNumericValue NumericValue false Normalized numeric value. -
codifiedValues CodifiedValues false Codified values. -
textValue string false Text value. -
dateValue DateValue false Date value. -

NumericValue

Name Type Required Description Accepted Values
value string true The integer or decimal value. -
unitOfMeasure CodeableConceptLite false Unit of measure. -

CodeableConceptLite

Name Type Required Description Accepted Values
codings [Code] true A list of codified values from standard code systems recognized by Health Data Intelligence. -
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 Health Data Intelligence does not recognize them. -

CodifiedValues

Name Type Required Description Accepted Values
values [CodifiedValue] false A list of codified values from standard code systems recognized by Health Data Intelligence. -

CodifiedValue

Name Type Required Description Accepted Values
value CodeableConceptLite false The value. -
normalizedValue CodeableConceptLite false The normalized value. -

DateValue

Name Type Required Description Accepted Values
date string false An ISO 8601 formatted date. -
startDate string false An ISO 8601 formatted date. -
endDate string false An ISO 8601 formatted date. -

Source

Name Type Required Description Accepted Values
id string false Source ID. -
type string true Source type. -
organizationName string false Name of the organization. -

ChildFactorFull

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. -
contribution number(float) false The weight of this factor’s contribution to the risk score value. -
basis [FactorBasis] false The list of bases supporting the factor. -
supportingDataPoints SupportingDataPoints false One or more supporting data points that caused a factor to be aligned with a risk assessment. -

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

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

RiskAssessmentFulls

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

postRiskAssessments

Name Type Required Description Accepted Values
riskAssessments [object] true A list of risk assessments to be created. -
» assessedAt string true The date and time when the risk score was created or recorded, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
» 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 value may be a localized or annotated description of the element provided by a source system. This value may also be 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 Health Data Intelligence. -
»»» 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 Health Data Intelligence does not recognize them. -
»»» 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 value may be a localized or annotated description of the element provided by a source system. This value may also be 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 Health Data Intelligence. -
»»» 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 Health Data Intelligence does not recognize them. -
»»» 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 value may be a localized or annotated description of the element provided by a source system. This value may also be 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 Health Data Intelligence. -
»»» 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 Health Data Intelligence does not recognize them. -
»»» 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 value may be a localized or annotated description of the element provided by a source system. This value may also be 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 Health Data Intelligence. -
»»» 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 Health Data Intelligence does not recognize them. -
»»» 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, Health Data Intelligence program algorithm) requirements to understand what factors may be returned and their meaning. For example, see Clinical Standard Registry Requirements on Oracle Health 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. -
Ruby Shell