NAV
ruby shell

HealtheRecord API

The HealtheRecord API provides data for a person’s longitudinal clinical record including:

Person

Person ID Lookup

Example Request

require 'httparty'

HTTParty.get(
  'https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/data_partitions/877307a0-b5f5-4a01-9d4b-9fead6bcf788/empi_lookup?id=151579',
  headers: {
    'Authorization' => '<auth_header>'
  }
)
curl -H 'Authorization: <auth_header>' https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/data_partitions/877307a0-b5f5-4a01-9d4b-9fead6bcf788/empi_lookup?id=151579

Example Response

{
  "response": {
    "fields": [
      {
        "field_name": "empi_person_id",
        "field_value": "a2f6a16d-1331-4ccc-8f70-6c4d953ba70b"
      }
    ],
    "error": {}
  }
}

GET https://{client}.record.healtheintent.com/api/populations/{population_id}/data_partitions/{data_partition_id}/empi_lookup?id={local_person_id}

Because HealtheIntent collects data from many different sources, we use one identifier to consolidate their information. Clinical data endpoints require the person’s HealtheIntent ID which can be looked up from the person’s source (typically EHR) ID.

Path Parameters

Parameter Description
population_id The HealtheIntent population ID.
data_partition_id The ID of the data partition the person belongs to.

Query Parameters

Parameter Type Description
id string The local ID corresponding to the person.

Responses

Status Type Description
200 PersonIDResponse The person ID response structure
204 N/A Person Not Found
400 N/A Bad Request
401 N/A Unauthorized
403 N/A Forbidden
409 N/A More than one person was found matching the provided identifier
500 N/A Internal Server Error

Person ID Lookup (POST)

Example Request

require 'httparty'

HTTParty.post(
  'https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/data_partitions/877307a0-b5f5-4a01-9d4b-9fead6bcf788/empi_lookup',
  headers: {
    'Authorization' => '<auth_header>',
    'Content-Type' => 'application/json'
  },
  body: {id: '<local-person-ID>'}.to_json
)
curl -X POST -H 'Authorization: <auth_header>' -H 'Content-Type: application/json' -d '{"id":"12345"}' https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/data_partitions/877307a0-b5f5-4a01-9d4b-9fead6bcf788/empi_lookup

Example Response

{
  "response": {
    "fields": [
      {
        "field_name": "empi_person_id",
        "field_value": "a2f6a16d-1331-4ccc-8f70-6c4d953ba70b"
      }
    ],
    "errors": {}
  }
}

POST https://{client}.record.healtheintent.com/api/populations/{population_id}/data_partitions/{data_partition_id}/empi_lookup

Deprecated: This operation has been deprecated in favor of the HTTP GET form of Person ID Lookup.

An alternative form of the Person ID Lookup that’s invoked via an HTTP POST.

Path Parameters

Parameter Description
population_id The HealtheIntent population ID.
data_partition_id The ID of the data partition the person belongs to.

Request Message Body

Parameter Type Description
id string The local ID corresponding to the person.

Responses

Status Type Description
200 PersonIDResponse The person ID response structure
204 N/A Person Not Found
400 N/A Bad Request
401 N/A Unauthorized
403 N/A Forbidden
409 N/A More than one person was found matching the provided identifier
500 N/A Internal Server Error

Example Request

require 'httparty'

HTTParty.get(
  'https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people?q=roberson&limit=1',
  headers: { 'Authorization' => '<auth_header>' }
)
curl -H 'Authorization: <auth_header>' https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people?q=roberson&limit=1

Example response

{
  "persons": [
    {
      "id": "a2f6a16d-1331-4ccc-8f70-6c4d953ba70b",
      "gender": "Female",
      "prefix": null,
      "suffix": null,
      "full_name": null,
      "given_names": [
        "Test"
      ],
      "family_names": [
        "Name"
      ],
      "formatted_name": "Name, Test",
      "date_of_birth": "1934-08-20",
      "date_of_death": null,
      "deceased": false,
      "address": {
        "street_addresses": [
          "12345 Anywhere Road"
        ],
        "city": "CHICAGO",
        "county_or_parish": null,
        "state_or_province": "IL",
        "postal_code": "60634",
        "country": null
      },
      "telecoms": [],
      "emails": [],
      "record_ids": [
        {
          "data_partition_id": "877307a0-b5f5-4a01-9d4b-9fead6bcf788",
          "person_id": "151579"
        }
      ]
    }
  ],
  "more_results": true,
  "total_results": 209
}

GET https://{client}.record.healtheintent.com/api/populations/{population_id}/people

Returns a list of people matching the search query.

Path Parameters

Parameter Description
population_id The HealtheIntent population ID.

Query Parameters

Parameter Default Description
q N/A The query string
date_of_birth N/A Filter to limit the response to only persons with a date of birth matching the given ISO-8601 YYYY-MM-DD or YYYYMMDD formatted date string.
start 0 Index at which to start. Must be >= 0.
limit 20 The number of results to return. Must be between 1 and 100.
sort name_asc How to sort the results (optional, only used if q is not specified). name_asc sorts by full name, ascending (default). name_desc sorts by full name, descending.
alias_value N/A A filter to limit the response to only people with a matching alias value, allowing you to search by aliases such as national health identifiers or medical record numbers. You have to use the assigning_authority parameter in conjunction with alias_value because there could be identical alias values that were assigned by different authorities. You can’t search by Social Security Number.
assigning_authority N/A A filter to limit the response to only people whose alias values were assigned by a certain assigning authority. You have to use the alias_value parameter in conjunction with assigning_authority. See the description of the alias_value parameter above.

All parameters are applied to further narrow the results. For example, searching with the parameters q=Smith&date_of_birth=1950-01-01 will return a list of people with the name “Smith”, born on January 1, 1950.

Responses

Status Type Description
200 PersonList List of people
400 array: Error Bad Request
401 array: Error Unauthorized
403 array: Error Forbidden
404 array: Error Resource Not Found
500 array: Error Internal Server Error

Person Demographics

Example Request

require 'httparty'

HTTParty.get(
  'https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b',
  headers: { 'Authorization' => '<auth_header>' }
)
curl -H 'Authorization: <auth_header>' https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b

Example Response

{
  "prefix": null,
  "suffix": null,
  "full_name": null,
  "given_names": [
    "Test"
  ],
  "family_names": [
    "Name"
  ],
  "formatted_name": "Name, Test",
  "date_of_birth": "1934-08-20",
  "date_of_death": null,
  "deceased": false,
  "gender": {
    "display": "Female",
    "id": "248152002",
    "code_system_name": "SNOMED CT",
    "code_system_id": "2.16.840.1.113883.6.96"
  },
  "address": {
    "street_addresses": [
      "12345 Anywhere Road"
    ],
    "city": "CHICAGO",
    "county_or_parish": null,
    "state_or_province": {
      "display": "IL",
      "id": "17",
      "code_system_name": "FIPS",
      "code_system_id": "2.16.840.1.113883.6.92"
    },
    "postal_code": "60634",
    "country": null,
    "type": {
      "display": "HL7 H",
      "id": "H",
      "code_system_name": "HL7",
      "code_system_id": "2.16.840.1.113883.12.190"
    }
  },
  "telecoms": [],
  "emails": [],
  "aliases": [
    {
      "value": "151579",
      "assigning_authority": "1.2.3.4.5.6.7.8.9.10.1",
      "source": {
        "partition_description": null,
        "type": "ENROLLMENT"
      }
    }
  ],
  "record_ids": [
    {
      "data_partition_id": "877307a0-b5f5-4a01-9d4b-9fead6bcf788",
      "person_id": "151579"
    }
  ],
  "benefit_coverages": [
    {
      "begin_date": "2014-01-01",
      "end_date": "2019-01-01",
      "member_id": "109597401",
      "line_of_business": null,
      "payer_name": "Medicare",
      "plan_ids": [],
      "plan_name": "Medicare PPO",
      "source": {
        "contributing_organization": null,
        "partition_description": null,
        "type": "ENROLLMENT"
      },
      "standard_benefit_plan_id": "Medicare PPO"
    }
  ],
  "mrn_aliases": [
    {
      "mrn": "151579",
      "source": {
        "partition_description": null,
        "type": "ENROLLMENT"
      }
    }
  ]
}

GET https://{client}.record.healtheintent.com/api/populations/{population_id}/people/{person_id}

Returns the person’s demographic information.

Path Parameters

Parameter Description
population_id The HealtheIntent population ID.
person_id The person’s HealtheIntent ID.

Query Parameters

Parameter Default Description
record_ids.data_partition_id N/A Filters the list of record_ids to those that match the given data partition ID.
benefit_coverages.type N/A Filters the list of benefit_coverages to those that match the given benefit coverage source type.

Responses

Status Type Description
200 PersonDemographics The person’s demographic information
401 array: Error Unauthorized
403 array: Error Forbidden
404 array: Error Resource Not Found
500 array: Error Internal Server Error

Allergies

Allergen Groups

Example Request

require 'httparty'

HTTParty.get(
  'https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/allergen_groups',
  headers: { 'Authorization' => '<auth_header>' }
)
curl -H 'Authorization: <auth_header>' https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/allergen_groups

Example Response

{
  "groups": [
    {
      "id": "2.16.840.1.113883.6.96294505008",
      "name": "Amoxicillin",
      "most_recent_allergy": {
        "code": {
          "display": "Amoxicillin",
          "id": "294505008",
          "code_system_name": "SNOMED CT",
          "code_system_id": "2.16.840.1.113883.6.96"
        },
        "onset_date": "1955-07-11",
        "status": "Active",
        "reactions": [],
        "comments": [],
        "source": {
          "contributing_organization": null,
          "partition_description": "Cerner - Demo EMR",
          "type": "EMR"
        }
      },
      "group_type": "STANDARDIZED_CODE",
      "total_count": 1
    }
  ],
  "more_results": false,
  "total_results": 1
}

GET https://{client}.record.healtheintent.com/api/populations/{population_id}/people/{person_id}/allergen_groups

Returns a list of a person’s allergies grouped by allergen or by its code.

Path Parameters

Parameter Description
population_id The HealtheIntent population ID.
person_id The person’s HealtheIntent ID.

Query Parameters

Parameter Default Description
start 0 Index at which to start. Must be >= 0.
limit 20 The number of results to return. Must be between 1 and 100.

Responses

Status Type Description
200 array: AllergenGroupList List of allergen groups
401 array: Error Unauthorized
403 array: Error Forbidden
404 array: Error Resource Not Found
500 array: Error Internal Server Error

Conditions

Condition Groups

Example Request

require 'httparty'

HTTParty.get(
  'https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/condition_groups',
  headers: { 'Authorization' => '<auth_header>' }
)
curl -H 'Authorization: <auth_header>' https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/condition_groups

Example Response

{
  "groups": [
    {
      "id": "6D915064E05245DDBCF256F2CF93FE03",
      "name": "Diabetes Mellitus Type 2",
      "most_recent_condition": {
        "code": {
          "display": "Diabetes",
          "id": "313436004",
          "code_system_name": "SNOMED CT",
          "code_system_id": "2.16.840.1.113883.6.96"
        },
        "effective_date": "2012-10-22",
        "source": {
          "contributing_organization": null,
          "partition_description": "Cerner - Demo EMR",
          "type": "EMR"
        },
        "type": "Problem",
        "status": "Active"
      },
      "group_type": "CONDITION_CATEGORY",
      "total_count": 3
    },
    {
      "id": "6B4B6E26162C437C8E910610A6B99582",
      "name": "Hyperlipidemia",
      "most_recent_condition": {
        "code": {
          "display": "Hyperlipidemia",
          "id": "272.4",
          "code_system_name": "ICD-9-CM",
          "code_system_id": "2.16.840.1.113883.6.103"
        },
        "effective_date": "2012-10-22",
        "source": {
          "contributing_organization": null,
          "partition_description": "Cerner - Demo EMR",
          "type": "EMR"
        },
        "type": "Problem",
        "status": "Active"
      },
      "group_type": "CONDITION_CATEGORY",
      "total_count": 1
    }
  ],
  "more_results": false,
  "total_results": 2
}

GET https://{client}.record.healtheintent.com/api/populations/{population_id}/people/{person_id}/condition_groups

Returns a list of a person’s conditions grouped by condition category or by its code.

Path Parameters

Parameter Description
population_id The HealtheIntent population ID.
person_id The person’s HealtheIntent ID.

Query Parameters

Parameter Default Description
start 0 Index at which to start. Must be >= 0.
limit 20 The number of results to return. Must be between 1 and 100.

Responses

Status Type Description
200 array: ConditionGroupList List of condition groups
401 array: Error Unauthorized
403 array: Error Forbidden
404 array: Error Resource Not Found
500 array: Error Internal Server Error

Medications

Medication Groups

Example Request

require 'httparty'

HTTParty.get(
  'https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/medication_groups?limit=1',
  headers: { 'Authorization' => '<auth_header>' }
)
curl -H 'Authorization: <auth_header>' https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/medication_groups?limit=1

Example Response

{
  "groups": [
    {
      "id": "3C8E3D53D05A3FB2E0535C2F47AA04CF",
      "name": "aspirin",
      "most_recent_medication": {
        "code": {
          "display": "Aspirin",
          "id": "d00170",
          "code_system_name": "Multum",
          "code_system_id": "2.16.840.1.113883.6.314"
        },
        "dose": null,
        "detail": "Aspirin",
        "start_datetime": "2015-07-30",
        "stop_datetime": null,
        "prescribing_provider_name": null,
        "comments": [],
        "source": {
          "contributing_organization": null,
          "partition_description": "Cerner - Demo EMR",
          "type": "EMR"
        },
        "status": "Active"
      },
      "group_type": "MAIN_INGREDIENT_CATEGORY",
      "total_count": 60
    }
  ],
  "more_results": true,
  "total_results": 5
}

GET https://{client}.record.healtheintent.com/api/populations/{population_id}/people/{person_id}/medication_groups

Returns a list of a person’s medications grouped by medication ingredient or by its code.

Path Parameters

Parameter Description
population_id The HealtheIntent population ID.
person_id The person’s HealtheIntent ID.

Query Parameters

Parameter Default Description
start 0 Index at which to start. Must be >= 0.
limit 20 The number of results to return. Must be between 1 and 100.

Responses

Status Type Description
200 array: MedicationGroupList List of medication groups
401 array: Error Unauthorized
403 array: Error Forbidden
404 array: Error Resource Not Found
500 array: Error Internal Server Error

Procedures

Procedures Groups

Example Request

require 'httparty'

HTTParty.get(
  'https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/procedure_groups?limit=1',
  headers: { 'Authorization' => '<auth_header>' }
)
curl -H 'Authorization: <auth_header>' https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/procedure_groups?limit=1

Example Response

{
  "groups": [
    {
      "id": "2.16.840.1.113883.6.96414191008",
      "name": "Falls Screening",
      "most_recent_procedure": {
        "code": {
          "display": "Falls Screening",
          "id": "414191008",
          "code_system_name": "SNOMED CT",
          "code_system_id": "2.16.840.1.113883.6.96"
        },
        "comments": [],
        "source": {
          "contributing_organization": null,
          "partition_description": "Cerner - Demo EMR",
          "type": "EMR"
        },
        "start_datetime": "2015-07-10",
        "end_datetime": null,
        "modifiers": [],
        "providers": []
      },
      "group_type": "STANDARDIZED_CODE",
      "total_count": 2
    }
  ],
  "more_results": true,
  "total_results": 2
}

GET https://{client}.record.healtheintent.com/api/populations/{population_id}/people/{person_id}/procedure_groups

Returns a list of a person’s procedures grouped by procedure category or by its code.

Path Parameters

Parameter Description
population_id The HealtheIntent population ID.
person_id The person’s HealtheIntent ID.

Query Parameters

Parameter Default Description
start 0 Index at which to start. Must be >= 0.
limit 20 The number of results to return. Must be between 1 and 100.

Responses

Status Type Description
200 array: ProcedureGroupList List of procedure groups
401 array: Error Unauthorized
403 array: Error Forbidden
404 array: Error Resource Not Found
500 array: Error Internal Server Error

Vaccines

Vaccine Groups

Example Request

require 'httparty'

HTTParty.get(
  'https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/vaccine_groups',
  headers: { 'Authorization' => '<auth_header>' }
)
curl -H 'Authorization: <auth_header>' https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/vaccine_groups

Example Response

{
  "groups": [
    {
      "id": "F8BD9284FBB4082BE043902F47AAB2CA",
      "name": "Pneumo PCV",
      "most_recent_immunization": {
        "code": {
          "display": "Pneumonococcal Vaccination",
          "id": "90670",
          "code_system_name": "CPT-4",
          "code_system_id": "2.16.840.1.113883.6.12"
        },
        "source": {
          "contributing_organization": null,
          "partition_description": "Cerner - Demo EMR",
          "type": "EMR"
        },
        "status": null,
        "comments": [],
        "administered_datetime": "2010-03-14",
        "product": null,
        "manufacturer": null,
        "lot_number": null,
        "provider_name": null
      },
      "group_type": "IMMUNIZATION_CATEGORY",
      "total_count": 1
    }
  ],
  "more_results": false,
  "total_results": 1
}

GET https://{client}.record.healtheintent.com/api/populations/{population_id}/people/{person_id}/vaccine_groups

Returns a list of a person’s vaccines grouped by vaccine code.

Path Parameters
Parameter Description
population_id The HealtheIntent population ID.
person_id The person’s HealtheIntent ID.
Query Parameters
Parameter Default Description
start 0 Index at which to start. Must be >= 0.
limit 20 The number of results to return. Must be between 1 and 100.

Responses

Status Type Description
200 array: VaccineGroupList List of vaccine groups
401 array: Error Unauthorized
403 array: Error Forbidden
404 array: Error Resource Not Found
500 array: Error Internal Server Error

Immunizations

Example Request

require 'httparty'

HTTParty.get(
  'https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/vaccine_groups/F8BD9284FBB4082BE043902F47AAB2CA/immunizations',
  headers: { 'Authorization' => '<auth_header>' }
)
curl -H 'Authorization: <auth_header>' https://cernerdemo.record.healtheintent.com/api/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/people/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/vaccine_groups/F8BD9284FBB4082BE043902F47AAB2CA/immunizations

Example Response

{
  "immunizations": [
    {
      "code": {
        "display": "Pneumonococcal Vaccination",
        "id": "90670",
        "code_system_name": "CPT-4",
        "code_system_id": "2.16.840.1.113883.6.12"
      },
      "source": {
        "contributing_organization": null,
        "partition_description": "Cerner - Demo EMR",
        "type": "EMR"
      },
      "status": null,
      "comments": [],
      "administered_datetime": "2010-03-14",
      "product": null,
      "manufacturer": null,
      "lot_number": null,
      "provider_name": null
    }
  ],
  "more_results": false,
  "total_results": 1
}

GET https://{client}.record.healtheintent.com/api/populations/{population_id}/people/{person_id}/vaccine_groups/{vaccine_group_id}/immunizations

Returns a list of a person’s immunizations associated to the specified vaccine group.

Path Parameters
Parameter Description
population_id The HealtheIntent population ID.
person_id The person’s HealtheIntent ID.
vaccine_group_id The ID associated with the vaccine group.
Query Parameters
Parameter Default Description
start 0 Index at which to start. Must be >= 0.
limit 20 The number of results to return. Must be between 1 and 100.

Responses

Status Type Description
200 array: ImmunizationList List of immunizations
401 array: Error Unauthorized
403 array: Error Forbidden
404 array: Error Resource Not Found
500 array: Error Internal Server Error

HealtheRecord API Definitions

Address

Name Type Description
street_addresses array:string May contain the house number, street, and apartment number.
city string The name of the city.
county_or_parish Code The county or parish’s codified information.
state_or_province Code The state or province’s codified information.
postal_code string The postal code.
country Code The country’s codified information.
type Code Codified address information.

Alias

Name Type Description
value string The value of the alias.
assigning_authority string The identifier of the issuing entity.
source Source The alias source.

AllergenGroupList

Name Type Description
group array: AllergenGroup A list of groups of allergies.
more_results boolean A boolean indicating if there are more groups to page through.
total_results integer The total allergen groups available.

AllergenGroup

Name Type Description
id string The unique identifier for the group.
name string The name of the group.
most_recent_allergy Allergy The most recent allergy that belongs to the group, by the onset_date.
total_count integer The number of allergies that belong to the group.
group_type string Notes how the allergies were grouped. Will be either “ALLERGEN_CATEGORY” or “STANDARDIZED_CODE”.

Allergy

Name Type Description
code Code Code information.
source Source The data source.
onset_date string ISO-8601 formatted DateTime noting when the allergy started.
reactions array: Reaction List of reactions when a person is exposed to this allergy.
comments array: Comment List of comments for the allergy.
status string Status of the allergy (Active, Inactive, and so on).

BenefitCoverage

Name Type Description
begin_date string ISO-8601 formatted date of when the coverage begins.
end_date string ISO-8601 formatted date of when the coverage ends.
member_id string Represents the person’s unique identifier for the benefit provider.
line_of_business string Distinguishes the sub-plan or populations within a health plan.
payer_name string The payer’s name.
plan_ids array: PlanID Identifiers for the health benefit payer/plan.
plan_name string The coverage plan’s name.
source RecordID The data source.
standard_benefit_plan_id string Unique identifier for the standard benefit plan.

Code

Name Type Description
display string Displayable text.
id string The code’s ID.
code_system_name sting The name of the code system.
code_system_id string The ID of the code system.

Condition

Name Type Description
code Code Code information.
source Source The data source.
effective_date string ISO-8601 formatted date and time for the condition.
type string Type of condition (e.g. Diagnosis).
status string Status of the condition (Active, Inactive, and so on).

ConditionGroup

Name Type Description
id string Unique identifier for the group.
name string Name of the group.
most_recent_condition Condition The most recent condition that belongs to the group.
total_count integer The number of allergies that belongs to the group.
group_type string Notes how the conditions were grouped. Will be either “CONDITION_CATEGORY” or “STANDARDIZED_CODE”.

ConditionGroupList

Name Type Description
group array: ConditionGroup A list of groups of conditions.
more_results boolean Indicates if there are more groups to page through.
total_results integer The total groups available.

Comment

Name Type Description
text string Text content of the comment.
datetime string ISO-8601 formatted date and time that the comment was documented.

GenericField

Name Type Description
field_name string DEFAULT: “empi_person_id”
field_value string The person’s ID.

Email

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

Immunization

Name Type Description
code Code Code information.
source Source The data source.
status Status The current status of immunization.
comments array List of comments.
administered_datetime string ISO-8601 formatted date and time that the immunization was administered.
product ImmunizationProduct Indicates the immunization product.
manufacturer string Manufacturer of the immunization.
lot_number string The lot number that the immunization came from.
provider_name string The provider that gave the immunization.

ImmunizationList

Name Type Description
immunizations array: Immunization A list of immunizations.
more_results boolean Indicates if there are more immunizations to page through.
total_results integer The total immunizations available.

ImmunizationProduct

Name Type Description
drug_name string The name of the drug.
route string The route of consumption for the drug.
drug_quantity string The quantity of drug prescribed.
drug_dosage string The dosage associated with the drug.

Medication

Name Type Description
code Code Code information.
dose string May contain the dose quantity, unit, route, and frequency.
detail string Dose detail line. May contain the dose quantity, unit, route, and frequency.
source Source The data source.
start_datetime string ISO-8601 formatted date and time noting when the medication was started.
stop_datetime string ISO-8601 formatted date and time noting when the medication was stopped.
comments array: Comment List of comments.
status Status Status of the medication (Active, Canceled, and so on).
prescribing_provider_name string Name of the provider who prescribed the medication.

MedicationGroup

Name Type Description
id string Unique identifier for the group.
name string Name of the group.
most_recent_medication Medication The most recent medication that belongs to the group, by its onset_date.
total_count integer The number of medications belonging to the group.
group_type string Notes how the medications were grouped. Will be either “MEDICATION_CATEGORY” or “STANDARDIZED_CODE”.

MedicationGroupList

Name Type Description
group array: MedicationGroup A list of groups of medications.
more_results boolean Indicates if there are more groups to page through.
total_results integer The total groups available.

Modifier

Name Type Description
display string The modifier’s displayable text (typically CPT-4 modifier).

MRNAlias

Name Type Description
mrn string The MRN
source Source The MRN source.

PersonIDResponse

Name Type Description
fields array: GenericField The person ID response structure.
error Error An error

PersonDemographics

Name Type Description
gender Code Codified gender information.
prefix string The person’s prefix (e.g. Dr).
suffix string The person’s suffix (e.g. Sr, Jr, III).
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.
formatted_name string The person’s formatted full name.
date_of_birth string ISO-8601 formatted date.
date_of_death string ISO-8601 formatted date.
deceased boolean true if the person is deceased.
address Address The person’s address.
telecoms array: Telecom List of telecommunication information.
emails array: Email A list of email addresses.
aliases array: Alias A list of aliases.
record_ids array: RecordId A list of record identifiers.
mrn_aliases array: MRNAlias List of the person’s MRN aliases.
benefit_coverages array: BenefitCoverage List insurance benefit information.

PersonList

Name Type Description
persons array: PersonSearchDemographics List of people.
more_results boolean true if there are more results.
total_results integer The number of people matching the search query.

PersonSearchDemographics

Name Type Description
id string The person’s HealtheIntent ID. (Only present for search results)
gender Code Codified gender information.
prefix string The person’s prefix (e.g. Dr).
suffix string The person’s suffix (e.g. Sr, Jr, III).
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.
formatted_name string The person’s formatted full name.
date_of_birth string ISO-8601 formatted date.
date_of_death string ISO-8601 formatted date.
deceased boolean true if the person is deceased.
address Address The person’s address.
telecoms array: Telecom List of telecommunication information.
emails array: Email A list of email addresses.
record_ids array: RecordId A list of record identifiers.

PlanID

Name Type Description
type string The type of plan.
value string The plan ID.

Procedure

Name Type Description
code Code Code information
comments array: Comment A list of comments associated with the procedure.
source Source The data source.
start_datetime string ISO-8601 formatted date noting when the procedure started.
end_datetime string ISO-8601 formatted date noting when the procedure ended.
modifiers array: Modifier A list of modifiers for the procedure.
providers array: Provider A list of providers that are associated with the procedure.

ProcedureGroup

Name Type Description
id string Unique identifier for the group.
name string Name of the group.
most_recent_procedure Procedure The most recent procedure that belongs to the group, by its start_datetime.
total_count integer The number of procedures belonging to the group.
group_type string Notes how the procedures were grouped. Will be either “COMMON_PROCEDURE_CATEGORY” or “STANDARDIZED_CODE”.

ProcedureGroupList

Name Type Description
group array: ProcedureGroup A list of groups of procedures.
more_results boolean Indicates if there are more groups to page through.
total_results integer The total groups available.

Provider

Name Type Description
relationship string Relationship to the provider.
name string The provider’s name.

Source

Name Type Description
contributing_organization string Contributing organization associated with the source.
partition_description string A description of the source partition.
type string Description of the type of source.

Status

Name Type Description
display string Text content of the status (e.g. “Completed”, “Refused”).
refusal_reason string The reason for refusal.

Reaction

Name Type Description
reaction_code Code Code information representing the reaction when the person is exposed to the allergen substance.
severity_code Code Code information representing the severity of the reaction.

RecordID

Name Type Description
data_partition_id string The data partition UUID.
data_partition_person_id string The ID of the person within the data partition.

Telecom

Name Type Description
country_code string The number’s country code.
number string The number.
extension string The number’s extension.
preferred boolean true if it is the preferred means of contact.
type Code Codified telecommunication information.

VaccineGroup

Name Type Description
id string Unique identifier for the group.
name string Name of the group.
most_recent_immunization Immunization The most recent medication that belongs to the group, by its onset_date.
total_count integer The number of immunizations that belong to the group.
group_type string Notes how the immunizations were grouped. Will be either “IMMUNIZATION_CATEGORY” or “STANDARDIZED_CODE”.

VaccineGroupList

Name Type Description
group array: VaccineGroup A list of groups of vaccines.
more_results boolean Indicates if there are more groups to page through.
total_results integer The total groups available.

Error

Name Type Description
message string A description of the error.
code string The codified status.