NAV Navbar
Logo cerner
Ruby Shell

Condition API v1

The HealtheIntent Condition API allows systems to interact with condition data in HealtheIntent.

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

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

Condition

Conditions include both problems and diagnoses. Diagnoses are typically captured in context of a specific encounter or visit for the purpose of billing. Problems can be anything that has risen to the level of concern or warrants management or tracking via a problem list. Conditions can be acute or chronic. Conditions are not limited to diseases and illnesses. For example, pregnancy, risks, and family history can all be represented as conditions.

Retrieve a Single Condition

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/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/conditions/9223350710483575807021bc72d0c51a99c7fe05109f2ebf4340bfc838b1821e4cf7297c99b05d73558', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/condition/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/conditions/9223350710483575807021bc72d0c51a99c7fe05109f2ebf4340bfc838b1821e4cf7297c99b05d73558 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "assertedOn": "2011-03-24",
  "classification": {
    "sourceCodings": [
      {
        "system": "urn:cerner:coding:codingsystem:codeset:17",
        "code": "12668688",
        "display": "Admitting"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "406524005",
        "display": "Admitting"
      }
    ],
    "text": "Reason for visit diagnosis"
  },
  "code": {
    "sourceCodings": [
      {
        "system": "urn:oid:2.16.840.1.113883.6.103",
        "code": "715.90",
        "display": "DA (degenerative arthritis)"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.103",
        "code": "715.90",
        "display": "Osteoarthrosis, unspecified whether generalized or localized, site unspecified"
      },
      {
        "system": "53EF3068AE8F4EDE9951DC170CBBE6DA",
        "code": "OSTEOARTHRITIS_CLIN",
        "display": "Osteoarthritis"
      }
    ],
    "text": "DA (degenerative arthritis)"
  },
  "confirmationStatus": {
    "sourceCodings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "410605003",
        "display": "confirmed present"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "410605003",
        "display": "confirmed present"
      }
    ],
    "text": "confirmation-status-text"
  },
  "encounter": {
    "id": "9828e369-1716-4f87-b4fb-3e0c61793bc8"
  },
  "id": "9223350710483575807021bc72d0c51a99c7fe05109f2ebf4340bfc838b1821e4cf7297c99b05d73558",
  "notes": [
    {
      "text": "The patient is feeling well today.",
      "author": {
        "aliases": [
          {
            "value": "1234",
            "type": "DEA",
            "system": "2.16.840.1.113883.4.814"
          }
        ],
        "name": {
          "family": [],
          "formatted": "Brizendine, Margaret",
          "given": []
        }
      },
      "date": "2018-01-23"
    }
  ],
  "onset": "2011-03-24",
  "presentOnAdmission": {
    "sourceCodings": [
      {
        "system": "vendor:presentonadmission",
        "code": "Y",
        "display": "Yes"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "Y",
        "display": "Yes"
      }
    ],
    "text": "Yes"
  },
  "provenances": [
    {
      "entities": [
        {
          "role": {
            "sourceCodings": [
              {
                "code": "source",
                "system": "2.16.840.1.113883.4.642.1.437",
                "display": "Source"
              }
            ],
            "codings": [
              {
                "code": "source",
                "system": "2.16.840.1.113883.4.642.1.437",
                "display": "Source"
              }
            ],
            "text": "Source"
          },
          "what": {
            "documentReference": {
              "id": "581433f4-b179-3df4-9bb2-9768ef76493c"
            }
          }
        }
      ],
      "agents": [
        {
          "type": {
            "sourceCodings": [
              {
                "code": "author",
                "system": "2.16.840.1.113883.4.642.1.1131",
                "display": "Author"
              }
            ],
            "codings": [
              {
                "code": "author",
                "system": "2.16.840.1.113883.4.642.1.1131",
                "display": "Author"
              }
            ],
            "text": "Author"
          },
          "who": {
            "organization": {
              "name": "Rockcreek Clinic",
              "aliases": [
                {
                  "value": "151579",
                  "type": "EXTERNAL",
                  "system": "1.2.3.4.5.6.7.8.9.10.1"
                }
              ]
            }
          }
        }
      ],
      "recordedOn": "2011-07-26T23:53:00.000Z"
    }
  ],
  "recorder": {
    "type": "PROVIDER",
    "provider": {
      "aliases": [
        {
          "type": "DEA"
        }
      ],
      "name": {
        "prefix": "Dr.",
        "given": [
          "Jane",
          "Susannah"
        ],
        "family": [
          "Smith"
        ],
        "suffix": "MD.",
        "formatted": "Dr. Jane Susannah Smith MD."
      }
    }
  },
  "responsibleProvider": {
    "aliases": [
      {
        "value": "235666",
        "type": "DEA",
        "system": "2.16.840.1.113883.4.814"
      }
    ],
    "name": {
      "family": [],
      "formatted": "Jones, Carolyn",
      "given": []
    }
  },
  "sourceIdentifier": {
    "dataPartitionId": "54dd3f9e-7c45-413d-88bc-3bafcee8b7ab",
    "id": "12345"
  },
  "status": {
    "sourceCodings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "55561003",
        "display": "Active"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "55561003",
        "display": "Active"
      }
    ],
    "text": "Active"
  },
  "statusUpdatedOn": "2018-01-23",
  "type": {
    "sourceCodings": [
      {
        "system": "urn:oid:2.16.840.1.113883.6.96",
        "code": "282291009"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "282291009",
        "display": "Diagnosis interpretation"
      }
    ],
    "text": "Diagnosis interpretation"
  }
}

GET /populations/{populationId}/patients/{patientId}/conditions/{conditionId}

Retrieves a single condition for a given patient.

Parameters

Parameter In Type Required Default Description Accepted Values
patientId path string true N/A The identifier of the patient. -
populationId path string true N/A The identifier of the population. -
conditionId path string true N/A The ID that uniquely identifies the condition for the patient. -

Response Statuses

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

Retrieve a List of 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.healtheintent.com/condition/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/conditions', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/condition/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/conditions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "assertedOn": "2011-03-24",
      "classification": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:17",
            "code": "12668688",
            "display": "Admitting"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "406524005",
            "display": "Admitting"
          }
        ],
        "text": "Reason for visit diagnosis"
      },
      "code": {
        "sourceCodings": [
          {
            "system": "urn:oid:2.16.840.1.113883.6.103",
            "code": "715.90",
            "display": "DA (degenerative arthritis)"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.103",
            "code": "715.90",
            "display": "Osteoarthrosis, unspecified whether generalized or localized, site unspecified"
          },
          {
            "system": "53EF3068AE8F4EDE9951DC170CBBE6DA",
            "code": "OSTEOARTHRITIS_CLIN",
            "display": "Osteoarthritis"
          }
        ],
        "text": "DA (degenerative arthritis)"
      },
      "confirmationStatus": {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "410605003",
            "display": "confirmed present"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "410605003",
            "display": "confirmed present"
          }
        ],
        "text": "confirmation-status-text"
      },
      "encounter": {
        "id": "9828e369-1716-4f87-b4fb-3e0c61793bc8"
      },
      "id": "9223350710483575807021bc72d0c51a99c7fe05109f2ebf4340bfc838b1821e4cf7297c99b05d73558",
      "notes": [
        {
          "text": "The patient is feeling well today.",
          "author": {
            "aliases": [
              {
                "value": "1234",
                "type": "DEA",
                "system": "2.16.840.1.113883.4.814"
              }
            ],
            "name": {
              "family": [],
              "formatted": "Brizendine, Margaret",
              "given": []
            }
          },
          "date": "2018-01-23"
        }
      ],
      "onset": "2011-03-24",
      "presentOnAdmission": {
        "sourceCodings": [
          {
            "system": "vendor:presentonadmission",
            "code": "Y",
            "display": "Yes"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "Y",
            "display": "Yes"
          }
        ],
        "text": "Yes"
      },
      "provenances": [
        {
          "entities": [
            {
              "role": {
                "sourceCodings": [
                  {
                    "code": "source",
                    "system": "2.16.840.1.113883.4.642.1.437",
                    "display": "Source"
                  }
                ],
                "codings": [
                  {
                    "code": "source",
                    "system": "2.16.840.1.113883.4.642.1.437",
                    "display": "Source"
                  }
                ],
                "text": "Source"
              },
              "what": {
                "documentReference": {
                  "id": "581433f4-b179-3df4-9bb2-9768ef76493c"
                }
              }
            }
          ],
          "agents": [
            {
              "type": {
                "sourceCodings": [
                  {
                    "code": "author",
                    "system": "2.16.840.1.113883.4.642.1.1131",
                    "display": "Author"
                  }
                ],
                "codings": [
                  {
                    "code": "author",
                    "system": "2.16.840.1.113883.4.642.1.1131",
                    "display": "Author"
                  }
                ],
                "text": "Author"
              },
              "who": {
                "organization": {
                  "name": "Rockcreek Clinic",
                  "aliases": [
                    {
                      "value": "151579",
                      "type": "EXTERNAL",
                      "system": "1.2.3.4.5.6.7.8.9.10.1"
                    }
                  ]
                }
              }
            }
          ],
          "recordedOn": "2011-07-26T23:53:00.000Z"
        }
      ],
      "recorder": {
        "type": "PROVIDER",
        "provider": {
          "aliases": [
            {
              "type": "DEA"
            }
          ],
          "name": {
            "prefix": "Dr.",
            "given": [
              "Jane",
              "Susannah"
            ],
            "family": [
              "Smith"
            ],
            "suffix": "MD.",
            "formatted": "Dr. Jane Susannah Smith MD."
          }
        }
      },
      "responsibleProvider": {
        "aliases": [
          {
            "value": "235666",
            "type": "DEA",
            "system": "2.16.840.1.113883.4.814"
          }
        ],
        "name": {
          "family": [],
          "formatted": "Jones, Carolyn",
          "given": []
        }
      },
      "sourceIdentifier": {
        "dataPartitionId": "54dd3f9e-7c45-413d-88bc-3bafcee8b7ab",
        "id": "12345"
      },
      "status": {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "55561003",
            "display": "Active"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "55561003",
            "display": "Active"
          }
        ],
        "text": "Active"
      },
      "statusUpdatedOn": "2018-01-23",
      "type": {
        "sourceCodings": [
          {
            "system": "urn:oid:2.16.840.1.113883.6.96",
            "code": "282291009"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "282291009",
            "display": "Diagnosis interpretation"
          }
        ],
        "text": "Diagnosis interpretation"
      }
    }
  ],
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/condition/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/conditions?limit=20",
  "nextLink": "https://cernerdemo.api.us.healtheintent.com/condition/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/conditions?cursor=9223350710483575807021bc72d0c51a99c7fe05109f2ebf4340bfc838b1821e4cf7297c99b05d73558&limit=20"
}

GET /populations/{populationId}/patients/{patientId}/conditions

Retrieves a list of the conditions for a given patient.

Parameters

Parameter In Type Required Default Description Accepted Values
patientId path string true N/A The identifier of the patient. -
populationId path string true N/A The identifier of the population. -
conditionId query array[string] false N/A The unique ID of the condition record. -
cursor query string false N/A The last item on the list in the response from the previous request. If you specify this parameter, the response begins with the next item on the list. -
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 Conditions
400 Bad Request Bad request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not found Error

Schema Definitions

Condition

Name Type Required Description Accepted Values
assertedOn string false The date the condition was first acknowledged and recorded in the system. In International Organization for Standardization (ISO) 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
classification CodeableConcept false The clinical stage or process at which the condition was identified, for example, Admitting, Discharge, Final, or Billing. -
code CodeableConcept false Identifies the condition, problem, diagnosis, or concern, or lack thereof, and its categories using a textual description or codified values. Assertions of refuted conditions typically are done using the confirmationStatus field, whereas holistic assertions of no known problems at all can be conveyed using the code. -
confirmationStatus CodeableConcept false The verification status or degree of certainty of the condition. -
encounter Encounter false The encounter associated with the condition. -
id string true The unique ID of the condition record. -
notes [ProviderNote] true The notes or comments associated with the condition. -
onset string false The clinically significant date when the condition was first reported as present. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
presentOnAdmission CodeableConcept false Identifies whether the condition was present on admission in the context of a particular visit. -
provenances [Provenance] true The record-keeping assertions about the context in which the condition information was obtained (for example, the authoring organization, the transmitter or custodian organization that informs the chain of custody, or the source Consolidated Clinical Document Architecture (C-CDA) document from which this condition was derived, if applicable). -
recorder Recorder false The individual who recorded the record and takes responsibility for its content. -
responsibleProvider Provider false The provider who is associated with the condition. The responsible provider can be the person who diagnosed the condition, added the condition to the problem list, recorded the condition, or is responsible for treating the condition. -
sourceIdentifier SourceIdentifier false An ID that uniquely identifies this condition for a patient in a data partition. -
status CodeableConcept false The state of the condition, such as active or resolved. -
statusUpdatedOn string false The date when the status was updated. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
type CodeableConcept false A categorization of the condition, such as problem or diagnosis. -

CodeableConcept

Name Type Required Description Accepted Values
codings [Code] true A list of codified values from standard code systems recognized by HealtheIntent. -
sourceCodings [Code] true The list of codified values provided in the source data. Not all of these codes are available in the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by HealtheIntent. -
text string false This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. -

Code

Name Type Required Description Accepted Values
code string true The unique ID of the code. -
display string false A human-readable representation of the code. -
system string true The ID of the coding system that gives meaning to the code. -

Encounter

Name Type Required Description Accepted Values
id string false The unique ID of the encounter. -

ProviderNote

Name Type Required Description Accepted Values
date string false The date when the note was recorded. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
text string true The textual content of the note or comment. -
author Provider false The individual who recorded the note or comment. -
type CodeableConcept false The type of the note or comment. -

Provider

Name Type Required Description Accepted Values
aliases [ProviderAlias] false A list of IDs of the provider, such as the ten-digit National Provider Identifier (NPI) or the Drug Enforcement Administration (DEA) number. -
name ProviderName false The attributes of the provider name. -

ProviderAlias

Name Type Required Description Accepted Values
system string false The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. -
value string false The unique ID of the provider in the context of the system or assigning authority. -
type string true The type of alias. DEA, EXTERNAL, NPI, SL, TAX, UPIN

ProviderName

Name Type Required Description Accepted Values
prefix string false The parts that come before the name such as Dr., Mr., or Mrs. -
given [string] true A list of given name portions of the person’s name. For example, if a person has a first name and a middle name, the first name should be the first item on the list and the middle name should be the second item on the list. -
family [string] true A list of family (last) name portions of the person’s name. Some people have multiple family names. -
suffix string false The parts that come after the name such as MD, III, or Jr. -
formatted string false The person’s fully-formatted name. -

Provenance

Name Type Required Description Accepted Values
entities [ProvenanceEntity] true A list of entities used in this activity. -
agents [ProvenanceAgent] true Actors taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. -
recordedOn string false When the activity was recorded/updated. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -

ProvenanceEntity

Name Type Required Description Accepted Values
role CodeableConcept false How the entity was used in a provenance activity (for example, source). -
what ProvenanceEntityIdentity false Identity of the entity used in the provenance activity. -

ProvenanceEntityIdentity

Name Type Required Description Accepted Values
documentReference DocumentReferenceId false The ID of the document reference entity used in the provenance activity. -

DocumentReferenceId

Name Type Required Description Accepted Values
id string false The unique ID that identifies the document reference within the data partition to which it was published. -

ProvenanceAgent

Name Type Required Description Accepted Values
type CodeableConcept true The participation the agent had with respect to the activity. -
who ProvenanceAgentEntity false Who participated as an agent in a provenance activity. -

ProvenanceAgentEntity

Name Type Required Description Accepted Values
organization Organization false An organization participating entity. -

Organization

Name Type Required Description Accepted Values
name string false The name of the organization. -
aliases [OrganizationAlias] true A list of IDs of the organization, such as the NPI or the tax ID. -

OrganizationAlias

Name Type Required Description Accepted Values
value string true The unique ID of the alias. -
type string true The type of organization alias, such as NPI. NPI, TAX, EXTERNAL, NABP, HL7_OID
system string false The authority responsible for assigning the alias value. Alias values may be unique within this system namespace but not across systems. -

Recorder

Name Type Required Description Accepted Values
type string false The type, or role, of the recorder. -
provider Provider false The provider who recorded the condition. -

SourceIdentifier

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

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

Conditions

Name Type Required Description Accepted Values
items [Condition] true [Retrieves a single condition for a given patient.] -
firstLink string true The first page of results. -
nextLink string false The next page of results. -