NAV Navbar
Logo cerner
ruby shell

HealtheCare API

The HealtheCare API allows you to retrieve the following types of care management data:

Terminology

Term Definiton
Aligned Provider An aligned provider is used to align candidates to care management personnel. A candidate is aligned to a health care provider, and that health care provider is aligned to a care management personnel. This alignment is done through the alignment algorithm.
Alignment Supporting Fact One or more supporting data points that caused a candidate to be aligned with a care management personnel member.
Attributed Provider A health care provider who has been identified through attribution to be responsible for the care of a candidate.
Benefit Coverage An insurance plan that is used to cover the cost of health care services.
Calculated Risk Score A person’s or population’s overall expected health outcomes or costs calculated by Cerner through customizable risk score calculation.
Candidate A person who has been identified through the established algorithm for care management services.
Care Manager A personnel member with the assigned position of care manager. Care managers are responsible for performing care management services.
Covariate A data point that contributes to the calculated risk score.
Exclusion A candidate who is excluded from being identified for a program is suppressed and not included on the candidate list for a program or programs for a certain amount of time.
Identification Supporting Fact One or more supporting data points that caused a candidate to be identified for care management services.
MARA Risk Score A person’s or population’s overall expected health outcomes or costs. HealtheCare currently models risk scores based on the Milliman Advanced Risk Adjusters (MARA) to make overall predictions about people’s future total claim costs. Risk scores are normalized for each population so that the average risk score for a person in the population is always one. The higher the risk score, the more costly than average a person’s care is likely to be. Risk scores less than one indicate that a person’s care is likely to cost less than the average person in the population. Person-level risk scores are aggregated at the person and organization level to provide an overall picture of the costs of care at each level.
Payer The payer responsible for a benefit coverage, for example, athenahealth or Blue Cross Blue Shield.
Product Type The type of benefit coverage, for example, Medicare or Medicaid.
Program Care management programs are used to align candidates to specific care management personnel for performing specific care management services based on the program (for example, High Risk Maternity for pregnant candidates). Care management programs are configured through the alignment algorithm.
Service Group A group of care management personnel who are used to identify, create, and manage specialized populations and limit user access to sensitive person and case data for those populations. This requires additional configuration and might not be defined in the API.

Aligned Organizations

Example Request:

require 'httparty'

HTTParty.get(
  'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/aligned_organizations',
    headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/aligned_organizations

Example Aligned Organizations Response:

{
  "aligned_organizations": [
    {
      "org_id": "2ee38e5d-b812-48de-aa4a-41fff9ae6bd9",
      "org_name": "Baseline Region West",
      "alignment_type": "CARE_MANAGER_REGION"
    },
    {
      "org_id": "6d108407-b9b7-4a75-87bf-97cb5c9c5b95",
      "org_name": "Millennium and HI Org 1",
      "alignment_type": "CARE_MANAGER_REGION"
    },
    {
      "org_id": "5dc9430a-fda0-4ccc-8ae9-9a5b1cbaf20d",
      "org_name": "Millennium and HI Org 2",
      "alignment_type": "CARE_MANAGER_REGION"
    },
    {
      "org_id": "1e3401eb-d851-4f1a-b676-84629ef39abc",
      "org_name": "Millennium and HI Org 3",
      "alignment_type": "CARE_MANAGER_REGION"
    }
  ],
  "more_results": false,
  "total_results": 4
}

GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/aligned_organizations

Retrieves a list of aligned organizations for care management candidates based on a specified population.

Path Parameters

Parameter Type Description
population_id string The HealtheIntent population ID

Query Parameters

Parameter Type Description
aligned_care_manager_id string Restricts the aligned organization list to organizations that are aligned to this care manager (Optional)
suppressed_candidates boolean Boolean determining if candidate suppression is considered when determining which organizations to return (Optional)
  • If true, this endpoint returns organizations which are aligned to at least one candidate who has been suppressed for at least one program for which they were identified
  • If false (Default), this endpoint returns organizations who are aligned to at least one candidate who is not suppressed for any of the programs for which they were identified
start integer Index of results at which to start (Optional)
  • Default = 0
  • Must be >= 0
limit integer The number of results to return (Optional)
  • Default = 20
  • 0 < limit <= 100

Response Statuses

Status Type Description
200 AlignedOrganizationsResponse Success
400 string Bad request
401 string Unauthorized
403 string Forbidden
404 string Not found
500 string Internal server error

Aligned Providers

Example Request:

require 'httparty'

HTTParty.get(
  'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/aligned_providers',
    headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/aligned_providers

Example Aligned Providers Response:

{
  "aligned_providers": [
    {
      "id": "2ee38e5d-b812-48de-aa4a-41fff9ae6bd9",
      "full_name": "Robert Smith"
    },
    {
      "id": "6d108407-b9b7-4a75-87bf-97cb5c9c5b95",
      "full_name": "John Williams"
    },
    {
      "id": "5dc9430a-fda0-4ccc-8ae9-9a5b1cbaf20d",
      "full_name": "David Brown"
    },
    {
      "id": "1e3401eb-d851-4f1a-b676-84629ef39abc",
      "full_name": "Richard  Davis"
    }
  ],
  "more_results": false,
  "total_results": 4
}

GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/aligned_providers

Retrieves a list of aligned providers for care management candidates based on a specified population.

Path Parameters

Parameter Type Description
population_id string The HealtheIntent population ID

Query Parameters

Parameter Type Description
personnel_id string Restricts the aligned provider list to providers that are aligned to this care manager (Optional)
suppressed_candidates boolean Boolean determining if candidate suppression is considered when determining which providers to return (Optional)
  • If true, this endpoint returns providers who are aligned to at least one candidate who has been suppressed for at least one program for which they were identified
  • If false (Default), this endpoint returns providers who are aligned to at least one candidate who is not suppressed for any of the programs for which they were identified
start integer Index of results at which to start (Optional)
  • Default = 0
  • Must be >= 0
limit integer The number of results to return (Optional)
  • Default = 20
  • 0 < limit <= 100

Response Statuses

Status Type Description
200 AlignedProvidersResponse Success
400 string Bad request
401 string Unauthorized
403 string Forbidden
404 string Not found
500 string Internal server error

Aligned Worksite Locations

Example Request:

require 'httparty'

HTTParty.get(
  'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/care_managers/3d4ca09f-5024-4d66-89d9-6d5780e4d694/aligned_worksite_locations',
    headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/care_managers/3d4ca09f-5024-4d66-89d9-6d5780e4d694/aligned_worksite_locations

Example Aligned Worksite Locations Response:

{
  "aligned_worksite_locations": [
    {
      "id": "5dc9430a-fda0-4ccc-8ae9-9a5b1cbaf20d",
      "name": "Millennium and HI Org 1"
    },
    {
      "id": "1e3401eb-d851-4f1a-b676-84629ef39abc",
      "name": "Millennium and HI Org 2"
    }
  ],
  "total_results": 2,
  "more_results": false
}

GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/care_managers/{care_manager_id}/aligned_worksite_locations

Retrieves a list of aligned worksite locations for a given care management candidate based on a specified population.

Path Parameters

Parameter Type Description
population_id string The HealtheIntent population ID
care_manager_id string The HealtheIntent care manager ID

Query Parameters

Parameter Type Description
start integer Index of results at which to start (Optional)
  • Default = 0
  • Must be >= 0
limit integer The number of results to return (Optional)
  • Default = 20
  • 0 < limit <= 100

Response Statuses

Status Type Description
200 AlignedWorksiteLocationsResponse Success
400 string Bad request
401 string Unauthorized
403 string Forbidden
404 string Not found
500 string Internal server error

Attributed Providers

Example Request:

require 'httparty'

HTTParty.get(
  'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/attributed_providers',
    headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/attributed_providers

Example Attributed Providers Response:

{
  "attributed_providers": [
    {
      "id": "2ee38e5d-b812-48de-aa4a-41fff9ae6bd9",
      "full_name": "Robert Smith"
    },
    {
      "id": "6d108407-b9b7-4a75-87bf-97cb5c9c5b95",
      "full_name": "John Williams"
    },
    {
      "id": "5dc9430a-fda0-4ccc-8ae9-9a5b1cbaf20d",
      "full_name": "David Brown"
    },
    {
      "id": "1e3401eb-d851-4f1a-b676-84629ef39abc",
      "full_name": "Richard  Davis"
    }
  ],
  "more_results": false,
  "total_results": 4
}

GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/attributed_providers

Retrieves a list of attributed providers for care management candidates based on a specified population.

Path Parameters

Parameter Type Description
population_id string The HealtheIntent population ID

Query Parameters

Parameter Type Description
personnel_id string Restricts the attributed provider list to providers attributed to candidates that are aligned to this care manager (Optional)
suppressed_candidates boolean Boolean determining if candidate suppression is considered when determining which providers to return
  • If true, this endpoint returns providers who are attributed to at least one candidate who has been suppressed for at least one program for which they were identified
  • If false (Default), this endpoint returns providers who are attributed to at least one candidate who is not suppressed for any of the programs for which they were identified
q string Query string that restricts the attributed provider list to the providers having a full name containing this string; case-insensitive (Optional)
start integer Index of results at which to start (Optional)
  • Default = 0
  • Must be >= 0
limit integer The number of results to return (Optional)
  • Default = 20
  • 0 < limit <= 100

Response Statuses

Status Type Description
200 AttributedProvidersResponse Success
400 string Bad request
401 string Unauthorized
403 string Forbidden
404 string Not found
500 string Internal server error

Candidates

Candidates List

Example Request:

require 'httparty'

HTTParty.get(
  'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates',
    headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates

Example Candidates List Response:

{
  "candidates": [
    {
      "empi_id": "2dcb4990-e4b7-40be-9bbc-fd5818f263cb",
      "identification_date": "2014-08-30T01:52:14.14Z",
      "programs": [
        {
          "id": "app.caremanagement.highrisksenior.clinical.high-risk-senior",
          "name": "High-Risk Senior",
          "identification_date": "2014-08-30T01:52:14.14Z",
          "risk_scores": [
            {
              "risk_score_type": "Cardiac",
              "risk_score": "51.9",
              "type": {
                "id": "161168008",
                "coding_system_id": "2.16.840.1.113883.6.96",
                "display": "Morbidity Prediction",
                "coding_system_display": "SNOMED CT"
              },
              "method": {
                "id": "10741000175107",
                "coding_system_id": "2.16.840.1.113883.6.96",
                "display": "ACC/AHA ASCVD Risk Calculation",
                "coding_system_display": "SNOMED CT"
              },
              "condition": {
                "id": "443502000",
                "coding_system_id": "2.16.840.1.113883.6.96",
                "display": "Atherosclerotic Cardiovascular Disease",
                "coding_system_display": "SNOMED CT"
              }
            }
          ],
          "assignable_care_managers": [
            {
              "id": "3d4ca09f-5024-4d66-89d9-6d5780e4d694",
              "name": "CareManager, Sally",
              "alignment_supporting_facts": {
                "provider_attribution": [
                  {
                    "provider_id": "1e3401eb-d851-4f1a-b676-84629ef39abc",
                    "provider_name": "Richard,  Davis",
                    "org_names_list": [
                      {
                        "org_name": "Baseline East Medical Center"
                      }
                    ]
                  }
                ],
                "worksite_locations": [
                  {
                    "id": "cca04290-3c2a-44c8-9326-e7117ad6859d",
                    "name": "Baseline Region West"
                  }
                ]
              }
            }
          ],
          "suppressed": false,
          "excluded": false
        }
      ],
      "demographics": {
        "address": {
          "city": "Kansas City",
          "country": "USA",
          "country_details": null,
          "county_or_parish": "Clay",
          "county_or_parish_details": null,
          "postal_code": "64117",
          "state_or_province": "Missouri",
          "state_or_province_details": null,
          "street_addresses": [
            "123 Roe Avenue"
          ]
        },
        "date_of_birth": "1980-05-04",
        "full_name": "Jason Doe",
        "gender": "Male",
        "given_names": [
          "Jason",
          "Jon"
        ],
        "family_names": [
          "Doe"
        ],
        "prefix": "Mr",
        "suffix": "Jr",
        "telecoms": [
          {
            "preferred": true,
            "number": "(789) 656-2451",
            "extension": "678",
            "country_code": "001"
          }
        ],
        "email_addresses": [
          {
            "address": "jason.doe@example.com"
          }
        ]
      },
      "record_ids": [],
      "risk_scores": {
        "mara_risk_scores": [
          {
            "total_score": 10.0,
            "model_name": "CXCONLAG0"
          }
        ],
        "calculated_risk_scores": [
          {
            "risk_score_type": "Cardiac",
            "risk_score": "51.9",
            "type": {
              "id": "161168008",
              "coding_system_id": "2.16.840.1.113883.6.96",
              "display": "Morbidity Prediction",
              "coding_system_display": "SNOMED CT"
            },
            "method": {
              "id": "10741000175107",
              "coding_system_id": "2.16.840.1.113883.6.96",
              "display": "ACC/AHA ASCVD Risk Calculation",
              "coding_system_display": "SNOMED CT"
            },
            "condition": {
              "id": "443502000",
              "coding_system_id": "2.16.840.1.113883.6.96",
              "display": "Atherosclerotic Cardiovascular Disease",
              "coding_system_display": "SNOMED CT"
            }
          }
        ]
      },
      "assignable_care_managers": [
        {
          "id": "3d4ca09f-5024-4d66-89d9-6d5780e4d694",
          "name": "CareManager, Sally",
          "alignment_supporting_facts": {
            "provider_attribution": [],
            "programs": [
              {
                "program_id": "millennium.caremanagement.highriskmaternity.clinical.high-risk-maternity",
                "program_name": "High-Risk Maternity"
              }
            ],
            "worksite_locations": [
              {
                "id": "cca04290-3c2a-44c8-9326-e7117ad6859d",
                "name": "Baseline Region West"
              }
            ]
          }
        }
      ],
      "aligned_providers": [
        {
          "provider_id": "2ee38e5d-b812-48de-aa4a-41fff9ae6bd9",
          "provider_name": "Robert, Smith",
          "org_names_list": [
            {
              "org_name": "Baseline East Medical Center"
            }
          ]
        }
      ],
      "benefit_coverages": [
        {
          "begin_date": "2007-12-05",
          "end_date": "2025-10-31",
          "member_id": "MO-1234-4567",
          "product_type": "Mock LOB A",
          "payer_name": "Mock Payer A",
          "plan_ids": [
            {
              "value": "HPVAL1",
              "type": "HPID"
            }
          ],
          "plan_name": "Mock Health Plan A",
          "source": {
            "contributing_organization": null,
            "partition_description": "Mock Partition A",
            "type": "ENROLLMENT"
          }
        }
      ],
      "suppressed": false,
      "start_date_of_latest_ed_visit": "2015-03-05T10:00:00Z",
      "end_date_of_latest_ed_visit": "2015-03-05T10:50:00Z",
      "start_date_of_latest_inpatient_visit": null,
      "end_date_of_latest_inpatient_visit": null,
      "total_ed_visits": 2,
      "total_inpatient_visits": 0
    }
  ],
  "plans": [
    {
      "candidate_count": 721,
      "payer_name": "HUMANA",
      "plan_name": "HUMANA Gold"
    }
  ],
  "product_types": [
    {
      "candidate_count": 403,
      "product_type": "HMO"
    }
  ],
  "programs": [
    {
      "program_id": "app.caremanagement.highriskadult.clinical.high-risk-adult",
      "program_name": "High-Risk Adult"
    }
  ],
  "aligned_providers": [
    {
      "fact_id": "2ee38e5d-b812-48de-aa4a-41fff9ae6bd9",
      "fact_display": "Robert, Smith"
    }
  ],
  "total_results": 1,
  "more_results": false
}

GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/candidates

Retrieves information regarding a group of candidates based on a specified population.

Path Parameters

Parameter Type Description
population_id string The HealtheIntent population ID

Query Parameters

Parameter Type Description
aligned_provider_id string Restricts the candidate list to those aligned with this provider
personnel_id string Restricts the candidates list to candidates that are aligned to this care manager (Optional)
program_id string Filters candidates who have been identified for a specified program or programs
  • Multiple program IDs must repeat the parameter name for each ID
  • Candidates qualify if they are on at least 1 of the provided programs
suppressed boolean Filters suppressed candidates
  • If true, the candidate list will include only suppressed candidates
  • If false, the candidate list will exclude suppressed candidates
payer string Restricts the candidate list to candidates with this payer name
plan string Restricts the candidate list to candidates with this plan name
product_type string Restricts the candidate list to candidates with this product_type
sort string Value by which to sort the candidate list:
  • risk_score (Default): the calculated risk scores of the candidates
  • identification_date: the date the candidate was initially identified as a candidate for care management
    • When a single program_id is specified, candidates are sorted based on the identification_date of the given program
    • When multiple or zero program_ids are given, the earliest identification_date is used across all programs
  • latest_ed_visit: the end date of the candidate’s latest emergency department visit
  • latest_inpatient_visit: the end date of the candidate’s latest inpatient visit
order string How the candidate list is sorted
  • Use asc to sort the list in ascending alphabetic order
  • Use desc (Default) to sort in descending alphabetic order
start integer Index of results at which to start (Optional)
  • Default = 0
  • Must be >= 0
limit integer The number of results to return (Optional)
  • Default = 20
  • 0 < limit <= 100
record_ids.data_partition_id string Returns only the record_ids for the data partition specified

Response Statuses

Status Type Description
200 CandidatesListResponse Success
400 string Bad request
401 string Unauthorized
403 string Forbidden
404 string Not found
500 string Internal server error

Candidates List Batch

Example Request:

require 'httparty'

HTTParty.post(
  'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates/batch',
    headers: {
      'Authorization' => 'auth_header',
      'Content-Type' => 'application/json'
      },
    body: {
        'empi_ids': [
          'empi_id_1',
          'empi_id_2'
        ]
      }
)
curl -X POST -H 'Authorization: <auth_header>' -H 'Content-Type: application/json' -d '{"emp_ids":["<empi_id", "<empi_id_2"]}' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates/batch

Example Candidates List Batch Response:

{
  "candidates": [
    {
      "empi_id": "2dcb4990-e4b7-40be-9bbc-fd5818f263cb",
      "empi_version": 1,
      "identification_date": "2014-08-30T01:52:14.17Z",
      "programs": [
        {
          "id": "app.caremanagement.highrisksenior.clinical.high-risk-senior",
          "name": "High-Risk Senior",
          "identification_date": "2014-08-30T01:52:14.17Z",
          "risk_scores": [
            {
               "risk_score": "56.4",
               "risk_score_type": "PPE free-text pre-existing field for CalculatedRiskScore",
               "type": {
                  "id": "PPE TYPE ID",
                  "coding_system_id": "2.16.840.1.113883.6.96",
                  "display": "PPE TYPE CODE DISPLAY",
                  "coding_system_display": "SNOMED CT"
               },
               "method": {
                  "id": "PPE METHOD ID",
                  "coding_system_id": "2.16.840.1.113883.6.96",
                  "display": "PPE METHOD CODE DISPLAY",
                  "coding_system_display": "SNOMED CT"
               },
               "condition": {
                  "id": "PPE CONDITION ID",
                  "coding_system_id": "2.16.840.1.113883.6.96",
                  "display": "PPE CONDITION CODE DISPLAY",
                  "coding_system_display": "SNOMED CT"
               }
            }
          ],
          "assignable_care_managers": [
            {
              "id": "3d4ca09f-5024-4d66-89d9-6d5780e4d694",
              "name": "CareManager, Sally",
              "alignment_supporting_facts": {
                "provider_attribution": [
                  {
                    "provider_id": "c0639837-7555-4bc5-b9b2-abeac567fd02",
                    "provider_name": "Malaker, Mike",
                    "org_names_list": [
                      {
                        "org_name": "Baseline East Medical Center"
                      }
                    ]
                  }
                ],
                "worksite_locations": [
                  {
                    "id": "cca04290-3c2a-44c8-9326-e7117ad6859d",
                    "name": "Baseline Region West"
                  }
                ]
              }
            }
          ],
          "suppressed": false,
          "excluded": false,
          "supporting_data_points_str": "{\"supporting_data_points\":{\"calculated_risk_scores\":[{\"name\":\"Calculated Risk Score: 0.65\",\"descriptions\":[{\"display\":\"Calculated Risk Score\",\"values\":[\"0.65\"]}],\"covariates\":[{\"name\":\"Personal Health Assessment Test\",\"value\":\"20.5\",\"supporting_facts\":[{\"questionnaires\":[{\"name\":\"PHA from employer\",\"iso_recorded_date\":\"2010-10-25:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}},{\"name\":\"PHA from Health Coaching Services\",\"iso_recorded_date\":\"2011-09-17:T14:48:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}}]}]}]}],\"conditions\":[{\"name\":\"Unspecified essential hypertension\",\"code\":\"401.9\",\"code_system\":\"ICD-9-CM\",\"date\":\"05\/14\/2015\",\"iso_begin_date\":\"2015-05-14:T00:00:00.000Z\",\"source\":{\"partition_description\":\"Pop Health 1 BCBS_PPO in Staging\",\"type\":\"CLAIM\"}}],\"encounters\":[{\"name\":\"Encounter with providerPersonnelLite1\",\"code\":\"452832018\",\"code_system\":\"SNOMED CT\",\"date\":\"11\/10\/2015\",\"iso_begin_date\":\"2015-11-10:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}}],\"derived_encounters\":[{\"name\":\"Emergency Department\",\"date\":\"01\/30\/2013-01\/30\/2014\",\"iso_begin_date\":\"2013-01-30:T00:00:00.000Z\",\"iso_end_date\":\"2014-01-30:T00:00:00.000Z\"},{\"name\":\"Emergency Department\",\"code\":\"401.9\",\"code_system\":\"ICD-9-CM\",\"date\":\"01\/30\/2013-01\/30\/2014\",\"iso_begin_date\":\"2013-01-30:T00:00:00.000Z\",\"iso_end_date\":\"2014-01-30:T00:00:00.000Z\",\"source\":{\"partition_description\":\"STGENG - PCCA Clone\",\"type\":\"EMR\"}}],\"generic_risk_scores\":[{\"name\":\"HRA: Medium - General Health Assessment, General Pregnancy Assessment\",\"date\":\"08\/15\/2015\",\"iso_begin_date\":\"2015-08-15:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}}],\"procedures\":[{\"name\":\"Tracheotomy\",\"code\":\"48387007\",\"code_system\":\"SNOMED CT\",\"date\":\"07\/17\/2015\",\"iso_begin_date\":\"2015-07-17:T00:00:00.000Z\",\"source\":{\"partition_description\":\"STGENG - PCCA Clone\",\"type\":\"EMR\"}},{\"name\":\"Wound care\",\"code\":\"225358003\",\"code_system\":\"SNOMED CT\",\"date\":\"07\/14\/2015\",\"iso_begin_date\":\"2015-07-14:T00:00:00.000Z\",\"source\":{\"partition_description\":\"STGENG - PCCA Clone\",\"type\":\"EMR\"}}],\"questions\":[{\"name\":\"Did you take any medications? Mucinex, Tylenol, Equate syrup - General Pregnancy Assessment\",\"date\":\"10\/25\/2010\",\"iso_begin_date\":\"2010-10-25:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}}],\"referral_files\":[{\"name\":\"Referred by: Dr. Schulz,  Referral reason: Food Poisoning,  Referral diagnosis: Congestive heart failure (SNOMED CT 70653017) (ADMITTING), Gastro-esophageal reflux disease (ICD-10-CM K21) (PRINCIPAL), Osteoporosis (ICD-9-CM 733.00) (OTHER)\",\"date\":\"02\/25\/2015\",\"iso_begin_date\":\"2015-02-25:T00:00:00.000Z\",\"source\":{\"partition_description\":\"Some Manga\",\"type\":\"EMR\"},\"descriptions\":[{\"display\":\"Referred by:\",\"values\":[\"Dr. Schulz\"]},{\"display\":\"Referral reason:\",\"values\":[\"Food Poisoning\"]},{\"display\":\"Referral diagnosis:\",\"values\":[\"Congestive heart failure (SNOMED CT 70653017) (ADMITTING)\",\"Gastro-esophageal reflux disease (ICD-10-CM K21) (PRINCIPAL)\",\"Osteoporosis (ICD-9-CM 733.00) (OTHER)\"]}]}],\"registry_measure_outcomes\":[{\"descriptions\":[{\"value\":[\"Body Mass Index Screening and Follow-Up\"],\"status\":\"NOT_MET_DATA_AVAILABLE\"}],\"header\":\"Preventive Care\",\"name\":\"Preventive Care: Body Mass Index Screening and Follow-Up (Not Achieved)\"},{\"descriptions\":[{\"value\":[\"Tobacco Use Screening and Cessation Intervention\"],\"status\":\"MET_DATA_AVAILABLE\"}],\"header\":\"Preventive Care\",\"name\":\"Preventive Care: Tobacco Use Screening and Cessation Intervention (Achieved)\"},{\"descriptions\":[{\"value\":[\"Screening for Clinical Depression and Follow-Up Plan\"],\"status\":\"NOT_MET_NO_DATA\"}],\"header\":\"Diabetes\",\"name\":\"Diabetes: Screening for Clinical Depression and Follow-Up Plan (Missing Data)\"},{\"descriptions\":[{\"value\":[\"Colorectal Cancer Screening\"],\"status\":\"NOT_MET_NO_DATA\"}],\"header\":\"Diabetes\",\"name\":\"Diabetes: Colorectal Cancer Screening (Missing Data)\"},{\"descriptions\":[{\"value\":[\"Screening for High Blood Pressure and Follow-Up\"],\"status\":\"NOT_MET_DATA_AVAILABLE\"}],\"header\":\"Diabetes\",\"name\":\"Diabetes: Screening for High Blood Pressure and Follow-Up (Not Achieved)\"}],\"registry_identification_outcomes\":[{\"name\":\"Preventive Care\"},{\"name\":\"Hypertension\"}],\"results\":[{\"name\":\"Chol\/HDL 3.1\",\"code\":\" 9830-1\",\"code_system\":\"LOINC\",\"date\":\"08\/15\/2015\",\"iso_begin_date\":\"2015-08-15:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}},{\"name\":\"HCO3 Art 24 mEq\/L\",\"code\":\"1960-4\",\"code_system\":\"LOINC\",\"date\":\"10\/25\/2010\",\"iso_begin_date\":\"2015-10-25:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}}],\"claims\":[{\"name\":\"Claim with Megan Fox at Hospital A\",\"date\":\"01\/11\/2013-05\/18\/2013\",\"iso_begin_date\":\"2013-01-11:T00:00:00.000Z\",\"iso_end_date\":\"2013-05-18:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"CLAIM\"}},{\"name\":\"Claim with Alex Morgan at Hospital B\",\"date\":\"02\/11\/2015-06\/20\/2015\",\"iso_begin_date\":\"2015-02-11:T00:00:00.000Z\",\"iso_end_date\":\"2015-06-20:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"CLAIM\"}}],\"medications\":[{\"name\":\"Aspirin, Oral\",\"code\":\"1960-4\",\"code_system\":\"LOINC\",\"date\":\"01\/11\/2010\",\"iso_begin_date\":\"2010-01-11:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}}],\"visit_intervals\":[{\"uid\":\"8487fd69-6de7-3d7f-95c7-79a6a31e794f\",\"id\":\"cerner-standard-heart-failure-unstable-visit-interval\",\"name\":\"Heart Failure Unstable Visit Interval\",\"previous_visit_date_iso8601\":\"2016-01-13\",\"next_visit_date_iso8601\":\"2016-07-11\",\"visit_interval\":180,\"visit_interval_unit\":\"DAYS\"},{\"uid\":\"4324sdf1-6de7-3d7f-95c7-79a6a31e794f\",\"id\":\"cerner-standard-heart-failure-stable-visit-interval\",\"name\":\"Heart Failure Stable Visit Interval\",\"previous_visit_date_iso8601\":\"2015-11-05\",\"next_visit_date_iso8601\":\"2016-02-04\",\"visit_interval\":91,\"visit_interval_unit\":\"DAYS\"},{\"uid\":\"542sgfd3-6de7-3d7f-95c7-79a6a31e794f\",\"id\":\"cerner-standard-heart-failure-advanced-visit-interval\",\"name\":\"Heart Failure Advanced Visit Interval\",\"previous_visit_date_iso8601\":\"2016-02-12\",\"next_visit_date_iso8601\":\"2016-09-23\",\"visit_interval\":224,\"visit_interval_unit\":\"DAYS\"},{\"uid\":\"92ds23sh-6de7-3d7f-95c7-79a6a31e794f\",\"id\":\"cerner-standard-diabetes-moderate-control-visit-interval\",\"name\":\"Diabetes Moderate Control Visit Interval\",\"previous_visit_date_iso8601\":\"2014-12-03\",\"next_visit_date_iso8601\":\"2015-03-06\",\"visit_interval\":93,\"visit_interval_unit\":\"DAYS\"},{\"uid\":\"37sd29js-6de7-3d7f-95c7-79a6a31e794f\",\"id\":\"cerner-standard-diabetes-poor-control-visit-interval\",\"name\":\"Diabetes Poor Control Visit Interval\",\"previous_visit_date_iso8601\":\"2015-04-13\",\"next_visit_date_iso8601\":\"2015-05-16\",\"visit_interval\":33,\"visit_interval_unit\":\"DAYS\"},{\"uid\":\"62ks93jf-6de7-3d7f-95c7-79a6a31e794f\",\"id\":\"cerner-standard-diabetes-controled-visit-interval\",\"name\":\"Diabetes Controled Visit Interval\",\"previous_visit_date_iso8601\":\"2015-05-08\",\"next_visit_date_iso8601\":\"2015-10-03\",\"visit_interval\":148,\"visit_interval_unit\":\"DAYS\"}],\"total_cost_of_care\":[{\"descriptions\":[{\"display\":\"Total Cost:\",\"values\":[\"1000.25\"]}],\"iso_begin_date\":\"2017-01-01\",\"iso_end_date\":\"2017-01-03\",\"name\":\"Total Cost: 1000.25\"}]}}",
          "supporting_data_points": {
            "calculated_risk_scores": [
              {
                "name": "Calculated Risk Score: 0.65",
                "descriptions": [
                  {
                    "display": "Calculated Risk Score",
                    "values": [
                      "0.65"
                    ]
                  }
                ],
                "covariates": [
                  {
                    "name": "Personal Health Assessment Test",
                    "value": "20.5",
                    "supporting_facts": [
                      {
                        "questionnaires": [
                          {
                            "name": "PHA from employer",
                            "iso_recorded_date": "2010-10-25:T00:00:00.000Z",
                            "source": {
                              "partition_description": "PCCA Clone",
                              "type": "EMR"
                            }
                          },
                          {
                            "name": "PHA from Health Coaching Services",
                            "iso_recorded_date": "2011-09-17:T14:48:00.000Z",
                            "source": {
                              "partition_description": "PCCA Clone",
                              "type": "EMR"
                            }
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ],
            "conditions": [
              {
                "name": "Unspecified essential hypertension",
                "code": "401.9",
                "code_system": "ICD-9-CM",
                "date": "05/14/2015",
                "iso_begin_date": "2015-05-14:T00:00:00.000Z",
                "source": {
                  "partition_description": "Pop Health 1 BCBS_PPO in Staging",
                  "type": "CLAIM"
                }
              }
            ],
            "encounters": [
              {
                "name": "Encounter with providerPersonnelLite1",
                "code": "408808013",
                "code_system": "SNOMED CT",
                "date": "11/10/2015",
                "iso_begin_date": "2015-11-10:T00:00:000Z",
                "source": {
                  "partition_description": "PCCA Clone",
                  "type": "EMR"
                }
              }
            ],
            "derived_encounters": [
              {
                "name": "Emergency Department",
                "code": "401.9",
                "code_system": "ICD-9-CM",
                "date": "01/30/2013-01/30/2014",
                "iso_begin_date": "2013-01-30:T00:00:00.000Z",
                "iso_end_date": "2014-01-30:T00:00:00.000Z",
                "source": {
                  "partition_description": "STGENG - PCCA Clone",
                  "type": "EMR"
                }
              }
            ],
            "generic_risk_scores": [
              {
                "name": "HRA: Medium - General Health Assessment, General Pregnancy Assessment",
                "date": "08/15/2015",
                "iso_begin_date": "2015-08-15:T00:00:000Z",
                "source": {
                  "partition_description": "PCCA Clone",
                  "type": "EMR"
                }
              }
            ],
            "procedures": [
              {
                "name": "Tracheotomy",
                "code": "48387007",
                "code_system": "SNOMED CT",
                "date": "07/17/2017",
                "iso_begin_date": "2017-07-17:T00:00:000Z",
                "source": {
                  "partition_description": "STGENG - PCCA Clone",
                  "type": "EMR"
                }
              }
            ],
            "questions": [
              {
                "name": "Did you take any medications? Mucinex, Tylenol, Equate syrup - General Pregnancy Assessment",
                "date": "10/25/2010",
                "iso_begin_date": "2010-10-25:T00:00:000Z",
                "source": {
                  "partition_description": "PCCA Clone",
                  "type": "EMR"
                }
              }
            ],
            "referral_files": [
              {
                "name": "Referred by: Dr. Schulz, Referral reason: Food Poisoning, Referral diagnosis: Congestive heart failure (SNOMED CT 70653017) (ADMITTING), Gastro-esophageal reflux disease (ICD-10-CM K21) (PRINCIPAL), Osteoporosis (ICD-9-CM 733.00) (OTHER)",
                "date": "02/25/2015",
                "iso_begin_date": "2015-02-25:T00:00:000Z",
                "source": {
                  "partition_description": "STGENG - PCCA Clone",
                  "type": "EMR"
                },
                "descriptions": [
                  {
                    "display": "Referred by:",
                    "values": [
                      "Dr. Schulz"
                    ]
                  }
                ]
              }
            ],
            "registry_measure_outcomes": [
              {
                "descriptions": [
                  {
                    "value": [
                      "Body Mass Index Screening and Follow-Up"
                    ],
                    "status": "NOT_MET_DATA_AVAILABLE"
                  }
                ],
                "header": "Preventive Care",
                "name": "Preventive Care: Body Mass Index Screening and Follow-Up (Not Achieved)"
              }
            ],
            "registry_identification_outcomes": [
              {
                "name": "Preventive Care"
              }
            ],
            "results": [
              {
                "name": "Chol/HDL 3.1",
                "code": " 9830-1",
                "code_system": "LOINC",
                "date": "08/15/2015",
                "iso_begin_date": "2015-08-15:T00:00:000Z",
                "source": {
                  "partition_description": "PCCA Clone",
                  "type": "EMR"
                }
              }
            ],
            "claims": [
              {
                "name": "Claim with Megan Fox at Hospital A",
                "date": "01/11/2013-05/18/2013",
                "iso_begin_date": "2013-01-11:T00:00:00Z",
                "iso_end_date": "2013-05-18:T00:00:00Z",
                "source": {
                  "partition_description": "PCCA Clone",
                  "type": "CLAIM"
                }
              }
            ],
            "medications": [
              {
                "name": "Aspirin, Oral",
                "code": "1960-4",
                "code_system": "LOINC",
                "date": "01/11/2010",
                "iso_begin_date": "2010-01-11:T00:00:000Z",
                "source": {
                  "partition_description": "PCCA Clone",
                  "type": "EMR"
                }
              }
            ],
            "visit_intervals": [
              {
                "uid": "8487fd69-6de7-3d7f-95c7-79a6a31e794f",
                "id": "cerner-standard-heart-failure-unstable-visit-interval",
                "name": "Heart Failure Unstable Visit Interval",
                "previous_visit_date_iso8601": "2016-01-13",
                "next_visit_date_iso8601": "2016-07-11",
                "visit_interval": 180,
                "visit_interval_unit": "DAYS"
              }
            ],
            "total_cost_of_care": [
              {
                "descriptions": [
                  {
                    "display": "Total Cost:",
                    "values": [
                      "1000.25"
                    ]
                  }
                ],
                "iso_begin_date": "2017-01-01",
                "iso_end_date": null,
                "name": "Total Cost: 1000.25"
              }
            ]
          }
        }
      ],
      "demographics": {
        "full_name": "Jason Doe",
        "given_names": [
          "Jason",
          "Jon"
        ],
        "family_names": [
          "Doe"
        ],
        "prefix": "Mr",
        "suffix": "Jr",
        "date_of_birth": "1980-05-04T00:00:00Z",
        "gender": "Male",
        "gender_details": {
          "id": "248153007",
          "coding_system_id": "2.16.840.1.113883.12.190",
          "display": "Male",
          "coding_system_display":"SNOMED CT 452832018"
        },
        "address": {
          "type": {
            "id": "H",
            "coding_system_id": "2.16.840.1.113883.12.190",
            "display": "Home",
            "coding_system_display":"HL7v2_5 Address Type"
          },
          "street_addresses": [
            "123 Roe Avenue"
          ],
          "city": "Kansas City",
          "state_or_province": "Missouri",
          "state_or_province_details": {
            "id": "MO",
            "coding_system_id": "2.16.840.1.113883.6.92",
            "display": "Missouri",
            "coding_system_display":"FIPS"
          },
          "postal_code": "64117",
          "county_or_parish": "Clay",
          "county_or_parish_details": {
            "id": "county_code_id_1",
            "coding_system_id": "county_coding_system_id_1",
            "display": "Clay"
          },
          "country": "United States",
          "country_details": {
            "id": "USA",
            "coding_system_id": "1.0.3166.1.2.3",
            "display": "United States",
            "coding_system_display": "ISO 3166-1 Standard Country Codes"
          }
        },
        "telecoms": [
          {
            "preferred": true,
            "number": "789656245",
            "extension": "678",
            "country_code": "001",
            "type": {
              "id": "WPN",
              "coding_system_id": "2.16.840.1.113883.12.201",
              "display": "Work",
              "coding_system_display":"HL7 V2.5 0201 Telecommunication Use"
            }
          }
        ],
        "email_addresses": [
          {
            "address": "jason.doe@example.com",
            "type": {
              "id": "H",
              "coding_system_id": "2.16.840.1.113883.12.190",
              "display": "Home",
              "coding_system_display":"HL7v2_5 Address Type"
            }
          }
        ]
      },
      "risk_scores": {
        "mara_risk_scores": [
          {
            "model_name": "CXCONLAG0",
            "total_score": 10.0
          }
        ],
        "calculated_risk_scores": [
          {
            "risk_score": "56.4",
            "risk_score_type": "PPE free-text pre-existing field for CalculatedRiskScore",
            "type": {
              "id": "PPE TYPE ID",
              "coding_system_id": "2.16.840.1.113883.6.96",
              "display": "PPE TYPE CODE DISPLAY",
              "coding_system_display": "SNOMED CT"
            },
            "method": {
              "id": "PPE METHOD ID",
              "coding_system_id": "2.16.840.1.113883.6.96",
              "display": "PPE METHOD CODE DISPLAY",
              "coding_system_display": "SNOMED CT"
            },
            "condition": {
              "id": "PPE CONDITION ID",
              "coding_system_id": "2.16.840.1.113883.6.96",
              "display": "PPE CONDITION CODE DISPLAY",
              "coding_system_display": "SNOMED CT"
             }
          }
        ]
      },
      "attributed_providers": [
        {
          "id": "c0123d92-9f04-498f-98f5-815b1dd46ce5",
          "full_name": "Attributed Provider 1"
        },
        {
          "id": "4926e5bd-fe45-4d5f-8e01-8d738e5e066d",
          "full_name": "Attributed Provider 2"
        }
      ],
      "benefit_coverages": [
        {
          "begin_date": "2007-12-05",
          "end_date": "2025-10-31",
          "member_id": "MO-1234-4567",
          "product_type": "Mock LOB A",
          "payer_name": "Mock Payer A",
          "plan_ids": [
            {
              "value": "HPVAL1",
              "type": "HPID"
            }
          ],
          "plan_name": "Mock Health Plan A",
          "source": {
            "partition_description": "Mock Partition A",
            "type": "ENROLLMENT"
          }
        }
      ],
      "assignable_care_managers": [
        {
          "name": "Care Manager 1",
          "id": "care-manager-1",
          "alignment_supporting_facts": {
            "programs": [
              {
                "program_id": "millennium.caremanagement.highriskmaternity.clinical.high-risk-maternity",
                "program_name": "High-Risk Maternity"
              },
              {
                "program_id": "millennium.caremanagement.highriskmaternity.clinical.high-risk-senior",
                "program_name": "High-Risk Senior"
              }
            ],
            "worksite_locations": [
              {
                "id": "cca04290-3c2a-44c8-9326-e7117ad6859d",
                "name": "Baseline Region West"
              }
            ]
          }
        }
      ],
      "assignable_personnel": [
        {
          "name": "Care Manager 1",
          "id": "care-manager-1",
          "programs": [
            {
              "program_id": "millennium.caremanagement.highrisksenior.clinical.high-risk-senior",
              "program_name": "High-Risk Senior",
              "alignment_supporting_facts": {
                "care_manager_regions": {
                  "descriptions": [
                    {
                      "display": "Organization 1"
                    }
                  ]
                },
                "provider_attribution": {
                  "descriptions": [
                    {
                      "display": "Provider 1",
                      "values": [
                        "Organization 1"
                      ]
                    }
                  ]
                },
                "worksite_locations": {
                  "descriptions": [
                    {
                      "display": "Baseline Region West"
                    }
                  ]
                }
              }
            }
          ]
        }
      ],
      "suppressed": false
    }
  ]
}

POST https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/candidates/batch

Retrieves information regarding a group of candidates based on HealtheIntent person IDs for a specified population.

Path Parameters

Parameter Type Description
population_id string The HealtheIntent population ID

Request Attributes

Parameter Type Description
empi_ids (required) string Returns candidates for the given empi_ids (commonly referred to as HealtheIntent person IDs)
  • Accepts between 1 and 20 empi_ids
  • If empi_ids are duplicated in the request, the duplicate IDs are ignored by the candidate services
  • empi_ids that are not found are ignored by the candidate services

Query Parameters

Parameter Type Description
benefit_coverages.type string Filters by a specified type of benefit coverage
record_ids.data_partition_id string Filters out record_ids section based on the data partition ID

Response Statuses

Status Type Description
200 CandidatesListBatchResponse Success
400 string Bad request
401 string Unauthorized
403 string Forbidden
404 string Not found
500 string Internal server error

Single Candidate

Example Request:

require 'httparty'

HTTParty.get(
  'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates/9bddfa1e-7028-428b-a273-1d76e3849d98',
    headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates/9bddfa1e-7028-428b-a273-1d76e3849d98

Example Single Candidate Response:

{
  "empi_id": "2dcb4990-e4b7-40be-9bbc-fd5818f263cb",
  "empi_version": 1,
  "identification_date": "2014-08-30T01:52:14.17Z",
  "programs": [
    {
      "id": "app.caremanagement.highrisksenior.clinical.high-risk-senior",
      "name": "High-Risk Senior",
      "identification_date": "2014-08-30T01:52:14.17Z",
      "risk_scores": [
        {
          "risk_score_type": "Cardiac",
          "risk_score": "51.9",
          "type": {
            "id": "161168008",
            "coding_system_id": "2.16.840.1.113883.6.96",
            "display": "Morbidity Prediction",
            "coding_system_display": "SNOMED CT"
          },
          "method": {
            "id": "10741000175107",
            "coding_system_id": "2.16.840.1.113883.6.96",
            "display": "ACC/AHA ASCVD Risk Calculation",
            "coding_system_display": "SNOMED CT"
          },
          "condition": {
            "id": "443502000",
            "coding_system_id": "2.16.840.1.113883.6.96",
            "display": "Atherosclerotic Cardiovascular Disease",
            "coding_system_display": "SNOMED CT"
          }
        }
      ],
      "assignable_care_managers": [
        {
          "id": "3d4ca09f-5024-4d66-89d9-6d5780e4d694",
          "name": "CareManager, Sally",
          "alignment_supporting_facts": {
            "provider_attribution": [
              {
                "provider_id": "c0639837-7555-4bc5-b9b2-abeac567fd02",
                "provider_name": "Malaker, Mike",
                "org_names_list": [
                  {
                    "org_name": "Baseline East Medical Center"
                  }
                ]
              }
            ],
            "worksite_locations": [
              {
                "id": "cca04290-3c2a-44c8-9326-e7117ad6859d",
                "name": "Baseline Region West"
              }
            ]
          }
        }
      ],
      "suppressed": false,
      "excluded": false,
      "supporting_data_points_str": "{\"supporting_data_points\":{\"calculated_risk_scores\":[{\"name\":\"Calculated Risk Score: 0.65\",\"descriptions\":[{\"display\":\"Calculated Risk Score\",\"values\":[\"0.65\"]}],\"covariates\":[{\"name\":\"Personal Health Assessment Test\",\"value\":\"20.5\",\"supporting_facts\":[{\"questionnaires\":[{\"name\":\"PHA from employer\",\"iso_recorded_date\":\"2010-10-25:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}},{\"name\":\"PHA from Health Coaching Services\",\"iso_recorded_date\":\"2011-09-17:T14:48:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}}]}]}]}],\"conditions\":[{\"name\":\"Unspecified essential hypertension\",\"code\":\"401.9\",\"code_system\":\"ICD-9-CM\",\"date\":\"05\/14\/2015\",\"iso_begin_date\":\"2015-05-14:T00:00:00.000Z\",\"source\":{\"partition_description\":\"Pop Health 1 BCBS_PPO in Staging\",\"type\":\"CLAIM\"}}],\"encounters\":[{\"name\":\"Encounter with providerPersonnelLite1\",\"code\":\"452832018\",\"code_system\":\"SNOMED CT\",\"date\":\"11\/10\/2015\",\"iso_begin_date\":\"2015-11-10:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}}],\"derived_encounters\":[{\"name\":\"Emergency Department\",\"date\":\"01\/30\/2013-01\/30\/2014\",\"iso_begin_date\":\"2013-01-30:T00:00:00.000Z\",\"iso_end_date\":\"2014-01-30:T00:00:00.000Z\"},{\"name\":\"Emergency Department\",\"code\":\"401.9\",\"code_system\":\"ICD-9-CM\",\"date\":\"01\/30\/2013-01\/30\/2014\",\"iso_begin_date\":\"2013-01-30:T00:00:00.000Z\",\"iso_end_date\":\"2014-01-30:T00:00:00.000Z\",\"source\":{\"partition_description\":\"STGENG - PCCA Clone\",\"type\":\"EMR\"}}],\"generic_risk_scores\":[{\"name\":\"HRA: Medium - General Health Assessment, General Pregnancy Assessment\",\"date\":\"08\/15\/2015\",\"iso_begin_date\":\"2015-08-15:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}}],\"procedures\":[{\"name\":\"Tracheotomy\",\"code\":\"48387007\",\"code_system\":\"SNOMED CT\",\"date\":\"07\/17\/2015\",\"iso_begin_date\":\"2015-07-17:T00:00:00.000Z\",\"source\":{\"partition_description\":\"STGENG - PCCA Clone\",\"type\":\"EMR\"}},{\"name\":\"Wound care\",\"code\":\"225358003\",\"code_system\":\"SNOMED CT\",\"date\":\"07\/14\/2015\",\"iso_begin_date\":\"2015-07-14:T00:00:00.000Z\",\"source\":{\"partition_description\":\"STGENG - PCCA Clone\",\"type\":\"EMR\"}}],\"questions\":[{\"name\":\"Did you take any medications? Mucinex, Tylenol, Equate syrup - General Pregnancy Assessment\",\"date\":\"10\/25\/2010\",\"iso_begin_date\":\"2010-10-25:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}}],\"referral_files\":[{\"name\":\"Referred by: Dr. Schulz,  Referral reason: Food Poisoning,  Referral diagnosis: Congestive heart failure (SNOMED CT 70653017) (ADMITTING), Gastro-esophageal reflux disease (ICD-10-CM K21) (PRINCIPAL), Osteoporosis (ICD-9-CM 733.00) (OTHER)\",\"date\":\"02\/25\/2015\",\"iso_begin_date\":\"2015-02-25:T00:00:00.000Z\",\"source\":{\"partition_description\":\"Some Manga\",\"type\":\"EMR\"},\"descriptions\":[{\"display\":\"Referred by:\",\"values\":[\"Dr. Schulz\"]},{\"display\":\"Referral reason:\",\"values\":[\"Food Poisoning\"]},{\"display\":\"Referral diagnosis:\",\"values\":[\"Congestive heart failure (SNOMED CT 70653017) (ADMITTING)\",\"Gastro-esophageal reflux disease (ICD-10-CM K21) (PRINCIPAL)\",\"Osteoporosis (ICD-9-CM 733.00) (OTHER)\"]}]}],\"registry_measure_outcomes\":[{\"descriptions\":[{\"value\":[\"Body Mass Index Screening and Follow-Up\"],\"status\":\"NOT_MET_DATA_AVAILABLE\"}],\"header\":\"Preventive Care\",\"name\":\"Preventive Care: Body Mass Index Screening and Follow-Up (Not Achieved)\"},{\"descriptions\":[{\"value\":[\"Tobacco Use Screening and Cessation Intervention\"],\"status\":\"MET_DATA_AVAILABLE\"}],\"header\":\"Preventive Care\",\"name\":\"Preventive Care: Tobacco Use Screening and Cessation Intervention (Achieved)\"},{\"descriptions\":[{\"value\":[\"Screening for Clinical Depression and Follow-Up Plan\"],\"status\":\"NOT_MET_NO_DATA\"}],\"header\":\"Diabetes\",\"name\":\"Diabetes: Screening for Clinical Depression and Follow-Up Plan (Missing Data)\"},{\"descriptions\":[{\"value\":[\"Colorectal Cancer Screening\"],\"status\":\"NOT_MET_NO_DATA\"}],\"header\":\"Diabetes\",\"name\":\"Diabetes: Colorectal Cancer Screening (Missing Data)\"},{\"descriptions\":[{\"value\":[\"Screening for High Blood Pressure and Follow-Up\"],\"status\":\"NOT_MET_DATA_AVAILABLE\"}],\"header\":\"Diabetes\",\"name\":\"Diabetes: Screening for High Blood Pressure and Follow-Up (Not Achieved)\"}],\"registry_identification_outcomes\":[{\"name\":\"Preventive Care\"},{\"name\":\"Hypertension\"}],\"results\":[{\"name\":\"Chol\/HDL 3.1\",\"code\":\" 9830-1\",\"code_system\":\"LOINC\",\"date\":\"08\/15\/2015\",\"iso_begin_date\":\"2015-08-15:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}},{\"name\":\"HCO3 Art 24 mEq\/L\",\"code\":\"1960-4\",\"code_system\":\"LOINC\",\"date\":\"10\/25\/2010\",\"iso_begin_date\":\"2015-10-25:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}}],\"claims\":[{\"name\":\"Claim with Megan Fox at Hospital A\",\"date\":\"01\/11\/2013-05\/18\/2013\",\"iso_begin_date\":\"2013-01-11:T00:00:00.000Z\",\"iso_end_date\":\"2013-05-18:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"CLAIM\"}},{\"name\":\"Claim with Alex Morgan at Hospital B\",\"date\":\"02\/11\/2015-06\/20\/2015\",\"iso_begin_date\":\"2015-02-11:T00:00:00.000Z\",\"iso_end_date\":\"2015-06-20:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"CLAIM\"}}],\"medications\":[{\"name\":\"Aspirin, Oral\",\"code\":\"1960-4\",\"code_system\":\"LOINC\",\"date\":\"01\/11\/2010\",\"iso_begin_date\":\"2010-01-11:T00:00:00.000Z\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"}}],\"visit_intervals\":[{\"uid\":\"8487fd69-6de7-3d7f-95c7-79a6a31e794f\",\"id\":\"cerner-standard-heart-failure-unstable-visit-interval\",\"name\":\"Heart Failure Unstable Visit Interval\",\"previous_visit_date_iso8601\":\"2016-01-13\",\"next_visit_date_iso8601\":\"2016-07-11\",\"visit_interval\":180,\"visit_interval_unit\":\"DAYS\"},{\"uid\":\"4324sdf1-6de7-3d7f-95c7-79a6a31e794f\",\"id\":\"cerner-standard-heart-failure-stable-visit-interval\",\"name\":\"Heart Failure Stable Visit Interval\",\"previous_visit_date_iso8601\":\"2015-11-05\",\"next_visit_date_iso8601\":\"2016-02-04\",\"visit_interval\":91,\"visit_interval_unit\":\"DAYS\"},{\"uid\":\"542sgfd3-6de7-3d7f-95c7-79a6a31e794f\",\"id\":\"cerner-standard-heart-failure-advanced-visit-interval\",\"name\":\"Heart Failure Advanced Visit Interval\",\"previous_visit_date_iso8601\":\"2016-02-12\",\"next_visit_date_iso8601\":\"2016-09-23\",\"visit_interval\":224,\"visit_interval_unit\":\"DAYS\"},{\"uid\":\"92ds23sh-6de7-3d7f-95c7-79a6a31e794f\",\"id\":\"cerner-standard-diabetes-moderate-control-visit-interval\",\"name\":\"Diabetes Moderate Control Visit Interval\",\"previous_visit_date_iso8601\":\"2014-12-03\",\"next_visit_date_iso8601\":\"2015-03-06\",\"visit_interval\":93,\"visit_interval_unit\":\"DAYS\"},{\"uid\":\"37sd29js-6de7-3d7f-95c7-79a6a31e794f\",\"id\":\"cerner-standard-diabetes-poor-control-visit-interval\",\"name\":\"Diabetes Poor Control Visit Interval\",\"previous_visit_date_iso8601\":\"2015-04-13\",\"next_visit_date_iso8601\":\"2015-05-16\",\"visit_interval\":33,\"visit_interval_unit\":\"DAYS\"},{\"uid\":\"62ks93jf-6de7-3d7f-95c7-79a6a31e794f\",\"id\":\"cerner-standard-diabetes-controled-visit-interval\",\"name\":\"Diabetes Controled Visit Interval\",\"previous_visit_date_iso8601\":\"2015-05-08\",\"next_visit_date_iso8601\":\"2015-10-03\",\"visit_interval\":148,\"visit_interval_unit\":\"DAYS\"}],\"total_cost_of_care\":[{\"descriptions\":[{\"display\":\"Total Cost:\",\"values\":[\"1000.25\"]}],\"iso_begin_date\":\"2017-01-01\",\"iso_end_date\":\"2017-01-03\",\"name\":\"Total Cost: 1000.25\"}]}}",
      "supporting_data_points": {
        "calculated_risk_scores": [
          {
            "name": "Calculated Risk Score: 0.65",
            "descriptions": [
              {
                "display": "Calculated Risk Score",
                "values": [
                  "0.65"
                ]
              }
            ],
            "covariates": [
              {
                "name": "Personal Health Assessment Test",
                "value": "20.5",
                "supporting_facts": [
                  {
                    "questionnaires": [
                      {
                        "name": "PHA from employer",
                        "iso_recorded_date": "2010-10-25:T00:00:00.000Z",
                        "source": {
                          "partition_description": "PCCA Clone",
                          "type": "EMR"
                        }
                      },
                      {
                        "name": "PHA from Health Coaching Services",
                        "iso_recorded_date": "2011-09-17:T14:48:00.000Z",
                        "source": {
                          "partition_description": "PCCA Clone",
                          "type": "EMR"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ],
        "conditions": [
          {
            "name": "Unspecified essential hypertension",
            "code": "401.9",
            "code_system": "ICD-9-CM",
            "date": "05/14/2015",
            "iso_begin_date": "2015-05-14:T00:00:00.000Z",
            "source": {
              "partition_description": "Pop Health 1 BCBS_PPO in Staging",
              "type": "CLAIM"
            }
          }
        ],
        "encounters": [
          {
            "name": "Encounter with providerPersonnelLite1",
            "code": "408808013",
            "code_system": "SNOMED CT",
            "date": "11/10/2015",
            "iso_begin_date": "2015-11-10:T00:00:000Z",
            "source": {
              "partition_description": "PCCA Clone",
              "type": "EMR"
            }
          }
        ],
        "derived_encounters": [
          {
            "name": "Emergency Department",
            "code": "401.9",
            "code_system": "ICD-9-CM",
            "date": "01/30/2013-01/30/2014",
            "iso_begin_date": "2013-01-30:T00:00:00.000Z",
            "iso_end_date": "2014-01-30:T00:00:00.000Z",
            "source": {
              "partition_description": "STGENG - PCCA Clone",
              "type": "EMR"
            }
          }
        ],
        "generic_risk_scores": [
          {
            "name": "HRA: Medium - General Health Assessment, General Pregnancy Assessment",
            "date": "08/15/2015",
            "iso_begin_date": "2015-08-15:T00:00:000Z",
            "source": {
              "partition_description": "PCCA Clone",
              "type": "EMR"
            }
          }
        ],
        "procedures": [
          {
            "name": "Tracheotomy",
            "code": "48387007",
            "code_system": "SNOMED CT",
            "date": "07/17/2017",
            "iso_begin_date": "2017-07-17:T00:00:000Z",
            "source": {
              "partition_description": "STGENG - PCCA Clone",
              "type": "EMR"
            }
          }
        ],
        "questions": [
          {
            "name": "Did you take any medications? Mucinex, Tylenol, Equate syrup - General Pregnancy Assessment",
            "date": "10/25/2010",
            "iso_begin_date": "2010-10-25:T00:00:000Z",
            "source": {
              "partition_description": "PCCA Clone",
              "type": "EMR"
            }
          }
        ],
        "referral_files": [
          {
            "name": "Referred by: Dr. Schulz, Referral reason: Food Poisoning, Referral diagnosis: Congestive heart failure (SNOMED CT 70653017) (ADMITTING), Gastro-esophageal reflux disease (ICD-10-CM K21) (PRINCIPAL), Osteoporosis (ICD-9-CM 733.00) (OTHER)",
            "date": "02/25/2015",
            "iso_begin_date": "2015-02-25:T00:00:000Z",
            "source": {
              "partition_description": "STGENG - PCCA Clone",
              "type": "EMR"
            },
            "descriptions": [
              {
                "display": "Referred by:",
                "values": [
                  "Dr. Schulz"
                ]
              }
            ]
          }
        ],
        "registry_measure_outcomes": [
          {
            "descriptions": [
              {
                "value": [
                  "Body Mass Index Screening and Follow-Up"
                ],
                "status": "NOT_MET_DATA_AVAILABLE"
              }
            ],
            "header": "Preventive Care",
            "name": "Preventive Care: Body Mass Index Screening and Follow-Up (Not Achieved)"
          }
        ],
        "registry_identification_outcomes": [
          {
            "name": "Preventive Care"
          }
        ],
        "results": [
          {
            "name": "Chol/HDL 3.1",
            "code": " 9830-1",
            "code_system": "LOINC",
            "date": "08/15/2015",
            "iso_begin_date": "2015-08-15:T00:00:000Z",
            "source": {
              "partition_description": "PCCA Clone",
              "type": "EMR"
            }
          }
        ],
        "claims": [
          {
            "name": "Claim with Megan Fox at Hospital A",
            "date": "01/11/2013-05/18/2013",
            "iso_begin_date": "2013-01-11:T00:00:00Z",
            "iso_end_date": "2013-05-18:T00:00:00Z",
            "source": {
              "partition_description": "PCCA Clone",
              "type": "CLAIM"
            }
          }
        ],
        "medications": [
          {
            "name": "Aspirin, Oral",
            "code": "1960-4",
            "code_system": "LOINC",
            "date": "01/11/2010",
            "iso_begin_date": "2010-01-11:T00:00:000Z",
            "source": {
              "partition_description": "PCCA Clone",
              "type": "EMR"
            }
          }
        ],
        "visit_intervals": [
          {
            "uid": "8487fd69-6de7-3d7f-95c7-79a6a31e794f",
            "id": "cerner-standard-heart-failure-unstable-visit-interval",
            "name": "Heart Failure Unstable Visit Interval",
            "previous_visit_date_iso8601": "2016-01-13",
            "next_visit_date_iso8601": "2016-07-11",
            "visit_interval": 180,
            "visit_interval_unit": "DAYS"
          }
        ],
        "total_cost_of_care": [
          {
            "descriptions": [
              {
                "display": "Total Cost:",
                "values": [
                  "1000.25"
                ]
              }
            ],
            "iso_begin_date": "2017-01-01",
            "iso_end_date": null,
            "name": "Total Cost: 1000.25"
          }
        ]
      }
    }
  ],
  "demographics": {
    "full_name": "Jason Doe",
    "given_names": [
      "Jason",
      "Jon"
    ],
    "family_names": [
      "Doe"
    ],
    "prefix": "Mr",
    "suffix": "Jr",
    "date_of_birth": "1980-05-04T00:00:00Z",
    "gender": "Male",
    "gender_details": {
      "id": "248153007",
      "coding_system_id": "2.16.840.1.113883.12.190",
      "display": "Male",
      "coding_system_display":"SNOMED CT 452832018"
    },
    "address": {
      "type": {
        "id": "H",
        "coding_system_id": "2.16.840.1.113883.12.190",
        "display": "Home",
        "coding_system_display":"HL7v2_5 Address Type"
      },
      "street_addresses": [
        "123 Roe Avenue"
      ],
      "city": "Kansas City",
      "state_or_province": "Missouri",
      "state_or_province_details": {
        "id": "MO",
        "coding_system_id": "2.16.840.1.113883.6.92",
        "display": "Missouri",
        "coding_system_display":"FIPS"
      },
      "postal_code": "64117",
      "county_or_parish": "Clay",
      "county_or_parish_details": {
        "id": "county_code_id_1",
        "coding_system_id": "county_coding_system_id_1",
        "display": "Clay"
      },
      "country": "United States",
      "country_details": {
        "id": "USA",
        "coding_system_id": "1.0.3166.1.2.3",
        "display": "United States",
        "coding_system_display": "ISO 3166-1 Standard Country Codes"
      }
    },
    "telecoms": [
      {
        "preferred": true,
        "number": "789656245",
        "extension": "678",
        "country_code": "001",
        "type": {
          "id": "WPN",
          "coding_system_id": "2.16.840.1.113883.12.201",
          "display": "Work",
          "coding_system_display":"HL7 V2.5 0201 Telecommunication Use"
        }
      }
    ],
    "email_addresses": [
      {
        "address": "jason.doe@example.com",
        "type": {
          "id": "H",
          "coding_system_id": "2.16.840.1.113883.12.190",
          "display": "Home",
          "coding_system_display":"HL7v2_5 Address Type"
        }
      }
    ]
  },
  "risk_scores": {
    "mara_risk_scores": [
      {
        "model_name": "CXCONLAG0",
        "total_score": 10.0
      }
    ],
    "calculated_risk_scores": [
      {
        "risk_score_type": "Cardiac",
        "risk_score": "51.9",
        "type": {
          "id": "161168008",
          "coding_system_id": "2.16.840.1.113883.6.96",
          "display": "Morbidity Prediction",
          "coding_system_display": "SNOMED CT"
        },
        "method": {
          "id": "10741000175107",
          "coding_system_id": "2.16.840.1.113883.6.96",
          "display": "ACC/AHA ASCVD Risk Calculation",
          "coding_system_display": "SNOMED CT"
        },
        "condition": {
          "id": "443502000",
          "coding_system_id": "2.16.840.1.113883.6.96",
          "display": "Atherosclerotic Cardiovascular Disease",
          "coding_system_display": "SNOMED CT"
        }
      }
    ]
  },
  "attributed_providers": [
    {
      "id": "c0123d92-9f04-498f-98f5-815b1dd46ce5",
      "full_name": "Attributed Provider 1"
    },
    {
      "id": "4926e5bd-fe45-4d5f-8e01-8d738e5e066d",
      "full_name": "Attributed Provider 2"
    }
  ],
  "benefit_coverages": [
    {
      "begin_date": "2007-12-05",
      "end_date": "2025-10-31",
      "member_id": "MO-1234-4567",
      "product_type": "Mock LOB A",
      "payer_name": "Mock Payer A",
      "plan_ids": [
        {
          "value": "HPVAL1",
          "type": "HPID"
        }
      ],
      "plan_name": "Mock Health Plan A",
      "source": {
        "partition_description": "Mock Partition A",
        "type": "ENROLLMENT"
      }
    }
  ],
  "assignable_care_managers": [
    {
      "name": "Care Manager 1",
      "id": "care-manager-1",
      "alignment_supporting_facts": {
        "programs": [
          {
            "program_id": "millennium.caremanagement.highriskmaternity.clinical.high-risk-maternity",
            "program_name": "High-Risk Maternity"
          },
          {
            "program_id": "millennium.caremanagement.highriskmaternity.clinical.high-risk-senior",
            "program_name": "High-Risk Senior"
          }
        ],
        "worksite_locations": [
          {
            "id": "cca04290-3c2a-44c8-9326-e7117ad6859d",
            "name": "Baseline Region West"
          }
        ]
      }
    }
  ],
  "assignable_personnel": [
    {
      "name": "Care Manager 1",
      "id": "care-manager-1",
      "programs": [
        {
          "program_id": "millennium.caremanagement.highrisksenior.clinical.high-risk-senior",
          "program_name": "High-Risk Senior",
          "alignment_supporting_facts": {
            "care_manager_regions": {
              "descriptions": [
                {
                  "display": "Organization 1"
                }
              ]
            },
            "provider_attribution": {
              "descriptions": [
                {
                  "display": "Provider 1",
                  "values": [
                    "Organization 1"
                  ]
                }
              ]
            },
            "worksite_locations": {
              "descriptions": [
                {
                  "display": "Baseline Region West"
                }
              ]
            }
          }
        }
      ]
    }
  ],
  "suppressed": false
}

GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/api/populations/{population_id}/candidates/{candidate_id}

Retrieves a candidate’s information using their HealtheIntent person ID based on a specified population.

Path Parameters

Parameter Type Description
population_id string The HealtheIntent population ID
candidate_id string The candidate’s HealtheIntent ID

Query Parameters

Parameter Type Description
record_ids.data_partition_id string Returns only the record_ids for the data partition specified
benefit_coverages.type string Filters by a specified type of benefit coverage

Response Statuses

Status Type Description
200 SingleCandidateResponse Success
400 string Bad request
401 string Unauthorized
403 string Forbidden
404 string Not found
500 string Internal server error

HealtheCare API Definitions

Address

Name Type Description
city string The city’s name
country string The country’s codified information
country_details string Country details
county_or_parish string The county’s or parish’s codified information
county_or_parish_details string County or parish details
postal_code string The postal code
state_or_province string The state’s or province’s codified information
state_or_province_details Code State or province details
street_addresses array:string May contain the house number, street, and apartment number

Alias

Name Type Description
alias_id string Alias ID of the care manager
alias_type string Alias type of the care manager

AlignedOrganization

Name Type Description
fact_id string Unique identifier of facts
fact_display string Fact name
type string Type of fact

AlignedOrganizationModel

Name Type Description
org_id string The ID of the aligned organization
org_name string The organization’s formatted name
alignment_type string Type of alignment supporting fact

AlignedOrganizationsResponse

Name Type Description
aligned_organizations array:AlignedOrganizationModel A list of aligned organizations
more_results boolean Boolean indicating if more results could be retrieved using paging
total_results integer The total results available

AlignedProvider

Name Type Description
fact_id string Unique identifier of facts
fact_display string Fact name

AlignedOrganizationsMatchResponse

Name Type Description
organization_id string Unique identifier of the organization
organization_name string Name of the organization

AlignedProviderModel

Name Type Description
id string The ID of the aligned provider
full_name string The provider’s formatted full name

AlignedProvidersResponse

Name Type Description
aligned_providers array:AlignedProviderModel A list of aligned providers
more_results boolean Boolean indicating if more results could be retrieved using paging
total_results integer The total results available

AlignmentSupportingFact

Name Type Description
provider_attribution array:ProviderAttribution An array of provider attribution information
programs array:Programs An array of programs
worksite_locations array:WorksiteLocation An array of worksite locations

AlignedSupportingDataPoints

Name Type Description
care_manager_regions struct:CareManagerRegionDataPoint Care manager regions
provider_attribution struct:ProviderAttributionDataPoint Provider attributions
worksite_locations struct:WorksiteLocationDataPoint Worksite locations

AlignedSupportingFactProgram

Name Type Description
program_id string Unique identifier of the program
program_name string Name of the program
alignment_supporting_facts array:AlignedSupportingDataPoints Alignment supporting facts information

AlignedWorksiteLocationModel

Name Type Description
id string The ID of the aligned worksite location
name string The worksite location’s formatted name

AlignedWorksiteLocationsResponse

Name Type Description
aligned_worksite_locations array:AlignedWorksiteLocationModel A list of aligned worksite locations
more_results boolean Boolean indicating if more results could be retrieved using paging
total_results integer The total results available

AssignableCareManager

Name Type Description
id string Unique identifier of the care manager
name string Name of the care manager
alignment_supporting_facts struct:AlignmentSupportingFact Alignment supporting facts information

AssignablePersonnel

Name Type Description
id string Unique identifier of the care manager
name string Name of the care manager
programs array:AlignedSupportingFactProgram Alignment supporting facts program

AttributeDescription

Name Type Description
display string Display string
values array:string An array of values
string string Status of description

AttributedProvider

Name Type Description
id string The provider’s ID
full_name string The provider’s name

AttributedProvidersResponse

Name Type Description
attributed_providers array:AttributedProvider A list of attributed providers
more_results boolean Boolean indicating if more results could be retrieved using paging
total_results integer The total results available

BenefitCoverage

Name Type Description
begin_date string An ISO 8601 formatted date of when the coverage begins
end_date string An ISO 8601 formatted date of when the coverage ends
member_id string Represents the person’s unique identifier for the benefit provider
payer_name string The payer’s name
plan_ids array: PlanID Identifiers for the health benefit payer or plan
plan_name string The coverage plan’s name
product_type string Type of product
source array:Source A list of plan sources

BulkCandidate

Name Type Description
demographics array:BulkDemographic Demographics information for the candidate
empi_id string Unique identifier for the candidate
empi_version string The EMPI version of the candidate
identification_date string An ISO 8601 formatted date
risk_scores struct:RiskScore A collection of risk scores
suppressed boolean Determines if the candidates are suppressed or not
start_date_of_latest_outpatient_visit string An ISO 8601 formatted date
end_date_of_latest_outpatient_visit string An ISO 8601 formatted date
total_outpatient_visits integer Total number of outpatient visits
total_bad_outcome_registry_measures integer Total number of bad outcome registry measures
assignable_care_managers array:AssignableCareManager An array of assignable care managers
assignable_peronnel array:AssignablePersonnel An array of assignable personnel
attributed_providers array:AttributedProvider A list of attributed providers
benefit_coverages array:BenefitCoverage A list of benefit coverages for the candidate
programs array:BulkProgram A list of programs information
record_ids array:RecordID A list of data partition IDs and person ID
registry_identification_outcomes array:CandidateRegistryIdentificationOutcome A list of registries that the candidate is identified with

BulkProgram

Name Type Description
id string Program ID
name string Program name
risk_scores array:CalculatedRiskScore - RiskScore An array of calculated risk scores on program level
identification_date string An ISO 8601 formatted date
suppressed boolean Indicates if the candidate is suppressed or not
excluded boolean Indicates if the candidate is excluded or not for the program
assignable_care_managers array:AssignableCareManager A list of assignable care managers
supporting_data_points_str string Supporting data points in string format
supporting_data_points struct:SupportingDataPoint Collection of supporting data points

BulkDemographic

Name Type Description
full_name string The person’s formatted full name
given_names array:string A list of given names
family_names array:string A list of family names
date_of_birth string An ISO 8601 formatted date
gender string Candidate’s gender
gender_details structGenderDetail Candidate’s gender details
prefix string The person’s prefix (e.g. Dr)
suffix string The person’s suffix (e.g. Sr, Jr, III)
address Address The person’s address
telecoms array: Telecom List of telecommunication information
email_addresses array: Email A list of email addresses

CalculatedRiskScore - SupportingDataPoint

Name Type Description
name string Name of the calculated risk score
descriptions array:AttributeDescription A list of descriptions
covariates array:Covariates A list of covariates

CalculatedRiskScore - RiskScore

Name Type Description
risk_score_type string The type of risk score that was calculated
risk_score string The numeric value of the risk score
type Code Identifies the type of score in the mode
method Code The algorithm, process, or mechanism used to evaluate the risk
condition Code Identifies the condition assessed by the risk score

Candidate

Name Type Description
demographics array:Demographic Demographics information for the candidate
empi_id string Unique identifier for the candidate
identification_date string An ISO 8601 formatted date
risk_scores struct:RiskScore A collection of risk scores
suppressed boolean Determines if the candidates are suppressed or not
start_date_of_latest_ed_visit string An ISO 8601 formatted date
end_date_of_latest_ed_visit string An ISO 8601 formatted date
start_date_of_latest_inpatient_visit string An ISO 8601 formatted date
end_date_of_latest_inpatient_visit string An ISO 8601 formatted date
total_ed_visits integer Total number of ED visits
total_inpatient_visits integer Total number of inpatient visits
assignable_care_managers array:AssignableCareManager An array of assignable care managers
aligned_providers array:AlignedProvider A list of aligned providers
benefit_coverages array:BenefitCoverage A list of benefit coverages for the candidate
programs array:CandidateProgram A list of programs information
record_ids array:RecordID A list of data partition IDs and person ID

CandidateProgram

Name Type Description
id string The ID of the program
identification_date string An ISO 8601 formatted date
name string Program name
risk_scores array:CalculatedRiskScore - RiskScore An array of calculated risk scores on program level
suppressed boolean Indicates if the candidate is suppressed or not
excluded boolean Indicates if the candidate is excluded or not for the program
assignable_care_managers array:AssignableCareManager A list of assignable care managers

CandidatesListResponse

Name Type Description
candidates array: Candidate Candidates array defined for the population
plans array:Plan A collective list of health plans associated to candidates within the population
product_types array:ProductType A list of candidate counts and product types
programs array:Program A list of program information
aligned_providers array:AlignedProvider A list of aligned providers
total_results integer Count of the total number of candidates
more_results boolean Identifies if there are more candidates

CandidatesListBatchResponse

Name Type Description
candidates array:BulkCandidate Candidates array defined for the population

CandidatesListMatchResponse

Name Type Description
candidates array:Person Candidates array defined for the population
total_results integer Count of the total number of candidates
more_results boolean Identifies if there are more candidates

CareManager

Name Type Description
id string ID of the care manager
aligned_candidates integer Aligned candidates count

CareManagerByAlias

Name Type Description
id string ID of the care manager
aligned_candidates integer Aligned candidates count
aliases array:Alias A list of care manager’s aliases

CareManagerRegionDataPoint

Name Type Description
descriptions array:AttributeDescription A list of descriptions

CareManagersAliasBatchResponse

Name Type Description
care_managers array:CareManagerByAlias Care managers by alias array for the population

CareManagersBatchResponse

Name Type Description
care_managers array:CareManager Care managers array for the population

CareManagersResponse

Name Type Description
care_managers array:CareManager Care managers array for the population

Claim

Name Type Description
name string Name of the claims
date string Date in mm/dd/yyyy–mm/dd/yyyy format
iso_begin_date string An ISO 8601 formatted date
iso_end_date string An ISO 8601 formatted date
source array:Source A list of sources

Code

Name Type Description
display string Displayable text
id string The code’s ID
coding_system_display string Coding system display
coding_system_id string Coding system ID

Condition

Name Type Description
name string Name of the condition
code string Condition code
code_system string Coding system
date string Date in mm/dd/yyyy format
iso_begin_date string An ISO 8601 formatted date
source array:Source A list of sources

Covariates

Name Type Description
name string Name of the covariate
value string Value of the covariate
supporting_facts array:CovariateSupporingFact A list of supporting facts corresponding to the covariate

CovariateSupporingFact

Name Type Description
questionnaires array:CovariateQuestionnaire Questionnaire corresponding to the covariate

CovariateQuestionnaire

Name Type Description
name string Name of the covariate questionnaire
iso_recorded_date string An ISO 8601 formatted date
source array:Source A list of sources

Demographic

Name Type Description
address Address The person’s address
date_of_birth string An ISO 8601 formatted date
full_name string The person’s formatted full name
gender string Candidate’s gender
given_names array:string A list of given names
family_names array:string A list of family names
prefix string The person’s prefix (e.g. Dr)
suffix string The person’s suffix (e.g. Sr, Jr, III)
telecoms array: Telecom List of telecommunication information
emails array: Email A list of email addresses

DerivedEncounter

Name Type Description
name string Name of the derived encounter
code string Derived encounter code
code_system string Coding system
date string Date in mm/dd/yyyy-mm/dd/yyyy format
iso_begin_date string An ISO 8601 formatted date
iso_end_date string An ISO 8601 formatted date
source array:Source A list of sources

Email

Name Type Description
address string The email address
type Code Codified email address information

Encounter

Name Type Description
code string Encounters code
code_system string Coding system
date string Date in mm/dd/yyyy format
iso_begin_date string An ISO 8601 formatted date
source array:Source A list of sources

GenderDetail

Name Type Description
id string ID of the gender details
coding_system_id string Coding system ID
display string Gender display
coding_system_display string Coding system display

GenericRiskScore

Name Type Description
name string Name of the generic risk scores
date string Date in mm/dd/yyyy format
iso_begin_date string An ISO 8601 formatted date
source array:Source A list of sources

CandidateRegistryIdentificationOutcome

Name Type Description
program_id string Unique identifier of the program
name string Name of the program
program_version string Program version

MaraRiskScore

Name Type Description
total_score integer Risk score value
model_name string Model name

MatchCandidate

Name Type Description
demographics array:Demographic Demographics information for the candidate
empi_id string Unique identifier for the candidate
identification_date string An ISO 8601 formatted date
risk_scores struct:RiskScore A collection of risk scores
suppressed boolean Determines if the candidates are suppressed or not
start_date_of_latest_ed_visit string An ISO 8601 formatted date
end_date_of_latest_ed_visit string An ISO 8601 formatted date
start_date_of_latest_inpatient_visit string An ISO 8601 formatted date
end_date_of_latest_inpatient_visit string An ISO 8601 formatted date
total_ed_visits integer Total number of ED visits
total_inpatient_visits integer Total number of inpatient visits
assignable_care_managers array:AssignableCareManager An array of assignable care managers
aligned_providers array:AlignedProvider A list of aligned providers
benefit_coverages array:BenefitCoverage A list of benefit coverages for the candidate
programs array:CandidateProgram A list of programs information
record_ids array:RecordID A list of data partition IDs and person ID

Medication

Name Type Description
name string Name of the medications
code string Procedures code
code_system string Coding system
date string Date in mm/dd/yyyy format
iso_begin_date string An ISO 8601 formatted date
source array:Source A list of sources

OrgName

Name Type Description
org_name string Name of the organization

Payer

Name Type Description
payer_name string Payer name

PayersListResponse

Name Type Description
payers array:Payer Collection of payers
more_results boolean Identifies if there are more payers
total_results integer Total number of payers

Person

Name Type Description
demographics array:Demographic Demographics information for the candidate
empi_id string Unique identifier for the candidate
identification_date string An ISO 8601 formatted date
risk_scores struct:RiskScore A collection of risk scores
suppressed boolean Determines if the candidates are suppressed or not
start_date_of_latest_ed_visit string An ISO 8601 formatted date
end_date_of_latest_ed_visit string An ISO 8601 formatted date
start_date_of_latest_inpatient_visit string An ISO 8601 formatted date
end_date_of_latest_inpatient_visit string An ISO 8601 formatted date
start_date_of_latest_outpatient_visit string An ISO 8601 formatted date
end_date_of_latest_outpatient_visit string An ISO 8601 formatted date
total_ed_visits integer Total number of ED visits
total_inpatient_visits integer Total number of inpatient visits
total_outpatient_visits integer Total number of outpatient visits
total_bad_outcome_registry_measures integer Total number of bad outcome registry measures
assignable_care_managers array:AssignableCareManager An array of assignable care managers
aligned_providers array:AlignedProvider A list of aligned providers
aligned_organizations array:AlignedOrganizationsMatchResponse A list of aligned organizations
benefit_coverages array:BenefitCoverage A list of benefit coverages for the candidate
programs array:CandidateProgram A list of programs information
record_ids array:RecordID A list of data partition IDs and person ID
attributed_providers array:AttributedProvider A list of attributed providers
registry_identification_outcomes array:CandidateRegistryIdentificationOutcome
A list of registries that the candidate is identified with

PersonAddress

Name Type Description
city string The city portion of the address
country string The country portion of the address
county_or_parish string The county or parish portion of the address
postal_code string The postal code or zip code portion of the address
state_or_province string The state or province portion of the address
street_addresses array:string A list of street addresses associated with the address

PersonServiceGroup

Name Type Description
id string The fully formatted representation of the person’s ID
prefix string The person’s prefix (e.g. Dr)
suffix string The person’s suffix (e.g. Sr, Jr, III)
full_name string The full name of the person
given_names array:string A list of given names
family_names array:string A list of family names
formatted_names string The fully formatted representation of the person’s name
gender string Preferred value for gender
date_of_death string Date of death of the person, in ISO 8601 format
date_of_birth string Preferred value for birth date
deceased boolean This is an indicator of the death for the person
address struct:PersonAddress Preferred address
telecoms arrayTelecom The telecoms of the person
emails array:string The email addresses of the person
record_ids array:RecordID This is an array of record IDs for the person
service_groups array:ServiceGroup This is an array of service group IDs for the person

PersonnelServiceGroup

Name Type Description
personnel_id string The ID of the personnel
service_groups array:ServiceGroup The list of service groups

Plan

Name Type Description
candidate_count integer The number of candidates aligned to this health plan
payer_name string The name of the health plan payer
plan_name string The name of the health plan

PlanByPayer

Name Type Description
payer_name string The name of the health plan payer
plans array:PlanName A list of health plans

Plans

Name Type Description
plan_name string The name of the health plan
candidate_count integer The number of candidates aligned to this health plan

PlansResponse

Name Type Description
plans array:Plan A list of health plans
plans_by_payer array:PlanByPayer A list of plans grouped by payer
more_results boolean Identifies if there are more plans
total integer Total number of plans

Procedure

Name Type Description
name string Name of the procedures
code string Procedures code
code_system string Coding system
date string Date in mm/dd/yyyy format
iso_begin_date string An ISO 8601 formatted date
source array:Source A list of sources

ProductType

Name Type Description
candidate_count integer The number of candidates aligned to this product type
product_type string The name of the product type

ProductTypesResponse

Name Type Description
prdouct_types array:ProductType A list of product types
more_results boolean Identifies if there are more product types
total_results integer Total number of product types

Program

Name Type Description
program_id string Unique identifier of the program
program_name string Program name
service_group_id string Unique identifier of the service group

Programs

Name Type Description
programs array:Program An array of programs
more_results boolean Identifies if there are more programs
total_results integer Total number of programs

ProgramsListResponse

Name Type Description
programs array:Program Collection of programs
more_results boolean Identifies if there are more programs
total_results integer Total number of programs

ProviderAttribution

Name Type Description
provider_id string ID of the attributed provider
provider_name string Name of the attributed provider
org_names_list array:OrgName An array of organizations for the attributed provider

ProviderAttributionDataPoint

Name Type Description
descriptions array:AttributeDescription A list of descriptions

Question

Name Type Description
name string Name of the questions
date string Date in mm/dd/yyyy format
iso_begin_date string An ISO 8601 formatted date
source array:Source A list of sources

RecordID

Name Type Description
data_partition_id string Identifier for the particular source for a consumer
person_id string Identifier for the person

ReferralFile

Name Type Description
name string Name of the referral files
date string Date in mm/dd/yyyy format
iso_begin_date string An ISO 8601 formatted date
source array:Source A list of sources
descriptions array:AttributeDescription A list of descriptions

RegistryIdentificationOutcome

Name Type Description
name string Name of the registry identification outcomes

RegistryMeasureOutcome

Name Type Description
descriptions array:AttributeDescription A list of descriptions
header string Header
name string Name of the procedures

Result

Name Type Description
name string Name of the results
code string Results code
code_system string Coding system
date string Date in mm/dd/yyyy format
iso_begin_date string An ISO 8601 formatted date
source array:Source A list of sources

RiskScore

Name Type Description
mara_risk_scores array:MaraRiskScore An array of total scores and model name
calculated_risk_scores array:CalculatedRiskScore - RiskScore An array of calculated risk scores

ServiceGroup

Name Type Description
service_group string Identifier for the service group

ServiceGroupsPersonnelBatchResponse

Name Type Description
personnel_service_groups array:PersonnelServiceGroup Collection of service groups for personnel

ServiceGroupsPersonsList

Name Type Description
persons array:PersonServiceGroup
more_results boolean Boolean indicating if more results could be retrieved using paging
total_results integer Count of total results

SingleCandidateResponse

Name Type Description
demographics array:BulkDemographic Demographics information for the candidate
empi_id string Unique identifier for the candidate
empi_version string The EMPI version of the candidate
identification_date string An ISO 8601 formatted date
risk_scores struct:RiskScore A collection of risk scores
suppressed boolean Determines if the candidates are suppressed or not
assignable_care_managers array:AssignableCareManager An array of assignable care managers
assignable_peronnel array:AssignablePersonnel An array of assignable personnel
attributed_providers array:AttributedProvider A list of attributed providers
benefit_coverages array:BenefitCoverage A list of benefit coverages for the candidate
programs array:BulkProgram A list of programs information
record_ids array:RecordID A list of data partition IDs and person ID
registry_identification_outcomes array:CandidateRegistryIdentificationOutcome A list of registries that the candidate is identified with

Source

Name Type Description
partition_description string Display name of the data partition that contributed this information to the person’s longitudinal record
type string Source type

SupportingDataPoint

Name Type Description
calculated_risk_scores array:CalculatedRiskScore - SupportingDataPoint A list of calculated risk scores
conditions array:Condition A list of candidates conditions
encounters array:Encounter A list of encounters
derived_encounters array:DerivedEncounter A list of derived encounters
generic_risk_scores array:GenericRiskScore A list of generic risk scores
procedures array:Procedure A list of procedures
questions array:Question A list of questions
referral_files array:ReferralFile A list of referral files
registry_measure_outcomes array:RegistryMeasureOutcome A list of registry measure outcomes
registry_identification_outcomes array:RegistryIdentificationOutcome A list of registry identification outcomes
results array:Result A list of results
claims array:Claim A list of claims
medications array:Medication A list of medications
visit_intervals array:VisitInterval A list of visit intervals
total_cost_of_care array:TotalCostOfCare A list of total cost of care

Telecom

Name Type Description
preferred boolean true if it is the preferred means of contact
number string The number
extension string The number’s extension
country_code string The number’s country code
type string Number type primary or secondary

TotalCostOfCare

Name Type Description
name string Name of the results
iso_begin_date string An ISO 8601 formatted date
iso_end_date string An ISO 8601 formatted date

VisitInterval

Name Type Description
uid string Unique identifier of visit intervals
id string Identifier of visit intervals
name string Name of the visit intervals
previous_visit_date_iso8601 string Date in yyyy/mm/dd format
next_visit_date_iso8601 string Date in yyyy/mm/dd format
visit_interval integer Value for the visit interval
visit_interval_unit string Unit for the visit interval value

WorksiteLocation

Name Type Description
id string Identifier of worksite location
name string Name of the worksite location

WorksiteLocationDataPoint

Name Type Description
descriptions array:WorksiteLocationDescription A list of descriptions

WorksiteLocationDescription

Name Type Description
display string Name of the worksite location

CandidateExclusionReasons

Name Type Description
exclusion_reasons array:ExclusionReason A list of exclusion reasons
more_results boolean Boolean indicating if more results could be retrieved using paging
total_results integer Count of total results

ExclusionReason

Name Type Description
reason_id string Unique ID of the reason
text string Textual name of the reason
excluded boolean Indicator of whether the reason is excluded
excluded_dt_tm string An ISO 8601 formatted date of when the reason was excluded
duration array:Duration The amount of time the person is excluded from identification due to the given reason.

Duration

Name Type Description
value integer Duration value
unit string Duration unit. The permitted units are DAYS and WEEKS.

CandidateExclusionIds

Name Type Description
candidate_exclusion_ids array:CandidateExclusionId A list of candidate exclusion identifiers

CandidateExclusionId

Name Type Description
id string Candidate exclusion identifier

CandidateExclusions

Name Type Description
exclusions array:Exclusion A list of exclusions
more_results boolean A Boolean indicating if more results could be retrieved using paging
total_results integer A count of total results

Exclusion

Name Type Description
person_id string The identifier for the person
program_id string The unique identifier of the program
exclusion_id string The exclusion identifier
requesting_personnel_id string The identifier of the requesting personnel
reason struct:Reason A Boolean indicating if more results could be retrieved using paging
created_date_time string An ISO 8601 formatted date of when the exclusion was created
expiration_date_time string An ISO 8601 formatted date of when the exclusion expires

Reason

Name Type Description
id string The reason identifier
display string The reason display text