NAV Navbar
Logo cerner
Ruby Shell

Condition Identification API v1

The HealtheIntent Condition Identification API identifies condition scenarios that are useful to a provider when considering what diagnoses are currently appropriate for a patient.

Note: The data retrieved by this API is filtered based on your sensitive data filters for HealtheIntent. Ensure that your implementations of this API are designed with this in mind, and if you integrate data from HealtheIntent into a clinical workflow using this API, ensure that your users are informed of your sensitive data filters. See Understand Sensitive Data in HealtheIntent in the Reference Pages on Cerner Wiki for more information.

URL: https://cernerdemo.api.us.healtheintent.com/condition-identification/v1

Prior Diagnoses

A prior diagnosis is a diagnosis that has been conclusively identified for a patient based on identification logic. The identification outcome is typically based on previous documentation of a condition through evidence from clinical or HCC-related inputs.

Retrieve a List of Prior Diagnoses

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/patients/206d2277-827b-478e-b543-308e28d74fdc/prior-diagnoses', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/patients/206d2277-827b-478e-b543-308e28d74fdc/prior-diagnoses \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "patient": {
        "id": "27d0677b-28e6-4648-9159-1e114eb7b829",
        "population": {
          "id": "5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"
        }
      },
      "hierarchy": {
        "group": {
          "name": "Obesity"
        },
        "isTrumped": true,
        "trumpedBy": [
          {
            "id": "2310677b-28e6-4648-9159-1e114eb7b829",
            "name": "Obesity (BMI ≥ 40) from claims"
          }
        ]
      },
      "confidenceWeight": {
        "weight": 0.74,
        "weightType": "SCHEDULE",
        "weightSchedule": {
          "name": "Schedule1 - Claims"
        }
      },
      "conditionIdentificationDefinition": {
        "id": "2310677b-28e6-4648-9159-1e114eb7b829",
        "name": "Obesity (BMI ≥ 40) from claims"
      },
      "pipeline": {
        "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
        "instanceId": "0b424e9d-b74a-4b78-9dde-22685ae9cdec"
      },
      "pastPeriodSupportingData": [
        {
          "componentMnemonic": "ObesityDxPriorYears",
          "isSatisfied": true,
          "basis": [
            {
              "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
              "kind": "condition#condition"
            }
          ]
        }
      ],
      "currentPeriodSupportingData": [
        {
          "componentMnemonic": "ObesityDxPriorYears",
          "isSatisfied": true,
          "basis": [
            {
              "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
              "kind": "condition#condition"
            }
          ]
        }
      ],
      "identificationStatus": "NEEDS_CURRENT_PERIOD_ATTENTION"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/patients/27d0677b-28e6-4648-9159-1e114eb7b829/prior-diagnoses?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/a426149a-c19c-413a-8d9f-d7988aec4a91/patients/27d0677b-28e6-4648-9159-1e114eb7b829/prior-diagnoses?offset=0&limit=20"
}

GET /pipelines/{pipelineId}/patients/{patientId}/prior-diagnoses

Retrieves a list of prior diagnoses.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The ID of the condition identification pipeline. -
patientId path string true N/A The ID of the patient. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK A collection of prior diagnosis objects PriorDiagnoses
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Suspected Diagnoses

A suspected diagnosis is a diagnosis that has been identified for a patient based on inclusion and exclusion criteria.

Retrieve a List of Suspected Diagnoses

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/patients/206d2277-827b-478e-b543-308e28d74fdc/suspected-diagnoses', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/patients/206d2277-827b-478e-b543-308e28d74fdc/suspected-diagnoses \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "patient": {
        "id": "27d0677b-28e6-4648-9159-1e114eb7b829",
        "population": {
          "id": "5d0f9ff9-d3b8-47e0-86a1-13d500d833ce"
        }
      },
      "hierarchy": {
        "group": {
          "name": "Obesity"
        },
        "isTrumped": true,
        "trumpedBy": [
          {
            "id": "2310677b-28e6-4648-9159-1e114eb7b829",
            "name": "Obesity (BMI ≥ 40) from claims"
          }
        ]
      },
      "confidenceWeight": {
        "weight": 0.74,
        "weightType": "SCHEDULE",
        "weightSchedule": {
          "name": "Schedule1 - Claims"
        }
      },
      "conditionIdentificationDefinition": {
        "id": "2310677b-28e6-4648-9159-1e114eb7b829",
        "name": "Obesity (BMI ≥ 40) from claims"
      },
      "pipeline": {
        "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
        "instanceId": "0b424e9d-b74a-4b78-9dde-22685ae9cdec"
      },
      "supportingData": [
        {
          "componentMnemonic": "ObesityDxPriorYears",
          "isSatisfied": true,
          "basis": [
            {
              "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
              "kind": "condition#condition"
            }
          ]
        }
      ],
      "competingData": [
        {
          "componentMnemonic": "ObesityDxPriorYears",
          "isSatisfied": true,
          "basis": [
            {
              "id": "e8f0e126-2e4b-11e9-b210-d663bd873d93",
              "kind": "condition#condition"
            }
          ]
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/d8454f2a-665c-49d4-87db-8c167feae10e/patients/27d0677b-28e6-4648-9159-1e114eb7b829/suspected_diagnoses?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/d8454f2a-665c-49d4-87db-8c167feae10e/patients/27d0677b-28e6-4648-9159-1e114eb7b829/suspected_diagnoses?offset=0&limit=20"
}

GET /pipelines/{pipelineId}/patients/{patientId}/suspected-diagnoses

Retrieves a list of suspected diagnoses.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The ID of the condition identification pipeline. -
patientId path string true N/A The ID of the patient. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK A collection of suspected diagnosis objects SuspectedDiagnoses
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Pipeline

The resources for managing condition identification pipelines.

A condition identification pipeline represents the concept of an isolated execution environment for processing condition identification-related outcomes. The pipeline is required to generate and access patient-level condition identification data.

Create a Pipeline

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines', headers: headers, body: {"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"name":"Condition identification production pipeline","configuration":{"id":"a426149a-c19c-413a-8d9f-d7988aec4a91"},"status":"DRAFT","executionSettings":{"frequencyValue":8,"frequencyUnit":"HOURS","timeOfDay":"00:00"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"name":"Condition identification production pipeline","configuration":{"id":"a426149a-c19c-413a-8d9f-d7988aec4a91"},"status":"DRAFT","executionSettings":{"frequencyValue":8,"frequencyUnit":"HOURS","timeOfDay":"00:00"}}

Example response

{
  "id": "09caa9f6-c384-4ad4-a4e2-203e1acee6db",
  "instanceId": "3d3cc121-31f3-4472-81e3-5983254d44f6",
  "name": "Condition identification production pipeline",
  "configuration": {
    "id": "b87dc60a-e421-4264-9da4-ad49854e6f69"
  },
  "status": "DRAFT",
  "executionSettings": {
    "frequencyValue": 8,
    "frequencyUnit": "HOURS"
  },
  "createdAt": "2018-05-14T12:23:12Z",
  "createdBy": {
    "id": "d7edf791-7ef6-433c-a6f9-49dbc09f24a3"
  }
}

POST /pipelines

Creates a pipeline.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a List of Pipelines

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
      "instanceId": "3d3cc121-31f3-4472-81e3-5983254d44f6",
      "name": "Condition identification production pipeline",
      "configuration": {
        "id": "b87dc60a-e421-4264-9da4-ad49854e6f69"
      },
      "status": "DRAFT",
      "executionSettings": {
        "frequencyValue": 8,
        "frequencyUnit": "HOURS"
      },
      "createdAt": "2018-05-14T12:23:12Z",
      "createdBy": {
        "id": "d7edf791-7ef6-433c-a6f9-49dbc09f24a3"
      }
    }
  ],
  "totalResults": 21,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines?offset=20&limit=20",
  "prevLink": "https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines?offset=0&limit=20",
  "nextLink": "https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines?offset=20&limit=20"
}

GET /pipelines

Retrieves a list of pipelines.

Parameters

Parameter In Type Required Default Description Accepted Values
configurationId query array[string] false N/A The configuration ID of the pipeline. This query parameter can be repeated multiple times to query for multiple configurations at a time. -
status query array[string] false N/A The status of the pipeline. This query parameter can be repeated multiple times to query for multiple statuses at a time. The default behavior is to return pipelines from all statuses. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false name A comma-separated list of fields by which to sort. name, -name, createdAt, -createdAt

Response Statuses

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

Retrieve a Single Pipeline

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/206d2277-827b-478e-b543-308e28d74fdc', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/206d2277-827b-478e-b543-308e28d74fdc \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /pipelines/{pipelineId}

Retrieves a single pipeline.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK Retrieves a single pipeline. Pipeline
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Create a Pipeline Instance

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/instances', headers: headers, body: {"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"name":"Condition identification production pipeline","configuration":{"id":"a426149a-c19c-413a-8d9f-d7988aec4a91"},"status":"DRAFT","executionSettings":{"frequencyValue":8,"frequencyUnit":"HOURS","timeOfDay":"00:00"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/instances \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"createdBy":{"id":"f89fa3dd-57a8-494b-b157-4640ccc081e3"},"name":"Condition identification production pipeline","configuration":{"id":"a426149a-c19c-413a-8d9f-d7988aec4a91"},"status":"DRAFT","executionSettings":{"frequencyValue":8,"frequencyUnit":"HOURS","timeOfDay":"00:00"}}

Example response

{
  "id": "09caa9f6-c384-4ad4-a4e2-203e1acee6db",
  "instanceId": "3d3cc121-31f3-4472-81e3-5983254d44f6",
  "name": "Condition identification production pipeline",
  "configuration": {
    "id": "b87dc60a-e421-4264-9da4-ad49854e6f69"
  },
  "status": "DRAFT",
  "executionSettings": {
    "frequencyValue": 8,
    "frequencyUnit": "HOURS"
  },
  "createdAt": "2018-05-14T12:23:12Z",
  "createdBy": {
    "id": "d7edf791-7ef6-433c-a6f9-49dbc09f24a3"
  }
}

POST /pipelines/{pipelineId}/instances

Creates a pipeline instance.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline. -
body body postPipelinesPipelineidInstances true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created A pipeline instance object Pipeline
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

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

Retrieve a List of Pipeline Instances

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/instances', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/instances \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
      "instanceId": "3d3cc121-31f3-4472-81e3-5983254d44f6",
      "name": "Condition identification production pipeline",
      "configuration": {
        "id": "b87dc60a-e421-4264-9da4-ad49854e6f69"
      },
      "status": "DRAFT",
      "executionSettings": {
        "frequencyValue": 8,
        "frequencyUnit": "HOURS"
      },
      "createdAt": "2018-05-14T12:23:12Z",
      "createdBy": {
        "id": "d7edf791-7ef6-433c-a6f9-49dbc09f24a3"
      }
    }
  ],
  "totalResults": 21,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines?offset=20&limit=20",
  "prevLink": "https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines?offset=0&limit=20",
  "nextLink": "https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines?offset=20&limit=20"
}

GET /pipelines/{pipelineId}/instances

Retrieves a list of pipeline instances.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false -createdAt A comma-separated list of fields by which to sort. createdAt, -createdAt

Response Statuses

Status Meaning Description Schema
200 OK A collection of pipeline instance objects Pipelines
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a Single Pipeline Instance

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/instances/206d2277-827b-478e-b543-308e28d74fdc', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/condition-identification/v1/pipelines/788ddaa0-1e28-4ecc-9945-e87f281b485b/instances/206d2277-827b-478e-b543-308e28d74fdc \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /pipelines/{pipelineId}/instances/{instanceId}

Retrieves a single pipeline instance.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline. -
instanceId path string true N/A The ID of the instance of the condition identification pipeline. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieves a single pipeline instance. Pipeline
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Schema Definitions

PriorDiagnoses

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

PriorDiagnosis

Name Type Required Description Accepted Values
patient PatientReference true The patient for which the diagnosis is being considered. -
hierarchy Hierarchy false The condition identification hierarchy. -
confidenceWeight ConfidenceWeight false The confidence weight of the condition identification. -
conditionIdentificationDefinition ConditionIdentificationDefinition true The condition identification definition. -
pipeline PipelineReference true The pipeline instance. -
pastPeriodSupportingData ComponentSupport true The supporting data that indicates a condition was documented in the previous period. -
currentPeriodSupportingData ComponentSupport false The supporting data that indicates a condition was documented in the current period. -
identificationStatus string false Indicates whether the identification status needs attention in the current period. -

PatientReference

Name Type Required Description Accepted Values
id string true The ID of the associated patient. -
population PopulationReference true The population to which the associated patient belongs. -

PopulationReference

Name Type Required Description Accepted Values
id string true The population ID. -

Hierarchy

Name Type Required Description Accepted Values
group GroupReference true The reference to the group of condition identification definitions, including the current condition identification, that have been ordered in a hierarchy. -
isTrumped boolean true Indicates whether this condition identification has been trumped by another item in the same group hierarchy. -
trumpedBy ConditionIdentificationDefinition false All of the condition identification definitions that are present on the patient that represent a higher-order item in the group hierarchy. If this list has one or more items, then that indicates that this particular condition identification outcome is considered trumped. -

GroupReference

Name Type Required Description Accepted Values
name string false The name of the referenced group. -

ConditionIdentificationDefinition

Name Type Required Description Accepted Values
id string true The ID of the condition identification definition. -
name string false The name of the condition identification definition. -

ConfidenceWeight

Name Type Required Description Accepted Values
weight number(float) true The value of the weight. -
weightType string true The type of weight (direct or schedule). -
weightSchedule WeightScheduleReference false The schedule of the confidence weight. -

WeightScheduleReference

Name Type Required Description Accepted Values
name string false The name of the weight schedule. -

PipelineReference

Name Type Required Description Accepted Values
id string true The pipeline ID. -
instanceId string true The pipeline instance ID. -

ComponentSupport

Name Type Required Description Accepted Values
componentMnemonic string true The mnemonic that identifies the condition. -
isSatisfied boolean true Indicates whether the logic of the component is satisfied by this supporting data. -
basis Basis false The basis for identifying the condition. -

Basis

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

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

SuspectedDiagnoses

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

SuspectedDiagnosis

Name Type Required Description Accepted Values
patient PatientReference true The patient associated with the suspected diagnosis. -
hierarchy Hierarchy false The condition identification hierarchy. -
confidenceWeight ConfidenceWeight false The confidence weight of the condition identification. -
conditionIdentificationDefinition ConditionIdentificationDefinition true The condition identification that the suspected diagnosis is based upon. -
pipeline PipelineReference true The condition identification pipeline that generated this suspected diagnosis. -
supportingData ComponentSupport false The facts that support the positive identification of the suspected diagnosis. -
competingData ComponentSupport false The facts that dispute the positive identification of the suspected diagnosis. -

postPipelines

Name Type Required Description Accepted Values
createdBy object false A representation of the individual who entered the pipeline into the system. -
» id string true The unique ID of the individual who entered the pipeline into the system. -
name string true The name of the condition identification pipeline. -
configuration object false The configuration of the condition identification pipeline. -
» id string true The configuration ID of the condition identification pipeline. -
status string false The status of the condition identification pipeline. DRAFT, PUBLISHED, SUSPENDED
executionSettings object false The execution settings for the condition identification pipeline. -
» frequencyValue integer(int32) false The numeric value of the frequency of the condition identification pipeline. The combination of frequencyValue and frequencyUnit must result in a minimum frequency of eight hours. -
» frequencyUnit string false The unit of time of the frequency of the condition identification pipeline. The combination of frequencyValue and frequencyUnit must result in a minimum frequency of eight hours. MINUTES, HOURS, DAYS, MONTHS
» dayOfMonth integer(int32) false The day of the month when the condition identification pipeline should run. This is required if the frequencyUnit parameter is set to MONTHS. -
» timeOfDay string false The time of day in Coordinated Universal Time (UTC) when the condition identification pipeline should run. -
» startTime string(date-time) false The start time of the condition identification pipeline. -

Pipeline

Name Type Required Description Accepted Values
id string true The ID of the pipeline. -
instanceId string true The ID of the pipeline instance. -
name string true The name of the pipeline. -
createdAt string true The date and time when the pipeline was initially entered into the system. In ISO 8601 formatting with precision to YYYY-MM-DDThh:mm:ss.SSSZ, such as 2018-02-13T20:41:18.181Z. The time is set automatically when the pipeline is first created. Therefore, the field does not need to be set explicitly. -
createdBy PersonnelReference false The ID of the individual who entered the pipeline into the system. -
configuration ConfigurationReference false The configuration ID of the condition identification pipeline. -
status string true The status of the condition identification pipeline. DRAFT, PUBLISHED, SUSPENDED
executionSettings ExecutionSettings false The execution settings for the condition identification pipeline. -

PersonnelReference

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

ConfigurationReference

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

ExecutionSettings

Name Type Required Description Accepted Values
frequencyValue integer(int32) true The numeric value of the frequency of the condition identification pipeline. The combination of frequencyValue and frequencyUnit must result in a minimum frequency of eight hours. -
frequencyUnit string true The unit of time of the frequency of the condition identification pipeline. The combination of frequencyValue and frequencyUnit must result in a minimum frequency of eight hours. MINUTES, HOURS, DAYS, MONTHS
dayOfMonth integer(int32) false The day of the month when the condition identification pipeline should run. This is required if the frequencyUnit parameter is set to MONTHS. -
timeOfDay string false The time of day in UTC when the condition identification pipeline should run. -
startTime string(date-time) false The start time of the condition identification pipeline. -

Pipelines

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

postPipelinesPipelineidInstances

Name Type Required Description Accepted Values
createdBy object false A representation of the individual who entered the pipeline into the system. -
» id string true The unique ID of the individual who entered the pipeline into the system. -
name string true The name of the condition identification pipeline. -
configuration object false The configuration of the condition identification pipeline. -
» id string true The configuration ID of the condition identification pipeline. -
status string false The status of the condition identification pipeline. DRAFT, PUBLISHED, SUSPENDED
executionSettings object false The execution settings for the condition identification pipeline. -
» frequencyValue integer(int32) false The numeric value of the frequency of the condition identification pipeline. The combination of frequencyValue and frequencyUnit must result in a minimum frequency of eight hours. -
» frequencyUnit string false The unit of time of the frequency of the condition identification pipeline. The combination of frequencyValue and frequencyUnit must result in a minimum frequency of eight hours. MINUTES, HOURS, DAYS, MONTHS
» dayOfMonth integer(int32) false The day of the month when the condition identification pipeline should run. This is required if the frequencyUnit parameter is set to MONTHS. -
» timeOfDay string false The time of day in Coordinated Universal Time (UTC) when the condition identification pipeline should run. -
» startTime string(date-time) false The start time of the condition identification pipeline. -