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. |
Diagnosis Related Group |
A Diagnosis Related Group (DRG) is a patient classification system that standardizes prospective payment to hospitals and encourages cost containment initiatives. |
Discharge Diagnosis |
A candidate’s final diagnosis before they are discharged. |
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 Candidates Discharge Diagnoses
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_candidates_discharge_diagnoses',
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_candidates_discharge_diagnoses
Example Aligned Candidates Discharge Diagnoses Response:
{
"discharge_diagnoses": [
{
"name": "Acute diastolic (congestive) heart failure",
"candidate_count": 1
},
{
"name": "Atherosclerosis",
"candidate_count": 1
}
],
"more_results": false,
"total_results": 2
}
GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/care_managers/{care_manager_id}/aligned_candidates_discharge_diagnoses
Retrieves a list of discharge diagnoses for candidates aligned with the provided care manager in the 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 |
q |
string |
Filters the discharge diagnoses to only those with a name that includes the specified text. This query parameter is case-insensitive. |
offset |
integer |
The index of results at which to start (Optional)
|
limit |
integer |
The number of results to return (Optional)
- Default = 20
- 0 < limit <= 100
|
Response Statuses
Status |
Type |
Description |
200 |
DischargeDiagnosesResponse |
Success |
400 |
string |
Bad request |
401 |
string |
Unauthorized |
403 |
string |
Forbidden |
404 |
string |
Not found |
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)
|
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)
|
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)
|
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) |
personnel_group_id |
string |
Restricts the attributed provider list by personnel groups. Between 0 and 20 IDs can be specified. |
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)
|
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
Note: The data retrieved by this API is filtered based on your sensitive data filters for HealtheIntent. Ensure that your implementations of this API are designed with this in mind, and if you integrate data from HealtheIntent into a clinical workflow using this API, ensure that your users are informed of your sensitive data filters. See the Understand Sensitive Data in HealtheIntent Reference Page for more information.
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"
},
"interpretation": {
"coding_system_id": "2.16.840.1.113883.6.96",
"display": "High risk",
"id": "15508007"
}
}
],
"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"
},
"interpretation": {
"coding_system_id": "2.16.840.1.113883.6.96",
"display": "High risk",
"id": "15508007"
}
}
]
},
"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": "2016-11-05T10:00:00Z",
"end_date_of_latest_inpatient_visit": "2016-11-05T11:30:00Z",
"start_date_of_latest_outpatient_visit": "2015-11-05T10:00:00Z",
"end_date_of_latest_outpatient_visit": "2015-11-05T11:30:00Z",
"latest_outpatient_discharge": {
"locations": [
{
"facility": "BaseLine East",
"start_date_time": "2015-11-05T10:00:00Z",
"end_date_time": "2015-11-05T10:00:00Z"
}
],
"disposition": {
"codings": [
{
"code": "01",
"display": "Home or Self Care",
"system": "urn:cerner:codingsystem:drg:msdrg"
}
],
"sourceCodings": [
{
"code": "01",
"display": "Home or Self Care",
"system": "urn:cerner:codingsystem:drg:msdrg"
}
],
"text": "Discharge Disposition"
}
},
"latest_ed_discharge":{
"locations": [
{
"facility": "BaseLine Hospital",
"start_date_time": "2012-12-05T10:00:00Z",
"end_date_time": "2012-15-05T10:00:00Z"
},
{
"facility": null,
"start_date_time": "2012-11-05T10:00:00Z",
"end_date_time": null
}
],
"disposition": {
"codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"source_codings": [
{
"code": "161168008",
"display": null,
"system": "2.16.840.1.113883.6.96"
}
],
"text": "Discharge Disposition"
}
},
"latest_inpatient_discharge": {
"locations": [
{
"facility": "BaseLine Hospital",
"start_date_time": "2020-11-05T10:00:00Z",
"end_date_time": "2020-11-05T10:00:00Z"
}
],
"disposition": {
"codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"source_codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"text": "Discharge Disposition"
}
},
"latest_discharge_disposition": {
"codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"source_codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"text": "Discharge Disposition"
},
"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 by candidates who are identified for a specified program or programs along with the assigned care manager. If you specify multiple program IDs, you must repeat the query parameter for each. Candidates are returned if they are identified for at least one of the specified 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)
|
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"
},
"interpretation": {
"coding_system_id": "2.16.840.1.113883.6.96",
"display": "High risk",
"id": "15508007"
}
}
],
"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\"}]}],\"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\"}],\"drgs\":[{\"name\":\"CELLULITIS W MCC\",\"code\":\"602\",\"code_system\":\"urn:cerner:codingsystem:drg:msdrg\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"},\"iso_begin_date\":\"2020-01-16\",\"iso_end_date\":\"2020-01-16\"},{\"name\":\"MAJOR SMALL & LARGE BOWEL PROCEDURES W MCC\",\"code\":\"329\",\"code_system\":\"urn:cerner:codingsystem:drg:msdrg\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"},\"iso_begin_date\":\"2020-04-01\",\"iso_end_date\":\"2020-04-05\"}]}}",
"supporting_data_points": {
"calculated_risk_scores": [
{
"name": "Calculated Risk Score: 0.65",
"descriptions": [
{
"display": "Calculated Risk Score",
"values": [
"0.65"
],
"interpretation": "Low"
}
],
"covariates": [
{
"name": "Personal Health Assessment Test",
"value": "20.5"
}
]
}
],
"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": [
{
"id": "174659243",
"name": "Encounter with providerPersonnelLite1",
"code": "408808013",
"code_system": "SNOMED CT",
"date": "11/10/2015",
"iso_begin_date": "2015-11-10:T00:00:000Z",
"source": {
"id": "1f9fd5bd-e83a-406f-9d39-3e0a33211f09",
"data_partition_id": "3c1b989e-b67f-43e8-8746-b70ad3336bd5",
"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"
}
],
"drgs": [
{
"name": "CELLULITIS W MCC",
"code": "602",
"code_system": "urn:cerner:codingsystem:drg:msdrg",
"source": {
"partition_description": "PCCA Clone",
"type": "EMR"
},
"iso_begin_date": "2020-01-16",
"iso_end_date": "2020-01-16"
},
{
"name": "MAJOR SMALL & LARGE BOWEL PROCEDURES W MCC",
"code": "329",
"code_system": "urn:cerner:codingsystem:drg:msdrg",
"source": {
"partition_description": "PCCA Clone",
"type": "EMR"
},
"iso_begin_date": "2020-04-01",
"iso_end_date": "2020-04-05"
}
]
}
}
],
"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"
},
"interpretation": {
"coding_system_id": "2.16.840.1.113883.6.96",
"display": "High risk",
"id": "15508007"
}
}
]
},
"start_date_of_latest_ed_visit": "2015-03-05T10:00:00Z",
"end_date_of_latest_ed_visit": "2015-03-05T10:50:00Z",
"latest_ed_discharge":{
"locations": [
{
"facility": "BaseLine Hospital",
"start_date_time": "2012-12-05T10:00:00Z",
"end_date_time": "2012-15-05T10:00:00Z"
},
{
"facility": null,
"start_date_time": "2012-11-05T10:00:00Z",
"end_date_time": null
}
],
"disposition": {
"codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"source_codings": [
{
"code": "161168008",
"display": null,
"system": "2.16.840.1.113883.6.96"
}
],
"text": "Discharge Disposition"
}
},
"start_date_of_latest_inpatient_visit": "2016-11-05T10:00:00Z",
"end_date_of_latest_inpatient_visit": "2016-11-05T11:30:00Z",
"latest_inpatient_discharge": {
"locations": [
{
"facility": "BaseLine Hospital",
"start_date_time": "2020-11-05T10:00:00Z",
"end_date_time": "2020-11-05T10:00:00Z"
}
],
"disposition": {
"codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"source_codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"text": "Discharge Disposition"
}
},
"latest_outpatient_discharge": {
"locations": [
{
"facility": "BaseLine East",
"start_date_time": "2015-11-05T10:00:00Z",
"end_date_time": "2015-11-05T10:00:00Z"
}
],
"disposition": {
"codings": [
{
"code": "01",
"display": "Home or Self Care",
"system": "urn:cerner:codingsystem:drg:msdrg"
}
],
"sourceCodings": [
{
"code": "01",
"display": "Home or Self Care",
"system": "urn:cerner:codingsystem:drg:msdrg"
}
],
"text": "Discharge Disposition"
}
},
"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,
"latest_discharge_diagnosis": "Secondary hypercholesterolemia",
"latest_discharge_disposition": {
"codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"source_codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"text": "Discharge Disposition"
}
}
]
}
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"
},
"interpretation": {
"coding_system_id": "2.16.840.1.113883.6.96",
"display": "High risk",
"id": "15508007"
}
}
],
"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\"], \"interpretation\" : \"Low\"}],\"covariates\":[{\"name\":\"Personal Health Assessment Test\",\"value\":\"20.5\"}]}],\"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\"}],\"drgs\":[{\"name\":\"CARDIAC ARRHYTHMIA & CONDUCTION DISORDERS W MCC\",\"code\":\"189\",\"code_system\":\"urn:cerner:codingsystem:drg:msdrg\",\"source\":{\"partition_description\":\"PCCA Clone\",\"type\":\"EMR\"},\"iso_begin_date\":\"2020-01-16\",\"iso_end_date\":\"2020-01-16\"}]}}",
"supporting_data_points": {
"calculated_risk_scores": [
{
"name": "Calculated Risk Score: 0.65",
"descriptions": [
{
"display": "Calculated Risk Score",
"values": [
"0.65"
],
"interpretation": "Low"
}
],
"covariates": [
{
"name": "Personal Health Assessment Test",
"value": "20.5",
"supporting_facts": []
}
]
}
],
"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": [
{
"id": "174659243",
"name": "Encounter with providerPersonnelLite1",
"code": "408808013",
"code_system": "SNOMED CT",
"date": "11/10/2015",
"iso_begin_date": "2015-11-10:T00:00:000Z",
"source": {
"id": "1f9fd5bd-e83a-406f-9d39-3e0a33211f09",
"data_partition_id": "3c1b989e-b67f-43e8-8746-b70ad3336bd5",
"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"
}
],
"drgs": [
{
"name": "CARDIAC ARRHYTHMIA & CONDUCTION DISORDERS W MCC",
"code": "189",
"code_system": "urn:cerner:codingsystem:drg:msdrg",
"source": {
"partition_description": "PCCA Clone",
"type": "EMR"
},
"iso_begin_date": "2020-01-16",
"iso_end_date": "2020-01-16"
}
]
}
}
],
"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"
},
"interpretation": {
"coding_system_id": "2.16.840.1.113883.6.96",
"display": "High risk",
"id": "15508007"
}
}
]
},
"start_date_of_latest_ed_visit": "2015-03-05T10:00:00Z",
"end_date_of_latest_ed_visit": "2015-03-05T10:50:00Z",
"latest_ed_discharge":{
"locations": [
{
"facility": "BaseLine Hospital",
"start_date_time": "2012-12-05T10:00:00Z",
"end_date_time": "2012-15-05T10:00:00Z"
},
{
"facility": null,
"start_date_time": "2012-11-05T10:00:00Z",
"end_date_time": null
}
],
"disposition": {
"codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"source_codings": [
{
"code": "161168008",
"display": null,
"system": "2.16.840.1.113883.6.96"
}
],
"text": "Discharge Disposition"
}
},
"start_date_of_latest_inpatient_visit": "2016-11-05T10:00:00Z",
"end_date_of_latest_inpatient_visit": "2016-11-05T11:30:00Z",
"latest_inpatient_discharge": {
"locations": [
{
"facility": "BaseLine Hospital",
"start_date_time": "2020-11-05T10:00:00Z",
"end_date_time": "2020-11-05T10:00:00Z"
}
],
"disposition": {
"codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"source_codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"text": "Discharge Disposition"
}
},
"latest_outpatient_discharge": {
"locations": [
{
"facility": "BaseLine East",
"start_date_time": "2015-11-05T10:00:00Z",
"end_date_time": "2015-11-05T10:00:00Z"
}
],
"disposition": {
"codings": [
{
"code": "01",
"display": "Home or Self Care",
"system": "urn:cerner:codingsystem:drg:msdrg"
}
],
"sourceCodings": [
{
"code": "01",
"display": "Home or Self Care",
"system": "urn:cerner:codingsystem:drg:msdrg"
}
],
"text": "Discharge Disposition"
}
},
"start_date_of_latest_outpatient_visit": "2015-11-05T10:00:00Z",
"end_date_of_latest_outpatient_visit": "2015-11-05T11:30:00Z",
"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,
"latest_discharge_diagnosis": "Secondary hypercholesterolemia",
"latest_discharge_disposition": {
"codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"source_codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"text": "Discharge Disposition"
}
}
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 |
Discharge Dispositions
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_candidates_discharge_disposition',
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_candidates_discharge_disposition
Example Discharge Dispositions Response:
{
"discharge_dispositions": [
{
"name": "Hospice Care",
"candidate_count": 19
}
],
"more_results": false,
"total_results": 1
}
GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/care_managers/{care_manager_id}/aligned_candidates_discharge_disposition
Retrieves a list of discharge dispositions for the specified care manager and 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 |
q |
string |
Filters the discharge dispositions to only those with a name that includes the specified text. This query parameter is case-insensitive. |
offset |
integer |
Index of results at which to start (Optional)
|
limit |
integer |
The number of results to return (Optional)
- Default = 20
- 0 < limit <= 100
|
Response Statuses
Status |
Type |
Description |
200 |
DischargeDispositionsResponse |
Success |
400 |
string |
Bad Request |
401 |
string |
Unauthorized |
403 |
string |
Forbidden |
404 |
string |
Not Found |
500 |
string |
Internal Server Error |
Candidates List Match
Example Request:
require 'httparty'
HTTParty.post(
'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates/persons',
headers: {
'Authorization' => 'auth_header',
'Content-Type' => 'application/json'
},
body: {
'benefit_coverages': [
{
'plan_name': 'Blue Cross HMO',
'payer_name': 'Blue Cross',
'source': {
'partition_description': 'Cerner Millennium',
'type': 'EMR'
},
'begin_date': '2018-12-07'
}
],
'attributed_providers': [
{
'id': '2bdc28e5-eb74-449e-8224-bcdc1d1701cf',
'full_name': 'Phyllis Willson',
'active': true,
'member_organizations': {
'id': '0f56b289-da34-49ac-9405-8367840651d5'
}
}
]
}
)
curl -X POST -H 'Authorization: <auth_header>' -H 'Content-Type: application/json' -d '{"benefit_coverages":[{"payer":"payer_name_1","plan":"plan_name_1","product_type": "product_type_1"},{"payer":"payer_filter_payer_test","plan": "plan_filter_payer_test","product_type":"product_type_payer_filter_test"}],"attributed_providers":[{"provider_id":"active_attributed_provider_id","member_org_id":"active_member_org_id"},{"provider_id":"inactive_attributed_provider_id","member_org_id":"inactive_member_org_id"}],"aligned_organizations":[{"org_id":"cm_aligned_organization_id","alignment_type":"care_manager_region"},{"org_id":"other_aligned_organization_id","alignment_type":"other_regions"}]}' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates/persons
Example Candidates List Match Response:
{
"candidates": [
{
"empi_id": "69a2ccde-ebb9-4981-8ae9-b12980aff707",
"identification_date": "2018-12-08T03:21:19.19Z",
"programs": [
{
"id": "cernerdemo.caremanagement.highrisksenior.clinical.program.high-risk-senior",
"name": "High-Risk Senior",
"risk_scores": [],
"identification_date": "2018-12-08T03:21:19.19Z",
"assignable_care_managers": [
{
"name": "Alexander Hall",
"id": "e9708f2f-97e6-4489-903f-788251fc73b9",
"alignment_supporting_facts": {
"provider_attribution": [
{
"provider_id": "2bdc28e5-eb74-449e-8224-bcdc1d1701cf",
"provider_name": "Phyllis Willson",
"org_names_list": [
{
"org_name": "Rockcreek Clinic"
},
{
"org_name": "Highland Clinic"
},
{
"org_name": "Baseline West Primary Care Clinic"
},
{
"org_name": "Baseline West Medical Center"
}
]
}
],
"care_manager_regions": [],
"worksite_locations": []
}
}
],
"suppressed": true
}
],
"latest_discharge_disposition": {
"text": "Rehabilitation Center",
"source_codings": [
{
"id": "rehab",
"coding_system_id": "2.16.840.1.113883.4.642.1.1093",
"display": "Rehabilitation Center"
}
],
"codings": [
{
"id": "rehab",
"coding_system_id": "2.16.840.1.113883.4.642.1.1093",
"display": "Rehabilitation Center"
}
]
},
"latest_discharge_diagnosis": "Secondary hypercholesterolemia",
"demographics": {
"full_name": "JERNLIND, NILS",
"given_names": [
"NILS"
],
"family_names": [
"JERNLIND"
],
"date_of_birth": "1953-09-08",
"gender": "Male",
"address": {
"street_addresses": [
"Lundagatan 3"
],
"city": "Lomma",
"state_or_province": "AK",
"postal_code": "12332",
"country": "US"
},
"telecoms": [
{
"preferred": true,
"number": "(046) 128-1789"
}
],
"email_addresses": []
},
"risk_scores": {
"mara_risk_scores": [
{
"model_name": "CXCONLAG0",
"total_score": 125
},
{
"model_name": "CXPROLAG3",
"total_score": 13.5
}
],
"calculated_risk_scores": [
{
"risk_score_type": "Cardiac",
"risk_score": "30.8",
"type": {
"id": "161168008",
"coding_system_id": "2.16.840.1.113883.6.96",
"display": "Morbidity Prediction"
},
"method": {
"id": "10741000175107",
"coding_system_id": "2.16.840.1.113883.6.96",
"display": "ACC/AHA ASCVD Risk Calculation"
},
"condition": {
"id": "443502000",
"coding_system_id": "2.16.840.1.113883.6.96",
"display": "Atherosclerotic Cardiovascular Disease"
},
"interpretation": {
"coding_system_id": "2.16.840.1.113883.6.96",
"display": "High risk",
"id": "15508007"
}
}
]
},
"latest_ed_discharge":{
"locations": [
{
"facility": "BaseLine Hospital",
"start_date_time": "2012-12-05T10:00:00Z",
"end_date_time": "2012-15-05T10:00:00Z"
},
{
"facility": "Smalls Hospital",
"start_date_time": "2012-11-05T10:00:00Z",
"end_date_time": "2012-12-05T10:00:00Z"
}
],
"disposition": {
"codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"source_codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"text": "Discharge Disposition"
}
},
"latest_inpatient_discharge": {
"locations": [
{
"facility": "BaseLine Hospital",
"start_date_time": "2020-11-05T10:00:00Z",
"end_date_time": "2020-11-05T10:00:00Z"
}
],
"disposition": {
"codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"source_codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"text": "Discharge Disposition"
}
},
"latest_outpatient_discharge": {
"locations": [
{
"facility": "BaseLine East",
"start_date_time": "2015-11-05T10:00:00Z",
"end_date_time": "2015-11-05T10:00:00Z"
}
],
"disposition": {
"codings": [
{
"code": "01",
"display": "Home or Self Care",
"system": "urn:cerner:codingsystem:drg:msdrg"
}
],
"sourceCodings": [
{
"code": "01",
"display": "Home or Self Care",
"system": "urn:cerner:codingsystem:drg:msdrg"
}
],
"text": "Discharge Disposition"
}
},
"benefit_coverages": [
{
"plan_name": "Blue Cross HMO",
"payer_name": "Blue Cross",
"source": {
"partition_description": "Cerner Millennium",
"type": "EMR"
},
"begin_date": "2018-12-07"
}
],
"assignable_care_managers": [
{
"name": "James Purley",
"id": "7ac35a18-403e-4ddd-9fed-e3e5cecd1420",
"alignment_supporting_facts": {
"provider_attribution": [
{
"provider_id": "2bdc28e5-eb74-449e-8224-bcdc1d1701cf",
"provider_name": "Phyllis Willson",
"org_names_list": [
{
"org_name": "Rockcreek Clinic"
}
]
}
],
"care_manager_regions": [],
"worksite_locations": []
}
}
],
"attributed_providers": [
{
"id": "2bdc28e5-eb74-449e-8224-bcdc1d1701cf",
"full_name": "Phyllis Willson",
"active": true,
"member_organizations": [
{
"id": "0f56b289-da34-49ac-9405-8367840651d5"
}
]
}
],
"personnel_group_ids": [
"1b44f00f-c746-49cc-bf94-215ed69c9e06",
"8003e033-9355-4afd-83d5-b65edb706a2d"
],
"registry_identification_outcomes": [
{
"program_id": "cernerdemo.seniorwellness.org.clinical.cernerdemo-senior-wellness",
"name": "Senior Wellness",
"program_version": 573,
"unmet_measure_outcomes": [
{
"measure_id": "app.annualpcpvisit.clinical/annual-pcp-visit-over-65-full-credit",
"name": "Annual PCP Visit Over 65",
"state": "NOT_MET_NO_DATA"
}
]
}
],
"latest_discharge_disposition": {
"codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"source_codings": [
{
"code": "161168008",
"display": "Maternity",
"system": "2.16.840.1.113883.6.96"
}
],
"text": "Discharge Disposition"
},
"suppressed": true,
"total_ed_visits": 0,
"start_date_of_latest_inpatient_visit": "2018-11-15T13:07:32.000Z",
"end_date_of_latest_inpatient_visit": "2018-11-16T08:31:00.000Z",
"total_inpatient_visits": 2,
"start_date_of_latest_outpatient_visit": "2018-12-10T20:00:00.000Z",
"end_date_of_latest_outpatient_visit": "2018-12-11T05:59:59.000Z",
"total_outpatient_visits": 5,
"record_ids": [
{
"data_partition_id": "8dee150d-505f-4635-b009-1bef63d7cf5a",
"person_id": "3641179"
}
],
"total_bad_outcome_registry_measures": 20
}
],
"total_results": 1,
"more_results": false
}
POST https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/candidates/persons
Retrieves information regarding a group of candidates based on specified criteria for a specified population.
Path Parameters
Parameter |
Type |
Description |
population_id |
string |
The HealtheIntent population ID |
Request Attributes
Parameter |
Type |
Description |
benefit_coverages |
array |
An array of benefit_coverage objects. Each object may contain the following key and value pairs:
- Key:
payer Value: string containing the payer name - Key:
plan Value: string containing the plan name - Key:
product_type Value: string containing the name of the product_type
|
attributed_providers |
array |
An array of attributed_provider objects. Each object may contain the following key and value pairs:
- Key:
provider_id Value: string containing the attributed_provider ID - Key:
member_org_id Value: string containing the member_org_id
|
aligned_organizations |
array |
An array of aligned_organizations objects. Each object may contain the following key and value pairs:
- Key:
org_id Value: string containing the organization ID - Key:
alignment_type Value: string containing the aligment type
|
Query Parameters
Parameter |
Type |
Description |
aligned_provider_id |
string |
Restricts the candidate list to those aligned with this provider |
attributed_provider |
string |
Filters out record_ids section based on attributed provider ID |
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 along with the assigned care manager. If you specify multiple program IDs, you must repeat the query parameter for each. Candidates are returned if they are identified for at least one of the specified 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
|
sort |
string |
You can sort the candidate list by the following values:
- 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
- latest_outpatient_visit: The end date of the candidate’s latest outpatient visit
- total_ed_visits: The total number of emergency department visits by a candidate
- total_inpatient_visits: The total number of inpatient visits by a candidate
- total_outpatient_visits: The total number of outpatient visits by a candidate
- total_bad_outcome_registry_measures: The total number of bad outcome registry measures for a candidate
- discharge_disposition: The candidate’s anticipated location or status following their latest encounter
- discharge_diagnosis: The candidate’s discharge diagnosis
|
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
|
order_by |
string |
How the candidate list is sorted. This parameter can be used to sort by multiple values. If this parameter is specified, the order and sort parameters are ignored. You can sort by each value in ascending or descending order using the following format: ?orderBy=-sort1,-sort2,sort3 . Use a prefix of - to specify descending order. If no prefix is specified, the list is sorted in ascending order by the specified value. The following sorting attributes are available:risk_score: Sorts by the calculated risk scores of the candidates. This is the default way that the list is sorted.identification_date: Sorts by 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 no program_ids are specified, the earliest identification_date from across all programs is used.latest_ed_visit: Sorts by the end date of the candidate’s most recent emergency department visit.latest_inpatient_visit: Sorts by the end date of the candidate’s most recent inpatient visit.latest_outpatient_visit: Sorts by the end date of the candidate’s most recent outpatient visit.total_ed_visits: Sorts by the total number of emergency department visits for the candidates.total_inpatient_visits: Sorts by the total number of inpatient visits for the candidates.total_outpatient_visits: Sorts by the total number of outpatient visits for the candidates.total_bad_outcome_registry_measures: Sorts by the total number of negative outcome registry measures for the candidates.discharge_disposition: Sorts candidates by their anticipated location or status following their latest encounter.discharge_diagnosis: Sorts candidates by their discharge diagnosis following their latest encounter. |
start |
integer |
Index of results at which to start (Optional)
|
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 |
q |
string |
Restricts the persons list to the providers having a full name that contains this string. It is case-insensitive |
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 |
personnel_group_id |
string |
Restricts the candidates to those in the specified personnel groups. Between 0 and 20 IDs can be specified. |
registry_unmet_measure_id |
string |
Filters by identified candidates who have the specified unmet registry measure. Between 0 and 20 IDs can be specified. |
discharge_disposition |
string |
Restricts the candidate list to candidates with the specified discharge dispositions. Between 0 and 20 IDs can be specified. |
discharge_diagnosis |
string |
Restricts the candidate list to candidates with the specified discharge diagnosis. Between 0 and 20 IDs can be specified. |
latest_visit_based_discharge_disposition |
string |
Restricts identified candidates to those who have the given latest visit based discharge disposition. |
latest_visit_based_discharge_disposition_visit_type |
string |
Restricts identified candidates to those who have latest discharge disposition for given visit type. |
min_registries_count |
integer |
Filters out any candidates who have less than this number of registries that they are identified for. |
registry_program_id |
string |
Restricts the candidates list to those who belong to the given registry program IDs. |
registry_program_id_operator |
string |
The logical operation that is applied between multiple registry_program_ids value. It supports the following values:
|
Response Statuses
Status |
Type |
Description |
200 |
CandidatesListMatchResponse |
Success |
400 |
string |
Bad request |
401 |
string |
Unauthorized |
403 |
string |
Forbidden |
404 |
string |
Not found |
500 |
string |
Internal server error |
Payers List
Example Request:
require 'httparty'
HTTParty.get(
'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates/payers',
headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates/payers
Example Payers List Response:
{
"payers": [
{
"payer_name": "AETNA"
},
{
"payer_name": "Assurant SF"
},
{
"payer_name": "BCBS of PA SF"
},
{
"payer_name": "Blue Cross"
},
{
"payer_name": "Blue Cross HMO"
},
{
"payer_name": "Centene"
},
{
"payer_name": "Humana Gold"
},
{
"payer_name": "Innovations Health"
},
{
"payer_name": "Iowa BCBS"
},
{
"payer_name": "Medi-Cal"
}
],
"more_results": true,
"total_results": 10
}
GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/candidates/payers
Retrieves payers information 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 payer list to candidates that are aligned to this care manager |
suppressed |
boolean |
Boolean value that will filter the list of payers to include or not include suppressed candidates- If
true , the candidate list will include only suppressed payers - If
false , the candidate list will exclude suppressed payers
|
start |
integer |
Index of results at which to start (Optional)
|
limit |
integer |
The number of results to return (Optional)
- Default = 20
- 0 < limit <= 100
|
normalized |
boolean |
Boolean value that filters the list of payers based on normalization; default value of true |
Response Statuses
Status |
Type |
Description |
200 |
PayersListResponse |
Success |
400 |
string |
Bad request |
401 |
string |
Unauthorized |
403 |
string |
Forbidden |
404 |
string |
Not found |
500 |
string |
Internal server error |
Programs List
Example Request:
require 'httparty'
HTTParty.get(
'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates/programs/',
headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates/programs/
Example Programs List Response:
{
"programs": [
{
"program_id": "cernerdemo.caremanagement.carecoordination.clinical.program.care-coordination",
"program_name": "Care Coordination"
},
{
"program_id": "cernerdemo.caremanagement.ccm.clinical.program.chronic-care-management",
"program_name": "Chronic Care Management"
},
{
"program_id": "cernerdemo.caremanagement.complexcasemanagement.clinical.program.complex-case-management",
"program_name": "Complex Case Management"
},
{
"program_id": "cernerdemo.caremanagement.diseasemanagement.clinical.program.disease-management",
"program_name": "Disease Management"
},
{
"program_id": "cernerdemo.caremanagement.highriskpediatric.clinical.program.high-risk-pediatric",
"program_name": "High-Risk Pediatric"
},
{
"program_id": "cernerdemo.caremanagement.highriskadult.clinical.program.high-risk-adult",
"program_name": "High-Risk Adult"
},
{
"program_id": "cernerdemo.caremanagement.highriskmaternity.clinical.program.high-risk-maternity",
"program_name": "High-Risk Maternity"
},
{
"program_id": "cernerdemo.caremanagement.highrisksenior.clinical.program.high-risk-senior",
"program_name": "High-Risk Senior"
},
{
"program_id": "cernerdemo.caremanagement.transitioncare.clinical.program.transition-care",
"program_name": "Transition Care Management"
},
{
"program_id": "cernerdemo.caremanagement.utilizationcoordination.clinical.program.utilization-coordination",
"program_name": "Utilization Coordination"
}
],
"total_results": 10,
"more_results": false
}
GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/candidates/programs
Retrieves programs information 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 programs list to candidates that are aligned to this care manager |
suppressed |
boolean |
Boolean value that will filter the list of payers to include or not include suppressed candidates- If
true , the programs list will include only programs for suppressed candidates - If
false , the programs list will exclude programs for suppressed candidates
|
start |
integer |
Index of results at which to start (Optional)
|
limit |
integer |
The number of results to return (Optional)
- Default = 20
- 0 < limit <= 100
|
Response Statuses
Status |
Type |
Description |
200 |
ProgramsListResponse |
Success |
400 |
string |
Bad request |
401 |
string |
Unauthorized |
403 |
string |
Forbidden |
404 |
string |
Not found |
500 |
string |
Internal server error |
Latest Visit Based Discharge Dispositions
Example Request:
require 'httparty'
HTTParty.get(
'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates/latest_visit_based_discharge_dispositions',
headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates/latest_visit_based_discharge_dispositions
Example Latest Discharge Dispositions Response:
{
"latest_discharge_dispositions_by_visit_type": [
{
"name": "Hospice Care",
"visit_type": [
"INPATIENT",
"OUTPATIENT"
]
},
{
"name": "Cardiac Care",
"visit_type": [
"OUTPATIENT"
]
},
{
"name": "Vital Care",
"visit_type": [
"OUTPATIENT",
"INPATIENT",
"ED"
]
},
{
"name": "Asthama Care",
"visit_type": [
"INPATIENT"
]
},
{
"name": "Neuro Care",
"visit_type": [
"ED"
]
}
],
"total_results": 5,
"more_results": false
}
GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/population/{population_id}/candidates/latest_visit_based_discharge_dispositions
Retrieves a list of latest discharge dispositions for the visit types for candidates for the specified population.
Path Parameters
Parameter |
Type |
Description |
population_id |
string |
The HealtheIntent population ID |
Query Parameters
Parameter |
Type |
Description |
q |
string |
Filters the discharge dispositions to only those with a name that includes the specified text. This query parameter is case-insensitive. |
offset |
integer |
Index of results at which to start. (Optional)
|
limit |
integer |
The number of results to return. (Optional)
- Default = 20
- 0 < limit <= 100
|
care_manager_id |
string |
Filters the discharge dispositions to only those whose candidates are aligned to this care manager ID. |
visit_type |
string |
Filters the discharge dispositions to only those with the corresponding visit type. |
Status |
Type |
Description |
200 |
DischargeDispositionsResponse |
Success |
400 |
string |
Bad Request. When invalid query parameters are provided. |
401 |
string |
OAuth token is invalid or expired. |
403 |
string |
The OAuth token is valid however the token is unauthorized for the endpoint. |
404 |
string |
Not Found |
Care Managers
Care Managers
Example Request:
require 'httparty'
HTTParty.get(
'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/care_managers',
headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/care_managers
Example Care Managers Response:
{
"care_managers": [
{
"id": "050e9739-9353-4a1d-8ebd-254ed409493c",
"aligned_candidates": 1057
},
{
"id": "18cf1d45-47e3-48be-8cde-6ce7b0e07d79",
"aligned_candidates": 1057
},
{
"id": "48eeae36-386b-44e0-ba42-580b4c183fd8",
"aligned_candidates": 1057
},
{
"id": "53b4bec5-69fa-45db-a4cb-fcc41bc77844",
"aligned_candidates": 1057
},
{
"id": "5cd9f9aa-0359-4eae-851e-07b714ba2746",
"aligned_candidates": 1057
}
],
"total_results": 5,
"more_results": false
}
GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/care_managers
Retrieves a non-suppressed candidate count for a specified care manager based on a population.
Path Parameters
Parameter |
Type |
Description |
population_id |
string |
The HealtheIntent population ID |
personnel_id |
string |
The ID corresponding to the care manager for which information is required |
Response Statuses
Status |
Type |
Description |
200 |
CareManagersResponse |
Success |
400 |
string |
Bad request |
401 |
string |
Unauthorized |
403 |
string |
Forbidden |
404 |
string |
Not found |
500 |
string |
Internal server error |
Care Managers Batch
Example Request:
require 'httparty'
HTTParty.post(
'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/care_managers/batch',
headers: {
'Authorization' => 'auth_header',
'Content-Type' => 'application/json'
},
body: {
'personnel_ids': [
'00a69111-cf37-4bbf-81de-c587a3d8ff04'
],
'suppressed': false
}
)
curl -X POST -H 'Authorization: <auth_header>' -H 'Content-Type: application/json' -d '{"personnel_ids":["123"],"suppressed":false}' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/care_managers/batch
Example Care Managers Batch Response:
{
"care_managers": [
{
"id": "00a69111-cf37-4bbf-81de-c587a3d8ff04",
"aligned_candidates": 0
}
]
}
POST https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/care_managers/batch
Retrieves a non-suppressed candidate count for specified care managers based on a population.
Path Parameters
Parameter |
Type |
Description |
population_id |
string |
The HealtheIntent population ID |
Request Attributes
Parameter |
Type |
Description |
personnel_ids (required) |
array |
An array of personnel_id strings which return the alignment count for given personnel_ids
- Number of personnel_ids must be greater than or equal to 1 and less than or equal to 100
- If personnel_ids are duplicated in the request, the duplicate IDs are ignored by the candidate services
- personnel_ids that are not found are returned with an alignment count of 0
|
suppressed |
boolean |
Filters alignments just to candidates with the specified suppression value |
Response Statuses
Status |
Type |
Description |
200 |
CareManagersBatchResponse |
Success |
400 |
string |
Bad request |
401 |
string |
Unauthorized |
403 |
string |
Forbidden |
404 |
string |
Not found |
500 |
string |
Internal server error |
Care Managers Alias Batch
Example Request:
require 'httparty'
HTTParty.post(
'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/care_managers/alias/batch',
headers: {
'Authorization' => 'auth_header',
'Content-Type' => 'application/json'
},
body: {
'aliases': [
{
'alias_id': '84683',
'alias_type': 'MRN_IDTYPE'
}
],
'suppressed': false
}
)
curl -X POST -H 'Authorization: <auth_header>' -H 'Content-Type: application/json' -d '{"aliases":[{"alias_id":"3094008","alias_type":"USER"}],"suppressed":false}' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/care_managers/alias/batch
Example Care Managers Alias Batch Response:
{
"care_managers": [
{
"id": "00a69111-cf37-4bbf-81de-c587a3d8ff04",
"aligned_candidates": 0,
"aliases": [
{
"alias_id": "84683",
"alias_type": "MRN_IDTYPE"
}
]
}
]
}
POST https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/care_managers/alias/batch
Retrieves bulk care managers information using aliases based on a specified population.
Path Parameters
Parameter |
Type |
Description |
population_id |
string |
The HealtheIntent population ID |
Request Attributes
Parameter |
Type |
Description |
aliases (required) |
array |
A list of alias_id and alias_type
- alias_id: alias ID of the care manager
|
suppressed |
boolean |
Filters alignments just to candidates with the specified suppression value |
Response Statuses
Status |
Type |
Description |
200 |
CareManagersAliasBatchResponse |
Success |
400 |
string |
Bad request |
401 |
string |
Unauthorized |
403 |
string |
Forbidden |
404 |
string |
Not found |
500 |
string |
Internal server error |
Plans
Example Request:
require 'httparty'
HTTParty.get(
'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/plans',
headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/plans
Example Plans Response:
{
"plans": [
{
"plan_name": "HEALTHE",
"payer_name": "Healthe",
"candidate_count": 359
},
{
"plan_name": "Medicare",
"payer_name": "Medicare",
"candidate_count": 250
},
{
"plan_name": "Aetna",
"payer_name": "Aetna",
"candidate_count": 148
},
{
"plan_name": "Blue Cross HMO",
"payer_name": "Blue Cross",
"candidate_count": 108
},
{
"plan_name": "Blue Cross PPO",
"payer_name": "Blue Cross",
"candidate_count": 107
}
],
"more_results": true,
"total": 5
}
GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/plans
Retrieves plan information from a specified population.
Path Parameters
Parameter |
Type |
Description |
population_id |
string |
The HealtheIntent population ID |
Query Parameters
Parameter |
Type |
Description |
personnel_id |
string |
The ID corresponding to the care manager for which information is required |
sort |
string |
Value by which to sort the plan distributions |
start |
integer |
Index of results at which to start (Optional)
|
limit |
integer |
The number of results to return (Optional)
- Default = 20
- 0 < limit <= 100
|
normalized |
boolean |
Boolean value that filters the list of plans based on normalization; default value of true |
Response Statuses
Status |
Type |
Description |
200 |
PlansResponse |
Success |
400 |
string |
Bad request |
401 |
string |
Unauthorized |
403 |
string |
Forbidden |
404 |
string |
Not found |
500 |
string |
Internal server error |
Product Types
Example Request:
require 'httparty'
HTTParty.get(
'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/product_types',
headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/product_types
Example Product Types Response:
{
"product_types": [
{
"candidate_count": 2,
"product_type": "Big Business"
},
{
"candidate_count": 1,
"product_type": "big business"
},
{
"candidate_count": 5,
"product_type": "MA"
},
{
"candidate_count": 8,
"product_type": "MMAI"
},
{
"candidate_count": 15,
"product_type": "SNP"
}
],
"more_results": false,
"total": 5
}
GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/product_types
Retrieves product types from 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 candidates list to candidates that are aligned to this care manager (Optional) |
start |
integer |
Index of results at which to start (Optional)
|
limit |
integer |
The number of results to return (Optional)
- Default = 20
- 0 < limit <= 100
|
Response Statuses
Status |
Type |
Description |
200 |
ProductTypesResponse |
Success |
400 |
string |
Bad request |
401 |
string |
Unauthorized |
403 |
string |
Forbidden |
404 |
string |
Not found |
500 |
string |
Internal server error |
Service Groups
Service Groups Personnel Batch
Example Request:
require 'httparty'
HTTParty.post(
'https://cernerdemo.caremanagement.healtheintent.com/api/clients/7bfa9802-7a17-41a5-a9a4-9c3fbbb66d89/service_groups/personnel/batch',
headers: {
'Authorization' => 'auth_header',
'Content-Type' => 'application/json'
},
body: {
{
'personnel_ids': [
'00a69111-cf37-4bbf-81de-c587a3d8ff04'
]
}
}
)
curl -X POST -H 'Authorization: <auth_header>' -H 'Content-Type: application/json' -d '{"personnel_ids":["027cfdd5-c048-45de-b971-454ad23279c2"]}' https://cernerdemo.caremanagement.healtheintent.com/api/clients/7bfa9802-7a17-41a5-a9a4-9c3fbbb66d89/service_groups/personnel/batch
Example Service Groups Personnel Batch Response:
{
"personnel_service_groups": [
{
"personnel_id": "00a69111-cf37-4bbf-81de-c587a3d8ff04",
"service_groups": [
{
"id": "4d567bc8-c887-5d5b-c9cb-4g6juba09758"
},
{
"id": "5d567bc8-d887-6d6b-d9db-5g6juba09758"
}
]
}
]
}
POST https://{client_mnemonic}.caremanagement.healtheintent.com/api/clients/{client_id}/service_groups/personnel/batch
Retrieving service groups for a list of personnel using POST.
Path Parameters
Parameter |
Type |
Description |
client_id |
string |
The unique identifier of the client |
Response Statuses
Status |
Type |
Description |
200 |
ServiceGroupsPersonnelBatchResponse |
Success |
400 |
string |
Bad request |
401 |
string |
Unauthorized |
403 |
string |
Forbidden |
404 |
string |
Not found |
500 |
string |
Internal server error |
Service Groups Persons List
Example Request:
require 'httparty'
HTTParty.get(
'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/service_groups/persons',
headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/service_groups/persons
Example Service Groups Persons List Response:
{
"persons": [
{
"person_id": "000d92f2-4dd8-4043-a5ab-06dd9697034c",
"given_names": [
"Shaquana"
],
"family_names": [
"Ballard"
],
"date_of_birth": "1999-11-19",
"gender": "Female",
"address": {
"type": {
"display": "HL7 H",
"id": "H",
"code_system_name": "HL7",
"code_system_id": "2.16.840.1.113883.12.190"
},
"city": "CHICAGO",
"postal_code": "60131",
"state_or_province": "IL",
"state_or_province_details": {
"display": "IL",
"id": "17",
"code_system_name": "FIPS",
"code_system_id": "2.16.840.1.113883.6.92"
},
"street_addresses": [
"66786 Freeway"
],
"source": {
"partition_description": "Cerner - Demo EMR",
"type": "ENROLLMENT"
}
},
"telecoms": [],
"emails": [],
"deceased": false,
"record_ids": [
{
"data_partition_id": "877307a0-b5f5-4a01-9d4b-9fead6bcf788",
"person_id": "84683"
}
],
"aliases": [
{
"source": {
"partition_description": "Cerner - Demo EMR",
"type": "ENROLLMENT"
},
"alias": "84683",
"source_display": "Medical record number",
"alias_type": "MRN_IDTYPE",
"assigning_authority": "1.2.3.4.5.6.7.8.9.10.1"
}
],
"service_groups": []
}
],
"more_results": false,
"total_results": 1
}
GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/service_groups/persons
Retrieving demographics and service groups for a list of people matching the search query using GET.
Path Parameters
Parameter |
Type |
Description |
population_id |
string |
The HealtheIntent population ID |
Query Parameters
Parameter |
Type |
Description |
q |
string |
Search query to filter by person name |
date_of_birth |
string |
Date of birth filter only accepting ISO 8601 date formats of YYYY-MM-DD or YYYYMMDD |
start |
integer |
Index of results at which to start (Optional)
|
limit |
integer |
The number of results to return (Optional)
- Default = 20
- 0 < limit <= 100
|
Response Statuses
Status |
Type |
Description |
200 |
ServiceGroupsPersonsList |
Success |
400 |
string |
Bad request |
401 |
string |
Unauthorized |
403 |
string |
Forbidden |
404 |
string |
Not found |
500 |
string |
Internal server error |
Candidate Exclusions
Candidate Exclusion Reasons
Example Request:
require 'httparty'
HTTParty.get(
'https://cernerdemo.caremanagement.healtheintent.com/api/clients/1424e81d-8cea-4d6b-b140-d6630b684a58/candidate_exclusion_reasons',
headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/clients/1424e81d-8cea-4d6b-b140-d6630b684a58/candidate_exclusion_reasons
Example Candidate Exclusion Reasons Response:
{
"exclusion_reasons": [
{
"id": "40ef2e8d-9ca5-4040-97ca-51681b67d279",
"text": "Does not meet priority guidelines",
"changeCriteria": {
"changeType": "CANDIDATE_SUPPRESSION"
},
"duration": {
"value": 90,
"unit": "DAYS"
},
"excluded": false
}
],
"more_results": false,
"total_results": 1
}
GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/clients/{client_id}/candidate_exclusion_reasons
Retrieves a list of exclusion reasons for a client.
Path Parameters
Parameter |
Type |
Description |
client_id |
string |
The unique identifier of the client |
Query Parameters
Parameter |
Type |
Description |
excluded |
boolean |
A Boolean value that filters the list to only excluded reasons. Excluded reasons are those that have been excluded from use during the onboarding process. By default all non-excluded reasons are returned unless you set this parameter to true. |
start |
integer |
The index of results at which to start (Optional)
|
limit |
integer |
The number of results to return (Optional)
- Default = 20
- 0 < limit <= 100
|
Response Statuses
Status |
Type |
Description |
200 |
CandidateExclusionReasons |
Success |
400 |
string |
Bad request A 400 HTTP status is returned in the following scenarios:- If the start is less than 0
- If the limit is less than 0
- If the limit is greater than 100
|
401 |
string |
Unauthorized A 401 HTTP status is returned in the following scenarios:- Authorization header missing
- Oauth token is invalid
- Oauth token is expired
|
403 |
string |
Forbidden A 403 HTTP status is returned in the following scenarios:- When the consumer does not have access to the client
- When the client does not exist
|
404 |
string |
Not found |
500 |
string |
Internal server error |
Candidate Exclusion Reason by Reason ID
Example Request:
require 'httparty'
HTTParty.get(
'https://cernerdemo.caremanagement.healtheintent.com/api/clients/1424e81d-8cea-4d6b-b140-d6630b684a58/candidate_exclusion_reasons/40ef2e8d-9ca5-4040-97ca-51681b67d279',
headers: { 'Authorization' => 'auth_header'}
)
curl -H 'Authorization: auth_header' https://cernerdemo.caremanagement.healtheintent.com/api/clients/1424e81d-8cea-4d6b-b140-d6630b684a58/candidate_exclusion_reasons/40ef2e8d-9ca5-4040-97ca-51681b67d279
Example Candidate Exclusion Reasons by Reason ID Response:
{
"reason_id": "40ef2e8d-9ca5-4040-97ca-51681b67d279",
"text": "Does not meet priority guidelines",
"excluded": false,
"excluded_dt_tm": null,
"duration": {
"value": 90,
"unit": "DAYS"
}
}
GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/clients/{client_id}/candidate_exclusion_reasons/{reason_id}
Retrieves a single exclusion reason.
Path Parameters
Parameter |
Type |
Description |
client_id |
string |
The unique ID of the client |
reason_id |
string |
The unique ID of the exclusion reason |
Response Statuses
Status |
Type |
Description |
200 |
ExclusionReason |
Success |
400 |
string |
The required parameters are not specified correctly. |
401 |
string |
The OAuth token is invalid or expired. |
404 |
string |
The client was not found. |
500 |
string |
Internal Server Error |
Create Candidate Exclusion Reason
Example Request:
require 'httparty'
HTTParty.post(
'https://cernerdemo.caremanagement.healtheintent.com/api/clients/1424e81d-8cea-4d6b-b140-d6630b684a58/candidate_exclusion_reasons',
headers: {
'Authorization' => 'auth_header',
'Content-Type' => 'application/json'
},
body: {
'text': 'test-reason',
'duration': {
'value': 10,
'unit': 'DAYS'
}
}
)
curl -H 'Authorization: auth_header' -H 'Content-Type: application/json' -d "{'text': 'tst-reason','duration': {'value': 10,'unit': 'DAYS'}}" https://cernerdemo.caremanagement.healtheintent.com/api/clients/1424e81d-8cea-4d6b-b140-d6630b684a58/candidate_exclusion_reasons
POST https://{client_mnemonic}.caremanagement.healtheintent.com/api/clients/{client_id}/candidate_exclusion_reasons
Creates an exclusion reason for a client.
Path Parameters
Parameter |
Type |
Description |
client_id |
string |
The unique ID of the client |
Request Attributes
Parameter |
Type |
Description |
- |
object |
A POST body that contains the following exclusion reason parameters:
text : The exclusion reason nameduration : The object that contains the following duration fields:value : The duration valueunit : The duration unit
|
Response Statuses
Status |
Type |
Description |
201 |
string |
The reason was successfully created. |
400 |
string |
The required parameters are not specified correctly. |
401 |
string |
The OAuth token is invalid or expired. |
404 |
string |
The client was not found. |
409 |
string |
Conflict |
500 |
string |
Internal Server Error |
Update Candidate Exclusion Reason
Example Request:
require 'httparty'
HTTParty.patch(
'https://cernerdemo.caremanagement.healtheintent.com/api/clients/1424e81d-8cea-4d6b-b140-d6630b684a58/candidate_exclusion_reasons/40ef2e8d-9ca5-4040-97ca-51681b67d279',
headers: {
'Authorization' => 'auth_header',
'Content-Type' => 'application/json'
},
body: {
'exclude': true
}
)
curl -H 'Authorization: auth_header' -H 'Content-Type: application/json' -d "{'exclude': true}" https://cernerdemo.caremanagement.healtheintent.com/api/clients/1424e81d-8cea-4d6b-b140-d6630b684a58/candidate_exclusion_reasons/40ef2e8d-9ca5-4040-97ca-51681b67d279
PATCH https://{client_mnemonic}.caremanagement.healtheintent.com/api/clients/{client_id}/candidate_exclusion_reasons/{reason_id}
Updates an exclusion reason for a client.
Path Parameters
Parameter |
Type |
Description |
client_id |
string |
The unique ID of the client |
reason_id |
string |
The unique ID of the exclusion reason |
Request Attributes
Parameter |
Type |
Description |
- |
object |
A POST body that contains the values to update an exclusion reason. Only the exclude field can be updated to be true or false. |
Response Statuses
Status |
Type |
Description |
204 |
string |
The reason was successfully updated. |
400 |
string |
The required parameters are not specified correctly. |
401 |
string |
The OAuth token is invalid or expired. |
404 |
string |
The client was not found. |
500 |
string |
Internal Server Error |
Candidates Exclusions List
Example Request:
require 'httparty'
HTTParty.get(
'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidates/9bddfa1e-7028-428b-a273-1d76e3849d98/exclusions',
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/exclusions
Example Candidate Exclusions Response:
{
"exclusions": [
{
"person_id": "9bddfa1e-7028-428b-a273-1d76e3849d98",
"program_id": "app.caremanagement.highrisksenior.clinical.high-risk-senior",
"exclusion_id": "08773854-8164-453c-8446-029c870eb3ca",
"requesting_personnel_id": "5dc9430a-fda0-4ccc-8ae9-9a5b1cbaf20d",
"reason": {
"id": "01373854-8164-453c-8446-029c870eb3ca",
"display": "Unable to Contact"
},
"created_date_time": "2018-01-16T16:26:44.114Z",
"expiration_date_time": "2018-01-17T16:26:44.114Z"
}
],
"more_results": false,
"total_results": 1
}
GET https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/candidates/{person_id}/exclusions
Retrieves a person’s exclusions using their HealtheIntent person ID based on a specified population.
Path Parameters
Parameter |
Type |
Description |
population_id |
string |
The HealtheIntent population ID |
person_id |
string |
The person’s HealtheIntent person ID |
Query Parameters
Parameter |
Type |
Description |
requesting_personnel_id |
string |
The requesting personnel’s HealtheIntent personnel ID |
program_id |
string |
Filters exclusions to those associated with the specified program |
expiration_date_time |
string |
An ISO 8601 formatted date that signifies when the exclusion expires |
start |
integer |
The index of results at which to start (Optional)
|
limit |
integer |
The number of results to return (Optional)
- Default = 20
- 0 < limit <= 100
|
Response Statuses
Status |
Type |
Description |
200 |
CandidateExclusions |
Success |
400 |
string |
Bad request A 400 HTTP status is returned in the following scenarios:- If the start is less than 0
- If the limit is less than 0
- If the limit is greater than 100
|
401 |
string |
Unauthorized A 401 HTTP status is returned in the following scenarios:- The authorization header is missing.
- The OAuth token is invalid.
- The OAuth token is expired.
|
403 |
string |
Forbidden A 403 HTTP status is returned in the following scenarios:- When the consumer does not have access to the population
- When the population does not exist
|
404 |
string |
Not found |
500 |
string |
Internal server error |
Create Candidate Exclusions
Example Request:
require 'httparty'
HTTParty.post(
'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidate_exclusions',
headers: {
'Authorization' => 'auth_header',
'Content-Type' => 'application/json'
},
body: [
{
'reason_id': '40ef2e8d-9ca5-4040-97ca-51681b67d279',
'empi_id': '3013b2f5-5380-42a7-aa71-3507c58a222e',
'program_id': 'cernerdemo.caremanagement.carecoordination.clinical.program.care-coordination',
'all_programs': false,
'requesting_personnel_id': '86387391-b7b3-4586-94fe-64aa6ca59068'
}
]
)
curl -X POST -H 'Authorization: <auth_header>' -H 'Content-Type: application/json' -d '[{"reason_id":"74c73115-7ce1-4359-9316-26c4eb65ab2b","empi_id":"0ed02b3f-d826-4ef4-80f2-691eae391035","program_id":"millennium.caremanagement.highriskmaternity.clinical.high-risk-maternity","all_programs":false,"requesting_personnel_id":"d826-4ef4-80f2-691eae391035-292def"}]' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/candidate_exclusions
Example Create Candidate Exclusion Response:
{
"candidate_exclusion_ids": [
{
"id": "33969e2b-4547-4919-a5f0-d00126a9a337"
}
]
}
POST https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/candidate_exclusions
Creates candidate exclusions. Creating a candidate exclusion suppresses a care management candidate so that the person is not included on the candidate lists for the programs specified for the amount of time associated with the exclusion reasons.
Path Parameters
Parameter |
Type |
Description |
population_id |
string |
The HealtheIntent population ID |
Request Attributes
Parameter |
Type |
Description |
- |
array |
A list of exclusion parameters
- reason_id: Exclusion reason ID
- empi_id: ID of the person within the HealtheIntent population
- program_id: Unique identifier of the program
- all_programs: Indicates if the candidate should be excluded for a single or all programs
- requesting_personnel_id: ID of the person requesting the exclusion within the HealtheIntent population
|
Response Statuses
Status |
Type |
Description |
201 |
CandidateExclusionIds |
Success |
400 |
string |
Bad request A 400 HTTP status is returned in the following scenarios:- If no empi_id is provided
- If no reason_id is provided
- If all_programs is set to true and a program_id is also provided
- If all_programs is set to false and no program_id is provided
|
401 |
string |
Unauthorized A 401 HTTP status is returned in the following scenarios:- If the authorization header is missing
- If the OAuth token is invalid
- If the OAuth token is expired
|
403 |
string |
Forbidden A 403 HTTP status is returned in the following scenarios:- When the consumer does not have access to the population
- When the population does not exist
|
404 |
string |
Not found |
409 |
string |
Conflict A 409 HTTP status is returned in the following scenarios:- If the combination of empi_id and all_programs is not unique
- If the combination of empi_id and program_id is not unique
|
422 |
string |
Unprocessable entity A 422 HTTP status is returned if the reason_id is invalid |
500 |
string |
Internal server error |
Delete Candidate Exclusions
Example Request:
require 'httparty'
HTTParty.delete(
'https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/exclusions/2982-se10-23lk9-wlk22',
headers: { 'Authorization' => 'auth_header' }
)
curl -X DELETE -H 'Authorization: <auth_header>' https://cernerdemo.caremanagement.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/exclusions/2982-se10-23lk9-wlk22
DELETE https://{client_mnemonic}.caremanagement.healtheintent.com/api/populations/{population_id}/candidates/{person_id}/exclusions/{exclusion_id}
Deletes candidate exclusions. Deleting a candidate exclusion means that the candidate is not suppressed and removed from the candidate lists for the programs they were going to be excluded from by the specified exclusion ID. This can be done only during the time between when the exclusion is created and when processing occurs for the HealtheIntent platform. Processing schedules can vary depending on configuration, but typically it occurs overnight.
Path Parameters
Parameter |
Type |
Description |
population_id |
string |
The HealtheIntent population ID |
person_id |
string |
The person’s HealtheIntent ID |
exclusion_id |
string |
The exclusion ID |
Response Statuses
Status |
Type |
Description |
204 |
|
Deleted |
401 |
string |
Unauthorized A 401 HTTP status is returned in the following scenarios:- If the authorization header is missing
- If the OAuth token is invalid
- If the OAuth token is expired
|
403 |
string |
Forbidden A 403 HTTP status is returned in the following scenarios:- When the consumer does not have access to the population
- When the population does not exist
|
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
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_ed_visit |
string |
An ISO 8601 formatted date |
end_date_of_latest_ed_visit |
string |
An ISO 8601 formatted date |
latest_ed_discharge |
struct:Discharge |
The discharge info of the latest emergency department visit for this candidate |
start_date_of_latest_inpatient_visit |
string |
An ISO 8601 formatted date |
end_date_of_latest_inpatient_visit |
string |
An ISO 8601 formatted date |
latest_inpatient_discharge |
struct:Discharge |
The discharge info of the latest inpatient visit for this candidate |
start_date_of_latest_outpatient_visit |
string |
An ISO 8601 formatted date |
end_date_of_latest_outpatient_visit |
string |
An ISO 8601 formatted date |
latest_outpatient_discharge |
struct:Discharge |
The discharge info of the latest outpatient visit for |
this candidate
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 |
latest_discharge_diagnosis | string | The discharge diagnosis for the candidate
latest_discharge_disposition | struct:DischargeDisposition | The latest Discharge Disposition information for the candidate
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 |
latest_ed_discharge |
struct:Discharge |
The discharge info of the latest emergency department visit for this candidate |
start_date_of_latest_inpatient_visit |
string |
An ISO 8601 formatted date |
end_date_of_latest_inpatient_visit |
string |
An ISO 8601 formatted date |
latest_inpatient_discharge |
struct:Discharge |
The discharge info of the latest inpatient visit for this candidate |
start_date_of_latest_outpatient_visit |
string |
An ISO 8601 formatted date |
end_date_of_latest_outpatient_visit |
string |
An ISO 8601 formatted date |
latest_outpatient_discharge |
struct:Discharge |
The discharge info of the latest outpatient visit for this candidate |
total_ed_visits |
integer |
Total number of ED visits |
total_inpatient_visits |
integer |
Total number of inpatient visits |
latest_discharge_disposition |
struct:DischargeDisposition |
The latest Discharge Disposition information for the candidate |
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
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 :[] |
A list of supporting facts that correspond with the covariate. This attribute is deprecated and is sent as an empty array only to maintain passivity for previous Cerner Millennium releases. |
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 |
Name |
Type |
Description |
name |
string |
The name of the DRG |
code |
string |
The DRG code |
code_system |
string |
The coding system |
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 |
DischargeDiagnosis
Name |
Type |
Description |
name |
string |
The name of the discharge diagnosis |
candidate_count |
string |
The number of candidates who have this discharge diagnosis |
DischargeDiagnosesResponse
Name |
Type |
Description |
discharge_diagnoses |
array:DischargeDiagnosis |
A list of discharge diagnoses for candidates aligned with a care manager in a population |
more_results |
boolean |
Indicates whether more discharge diagnoses exist |
total_results |
integer |
The total number of discharge diagnoses |
DischargeDispositionCount
Name |
Type |
Description |
name |
string |
The name of the discharge disposition |
candidate_count |
string |
The number of candidates with the discharge disposition |
AggregateDischargeDispositions
Name |
Type |
Description |
discharge_dispositions |
array:DischargeDispositionCount |
A list of counts for the discharge dispositions that belong to a care manager |
more_results |
boolean |
Indicates whether more candidates exist |
total_results |
integer |
The total number of candidates |
Email
Name |
Type |
Description |
address |
string |
The email address |
type |
Code |
Codified email address information |
Encounter
Name |
Type |
Description |
id |
string |
The ID of the encounter |
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 |
latest_ed_discharge |
struct:Discharge |
The discharge info of the latest emergency department visit for this candidate |
start_date_of_latest_inpatient_visit |
string |
An ISO 8601 formatted date |
end_date_of_latest_inpatient_visit |
string |
An ISO 8601 formatted date |
latest_inpatient_discharge |
struct:Discharge |
The discharge info of the latest inpatient visit for this candidate |
latest_outpatient_discharge |
struct:Discharge |
The discharge info of the latest outpatient visit for this candidate |
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 |
discharge_diagnosis |
string |
The discharge diagnosis of the candidate |
latest_discharge_disposition |
struct:DischargeDisposition |
The latest Discharge Disposition information for the candidate |
Discharge
Name |
Type |
Description |
locations |
array:EncounterLocation |
The locations the person was at during an encounter |
disposition |
struct:DischargeDisposition |
The disposition information for a discharge |
EncounterLocation
Name |
Type |
Description |
facility |
string |
The name of the facility that the person was at in an encounter |
start_date_time |
string |
An ISO 8601 formatted date |
end_date_time |
string |
An ISO 8601 formatted date |
DischargeDisposition
Name |
Type |
Description |
codings |
array:CodeableConcept |
An array of codings |
sourceCodings |
array:CodeableConcept |
An array of source codings |
text |
string |
Textual name of the discharge disposition |
CodeableConcept
Name |
Type |
Description |
code |
string |
Codeable concept code |
display |
string |
Displayable text |
system |
string |
Coding system |
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
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
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 |
start_date_of_latest_ed_visit |
string |
An ISO 8601 formatted date |
end_date_of_latest_ed_visit |
string |
An ISO 8601 formatted date |
latest_ed_discharge |
struct:Discharge |
The discharge info of the latest emergency department visit for this candidate |
start_date_of_latest_inpatient_visit |
string |
An ISO 8601 formatted date |
end_date_of_latest_inpatient_visit |
string |
An ISO 8601 formatted date |
latest_inpatient_discharge |
struct:Discharge |
The discharge info of the latest inpatient visit for this candidate |
start_date_of_latest_outpatient_visit |
string |
An ISO 8601 formatted date |
end_date_of_latest_outpatient_visit |
string |
An ISO 8601 formatted date |
latest_outpatient_discharge |
struct:Discharge |
The discharge info of the latest outpatient visit for this candidate |
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 |
latest_discharge_diagnosis |
string |
The discharge diagnosis for the candidate |
latest_discharge_disposition |
struct:DischargeDisposition |
The latest Discharge Disposition information for the candidate |
Source
Name |
Type |
Description |
id |
string |
Source ID |
data_partition_id |
string |
The data partition ID |
partition_description |
string |
Display name of the data partition that contributed this information to the person’s longitudinal record |
type |
string |
Source type |
SupportingDataPoint
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
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 |