HealtheRegistries API
The HealtheRegistries API provides structured JSON representations of a variety of data sources:
- Person Registries - Allows retrieving information about a person’s registry data
- Person Search - Allows searching for people based on specific search criteria
- Supporting Facts - Allows retrieving all of a person’s supporting fact data for a provided measure in a program
- Program Reference Data - Allows retrieving reference data about programs and measures
- Registry Changes - Allows retrieving the people for whom changes in registry have occurred in a given time frame
- Attribution Changes - Allows retrieving the people for whom changes in attribution have occurred in a given time frame
Note: The supporting fact data retrieved by the Person Registries Summaries and Person Measure Component Group APIs is filtered based on your sensitive data filters for Oracle Health Data Intelligence. Ensure that your implementations of these APIs are designed with this in mind, and if you integrate data from Health Data Intelligence into a clinical workflow using these APIs, ensure that your users are informed of your sensitive data filters. See Understand Sensitive Data in Oracle Health Data Intelligence in the Reference Pages on Cerner Wiki for more information.
Terminology
- Achieved - Measure status indicating a measure has been performed and successfully achieved by a person.
- Due date - The specific date when a measure is due based on when it was last performed and its defined frequency. For example, a patient completed a foot exam on November 1, 2013, and because the measure frequency of the foot exam is once a year, the due date for the patient’s next foot exam would be November 1, 2014.
- Due - A measure becomes due 30 days before its due date. This also includes a measure that has not been met or is missing data after the due date has passed. For example, a measure with a due date of January 31, 2015, would appear due on January 1, 2015, and would remain due from that point on (there is no concept of being past due on February 1). See also Due date.
- Excluded - Measure status indicating a measure is not applicable for a person. For example, a cervical cancer screening is not applicable for someone who had a complete hysterectomy.
- Fully Qualified Name (FQN) - The name of a measure as a fully qualified name, often including the program name (or some derivation) followed by a normalized version of the measure’s name.
- MARA Risk Score - A person’s or population’s overall expected health outcomes or costs. HealtheRegistries currently models risk scores based on the Milliman Advanced Risk Adjusters (MARA) risk-adjustment system to make overall predictions about peoples’ future total claim costs. Risk scores are normalized to a given population so that the average risk score for a person in the population is always one. The higher the risk score, the costlier 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.
- Measure - The combination of a discrete concept, a time window, and possibly a threshold value. Measures are the items of interest that are measurable for a given program (for example, HbA1c for the Diabetes program).
- Population - A group of people whose health a health care organization is responsible for managing.
- Program - The clinical reason for monitoring a person (such as disease, condition, and wellness). Programs identify persons using measures (such as diagnoses, treatments, and results).
- Quality score - The total number of measures met divided by the total number of measures eligible, calculated on all people (not just scorable people).
- Registry - The subset of the overall person population that is being managed for a specific program. Persons are on registries when they meet the program’s qualifying criteria.
- Scorability - A person attribute indicating whether the person is counted in scorecard calculations for a given registry.
- Supporting facts - For registries, what caused a person to be placed on a registry. For measures, the reasons a measure received a certain outcome.
Person Registries Summaries
A patient is included on a regular registry (such as Adult Wellness or Diabetes) based primarily on their demographic information (such as age and gender) and their health status (such as a diagnosis indicating diabetes). In contrast, a patient is included on an event-based registry due to an occurrence (usually an encounter) with a provider or providers at a particular point in time. For example, a patient may qualify for an event-based registry because they had an emergency department or urgent care encounter.
The measures for event-based registries are focused on clinical processes that are related to discrete encounters rather than on wellness- or care-management activities. For example, if a patient has an urgent care visit with a diagnosis of acute bronchitis, the responsible provider is measured on whether they followed the organization’s practice guidelines for the prescription of antibiotics to treat that condition.
Because the same patient may have multiple qualifying events throughout the registry’s measurement period and a different provider may be responsible for each event, the information model for this type of registry has an extra level. The model for regular registries has two levels (registries and measures), while the model for event-based registries has three levels (registries, events, and measures).
Person Registry Summary in a Single Regular Registry
Example Person Registry Summary in a Single Regular Registry
{
"id": "ae3a2060-1261-43a3-a42b-013b0d700fca",
"programs": [
{
"id": "cernerdemo.adultwellness.clinical.adult-wellness",
"name": "Adult Wellness",
"scorable": false,
"total_measure_count": 1,
"met_measure_count": 1,
"measures": [
{
"fqn": "cernerdemo.adultwellness.clinical/annual-office-visit",
"name": "Annual Office Visit",
"outcome": "ACHIEVED",
"value_unit": "Achieved",
"due_date": null,
"measure_due": false,
"supporting_facts": [
{
"name": "Encounter with Abbott, Roxie",
"date": "2018-03-06T16:20:00+00:00",
"details": [],
"formatted_code": null,
"formatted_source": "Cerner Millennium (EHR)"
}
],
"frequency": null,
"last_satisfied_date": null,
"has_displayable_components": false
}
]
}
]
}
In a regular, or nonevent-based, registry, the measures array is nested directly under programs at the same level as the name and ID of the registry. In this example, Adult Wellness is the registry and the Annual Office Visit measure is nested in the measures array.
Person Registry Summary in a Single Event-Based Registry
Example Person Registry Summary in a Single Event-Based Registry
{
"id": "ae3a2060-1261-43a3-a42b-013b0d700fca",
"programs": [
{
"id": "cernerdemo.events.ambulatory-urgent-care",
"name": "Ambulatory Urgent Care",
"scorable": true,
"total_measure_count": 0,
"met_measure_count": 0,
"events": [
{
"id": "24717504-b333-382b-8934-1ff618c9590b",
"name": "Jan 2, 2018 - Event performed by Abbott, Roxie",
"date": "2018-01-02",
"responsible_providers": [
{
"active": true,
"full_name": "Abbott, Roxie",
"id": "e0e6af12-4792-4139-bc26-9cf7b7d947d6"
}
],
"measures": [
{
"fqn": "cernerdemo.events.ambulatory-urgent-care/bronchitis-antibiotic-avoidance",
"name": "Bronchitis Antibiotic Avoidance",
"outcome": "EXCLUDED",
"value_unit": "Excluded",
"due_date": null,
"measure_due": false,
"supporting_facts": [
{
"name": "Acute bronchitis, unspecified",
"date": "2018-01-02T00:00:00+00:00",
"details": [],
"formatted_code": "ICD-10-CM J20.9",
"formatted_source": "Cerner Millennium (EHR)",
},
{
"name": "cephalexin 500 mg oral capsule",
"date": "2017-10-27T06:00:00+00:00",
"details": [],
"formatted_code": "NDC 76439010250",
"formatted_source": "Cerner Millennium (EHR)"
}
],
"frequency": null,
"last_satisfied_date": null,
"has_displayable_components": null
}
],
"supporting_facts": [
{
"name": "Acute bronchitis, unspecified",
"date": "2018-01-02T00:00:00+00:00",
"details": [],
"formatted_code": "ICD-10-CM J20.9",
"formatted_source": "Cerner Millennium (EHR)"
},
{
"name": "Office or other outpatient visit for the evaluation and management of an established patient. Requires at least two of the following three key components: a detailed history; a detailed examination; and a medical decision making of moderate complexity. Counseling and the coordination of care with other physicians, other qualified health care professionals, or agencies are provided consistent with the nature of the problems and the patient's and family's needs. Usually, the presenting problems are of moderate to high severity. Typically, 25 minutes are spent face-to-face with the patient or family.",
"date": "2018-01-02T00:00:00+00:00",
"details": [],
"formatted_code": "CPT-4 99214",
"formatted_source": "Cerner Millennium (EHR)"
}
]
}
]
}
]
}
In an event-based registry, the events array is nested directly under programs, and each events array contains its own measures array. In this example, the patient had only one qualifying event for the Ambulatory Urgent Care registry, but the same patient could have multiple qualifying events for the same registry with different responsible providers and different lists of measures.
Person Registry Summary Object
Example Person Registry Summary Object
{
"id": "ae3a2060-1261-43a3-a42b-013b0d700fca",
"programs": [
{
"id": "cernerdemo.adultwellness.org.clinical.cernerdemo-adult-wellness",
"name": "Adult Wellness",
"scorable": true,
"total_measure_count": 12,
"met_measure_count": 2,
"measures": [
{
"fqn": "cernerstandard.adultwellness.org2014.clinical/body-mass-index",
"name": "Body Mass Index",
"outcome": "ACHIEVED",
"value_unit": "21.57 kg/m2",
"due_date": "2016-10-01",
"measure_due": true,
"supporting_facts": [
{
"name": "Body Mass Index Measured 21.57 kg/m2",
"date": "2015-10-02",
"details": [],
"formatted_code": null,
"formatted_source": "Cerner Millennium (EHR)"
}
],
"frequency": 365,
"last_satisfied_date": "2015-10-02",
"has_displayable_components": false
}
],
"supporting_facts": [
{
"name": "Encounter with Dubois MD, Penny, Majors MD, Phil, Majors MD, Phil, Davis MD, Perry, Majors MD, Phil, Matt MD, Olivia, Matt, Deena and Chris McFaul",
"date": "2015-10-06",
"details": [],
"formatted_code": null,
"formatted_source": "Baseline West Medical Center; Cerner Millennium (EHR)"
}
],
"as_of_datetime": "2016-10-17T04:10:47.075Z"
}
],
"quality_score": "16%",
"mara_total_risk_score": 0.16,
"record_ids": [
{
"data_partition_id": "8dee150d-505f-4635-b009-1bef63d7cf5a",
"person_id": "3624062",
"data_partition_person_id": "3624062"
}
]
}
Person Registry Summary objects contain all the data for a person as it pertains to their registries data. The API allows you to retrieve either a single person or multiple people.
Name |
Type |
Description |
id |
string |
Person ID used to identify the person in the population. |
programs |
array : Program |
Programs whose registry the person belongs to. |
quality_score |
string |
OPTIONAL The person’s quality score. |
mara_total_risk_score |
number |
OPTIONAL MARA total risk score for person in population. This field will be omitted if the MARA risk score is not being produced for the client associated to this request. |
record_ids |
array : RecordIDs |
Source record identifiers. |
Get a Person Registries Summary Using Person ID
Example Request
require 'httparty'
HTTParty.get(
'https://cernerdemo.registries.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/ae3a2060-1261-43a3-a42b-013b0d700fca/registries',
headers: { 'Authorization' => '<auth_header>' }
)
curl -H 'Authorization: <auth_header>' https://cernerdemo.registries.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/ae3a2060-1261-43a3-a42b-013b0d700fca/registries
Example Response
{
"id": "ae3a2060-1261-43a3-a42b-013b0d700fca",
"programs": [
{
"id": "cernerdemo.adultwellness.org.clinical.cernerdemo-adult-wellness",
"name": "Adult Wellness",
"scorable": true,
"total_measure_count": 12,
"met_measure_count": 2,
"measures": [
{
"fqn": "cernerstandard.adultwellness.org2014.clinical/body-mass-index",
"name": "Body Mass Index",
"outcome": "ACHIEVED",
"value_unit": "21.57 kg/m2",
"due_date": "2016-10-01",
"measure_due": true,
"supporting_facts": [
{
"name": "Body Mass Index Measured 21.57 kg/m2",
"date": "2015-10-02",
"details": [],
"formatted_code": null,
"formatted_source": "Cerner Millennium (EHR)"
}
],
"frequency": 365,
"last_satisfied_date": "2015-10-02",
"has_displayable_components": false
}
],
"supporting_facts": [
{
"name": "Encounter with Dubois MD, Penny, Majors MD, Phil, Majors MD, Phil, Davis MD, Perry, Majors MD, Phil, Matt MD, Olivia, Matt, Deena and Chris McFaul",
"date": "2015-10-06",
"details": [],
"formatted_code": null,
"formatted_source": "Baseline West Medical Center; Cerner Millennium (EHR)"
}
],
"as_of_datetime": "2016-10-17T04:10:47.075Z"
}
],
"quality_score": "16%",
"mara_total_risk_score": 0.16,
"record_ids": [
{
"data_partition_id": "8dee150d-505f-4635-b009-1bef63d7cf5a",
"person_id": "3624062",
"data_partition_person_id": "3624062"
}
]
}
GET https://{client}.registries.healtheintent.com/api/populations/{population_id}/people/{person_id}/registries
Retrieves a single Person Registries Summary that exists in the Health Data Intelligence system. Supply the unique person ID and the ID of the population in which to search.
Path Parameters
Parameter |
Description |
population_id |
The Health Data Intelligence population ID. |
person_id |
The person ID corresponding to the person. |
Query Parameters
Parameter |
Description |
measures_status_filter |
string Filter the measures to display.Allowed: all not_achieved missing due Default: all |
fields |
string OPTIONAL Fields to include in the response. Use commas to separate and slashes to nest, for example: fields=id,programs/id,programs/name |
Response Statuses
Status |
Header |
Type |
Description |
200 |
programs-execution-real-time-status |
string |
The status of the real-time person data retrieval, if applicable. If the solution is not configured to generate program outcomes for recently received person data, the field will not be present in the response. The following are possible values for this field: FAIL : If an unknown issue occurred while trying to retrieve real-time person data NO_NEW_DATA : If the real-time data retrieval was successful, but no new data was added SUCCESS : If the real-time data retrieval was successful, and new data was added TIME_OUT : If a timeout occurred while trying to retrieve real-time data |
Get a Person Registries Summary Using Data Partition ID
Note: This endpoint is being deprecated. To retrieve a person’s registries, use the person registries summary API, which uses the person ID. To retrieve the person ID, you can use the HealtheRecord person API.
Example Request
require 'httparty'
HTTParty.get(
'https://cernerdemo.registries.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/data_partitions/8dee150d-505f-4635-b009-1bef63d7cf5a/people/3624062/registries',
headers: { 'Authorization' => '<auth_header>' })
curl -H 'Authorization: <auth_header>' https://cernerdemo.registries.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/data_partitions/8dee150d-505f-4635-b009-1bef63d7cf5a/people/3624062/registries
GET https://{client}.registries.healtheintent.com/api/populations/{population_id}/data_partitions/{data_partition_id}/people/{data_partition_person_id}/registries
Retrieves a person’s registry.
Path Parameters
Parameter |
Description |
population_id |
The Health Data Intelligence population ID. |
data_partition_id |
The data partition universally unique identifier (UUID). |
data_partition_person_id |
The ID of the person in the data partition. |
Query Parameters
Parameter |
Description |
measures_status_filter |
string Filter the measures to display.Allowed: all not_achieved missing due Default: all |
fields |
string OPTIONAL Fields to include in the response. Use commas to separate and slashes to nest, for example: fields=id,programs/id,programs/name |
Response Statuses
Status |
Header |
Type |
Description |
200 |
programs-execution-real-time-status |
string |
The status of the real-time person data retrieval, if applicable. If the solution is not configured to generate program outcomes for recently received person data, the field will not be present in the response. The following are possible values for this field: FAIL : If an unknown issue occurred while trying to retrieve real-time person data NO_NEW_DATA : If the real-time data retrieval was successful, but no new data was added SUCCESS : If the real-time data retrieval was successful, and new data was added TIME_OUT : If a timeout occurred while trying to retrieve real-time data |
List of Person Registry Summaries
Example Request
curl -H 'Authorization: <auth_header>' -H 'Content-Type: application/json' -X POST -d '{"person_ids":["ae3a2060-1261-43a3-a42b-013b0d700fca","a6facde2-b5b3-41e0-b939-3d9c87b258c9"]}' https://cernerdemo.registries.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/registries
require 'httparty'
HTTParty.post('https://cernerdemo.registries.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/registries',
headers: { 'Authorization' => '<auth_header>'},
body: {person_ids: ['ae3a2060-1261-43a3-a42b-013b0d700fca', 'a6facde2-b5b3-41e0-b939-3d9c87b258c9']}.to_json
)
Example Response
{
"persons": [
{
"id": "ae3a2060-1261-43a3-a42b-013b0d700fca",
"programs": [
{
"id": "cernerdemo.adultwellness.org.clinical.cernerdemo-adult-wellness",
"name": "Adult Wellness",
"scorable": true,
"total_measure_count": 12,
"met_measure_count": 2,
"measures": [
{
"fqn": "cernerstandard.adultwellness.org2014.clinical/body-mass-index",
"name": "Body Mass Index",
"outcome": "ACHIEVED",
"value_unit": "21.57 kg/m2",
"due_date": "2016-10-01",
"measure_due": true,
"supporting_facts": [
{
"name": "Body Mass Index Measured 21.57 kg/m2",
"date": "2015-10-02",
"details": [],
"formatted_code": null,
"formatted_source": "Cerner Millennium (EHR)"
}
],
"frequency": 365,
"last_satisfied_date": "2015-10-02",
"has_displayable_components": false
},
],
"supporting_facts": [
{
"name": "Encounter with Dubois MD, Penny, Majors MD, Phil, Majors MD, Phil, Davis MD, Perry, Majors MD, Phil, Matt MD, Olivia, Matt, Deena and Chris McFaul",
"date": "2015-10-06",
"details": [],
"formatted_code": null,
"formatted_source": "Baseline West Medical Center; Cerner Millennium (EHR)"
}
],
"as_of_datetime": "2016-10-17T04:10:47.075Z"
}
],
"quality_score": "16%",
"mara_total_risk_score": 0.16,
"record_ids": [
{
"data_partition_id": "8dee150d-505f-4635-b009-1bef63d7cf5a",
"person_id": "3624062",
"data_partition_person_id": "3624062"
}
]
},
{
"id": "a6facde2-b5b3-41e0-b939-3d9c87b258c9",
"programs": [
{
"id": "cernerdemo.adultwellness.org.clinical.cernerdemo-adult-wellness",
"name": "Adult Wellness",
"scorable": true,
"total_measure_count": 9,
"met_measure_count": 0,
"measures": [
{
"fqn": "cernerstandard.adultwellness.org2014.clinical/tobacco-use-screening-and-cessation",
"name": "Tobacco Use Screening and Cessation",
"outcome": "MISSING_DATA",
"value_unit": "--",
"due_date": null,
"measure_due": true,
"supporting_facts": [],
"frequency": null,
"last_satisfied_date": null,
"has_displayable_components": false
}
],
"supporting_facts": [
{
"name": "Encounter with Williams, Melinda, Williams, Melinda, Williams, Melinda, Williams, Melinda, Williams, Melinda, Williams, Melinda and Phyllis Callahan",
"date": "2015-10-07",
"details": [],
"formatted_code": null,
"formatted_source": "Baseline West Medical Center; Cerner Millennium (EHR)"
}
],
"as_of_datetime": "2016-10-17T04:10:47.075Z"
}
],
"quality_score": "0%",
"mara_total_risk_score": 0.05,
"record_ids": [
{
"data_partition_id": "8dee150d-505f-4635-b009-1bef63d7cf5a",
"person_id": "3624417",
"data_partition_person_id": "3624417"
}
]
}
]
}
POST https://{client}.registries.healtheintent.com/api/populations/{population_id}/people/registries
Retrieves multiple Person Registries Summaries based on the person IDs supplied and the ID of the population in which to search. Accepts a JSON POST body with the allowed body parameters below.
Path Parameters
Parameter |
Description |
population_id |
The Health Data Intelligence population ID. |
Query Parameters
Parameter |
Default |
Description |
measures_status_filter |
all |
string Filter the measures to display.Allowed: all not_achieved missing due
|
fields |
N/A |
string OPTIONAL Fields to include in the response. Use commas to separate and slashes to nest, for example: fields=id,programs/id,programs/name |
Request Message Body
Name |
Type |
Description |
person_ids |
array : string |
The IDs of the persons in the population. |
program_ids |
array : string |
OPTIONAL The IDs of the programs to filter the data by. |
person_by_program_filter_type |
string |
Determines how the program_ids should filter the person data. Defaults to OR if left blank.Allowed: Default: OR |
Responses
Person Search Results
Used to collect primarily demographics data by allowing consumers to search for people. Currently, it allows searching by personnel responsible for the person and program and measures the person is included on.
Person Search Result Object
Example Person Search Result Object
{
"id": "0d9b99bd-97d9-4876-b3b6-990f40037a94",
"family_names": [
"Abbott"
],
"given_names": [
"Dianne"
],
"formatted_name": "Abbott, Dianne",
"date_of_birth": "1928-11-21",
"gender": "Female",
"record_ids": [
{
"data_partition_id": "877307a0-b5f5-4a01-9d4b-9fead6bcf788",
"person_id": "148378",
"data_partition_person_id": "148378"
}
]
}
Name |
Type |
Description |
id |
string |
The ID used to identify the person in the population. |
family_names |
array : string |
A collection of family names. |
given_names |
array : string |
A collection of given names. |
full_name |
string |
OPTIONAL The full name of a person. |
suffix |
string |
OPTIONAL Part of the name that is acquired as a title due to academic, legal, employment, nobility status, and so on and that appears at the end of the name. |
formatted_name |
string |
OPTIONAL Name of the person formatted according to Health Data Intelligence requirements. |
date_of_birth |
string |
OPTIONAL The date of the person’s birth. |
date_of_death |
string |
OPTIONAL The date of the person’s death. |
gender |
string |
OPTIONAL The gender of the person. |
record_ids |
array : RecordIDs |
Source record identifiers. |
Search for Persons
Example Request
curl -H 'Authorization: <auth_header>' https://cernerdemo.registries.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people?personnel_id=6affb989-7b5f-407b-889d-713bf8a23aed&limit=2
require 'httparty'
HTTParty.get(
'https://cernerdemo.registries.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people?personnel_id=6affb989-7b5f-407b-889d-713bf8a23aed&limit=2',
headers: { 'Authorization' => '<auth_header>' }
)
Example Response
{
"persons": [
{
"id": "0d9b99bd-97d9-4876-b3b6-990f40037a94",
"family_names": [
"Abbott"
],
"given_names": [
"Dianne"
],
"formatted_name": "Abbott, Dianne",
"date_of_birth": "1928-11-21",
"gender": "Female",
"record_ids": [
{
"data_partition_id": "877307a0-b5f5-4a01-9d4b-9fead6bcf788",
"person_id": "148378",
"data_partition_person_id": "148378"
}
]
},
{
"id": "691ff7fe-7989-4aa7-810b-63ec1c13b7e5",
"family_names": [
"Abbott"
],
"given_names": [
"Jolynn"
],
"formatted_name": "Abbott, Jolynn",
"date_of_birth": "1949-07-27",
"gender": "Female",
"record_ids": [
{
"data_partition_id": "877307a0-b5f5-4a01-9d4b-9fead6bcf788",
"person_id": "112087",
"data_partition_person_id": "112087"
}
]
}
],
"more_results": true,
"total_results": 6501
}
GET https://{client}.registries.healtheintent.com/api/populations/{population_id}/people
Retrieves the person demographics information of people matching the provided search criteria.
Path Parameters
Parameter |
Description |
population_id |
The Health Data Intelligence population ID |
Query Parameters
Parameter |
Default |
Description |
program_id |
N/A |
string ID of the program to filter by. Required if personnel_id is not passed. |
measure_fqn |
N/A |
string Fully qualified name of the measure to further filter by. Will not include persons who are excluded or not included. program_id is required if measure_fqn is passed. |
personnel_id |
N/A |
string ID of the personnel to further filter by. Required if program_id is not passed. |
start |
0 |
integer Index of result to begin retrieving results at. Defaults to 0. |
limit |
20 |
integer Number of results to retrieve at a given time. Must be between 1 and 100. Defaults to 20. |
Responses
Population Change
Used to collect primarily attribution changes that has happened in the population.
Get Attribution Changes
Example Request
curl -H 'Authorization: <auth_header>' https://cernerdemo.registries.healtheintent.com/api/populations/ab9176be-4303-4e6c-aa8d-219d31e29d76/attribution_changes
require 'httparty'
HTTParty.get(
'https://cernerdemo.registries.healtheintent.com/api/populations/ab9176be-4303-4e6c-aa8d-219d31e29d76/attribution_changes',
headers: { 'Authorization' => '<auth_header>' }
)
Example Response
{
"start_date": "2017-03-08T00:00:00.000Z",
"end_date": "2017-04-07T00:00:00.000Z",
"attribution_changes": [
{
"change_date": "2017-03-30T17:34:54.817Z",
"change_type": "REMOVAL",
"start_date": "2017-03-30T17:08:03.819Z",
"end_date": "2017-03-30T17:34:54.817Z",
"person": {
"id": "7280af5f-dbe1-40c9-a8a7-c6e4e2d7e3d5",
"record_ids": [
{
"data_partition_id": "f12d1f15-807f-4f2e-85e0-5f4acf98e8dd",
"person_id": "JZ8675309"
}
]
},
"personnel": {
"id": "8dce4899-6080-4cb6-9df2-6a59214a6223",
"aliases": [
{
"value": "Palmer Crooker",
"type": "USER",
"assigning_authority": "fe1b797b-8e60-491e-9cc3-2e009220e767"
},
{
"value": "FT0263613",
"type": "DEA",
"assigning_authority": "2.16.840.1.113883.4.814"
},
{
"value": "683613",
"type": "EXTERNAL",
"assigning_authority": "com.external"
},
{
"value": "1417163613",
"type": "NPI",
"assigning_authority": "2.16.840.1.113883.4.6"
},
{
"value": "FT1832613",
"type": "DEA",
"assigning_authority": "2.16.840.1.113883.4.814"
}
]
},
"organization": {
"id": "973b1740-c708-4b2c-a9b7-be286427346c",
"aliases": [
{
"value": "683992",
"type": "EXTERNAL",
"assigning_authority": null
},
{
"value": "12346",
"type": "NPI",
"assigning_authority": null
}
]
}
},
{
"change_date": "2017-03-30T17:34:54.817Z",
"change_type": "ADDITION",
"start_date": "2017-03-30T17:34:54.817Z",
"person": {
"id": "7280af5f-dbe1-40c9-a8a7-c6e4e2d7e3d5",
"record_ids": [
{
"data_partition_id": "f12d1f15-807f-4f2e-85e0-5f4acf98e8dd",
"person_id": "JZ8675309"
}
]
},
"personnel": {
"id": "b62bc3eb-f6a0-4608-a3c0-4847ba579388",
"aliases": [
{
"value": "Tolentino_Angelica",
"type": "USER",
"assigning_authority": "fe1b797b-8e60-491e-9cc3-2e009220e767"
},
{
"value": "1417163618",
"type": "NPI",
"assigning_authority": "2.16.840.1.113883.4.6"
},
{
"value": "683618",
"type": "EXTERNAL",
"assigning_authority": "com.external"
},
{
"value": "FT1832618",
"type": "DEA",
"assigning_authority": "2.16.840.1.113883.4.814"
},
{
"value": "FT0263618",
"type": "DEA",
"assigning_authority": "2.16.840.1.113883.4.814"
}
]
},
"organization": {
"id": "973b1740-c708-4b2c-a9b7-be286427346c",
"aliases": [
{
"value": "683992",
"type": "EXTERNAL",
"assigning_authority": null
},
{
"value": "12346",
"type": "NPI",
"assigning_authority": null
}
]
}
}
],
"total_results": 118,
"more_results": true
}
GET https://{client_mnemonic}.registries.healtheintent.com/api/populations/{population_id}/attribution_changes
Retrieves the population attribution changes for a given date range.
Path Parameters
Parameter |
Description |
population_id |
The Health Data Intelligence population ID. |
Query Parameters
Parameter |
Default |
Description |
start_date |
-24h |
string OPTIONAL Filter for the starting of the range of change dates of the attribution change. If you do not specify a start date, -24h is used and attribution change data for the last 24 hours is retrieved. |
end_date |
Now |
string The end date to use when searching for population change data. |
data_partition_id |
N/A |
string OPTIONAL The data partition UUID. |
start |
0 |
integer OPTIONAL Index of result to begin retrieving results at. Defaults to 0. |
limit |
20 |
integer OPTIONAL Number of results to retrieve at a given time. Must be between 1 and 100. Defaults to 20. |
Responses
Get Registry Changes
Example Request
curl -H 'Authorization: <auth_header>' https://cernerdemo.registries.healtheintent.com/api/populations/69ab8124-257d-4abf-8b4c-e434167c5d4a/people/changed?start_date=2017-06-19T08:27:17.453Z&end_date=2017-06-20T08:27:17.454Z&start=0&limit=2&data_partition_id=8cd6117e-91d5-437c-a583-362bfdabeffb
require 'httparty'
HTTParty.get(
'https://cernerdemo.registries.healtheintent.com/api/populations/69ab8124-257d-4abf-8b4c-e434167c5d4a/people/changed?start_date=2017-06-19T08:27:17.453Z&end_date=2017-06-20T08:27:17.454Z&start=0&limit=2&data_partition_id=8cd6117e-91d5-437c-a583-362bfdabeffb',
headers: { 'Authorization' => '<auth_header>' }
)
Example Response
{
"persons": [
{
"id": "1ecc1f86-f42a-4177-8b7d-848e25c0b83c",
"record_ids": [],
"change_date": "2017-06-19T09:54:08.749Z",
"program_id": "millennium.hypertension.clinical.hypertension",
"fqn": "cernerstandard.hypertension.org2014.clinical/bp-less-than-140-90"
},
{
"id": "943a86b6-e391-4101-a369-0b52940862ea",
"record_ids": [
{
"data_partition_id": "8cd6117e-91d5-437c-a583-362bfdabeffb",
"person_id": "34056336"
}
],
"change_date": "2017-06-19T15:56:20.332Z"
}
],
"total_results": 8,
"more_results": true
}
GET https://{client_mnemonic}.registries.healtheintent.com/api/populations/{population_id}/people/changed?start_date=<start_date>&end_date=<end_date>&start=<start>&limit=<limit>&data_partition_id=<data_partition_id>
Retrieves the population registries outcomes for a given date range.
Path Parameters
Parameter |
Description |
population_id |
The Health Data Intelligence population ID. |
Query Parameters
Parameter |
Default |
Description |
start_date |
-24h |
string OPTIONAL Filters registries changes to those after the specified date and time. If you do not specify a start date, -24h is used and registries change data for the last 24 hours is retrieved. In ISO 8601 formatting. |
end_date |
Now |
string OPTIONAL Filters registries changes to those before the specified date and time. If you do not specify an end date, Now is used and registries change data from up to the current date and time is retrieved. In ISO 8601 formatting. |
data_partition_id |
N/A |
string OPTIONAL The data partition UUID. |
start |
0 |
integer OPTIONAL Index of result to begin retrieving results at. Defaults to 0. |
limit |
20 |
integer OPTIONAL Number of results to retrieve at a given time. Must be between 1 and 100. Defaults to 20. |
Responses
Person Measure Component Group
Person Measure Component Group objects contain all the supporting fact data for a person on a given program and measure combination.
Component Group Object
Example Component Group Object
{
"display": null,
"operator": "OR",
"is_satisfied": true,
"component_groups": [],
"satisfying_supporting_facts": [
{
"name": "Body Mass Index Measured 21.57 kg/m2",
"date": "2015-10-02",
"details": [],
"formatted_code": null,
"formatted_source": "Cerner Millennium (EHR)"
}
],
"non_satisfying_supporting_facts": []
}
Name |
Type |
Description |
display |
string |
OPTIONAL Display name of the component group. |
operator |
string |
The operator type of the component group.Possible values: |
is_satisfied |
boolean |
Indicator whether the component group was satisfied. |
component_groups |
array : ComponentGroup |
A list of component groups. |
satisfying_supporting_facts |
array : SupportingFact |
Supporting fact data points that contributed to the satisfying criteria of this component group. |
non_satisfying_supporting_facts |
array : SupportingFact |
Supporting fact data points that did not contribute to the satisfying criteria of this component group. |
Get Component Group
Example Request
curl -H 'Authorization: <auth_header>' https://cernerdemo.registries.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/ae3a2060-1261-43a3-a42b-013b0d700fca/registries/cernerdemo.adultwellness.org.clinical.cernerdemo-adult-wellness/measures/cernerstandard.adultwellness.org2014.clinical%2Fbody-mass-index/componentGroup
require 'httparty'
HTTParty.get(
'https://cernerdemo.registries.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/ae3a2060-1261-43a3-a42b-013b0d700fca/registries/cernerdemo.adultwellness.org.clinical.cernerdemo-adult-wellness/measures/cernerstandard.adultwellness.org2014.clinical%2Fbody-mass-index/componentGroup',
headers: { 'Authorization' => '<auth_header>' }
)
Example Response
{
"display": null,
"operator": "OR",
"is_satisfied": true,
"component_groups": [],
"satisfying_supporting_facts": [
{
"name": "Body Mass Index Measured 21.57 kg/m2",
"date": "2015-10-02",
"details": [],
"formatted_code": null,
"formatted_source": "Cerner Millennium (EHR)"
}
],
"non_satisfying_supporting_facts": []
}
GET https://{client}.registries.healtheintent.com/api/populations/{population_id}/people/{person_id}/registries/{program_id}/measures/{fqn}/componentGroup
Retrieves all the supporting facts for a given person on a specific program and measure.
Path Parameters
Parameter |
Description |
population_id |
The Health Data Intelligence population ID. |
person_id |
The person ID corresponding to the person. |
program_id |
Health Data Intelligence program ID to which the corresponding measure belongs. |
fqn |
OPTIONAL The fully qualified name of the measure (its identifier). |
Responses
Programs
People can qualify for certain registries in a population. The Programs endpoint allows accessing the reference data used to build this information out.
Program Object
Example Program Object
{
"program_id": "cernerdemo.copd.org.clinical.cernerdemo-copd",
"version": 127,
"name": "Chronic Obstructive Pulmonary Disease",
"description": "The COPD registry will include persons in the population, aged 18 years and older, with a diagnosis of Chronic Obstructive Pulmonary Disorder (COPD), and at least one outpatient encounter in the current measurement period or prior two measurement periods.",
"population_id": "1424e81d-8cea-4d6b-b140-d6630b684a58",
"measures": [
{
"measure_id": "9aa3e64a-08bc-4b16-b24a-b25cd4ca8672",
"fqn": "cernerstandard.copd.org2014.clinical/spirometry-evaluation",
"name": "Spirometry Evaluation",
"short_display": "Spirometry Evaluation",
"description": "The proportion of persons in the COPD Registry population with documented spirometry testing to confirm a new diagnosis of COPD during the current measure period."
}
]
}
Name |
Type |
Description |
program_id |
string |
The unique ID given to the program. |
version |
number |
OPTIONAL Version for the program, which helps in identifying how many times the program has been updated. |
name |
string |
Name of the program. |
description |
string |
OPTIONAL Configured description of the program. |
population_id |
string |
The Health Data Intelligence population ID. |
measures |
array : MeasureReferenceData |
Measures that are part of the program. Note that this may be empty, but it will be present. |
Please see the full reference for further details about the object.
Get All Programs
Example Request
curl -H 'Authorization: <auth_header>' https://cernerdemo.registries.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/programs
HTTParty.get(
'https://cernerdemo.registries.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/programs',
headers: { 'Authorization' => '<auth_header>' }
)
Example Response
{
"programs": [
{
"program_id": "cernerdemo.copd.org.clinical.cernerdemo-copd",
"version": 127,
"name": "Chronic Obstructive Pulmonary Disease",
"description": "The COPD registry will include persons in the population, aged 18 years and older, with a diagnosis of Chronic Obstructive Pulmonary Disorder (COPD), and at least one outpatient encounter in the current measurement period or prior two measurement periods.",
"population_id": "1424e81d-8cea-4d6b-b140-d6630b684a58",
"measures": [
{
"measure_id": "9aa3e64a-08bc-4b16-b24a-b25cd4ca8672",
"fqn": "cernerstandard.copd.org2014.clinical/spirometry-evaluation",
"name": "Spirometry Evaluation",
"short_display": "Spirometry Evaluation",
"description": "The proportion of persons in the COPD Registry population with documented spirometry testing to confirm a new diagnosis of COPD during the current measure period."
},
{
"measure_id": "90736267-45c7-4594-ae57-fd52e990ee59",
"fqn": "cernerstandard.copd.org2014.clinical/bronchodilator-therapy",
"name": "Bronchodilator Therapy",
"short_display": "Bronchodilator Therapy",
"description": "The proportion of persons in the COPD Registry population with a diagnosis of COPD and documented FEV1/FVC < 60%, AND were prescribed an inhaled bronchodilator during the current measurement period."
}
]
},
{
"program_id": "cernerdemo.congestiveheartfailure.org.clinical.cernerdemo-congestive-heart-failure",
"version": 131,
"name": "Heart Failure",
"description": "The Heart Failure Registry will include persons in the population, aged 18 years and older, with a diagnosis of heart failure, or some level of documented left ventricular dysfunction, and at least one outpatient encounter during the current measurement period or prior two measurement periods.",
"population_id": "1424e81d-8cea-4d6b-b140-d6630b684a58",
"measures": [
{
"measure_id": "e3ccd35e-6ecb-4e4c-9079-0fc568e0c245",
"fqn": "cernerstandard.heartfailure.org2014.clinical/left-ventricular-function-assessment",
"name": "Left Ventricular Function Assessment",
"short_display": "LV Assessment",
"description": "The proportion of persons in the Heart Failure Registry population with quantitative or qualitative results of left ventricular function (LVF) recorded in the medical record, and a LVF assessment performed at any time during the measurement period or in the year prior to the measurement period."
},
{
"measure_id": "49b0bfc3-1155-47cb-9d37-2e2c473e2c33",
"fqn": "cernerstandard.heartfailure.org2014.clinical/beta-blocker-therapy",
"name": "Beta Blocker Therapy",
"short_display": "Beta Blocker Therapy",
"description": "The proportion of persons in the Heart Failure Registry population with documented moderate or severe left ventricular systolic dysfunction who, in the absence of contraindications, are taking or have been prescribed a beta blocker medication during the measurement period."
}
]
}
]
}
GET https://{client}.registries.healtheintent.com/api/populations/{population_id}/programs
Retrieves all programs defined for a given population.
Path Parameters
Parameter |
Description |
population_id |
The Health Data Intelligence population ID. |
Responses
Get a Program
Example Request
curl -H 'Authorization: <auth_header>' https://cernerdemo.registries.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/programs/cernerdemo.copd.org.clinical.cernerdemo-copd?measure_fqn=cernerstandard.copd.org2014.clinical/spirometry-evaluation
require 'httparty'
HTTParty.get(
'https://cernerdemo.registries.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/programs/cernerdemo.copd.org.clinical.cernerdemo-copd?measure_fqn=cernerstandard.copd.org2014.clinical/spirometry-evaluation',
headers: { 'Authorization' => '<auth_header>' }
)
Example Response
{
"program_id": "cernerdemo.copd.org.clinical.cernerdemo-copd",
"version": 127,
"name": "Chronic Obstructive Pulmonary Disease",
"description": "The COPD registry will include persons in the population, aged 18 years and older, with a diagnosis of Chronic Obstructive Pulmonary Disorder (COPD), and at least one outpatient encounter in the current measurement period or prior two measurement periods.",
"population_id": "1424e81d-8cea-4d6b-b140-d6630b684a58",
"measures": [
{
"measure_id": "9aa3e64a-08bc-4b16-b24a-b25cd4ca8672",
"fqn": "cernerstandard.copd.org2014.clinical/spirometry-evaluation",
"name": "Spirometry Evaluation",
"short_display": "Spirometry Evaluation",
"description": "The proportion of persons in the COPD Registry population with documented spirometry testing to confirm a new diagnosis of COPD during the current measure period."
}
]
}
GET https://{client}.registries.healtheintent.com/api/populations/{population_id}/programs/{program_id}
Retrieves a particular program from the data. Allows filtering the measures returned down to a single desired measure using the measure_fqn
.
Path Parameters
Parameter |
Description |
population_id |
The Health Data Intelligence population ID. |
program_id |
The Health Data Intelligence program ID. |
Query Parameters
Parameter |
Default |
Description |
measure_fqn |
N/A |
string Used to filter the program’s measures by a measure FQN. If an invalid FQN is provided, the resulting measures attribute will be an empty array. |
Responses
Person’s Provider Relationships
Retrieves a person’s provider relationships. These relationships are driven by the responsible provider or attributed to the patient in context.
Get Provider Relationships
Example Request
curl -H 'Authorization: <auth_header>' https://cernerdemo.registries.healtheintent.com/api/populations/ab9176be-4303-4e6c-aa8d-219d31e29d76/people/6313678f-7be1-4a54-a175-98749ab00664/provider_relationships
require 'httparty'
HTTParty.get(
'https://cernerdemo.registries.healtheintent.com/api/populations/ab9176be-4303-4e6c-aa8d-219d31e29d76/people/6313678f-7be1-4a54-a175-98749ab00664/provider_relationships',
headers: { 'Authorization' => '<auth_header>' }
)
Example Response
[
{
"id": "1fc8918c-f5e1-4240-87da-5e84ca012403",
"name": "Sherry Johnson",
"aliases": [
{
"alias_id": "Johnson_Sherry",
"alias_type": "USER",
"assigning_authority": "01800594-0d8e-4960-ab20-257b4f4877e6"
},
{
"alias_id": "CERN19",
"alias_type": "NPI",
"assigning_authority": "2.16.840.1.113883.4.6"
}
],
"relationship_types": [
"responsible",
"attributed"
],
"supporting_facts": [
{
"name": "Assigned Practitioner",
"date": "2012-11-04T00:00:00+00:00",
"details": [],
"formatted_code": "SNOMED CT 405623001",
"formatted_source": "Cerner - Demo EMR (Enrollment File)"
}
],
"organization": {
"id": "5f04ec06-b7fd-470b-9c14-0664b62fa768",
"name": "LGHPHO"
}
}
]
GET https://{client_mnemonic}.registries.healtheintent.com/api/populations/{population_id}/people/{person_id}/provider_relationships
Retrieves a single person’s provider relationships by person ID.
Path Parameters
Parameter |
Description |
population_id |
The Health Data Intelligence population ID. |
person_id |
The Health Data Intelligence person ID corresponding to the person. |
Query Parameters
Parameter |
Type |
Description |
type |
string |
OPTIONAL The type query parameter filters the list of provider relationships to display. Both attributed and responsible providers are returned if you do not set this parameter. Possible values: |
Responses
HealtheRegistries API Definitions
PersonRegistrySummaries
PersonRegistrySummary
Name |
Type |
Description |
id |
string |
Person ID used to identify the person within the population |
programs |
array : Program |
Programs whose registry the person belongs to |
quality_score |
string |
OPTIONAL The person’s quality score |
mara_total_risk_score |
number |
MARA total risk score for person within population. This field will be omitted if the MARA risk score is not being produced for the client associated to this request. |
record_ids |
array : RecordIDs |
OPTIONAL Source record identifiers |
RecordID
Name |
Type |
Description |
data_partition_id |
string |
The data partition UUID |
person_id |
string |
The ID of the person within the data partition |
data_partition_person_id |
string |
OPTIONAL The ID of the person within the data partition. NOTE: data_partition_person_id is being deprecated in favor of person_id . |
RecordIDs
Name |
Type |
Description |
data_partition_id |
string |
The data partition UUID |
person_id |
string |
The ID of the person within the data partition |
Program
Name |
Type |
Description |
id |
string |
ID of the program |
name |
string |
Name of the program |
scorable |
boolean |
A boolean indicator if the person is scorable on this particular program |
total_measure_count |
integer |
OPTIONAL The total number of measures in this program |
met_measure_count |
integer |
OPTIONAL The number of the person’s met measures within this program |
measures |
array : Measure |
OPTIONAL Outcomes for the measures of the program. This array of measures is not present when the program represents an event-based registry. |
events |
array : Event |
OPTIONAL For event-based programs, these are the events for this person that fall under this program. For non-event-based programs, this field will not be present. |
supporting_facts |
array : SupportingFact |
OPTIONAL Details about the person’s inclusion in this program. This array of supporting facts is not present when the program represents an event-based registry. |
as_of_datetime |
string |
OPTIONAL Indicates the date and time (ISO-8601 format) when the program was extracted from the reference record. There are no guarantees the reference record contains all updates from the source system. |
Event
Name |
Type |
Description |
name |
string |
Name of the event |
id |
string |
ID of the event |
date |
string |
Date the event was entered into the system |
responsible_providers |
array : ResponsibleProvider |
Providers responsible for the event |
measures |
array : Measure |
Measures that are part of this particular program |
supporting_facts |
array : SupportingFact |
OPTIONAL Supporting facts for the event |
ResponsibleProvider
Name |
Type |
Description |
full_name |
string |
OPTIONAL Formatted full name for the provider |
id |
string |
OPTIONAL ID of the provider |
active |
boolean |
Indicator for if the provider is still active |
Measure
Name |
Type |
Description |
measure_due |
boolean |
OPTIONAL Returns true if the measure is due within 30 days or the date is beyond the due date, false if not, or null if there is no due_date |
due_date |
string |
OPTIONAL A string representing the due date (ISO-8601 format) of the measure or null if there is no date |
fqn |
string |
The fully qualified name of the measure (its identifier) |
name |
string |
Displayable name of the measure |
outcome |
string |
Current state of the measure.Allowed: ACHIEVED NOT_ACHIEVED EXCLUDED MISSING_DATA
|
frequency |
integer |
OPTIONAL How often the measure is due, in days |
last_satisfied_date |
string |
OPTIONAL The last date the measure was satisfied |
value_unit |
string |
OPTIONAL The value to display for the measure. Either a measurement-like value (potentially including a unit), or a non-measurement value such as ‘Excluded’, ‘Performed’, or ‘Completed’ |
has_displayable_components |
boolean |
OPTIONAL Returns true if a measure has displayable components inside, false if not |
supporting_facts |
array : SupportingFact |
OPTIONAL Components supporting the measure outcome. The facts are sorted in descending order by start date, with any null values coming first |
SupportingFact
Name |
Type |
Description |
details |
array : string |
Collection of detailed data about the supporting fact. |
name |
string |
Display value for the supporting fact |
date |
string |
OPTIONAL Date when the supporting fact occurred |
formatted_code |
string |
OPTIONAL Formatted display text for codified supporting fact information |
formatted_source |
string |
OPTIONAL Formatted display of the source. |
ProgramReferenceHolder
Name |
Type |
Description |
programs |
array : ProgramReferenceData |
Collection of Program Reference data objects. |
ProgramReferenceData
Name |
Type |
Description |
program_id |
string |
The unique id given to the program |
version |
number |
Version for the program, which helps in identifying how many times the program has been updated |
name |
string |
Name of the program |
description |
string |
OPTIONAL Configured description of the program |
population_id |
string |
The Oracle Health Data Intelligence population ID |
measures |
array : MeasureReferenceData |
Measures that are part of the program. Note that this may be empty, but it will be present. |
MeasureReferenceData
Name |
Type |
Description |
measure_id |
string |
ID of the measure from program reference service |
fqn |
string |
Fully qualified name of the measure (its identifier) |
name |
string |
Display name for the measure |
short_display |
string |
OPTIONAL Short display text of the measure |
description |
string |
OPTIONAL Configured description of the measure |
PopulationAttributionChange
Name |
Type |
Description |
start_date |
integer |
OPTIONAL The start date to use when searching for population change data. The default value is 24 hours before the current time. |
end_date |
integer |
OPTIONAL Filter for the end of the range of change dates of the attribution change. Default value is the current time. |
attribution_changes |
array : AttributionChanges |
An array of attribution change summary |
total_results |
integer |
It gives total number of results available |
more_results |
boolean |
Indicating whether more results are available apart from the given start and end dates. |
AttributionChanges
Name |
Type |
Description |
change_date |
integer |
It shows the date when the attribution type changes |
change_type |
string |
The change_type shows the attribution change is ADDITION or REMOVAL . |
start_date |
string |
Shows the date and time of initial attribution |
end_date |
string |
Shows The date and time the attribution was ended |
person |
array : Person |
Person information |
personnel |
array : Personnel |
Personnel information |
organization |
array : Organization |
OPTIONAL Organization information |
PopulationRegistriesOutcomes
Name |
Type |
Description |
persons |
array : persons |
A list of the people for whom registries changes were returned |
total_results |
integer |
Total number of results available |
more_results |
boolean |
Indicates whether more results are available between the given start and end dates |
Persons
Name |
Type |
Description |
id |
string |
The ID of the person with the registry change |
record_ids |
array : RecordIDs |
Source record identifiers |
change_date |
string |
Indicates the date when the registry type changed. Format allowed ISO 8601. |
program_id |
string |
OPTIONAL The unique ID given to the program |
fqn |
string |
OPTIONAL Fully qualified name of the measure (its identifier) |
Person
Name |
Type |
Description |
id |
integer |
The ID of the person with attribution change |
record_ids |
array : RecordIDs |
OPTIONAL Source record identifiers |
Personnel
Name |
Type |
Description |
id |
integer |
The ID of the personnel associated to the person with attribution change |
aliases |
array : Aliases |
An array of aliases |
Organization
Name |
Type |
Description |
id |
integer |
The ID of the organization associated to the person with attribution change |
aliases |
array : Aliases |
An array of aliases |
Aliases
Name |
Type |
Description |
value |
string |
Alias value |
type |
string |
Alias type of the personnel |
assigning_authority |
string |
System id which is assigning the alias type for the personnel |
ComponentGroup
Name |
Type |
Description |
display |
string |
OPTIONAL Display name of the component group |
operator |
string |
The operator type of the component group.Possible values: |
is_satisfied |
boolean |
Indicator whether the component group was satisfied |
component_groups |
array : ComponentGroup |
A list of component groups |
satisfying_supporting_facts |
array : SupportingFact |
Supporting fact data points that contributed to the satisfying criteria of this component group |
non_satisfying_supporting_facts |
array : SupportingFact |
Supporting fact data points that did not contribute to the satisfying criteria of this component group |
PersonSearchResults
Name |
Type |
Description |
persons |
array : PersonSummary |
Person information |
total_results |
integer |
Total number of results for the criteria passed |
more_results |
boolean |
Boolean indicating if more results could be retrieved via paging |
PersonSummary
Name |
Type |
Description |
id |
string |
Person ID used to identify the person within the population |
family_names |
array : string |
A collection of family names |
given_names |
array : string |
A collection of given names |
full_name |
string |
OPTIONAL Full name of a person |
suffix |
string |
OPTIONAL Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. |
formatted_name |
string |
OPTIONAL Name of the person formatted according to Health Data Intelligence requirements. |
date_of_birth |
string |
OPTIONAL Date of the person’s birth |
date_of_death |
string |
OPTIONAL Date of the person’s death |
gender |
string |
OPTIONAL Gender of the person |
record_ids |
array : RecordIDs |
OPTIONAL Source record identifiers |
ProviderRelationshipSummary
Name |
Type |
Description |
id |
string |
The ID of the personnel associated with the person. |
name |
string |
The name of the personnel. |
aliases |
array : Aliases |
An array of aliases. |
relationship_types |
array : string |
A collection of relationship types. |
supporting_facts |
array : SupportingFact |
Details about the person’s inclusion in this relationship. |
organization |
AttributedOrganization |
OPTIONAL The organization to which the person is attributed. |
AttributedOrganization
Name |
Type |
Description |
id |
string |
The ID used to identify the organization to which the person is attributed. |
name |
string |
The name of the organization. |
Exception
Name |
Type |
Description |
message |
string |
Descriptive message providing context for the error condition |