NAV
Ruby Shell

Diagnosis Insights Application API v1

The Oracle Health Data Intelligence Diagnosis Insights application API enables you to configure and monitor the Diagnosis Insights application and related components.

URL: https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1

Condition Actions

Condition actions are the actions that a user can take on a patient’s conditions as part of a Health Data Intelligence condition identification workflow. For example, adding an encounter diagnosis to a condition, adding a diagnosis to a patient’s problem list, dismissing a patient’s condition, and so on.

Retrieve a Single Condition Action

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/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/condition-actions/3fa85f64-5717-4562-b3fc-2c963f66afa6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/condition-actions/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /pipelines/{pipelineId}/patients/{patientId}/condition-actions/{conditionActionId}

Retrieves a single condition action performed on the patient’s condition.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline in which the condition outcomes are performed. -
patientId path string true N/A The unique ID of the patient to retrieve conditions. -
conditionActionId path string true N/A The unique ID of the condition action performed on the patient’s condition. -

Response Statuses

Status Meaning Description Schema
200 OK Single condition action performed on the patient’s condition. DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_ConditionAction
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Create a Condition Action

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/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/condition-actions', headers: headers, body: {"conditionIdentificationDefinition":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"type":"ADD_ENCOUNTER_DIAGNOSIS","contextEntity":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3","kind":"hcc#hierarchical-condition-category","hccType":"PERSISTENT"},"suppression":{"id":"e4f12a89-f967-12c3-c9ad-6ac438ecda8d","kind":"hcc#hcc-suppression"},"encounter":{"sourceIdentifier":{"dataPartitionId":"e5f34c23-e572-44c3-a2cd-7ca358dcec9f","id":"d5f34c23-e572-44c3-a2cd-7ca358dcec9a"}},"condition":{"sourceIdentifier":{"dataPartitionId":"e5f34c23-e572-44c3-a2cd-7ca358dcec9f","id":"d5f34c23-e572-44c3-a2cd-7ca358dcec9a"},"codes":[{"code":"T86.40","display":"Amputation","system":"2.16.8404.1.113883.6.96"}]},"performedBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/condition-actions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"conditionIdentificationDefinition":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"type":"ADD_ENCOUNTER_DIAGNOSIS","contextEntity":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3","kind":"hcc#hierarchical-condition-category","hccType":"PERSISTENT"},"suppression":{"id":"e4f12a89-f967-12c3-c9ad-6ac438ecda8d","kind":"hcc#hcc-suppression"},"encounter":{"sourceIdentifier":{"dataPartitionId":"e5f34c23-e572-44c3-a2cd-7ca358dcec9f","id":"d5f34c23-e572-44c3-a2cd-7ca358dcec9a"}},"condition":{"sourceIdentifier":{"dataPartitionId":"e5f34c23-e572-44c3-a2cd-7ca358dcec9f","id":"d5f34c23-e572-44c3-a2cd-7ca358dcec9a"},"codes":[{"code":"T86.40","display":"Amputation","system":"2.16.8404.1.113883.6.96"}]},"performedBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"}}

POST /pipelines/{pipelineId}/patients/{patientId}/condition-actions

Creates a condition action that can be performed on the patient’s condition.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline in which the condition outcomes are performed. -
patientId path string true N/A The unique ID of the patient to retrieve conditions. -
body body postPipelinesPipelineidPatientsPatientidConditionActions true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created A condition action object DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_ConditionAction
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the created condition action.

Retrieve a List of Condition Actions

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/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/condition-actions', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/condition-actions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /pipelines/{pipelineId}/patients/{patientId}/condition-actions

Retrieves a paginated list of condition actions performed on the patient.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline in which the condition outcomes are performed. -
patientId path string true N/A The unique ID of the patient to retrieve conditions. -
type query array[string] false N/A The type of the actions performed on the condition. This query parameter can be -
conditionIdentificationDefinitionId query array[string] false N/A The unique ID of the condition identification definition ID on which the condition -
id query array[string] false N/A The unique ID of the condition action. This query parameter can be repeated multiple -
contextEntityId query array[string] false N/A The unique ID of the resource that corresponds to the source of the action. This query parameter can -
contextEntityKind query string false N/A The resource that corresponds to the source of the action. This filter is not case-sensitive. -
contextEntityCategoryNumber query array[integer] false N/A The numeric identifier used to uniquely represent a hierarchical condition category. This query parameter can -
contextEntityHccType query string false N/A The type of hierarchical condition category. PERSISTENT, SUSPECTED
encounterId query array[string] false N/A The unique ID of the encounter. This query parameter can be repeated multiple -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false type A comma-separated list of fields by which to sort. type, -type, performedAt, -performedAt

Response Statuses

Status Meaning Description Schema
200 OK A collection of condition action objects ConditionActions
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Comments

Allows users to record and read comments to communicate information to other users.

Delete a Comment

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/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/comments/3fa85f64-5717-4562-b3fc-2c963f66afa6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/comments/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /pipelines/{pipelineId}/patients/{patientId}/comments/{commentId}

Deletes a comment.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline in which the condition outcomes are performed. -
patientId path string true N/A The unique ID of the patient associated with the conditions you want to retrieve. -
commentId path string true N/A The unique ID of the comment. -

Response Statuses

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

Update a Comment

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/comments/3fa85f64-5717-4562-b3fc-2c963f66afa6', headers: headers, body: {"contextEntity":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3","kind":"hcc#hierarchical-condition-category","hccType":"PERSISTENT"},"encounter":{"sourceIdentifier":{"dataPartitionId":"e5f34c23-e572-44c3-a2cd-7ca358dcec9f","id":"d5f34c23-e572-44c3-a2cd-7ca358dcec9a"}},"comment":"This is a sample comment","updatedBy":{"type":"SYSTEM","display":"Service Account - Prod","reference":{"id":"fbc4117a-4f2f-4e39-9d60-76563fa5b83e"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/comments/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"contextEntity":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3","kind":"hcc#hierarchical-condition-category","hccType":"PERSISTENT"},"encounter":{"sourceIdentifier":{"dataPartitionId":"e5f34c23-e572-44c3-a2cd-7ca358dcec9f","id":"d5f34c23-e572-44c3-a2cd-7ca358dcec9a"}},"comment":"This is a sample comment","updatedBy":{"type":"SYSTEM","display":"Service Account - Prod","reference":{"id":"fbc4117a-4f2f-4e39-9d60-76563fa5b83e"}}}

PUT /pipelines/{pipelineId}/patients/{patientId}/comments/{commentId}

Updates a comment.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline in which the condition outcomes are performed. -
patientId path string true N/A The unique ID of the patient associated with the conditions you want to retrieve. -
commentId path string true N/A The unique ID of the comment. -
body body putPipelinesPipelineidPatientsPatientidComments true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK A single comment object DiagnosisInsightsPublicApi_Entities_V1_Comment_Comment
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Single Comment

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/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/comments/3fa85f64-5717-4562-b3fc-2c963f66afa6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/comments/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /pipelines/{pipelineId}/patients/{patientId}/comments/{commentId}

Retrieves a single comment.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline in which the condition outcomes are performed. -
patientId path string true N/A The unique ID of the patient associated with the conditions you want to retrieve. -
commentId path string true N/A The unique ID of the comment. -

Response Statuses

Status Meaning Description Schema
200 OK Single comment. DiagnosisInsightsPublicApi_Entities_V1_Comment_Comment
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Create a Comment

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/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/comments', headers: headers, body: {"contextEntity":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3","kind":"hcc#hierarchical-condition-category","hccType":"PERSISTENT"},"encounter":{"sourceIdentifier":{"dataPartitionId":"e5f34c23-e572-44c3-a2cd-7ca358dcec9f","id":"d5f34c23-e572-44c3-a2cd-7ca358dcec9a"}},"comment":"This is a sample comment","createdBy":{"type":"SYSTEM","display":"Service Account - Prod","reference":{"id":"c5693417-38ad-408d-a438-3581f416e512"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/comments \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"contextEntity":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3","kind":"hcc#hierarchical-condition-category","hccType":"PERSISTENT"},"encounter":{"sourceIdentifier":{"dataPartitionId":"e5f34c23-e572-44c3-a2cd-7ca358dcec9f","id":"d5f34c23-e572-44c3-a2cd-7ca358dcec9a"}},"comment":"This is a sample comment","createdBy":{"type":"SYSTEM","display":"Service Account - Prod","reference":{"id":"c5693417-38ad-408d-a438-3581f416e512"}}}

POST /pipelines/{pipelineId}/patients/{patientId}/comments

Creates a comment.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline in which the condition outcomes are performed. -
patientId path string true N/A The unique ID of the patient associated with the conditions you want to retrieve. -
body body postPipelinesPipelineidPatientsPatientidComments true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created A comment object DiagnosisInsightsPublicApi_Entities_V1_Comment_Comment
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the created comment.

Retrieve a List of Comments

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/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/comments', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/comments \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /pipelines/{pipelineId}/patients/{patientId}/comments

Retrieves a paginated list of comments.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline in which the condition outcomes are performed. -
patientId path string true N/A The unique ID of the patient associated with the conditions you want to retrieve. -
id query array[string] false N/A The unique ID of the comment. This query parameter can be repeated multiple -
encounterId query array[string] false N/A The unique ID of the encounter. This query parameter can be repeated multiple -
contextEntityCategoryNumber query array[integer] false N/A The numeric identifier used to uniquely represent a hierarchical condition category. This query parameter can -
contextEntityId query array[string] false N/A The unique ID of the context entity. This query parameter can be repeated multiple -
contextEntityKind query string false N/A The kind of resource that corresponds to the ID of this reference. condition-identification#definition, hcc#hierarchical-condition-category
contextEntityHccType query string false N/A The type of hierarchical condition category. PERSISTENT, SUSPECTED
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false -createdAt A comma-separated list of fields by which to sort. createdAt, -createdAt, updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK A collection of comments objects Comments
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Inferred Conditions

Allows users to add a condition and enter supporting fact details that are reviewed by a provider. The provider can then choose to either add diagnoses to the problems list or reject the entry for the condition.

Delete an Inferred Condition

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/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/inferred-conditions/{inferredConditionId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/inferred-conditions/{inferredConditionId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /pipelines/{pipelineId}/patients/{patientId}/inferred-conditions/{inferredConditionId}

Deletes an inferred condition.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline in which the condition outcomes are performed. -
patientId path string true N/A The unique ID of the patient to retrieve conditions. -
inferredConditionId path string true N/A The ID of the inferred condition. -

Response Statuses

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

Update an Inferred Condition

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/inferred-conditions/3fa85f64-5717-4562-b3fc-2c963f66afa6', headers: headers, body: {"codes":{"code":"T86.40","display":"Amputation","system":"2.16.8404.1.113883.6.96","createdBy":{"type":"SYSTEM","display":"Service Account - Prod","reference":{"id":"c5693417-38ad-408d-a438-3581f416e512"}}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/inferred-conditions/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"codes":{"code":"T86.40","display":"Amputation","system":"2.16.8404.1.113883.6.96","createdBy":{"type":"SYSTEM","display":"Service Account - Prod","reference":{"id":"c5693417-38ad-408d-a438-3581f416e512"}}}}

PUT /pipelines/{pipelineId}/patients/{patientId}/inferred-conditions/{inferredConditionId}

Updates an Inferred Condition.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline in which the condition outcomes are performed. -
patientId path string true N/A The unique ID of the patient to retrieve conditions. -
inferredConditionId path string true N/A The ID of the inferred condition. -
body body putPipelinesPipelineidPatientsPatientidInferredConditions true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK A single inferred condition object DiagnosisInsightsPublicApi_Entities_V1_InferredCondition_Code
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Create an Inferred Condition

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/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/inferred-conditions', headers: headers, body: {"riskAdjustmentModel":{"id":"e4f12a89-f967-12c3-c9ad-6ac438ecda8d","type":"CMS"},"hierarchicalConditionCategory":{"id":"e4f12a89-f967-12c3-c9ad-6ac438ecda8d","categoryNumber":"hcc-category","name":"hcc-name"},"supportingFacts":[{"factType":"Medication","documentation":"albuterol sulfate concentrate 5 mg/mL(0.5 %) solution for nebulization every 4 hours","date":"2021-05-14T12:23:12Z","source":"EMR"}],"createdBy":{"type":"SYSTEM","display":"Service Account - Prod","reference":{"id":"c5693417-38ad-408d-a438-3581f416e512"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/inferred-conditions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"riskAdjustmentModel":{"id":"e4f12a89-f967-12c3-c9ad-6ac438ecda8d","type":"CMS"},"hierarchicalConditionCategory":{"id":"e4f12a89-f967-12c3-c9ad-6ac438ecda8d","categoryNumber":"hcc-category","name":"hcc-name"},"supportingFacts":[{"factType":"Medication","documentation":"albuterol sulfate concentrate 5 mg/mL(0.5 %) solution for nebulization every 4 hours","date":"2021-05-14T12:23:12Z","source":"EMR"}],"createdBy":{"type":"SYSTEM","display":"Service Account - Prod","reference":{"id":"c5693417-38ad-408d-a438-3581f416e512"}}}

POST /pipelines/{pipelineId}/patients/{patientId}/inferred-conditions

Creates an inferred condition that can be performed on the patient’s condition.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline in which the condition outcomes are performed. -
patientId path string true N/A The unique ID of the patient to retrieve conditions. -
body body postPipelinesPipelineidPatientsPatientidInferredConditions true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created An inferred condition object DiagnosisInsightsPublicApi_Entities_V1_InferredCondition_InferredCondition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the created inferred condition.

Retrieve a List of Inferred Conditions

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/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/inferred-conditions', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/diagnosis-insights-application/v1/pipelines/61ea6fe1-6d57-4637-ac7e-72acc5d2390e/patients/8c075cb6-2bd0-4a6b-b3ba-abfbf3660044/inferred-conditions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /pipelines/{pipelineId}/patients/{patientId}/inferred-conditions

Retrieves a paginated list of inferred conditions performed on the patient.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline in which the condition outcomes are performed. -
patientId path string true N/A The unique ID of the patient to retrieve conditions. -
riskAdjustmentModelType query string false N/A The type of hierarchical condition category. CMS, HHS, ESRD, CDPS, SDOH, CMSV24
status query string false N/A The status of the inferred condition. ALL, ACTIVE, SUPPRESSED
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false -createdAt A comma-separated list of fields by which to sort. createdAt, -createdAt, updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK A collection of inferred condition objects InferredConditions
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Schema Definitions

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

putPipelinesPipelineidPatientsPatientidInferredConditions

Name Type Required Description Accepted Values
status string false Desired Status of the inferred condition. -
codes object false Defines the attributes associated with a HierarchicalConditionCategory entity. -
» 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. -
» createdBy object true The personnel who created the inferred condition. -
»» reference object true The referenced entity. -
»»» id string true The unique ID of the personnel who created the inferred condition. -
»» type string true An enumerated list that describes the role of a user in relation to the entity. SYSTEM, PERSONNEL
»» display string false A textual display that describes the user entity. When type is SYSTEM, display is required. -

DiagnosisInsightsPublicApi_Entities_V1_InferredCondition_Code

Name Type Required Description Accepted Values
codes DiagnosisInsightsPublicApi_Entities_V1_InferredCondition_Code false A List of codes submitted for the inferred condition. -
status string false Inferred Condition Status (ACTIVE or SUPPRESSED) -

postPipelinesPipelineidPatientsPatientidInferredConditions

Name Type Required Description Accepted Values
riskAdjustmentModel object true Defines the attributes associated with a RiskAdjustmentModel entity. -
» id string true The unique ID of the risk adjustment model. -
» type string true The risk adjustment model type. -
hierarchicalConditionCategory object true Defines the attributes associated with a HierarchicalConditionCategory entity. -
» id string true The unique ID of the hierarchical condition category. -
» categoryNumber string true The numeric identifier used to uniquely represent a hierarchical condition category. -
» name string true The name of the hierarchical condition category. -
supportingFacts [object] true Defines the attributes associated with a SupportingFacts entity. -
» factType string true The Supporting facts documented for the inferred condition. -
» documentation string true The Free-text documentation of the supporting fact that gives meaning to the condition. -
» date string true The Date of the documentation. -
» source string true The Source of the supporting fact. -
createdBy object true The personnel who created the inferred condition. -
» reference object true The referenced entity. -
»» id string true The unique ID of the personnel who created the inferred condition. -
» type string true An enumerated list that describes the role of a user in relation to the entity. SYSTEM, PERSONNEL
» display string false A textual display that describes the user entity. When type is SYSTEM, display is required. -

DiagnosisInsightsPublicApi_Entities_V1_InferredCondition_InferredCondition

Name Type Required Description Accepted Values
id string true The ID of the inferred condition. -
pipeline DiagnosisInsightsPublicApi_Entities_V1_PipelineReference true The ID of the pipeline. -
patient DiagnosisInsightsPublicApi_Entities_V1_PatientReference true The ID of the patient. -
riskAdjustmentModel DiagnosisInsightsPublicApi_Entities_V1_InferredCondition_RiskAdjustmentModel true The type of risk adjustment model. -
hierarchicalConditionCategory DiagnosisInsightsPublicApi_Entities_V1_InferredCondition_HierarchicalConditionCategory true The HCC of the inferred condition. -
codes DiagnosisInsightsPublicApi_Entities_V1_InferredCondition_Code false A List of codes submitted for the inferred condition. -
supportingFacts [DiagnosisInsightsPublicApi_Entities_V1_InferredCondition_SupportingFacts] true A List of the Supporting facts documented for the inferred condition. -
createdBy DiagnosisInsightsPublicApi_Entities_V1_User true The unique ID of the individual who entered the inferred condition into the system. -
updatedBy DiagnosisInsightsPublicApi_Entities_V1_User false The unique ID of the individual who updated the inferred condition in the system. -
createdAt string true The date and time when the inferred condition was initially entered into the system, in International Organization for Standardization (ISO) 8601 formatting with precision to YYYY-MM-DDThh:mm:ss.SSSZ, such as 2018-02-13T20:41:18.181Z. The time is set automatically when the inferred condition is first created. Therefore, the field does not need to be set explicitly. -
status string true The status of the inferred condition. -

DiagnosisInsightsPublicApi_Entities_V1_PipelineReference

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

DiagnosisInsightsPublicApi_Entities_V1_PatientReference

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

DiagnosisInsightsPublicApi_Entities_V1_InferredCondition_RiskAdjustmentModel

Name Type Required Description Accepted Values
id string true The unique ID of the risk adjustment model. -
type string true The risk adjustment model type. CMS, ESRD, HHS, CDPS, SDOH, CMSV24

DiagnosisInsightsPublicApi_Entities_V1_InferredCondition_HierarchicalConditionCategory

Name Type Required Description Accepted Values
id string true The unique ID of the hierarchical condition category. -
categoryNumber integer(int32) true The numeric identifier used to uniquely represent a hierarchical condition category. -
name string true The name of the hierarchical condition category. -

DiagnosisInsightsPublicApi_Entities_V1_InferredCondition_SupportingFacts

Name Type Required Description Accepted Values
id string true The unique ID of the supporting fact. -
factType string true The Supporting facts documented for the inferred condition. -
documentation string true Free-text documentation of the supporting fact that gives meaning to the condition. -
date string(date-time) true The Date of the documentation. -
source string true The Source of the supporting fact. -

DiagnosisInsightsPublicApi_Entities_V1_User

Name Type Required Description Accepted Values
type string true An enumerated list that describes the role of a user in relation to the entity. SYSTEM, PERSONNEL
display string false A textual display that describes the user entity. When type is SYSTEM, display is required. -
reference DiagnosisInsightsPublicApi_Entities_V1_PersonnelReference false The referenced entity. -

DiagnosisInsightsPublicApi_Entities_V1_PersonnelReference

Name Type Required Description Accepted Values
id string true The ID of the personnel in the tenant. -

InferredConditions

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

putPipelinesPipelineidPatientsPatientidComments

Name Type Required Description Accepted Values
contextEntity object true The reference to the resource that the comment pertains to. -
» id string true The unique ID of the context entity. -
» kind string true The kind of resource that corresponds to the ID of this reference. condition-identification#definition, hcc#hierarchical-condition-category
» hccType string false The type of hierarchical condition category. PERSISTENT, SUSPECTED
encounter object false The encounter associated with the condition. -
» sourceIdentifier object true The source identifier information. -
»» dataPartitionId string true The unique ID of the data partition. See the Data Partitions section of the Data Source API for more information. -
»» id string true The unique ID associated with this entity for a patient in the data partition. -
comment string true The comment for the condition. The maximum length is 512 characters. -
updatedBy object true The personnel who updated the comments. -
» reference object true The referenced entity. -
»» id string true The unique ID of the personnel who updated the comment. -
» type string true An enumerated list that describes the role of a user in relation to the entity. SYSTEM, PERSONNEL
» display string false A textual display that describes the user entity. When type is SYSTEM, display is required. -

DiagnosisInsightsPublicApi_Entities_V1_Comment_Comment

Name Type Required Description Accepted Values
id string true The unique ID of the comment. -
contextEntity DiagnosisInsightsPublicApi_Entities_V1_ContextEntity true The resource that the comment pertains to. -
encounter DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_Encounter false The encounter that this condition belongs to. -
comment string true The comment for the condition. The maximum length is 512 characters. -
createdBy DiagnosisInsightsPublicApi_Entities_V1_User true The unique ID of the individual who entered the comment into the system. -
createdAt string true The date and time when the comment was initially entered into the system, in International Organization for Standardization (ISO) 8601 formatting with precision to YYYY-MM-DDThh:mm:ss.SSSZ, such as 2018-02-13T20:41:18.181Z. The time is set automatically when the comment is first created. Therefore, the field does not need to be set explicitly. -
updatedBy DiagnosisInsightsPublicApi_Entities_V1_User false The unique ID of the individual who updated the comment. -
updatedAt string true The date and time when the comment was updated in the system, in ISO 8601 formatting with precision to YYYY-MM-DDThh:mm:ss.SSSZ, such as 2018-02-13T20:41:18.181Z. The time is set automatically when the comment is updated. Therefore, the field does not need to be set explicitly. -

DiagnosisInsightsPublicApi_Entities_V1_ContextEntity

Name Type Required Description Accepted Values
id string true The unique ID of the context entity. -
kind string true The kind of resource that corresponds to the ID of this reference. condition-identification#definition, hcc#hierarchical-condition-category
categoryNumber integer(int32) false The numeric identifier used to uniquely represent a hierarchical condition category. -
hccType string false The type of hierarchical condition category. PERSISTENT, SUSPECTED

DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_Encounter

Name Type Required Description Accepted Values
sourceIdentifier DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_SourceIdentifier true The source identifier information for the encounter. -

DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_SourceIdentifier

Name Type Required Description Accepted Values
dataPartitionId string true The ID of the data partition. See the Data Partitions endpoint of the Data Source API for more information. -
id string true An ID that uniquely identifies this entity for a patient in the data partition. -

postPipelinesPipelineidPatientsPatientidComments

Name Type Required Description Accepted Values
contextEntity object true The reference to the resource that the comment pertains to. -
» id string true The unique ID of the context entity. -
» kind string true The kind of resource that corresponds to the ID of this reference. condition-identification#definition, hcc#hierarchical-condition-category
» hccType string false The type of hierarchical condition category. PERSISTENT, SUSPECTED
encounter object false The encounter associated with the condition. -
» sourceIdentifier object true The source identifier information. -
»» dataPartitionId string true The unique ID of the data partition. See the Data Partitions section of the Data Source API for more information. -
»» id string true The unique ID associated with this entity for a patient in the data partition. -
comment string true The comment for the condition. The maximum length is 512 characters. -
createdBy object true The personnel who created the comment. -
» reference object true The referenced entity. -
»» id string true The unique ID of the personnel who created the comment. -
» type string true An enumerated list that describes the role of a user in relation to the entity. SYSTEM, PERSONNEL
» display string false A textual display that describes the user entity. When type is SYSTEM, display is required. -

Comments

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

DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_ConditionAction

Name Type Required Description Accepted Values
id string true The ID of the condition action. -
pipeline DiagnosisInsightsPublicApi_Entities_V1_PipelineReference true The ID of the pipeline. -
patient DiagnosisInsightsPublicApi_Entities_V1_PatientReference true The ID of the patient. -
encounter DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_Encounter false The encounter that this condition belongs to. -
conditionIdentificationDefinition DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_ConditionIdentificationDefinition false The condition identification definition that this condition belongs to. -
type string true The type of the action performed on this patient’s condition. ADD_DISMISSED_CONDITION, ADD_ENCOUNTER_DIAGNOSIS, ADD_PROBLEM, ADD_REJECTED_CONDITION, ADD_RESOLVED_CONDITION, DELETE_DISMISSED_CONDITION, DELETE_REJECTED_CONDITION, DELETE_RESOLVED_CONDITION
condition DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_Condition false The condition details of the source system. -
location string false The location of the created resource. -
contextEntity DiagnosisInsightsPublicApi_Entities_V1_ContextEntity false The HCC or condition identification definition resource from which the action originated. -
suppression DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_Suppression false The suppression that was created based on feedback from a user. -
performedAt string true The date and time when the condition action was initially entered into the system. In ISO 8601 formatting with precision to YYYY-MM-DDThh:mm:ss.SSSZ, such as 2018-02-13T20:41:18.181Z. The time is set automatically when the condition action is first created. Therefore, the field does not need to be set explicitly. -
performedBy DiagnosisInsightsPublicApi_Entities_V1_PersonnelReference true The personnel who performed the condition action. -

DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_ConditionIdentificationDefinition

Name Type Required Description Accepted Values
id string true The unique ID of the condition identification definition. -
name string false The name of the condition identification definition. -
type string true The type of the condition identification definition. PRIOR, SUSPECTED, CLARIFICATION

DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_Condition

Name Type Required Description Accepted Values
sourceIdentifier DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_SourceIdentifier true The source identifier information for the condition. -
codes [DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_Code] false Identifies the condition and its categories using a textual description or codified values. -

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

DiagnosisInsightsPublicApi_Entities_V1_ConditionAction_Suppression

Name Type Required Description Accepted Values
id string true The unique ID of the suppression. -
kind string true The kind of resource that corresponds to the ID of this reference. condition-identification#suppression, hcc#hcc-suppression

postPipelinesPipelineidPatientsPatientidConditionActions

Name Type Required Description Accepted Values
conditionIdentificationDefinition object false The condition identification definition that this condition belongs to. -
» id string true The unique ID of the condition identification definition. -
type string true The type of the action performed on this patient’s condition. ADD_DISMISSED_CONDITION, ADD_ENCOUNTER_DIAGNOSIS, ADD_PROBLEM, ADD_REJECTED_CONDITION, ADD_RESOLVED_CONDITION, DELETE_DISMISSED_CONDITION, DELETE_REJECTED_CONDITION, DELETE_RESOLVED_CONDITION
contextEntity object false The reference to the resource that provides context for the action. -
» id string true The unique ID of the context. -
» kind string true The kind of resource that corresponds to the ID of this reference. condition-identification#definition, hcc#hierarchical-condition-category
» hccType string false The type of hierarchical condition category. PERSISTENT, SUSPECTED
suppression object false The suppression that was created based on feedback from a user. -
» id string true The unique ID of the suppression. -
» kind string true The kind of resource that corresponds to the ID of this reference. condition-identification#suppression, hcc#hcc-suppression
encounter object false The encounter associated with the condition. -
» sourceIdentifier object true The source identifier information. -
»» dataPartitionId string true The ID of the data partition. See the Data Partitions endpoint of the Data Source API for more information. -
»» id string true An ID that uniquely identifies this entity for a patient in the data partition. -
condition object false The condition details of the source system. -
» sourceIdentifier object true The source identifier information. -
»» dataPartitionId string true The ID of the data partition. See the Data Partitions endpoint of the Data Source API for more information.‘ -
»» id string true An ID that uniquely identifies this entity for a patient in the data partition. -
» codes [object] false List of condition codes associated with the condition. -
»» 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. -
performedBy object true The personnel who performed the condition action. -
» id string true The unique ID of the personnel who performed the condition action. -

ConditionActions

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