NAV Navbar
Logo cerner

Longitudinal Record Data Set

General

The Longitudinal Record Data Set is delivered as a gzipped tar file that packages together all of the files, documented below. Each file is a CSV file and will have a ‘txt’ extension. For example, the Claim file will have the name Claim.txt within the tar file.

Common Fields

Field Description
operation Indicates whether the entity or child entity should be inserted or deleted. Possible values are {I or D}.
person_id An ID that identifies the person with which the entity is associated.
source_person_id An ID that identifies the person in the data source from which the entity originated.
contributor_id An ID that identifies the particular contributor of the entity. Typically a contributor is one-to-one with a data source, unless the data source is multi-tenant. In the case of multi-tenant, the contributor identifies which tenant contributed to the entity. Refer to the contributor file to find a complete list of contributors and the data source with which they are associated.
source_encounter_id An ID that identifies the encounter in the data source that the entity is associated with, if applicable.

Codifed Attribute Fields

When an attribute is codified using an industry-standard coding system, its fields follow the column naming pattern <attribute_name>_<field_suffix> (for example, reason_std_code). The following field suffixes are used with codified attributes:

Field Suffix Description
raw_display The display value associated with the raw code provided by the data source.
std_code The industry-standard code for the codified attribute.
std_system An ID of the industry standard coding system from which the standard code came.
std_display The display, if known, for the standard code.

Date Attribute Fields

Unless otherwise noted, all date fields are represented in ISO 8601 format with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. If time is specified, then it is in Coordinated Universal Time (UTC), which is denoted by the suffix Z.

Files

AdvanceDirective

File Name

AdvanceDirective

Description

Advance directives that pertain to the medical treatment of a person.

Children Files

AdvanceDirective_RecorderIdentifier: Identifiers of the provider who recorded the advance directive for the person.

Columns

Index Column Name Required Description
1 advance_directive_id Y An ID that uniquely identifies the advance directive across all advance directives for all people.
2 operation Y See General.
3 person_id Y See General.
4 source_advance_directive_id N An ID that uniquely identifies this advance directive for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 type_raw_display N See General.
9 type_std_code Y The codified type of advance directive, such as living will, durable power of attorney, and do not resuscitate. See General.
10 type_std_system Y See General.
11 type_std_display N See General.
12 recorded_date N The date and time that the advance directive was recorded. See General.
13 recorder_name_text N The fully formatted name of the provider who recorded the advance directive, if known.

AdvanceDirective_RecorderIdentifier

File Name

AdvanceDirective_RecorderIdentifier

Description

Identifiers of the provider who recorded the advance directive for the person.

Parent File

AdvanceDirective

Columns

Index Column Name Required Description
1 advance_directive_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the provider who recorded the advance directive.
4 value Y The value of the provider alias, such as the provider National Provider Identifier (NPI), Drug Enforcement Administration (DEA) number, or Tax ID.
5 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA,TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
6 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

AllergyIntolerance

File Name

AllergyIntolerance

Description

Patient allergies.

Children Files

Rules

At least the substance_std_code field, substance_raw_display field, or the substance_text field is populated. However, all three may be populated.

Columns

Index Column Name Required Description
1 allergy_intolerance_id Y An ID that uniquely identifies the allergy across all allergies for all people.
2 operation Y See General.
3 person_id Y See General.
4 source_allergy_intolerance_id N An ID that uniquely identifies this allergy for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 substance_raw_display N See General.
9 substance_std_code N A codified allergen that triggers the allergy or adverse reaction, for example a drug, drug allergy class, food, or environmental substance. See General.
10 substance_std_system N See General.
11 substance_std_display N See General.
12 substance_text N The textual allergen that triggers the allergy or adverse reaction (for example, a drug, drug allergy class, food, or environmental substance).
13 onset N The date the allergy was first reported as present. See General for more information on date fields.
14 resolved N The date the allergy was updated to resolved status or was no longer active. See General.
15 type_raw_display N See General.
16 type_std_code N The codified combination of the category of allergen (such as drug, food, or substance) and the allergy type (such as allergy or intolerance). For example, drug allergy, drug intolerance, food allergy, food intolerance, or allergy to substance. See General for more information.
17 type_std_system N See General.
18 type_std_display N See General.
19 category_type_raw_display N See General.
20 category_type_std_code N The codified type of allergic reaction (for example, an adverse reaction, allergy, or intolerance). See General.
21 category_type_std_system N See General.
22 category_type_std_display N See General.
23 criticality_raw_display N See General.
24 criticality_std_code N The codified criticality, clinical harm, or potential seriousness of a future reaction. See General.
25 criticality_std_system N See General.
26 criticality_std_display N See General.
27 status_raw_display N See General.
28 status_std_code N The codified status of the allergy, such as active, resolved, or in error. See General.
29 status_std_system N See General.
30 status_std_display N See General.

AllergyIntolerance_Reaction

File Name

AllergyIntolerance_Reaction

Description

Reactions associated with patient allergies.

Parent File

AllergyIntolerance

Rules

At least the manifestation_std_code field or the manifestation_text field is populated. However, both may be populated.

Columns

Index Column Name Required Description
1 allergy_intolerance_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 reaction_id Y An ID that uniquely identifies the reaction across all reactions for all people.
4 manifestation_raw_display N See General.
5 manifestation_std_code N The codified reaction occuring when the person is exposed to the allergen (for example, rash, hives, itching, or swelling). See General.
6 manifestation_std_system N See General.
7 manifestation_std_display N See General.
8 manifestation_text N The textual reaction occuring when the person is exposed to the allergen (for example, rash, hives, itching, or swelling).
9 severity_raw_display N See General.
10 severity_std_code N The codified severity of the reaction triggered by the allergen, such as mild, moderate, or severe. See General.
11 severity_std_system N See General.
12 severity_std_display N See General.

AllergyIntolerance_Note

File Name

AllergyIntolerance_Note

Description

Notes associated with patient allergies.

Parent File

AllergyIntolerance

Children Files

AllergyIntolerance_Note_AuthorIdentifier: A list of identifiers for the provider who authored the comment.

Columns

Index Column Name Required Description
1 allergy_intolerance_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 note_id Y An ID that uniquely identifies the note across all allergy notes for all people.
4 text Y The text of the comment.
5 time N The date of the comment. See General.
6 author_name_text N The fully-formatted name of the provider who authored the note, if known.

AllergyIntolerance_Note_AuthorIdentifier

File Name

AllergyIntolerance_Note_AuthorIdentifier

Description

Identifiers of the provider who authored the patient allergy note.

Parent File

AllergyIntolerance_Note

Columns

Index Column Name Required Description
1 allergy_intolerance_id Y The allergy_intolerance_id associated with this record.
2 note_id Y The note_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the author of an allergy note.
5 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
6 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA,TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Appointment

File Name

Appointment

Description

A past or future appointment or planned meeting.

Children Files

Columns

Index Column Name Required Description
1 appointment_id Y An ID that uniquely identifies the appointment across all appointments for all people.
2 operation Y See General.
3 person_id Y See General.
4 source_appointment_id N An ID that uniquely identifies this appointment for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 start N The date and time that the appointment takes place. See General.
9 end N The date and time that the appointment concludes. See General.
10 status_raw_display N See General.
11 status_std_code N The codified status of this appointment, such as cancelled, no show, arrived, or booked. See General.
12 status_std_system N See General.
13 status_std_display N See General.
14 type_raw_display N See General.
15 type_std_code N The codified administrative type of appointment. See General.
16 type_std_system N See General.
17 type_std_display N See General.
18 reason_raw_display N See General.
19 reason_std_code N The codified clinical reason the appointment was scheduled. See General.
20 reason_std_system N See General.
21 reason_std_display N See General.

Appointment_Action

File Name

Appointment_Action

Description

Actions taken on the appointment, such as reschedule, check-in, and check-out.

Parent File

Appointment

Rules

At least the type_std_code field or reason_std_code field is populated. However, both fields may be populated.

Columns

Index Column Name Required Description
1 appointment_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 action_id Y An ID that uniquely identifies the appointment action across all appointments for all people.
4 type_raw_display N See General.
5 type_std_code N The codified action taken on the appointment, such as book, confirm, reschedule, check-in, check-out, or patient seen. See General.
6 type_std_system N See General.
7 type_std_display N See General.
8 date_time N The date and time the action was taken. See General.
9 reason_raw_display N See General.
10 reason_std_code N The codified reason for the action taken on the appointment, such as no show, patient request, patient deceased, or bad weather. See General.
11 reason_std_system N See General.
12 reason_std_display N See General.

Appointment_Slot

File Name

Appointment_Slot

Description

Slot of time on a schedule for booking appointments.

Parent File

Appointment

Children Files

Appointment_Slot_ScheduleActorIdentifier: Identifiers of the provider whose schedule contains the slot of the scheduled appointment.

Rules

At least the display field, schedule_actor_name_text field, schedule_actor_display field, start field, end field, or Appointment_Slot_ScheduleActorIdentifier file is populated. However, multiple fields and the file may be populated.

Columns

Index Column Name Required Description
1 appointment_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 slot_id Y An ID that uniquely identifies the slot across all appointments for all people.
4 source_slot_id N An ID that uniquely identifies this slot for an appointment in the data source from which the entity originated.
5 display N The display name of the slot on the schedule.
6 schedule_actor_display N The display of the schedule resource, such as the room or device.
7 schedule_actor_name_text N The fully-formatted name of the provider whose schedule contains the slot of the scheduled appointment.
8 status N An enumerated value to represent the status of the slot on the schedule. Possible values include BUSY, FREE, UNAVAILABLE, TENTATIVE, _NOT_RECOGNIZED, and _NOT_VALUED.
9 start N The date and time that the slot is to begin. See General.
10 end N The date and time that the slot is to conclude. See General.

Appointment_Slot_ScheduleActorIdentifier

File Name

Appointment_Slot_ScheduleActorIdentifier

Description

Identifiers of the provider whose schedule contains the slot of the scheduled appointment.

Parent File

Appointment_Slot

Columns

Index Column Name Required Description
1 appointment_id Y The appointment_id associated with this record.
2 slot_id Y The slot_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the provider whose schedule contains the slot of the scheduled appointment.
5 value Y The value of the provider alias, such as the National Provider Identifier (NPI), Drug Enforcement Administration (DEA) number, or Tax ID.
6 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Appointment_Participant

File Name

Appointment_Participant

Description

Participants in an appointment. Participants can be providers, locations, or devices.

Parent File

Appointment

Children Files

Rules

At least the actor_display field, source_location_id field, location_name field, actor_name_text field, or Appointment_Participant_ActorIdentifier file is populated. However, many of these may be populated.

Columns

Index Column Name Required Description
1 appointment_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 participant_id Y An ID that uniquely identifies the participant who is involved in the appointment across all appointments for all people.
4 type_raw_display N See General.
5 type_std_code N The codified role of the participant in the appointment. See General.
6 type_std_system N See General.
7 type_std_display N See General.
8 actor_display N The display of the resource participating in the appointment, such as the room or device.
9 actor_name_text N The fully-formatted name of the provider who is a participant in the appointment.
10 source_location_id N An ID that uniquely identifies the location in the data source from which this entity originated.
11 location_name N The display name of the location.
12 location_time_zone_id N The time zone of the location, such as America/Chicago, America/New_York, or America/Los_Angeles.

Appointment_Participant_ActorIdentifier

File Name

Appointment_Participant_ActorIdentifier

Description

Identifiers of a provider who is involved in the appointment.

Parent File

Appointment_Participant

Columns

Index Column Name Required Description
1 appointment_id Y The appointment_id associated with this record.
2 participant_id Y The participant_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the provider who is involved in the appointment.
5 value Y The value of the provider alias, such as the National Provider Identifier (NPI), Drug Enforcement Administration (DEA) number, or Tax ID.
6 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Appointment_Participant_LocationType

File Name

Appointment_Participant_LocationType

Description

Type of function performed at the location.

Parent File

Appointment_Participant

Columns

Index Column Name Required Description
1 appointment_id Y The appointment_id associated with this record.
2 participant_id Y The participant_id associated with this record.
3 operation Y See General.
4 type_id Y An ID that uniquely identifies the type of function performed at the location across all appointments for all people.
5 code_raw_display N See General.
6 code_std_code N The codified type of function performed at the location. See General.
7 code_std_system N See General.
8 code_std_display N See General.

CarePlan

File Name

CarePlan

Description

A plan of care for a person.

Children Files

Columns

Index Column Name Required Description
1 care_plan_id Y An ID that uniquely identifies the care plan across all care plans for all people.
2 operation Y See General.
3 person_id Y See General.
4 source_care_plan_id N An ID that uniquely identifies this care plan for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 author N An enumerated value to represent the type of the person who assigned the care plan. Possible values include SELF, PROVIDER, SYSTEM, UNKNOWN, _NOT_RECOGNIZED, and _NOT_VALUED.

CarePlan_ActivityDetail

File Name

CarePlan_ActivityDetail

Description

Activities or actions that are planned to occur as part of the care plan.

Parent File

CarePlan

Children Files

Rules

Only one of the following is populated: the code_std_code field, code_text field or the source_appointment_id field.

Columns

Index Column Name Required Description
1 care_plan_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 activity_id Y An ID that uniquely identifies the activity across all care plans for all people.
4 source_activity_id N An ID that uniquely identifies this care plan activity for a person in the data source from which the entity originated.
5 category_code_raw_display N See General.
6 category_code_std_code N The codified categorization of the activity associated with the care plan, such as health promotion management, follow-up appointment, or education. See General.
7 category_code_std_system N See General.
8 category_code_std_display N See General.
9 code_raw_display N See General.
10 code_std_code N The codified description of the activity. See General.
11 code_std_system N See General.
12 code_std_display N See General.
13 code_text N The textual description of the activity.
14 source_appointment_id N An ID that uniquely identifies the appointment for a person in the data source from which the entity originated.
15 appointment_scheduled_period_start N The date and time that the appointment takes place, if a specific date is known. See General.
16 appointment_scheduled_timing_offset_value N A non-negative decimal value that represents the offset of when the appointment occurs.
17 appointment_scheduled_timing_offset_code_raw_display N See General.
18 appointment_scheduled_timing_offset_code_std_code N The codified unit of measure associated with the appointment_scheduled_timing_offset_value, such as days or weeks. See General.
19 appointment_scheduled_timing_offset_code_std_system N See General.
20 appointment_scheduled_timing_offset_code_std_display N See General.
21 appointment_scheduled_string N The textual description of when the appointment takes place.
22 appointment_comment N The comments associated with the care plan appointment.
23 appointment_instruction_raw_display N See General.
24 appointment_instruction_std_code N The codified instructions to the patient about the appointment. See General.
25 appointment_instruction_std_system N See General.
26 appointment_instruction_std_display N See General.
27 status_raw_display N See General.
28 status_std_code N The codified status of the activity, such as not started or completed. See General.
29 status_std_system N See General.
30 status_std_display N See General.
31 activity_completed_date N The date and time the activity was completed. See General.
32 scheduled_period_start N The date and time that the activity takes place, if a specific date is known. See General.
33 scheduled_timing_offset_value N A non-negative decimal value that represents the offset of when the activity concludes.
34 scheduled_timing_offset_code_raw_display N See General.
35 scheduled_timing_offset_code_std_code N The codified unit of measure associated with the scheduled_timing_offset_value, such as days or weeks. See General.
36 scheduled_timing_offset_code_std_system N See General.
37 scheduled_timing_offset_code_std_display N See General.

CarePlan_ActivityDetail_Goal

File Name

CarePlan_ActivityDetail_Goal

Description

The goals that the care plan activity intends to address.

Parent File

CarePlan_ActivityDetail

Columns

Index Column Name Required Description
1 care_plan_id Y The care_plan_id associated with this record.
2 activity_id Y The activity_id associated with this record.
3 operation Y See General.
4 goal_id Y An ID that uniquely identifies the relationship between the goal and activity across all care plans for all people.
5 source_goal_id Y An ID that uniquely identifies the related care plan goal for a person in the data source from which the entity originated.

CarePlan_ActivityDetail_Note

File Name

CarePlan_ActivityDetail_Note

Description

The comments associated with the care plan activity.

Parent File

CarePlan_ActivityDetail

Children Files

CarePlan_ActivityDetail_Note_AuthorIdentifier: The identifiers of the provider who authored the comment associated with the care plan activity.

Columns

Index Column Name Required Description
1 care_plan_id Y The care_plan_id associated with this record.
2 activity_id Y The activity_id associated with this record.
3 operation Y See General.
4 note_id Y An ID that uniquely identifies the note across all care plan activity notes for all people.
5 text Y The text of the comment.
6 time N The date of the comment. See General.
7 author_name_text N The fully-formatted name of the provider who authored the note, if known.

CarePlan_ActivityDetail_Note_AuthorIdentifier

File Name

CarePlan_ActivityDetail_Note_AuthorIdentifier

Description

The identifiers of the provider who authored the comment associated with the care plan activity.

Parent File

CarePlan_ActivityDetail_Note

Columns

Index Column Name Required Description
1 care_plan_id Y The care_plan_id associated with this record.
2 activity_id Y The activity_id associated with this record.
3 note_id Y The note_id associated with this record.
4 operation Y See General.
5 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the author of the note associated with the care plan activity.
6 value Y The value of the provider alias, such as the provider National Provider Identifier (NPI), Drug Enforcement Administration (DEA) number, or Tax ID.
7 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
8 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

CarePlan_ActivityDetail_AppointmentParticipant

File Name

CarePlan_ActivityDetail_AppointmentParticipant

Description

The participants in the appointment.

Parent File

CarePlan_ActivityDetail

Children Files

CarePlan_ActivityDetail_AppointmentParticipant_ActorIdentifier: The identifiers of the providers who are involved in the appointment.

Rules

At least the actor_name_text field or CarePlan_ActivityDetail_AppointmentParticipant_ActorIdentifier file is populated. However, both may be populated.

Columns

Index Column Name Required Description
1 care_plan_id Y The care_plan_id associated with this record.
2 activity_id Y The activity_id associated with this record.
3 operation Y See General.
4 participant_id Y An ID that uniquely identifies the participant who is involved in the appointment across all appointments for all people.
5 actor_name_text N The fully-formatted name of the provider who is a participant in the appointment.
6 type_raw_display N See General.
7 type_std_code N The codified role of the participant in the appointment. See General.
8 type_std_system N See General.
9 type_std_display N See General.

CarePlan_ActivityDetail_AppointmentParticipant_ActorIdentifier

File Name

CarePlan_ActivityDetail_AppointmentParticipant_ActorIdentifier

Description

The identifiers of a provider who is involved in the appointment.

Parent File

CarePlan_ActivityDetail_AppointmentParticipant

Columns

Index Column Name Required Description
1 care_plan_id Y The care_plan_id associated with this record.
2 activity_id Y The activity_id associated with this record.
3 participant_id Y The participant_id associated with this record.
4 operation Y See General.
5 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the provider who is involved in the appointment.
6 value Y The value of the provider alias, such as the provider National Provider Identifier (NPI), Drug Enforcement Administration (DEA) number, or Tax ID.
7 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
8 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

CarePlan_Goal

File Name

CarePlan_Goal

Description

The goals or desired outcomes of the care plan.

Parent File

CarePlan

Children Files

Columns

Index Column Name Required Description
1 care_plan_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 goal_id Y An ID that uniquely identifies the goal across all care plans for all people.
4 source_goal_id N An ID that uniquely identifies this care plan goal for a person in the data source from which the entity originated.
5 description N The textual description of the desired outcome of the care plan.
6 status_raw_display N See General.
7 status_std_code N The codified state of the goal, such as achieved or cancelled. See General.
8 status_std_system N See General.
9 status_std_display N See General.
10 category_raw_display N See General.
11 category_std_code N The codified categorization of the goal associated with the care plan. See General.
12 category_std_system N See General.
13 category_std_display N See General.
14 expressed_by N An enumerated value to represent the type of person who is responsible for the creation of the goal. Possible values include SELF, PROVIDER, and _NOT_VALUED.
15 start_date N The date and time when the goal pursuit begins. See General.
16 target_date N The date and time when the goal should be met. See General.

CarePlan_Goal_Activity

File Name

CarePlan_Goal_Activity

Description

The care plan activities associated with the goal.

Parent File

CarePlan_Goal

Columns

Index Column Name Required Description
1 care_plan_id Y The care_plan_id associated with this record.
2 goal_id Y The goal_id associated with this record
3 operation Y See General.
4 activity_id Y An ID that uniquely identifies the relationship between the goal and activity across all care plans for all people.
5 source_activity_id Y An ID that uniquely identifies the related care plan activity for a person in the data source from which the entity originated.

CarePlan_Goal_Barrier

File Name

CarePlan_Goal_Barrier

Description

The barriers of achieving the goal of the care plan.

Parent File

CarePlan_Goal

Columns

Index Column Name Required Description
1 care_plan_id Y The care_plan_id associated with this record.
2 goal_id Y The goal_id associated with this record.
3 operation Y See General.
4 barrier_id Y An ID that uniquely identifies the barrier across all care plan barriers for all people.
5 category_raw_display N See General.
6 category_std_code N A codified categorization of the barrier, such as financial, legal, or language. See General.
7 category_std_system N See General.
8 category_std_display N See General.

CarePlan_Goal_Note

File Name

CarePlan_Goal_Note

Description

The comments associated with the care plan goal.

Parent File

CarePlan_Goal

Children Files

CarePlan_Goal_Note_AuthorIdentifier: The identifiers of the provider who authored the comment associated with the care plan goal.

Columns

Index Column Name Required Description
1 care_plan_id Y The care_plan_id associated with this record.
2 goal_id Y The goal_id associated with this record.
3 operation Y See General.
4 note_id Y An ID that uniquely identifies the note across all care plan goal notes for all people.
5 text Y The text of the comment.
6 time N The date of the comment. See General.
7 author_name_text N The fully-formatted name of the provider who authored the note, if known.

CarePlan_Goal_Note_AuthorIdentifier

File Name

CarePlan_Goal_Note_AuthorIdentifier

Description

The identifiers of the provider who authored the comment associated with the care plan goal.

Parent File

CarePlan_Goal_Note

Columns

Index Column Name Required Description
1 care_plan_id Y The care_plan_id associated with this record.
2 goal_id Y The goal_id associated with this record.
3 note_id Y The note_id associated with this record.
4 operation Y See General.
5 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the author of the note associated with the care plan goal.
6 value Y The value of the provider alias, such as the provider National Provider Identifier (NPI), Drug Enforcement Administration (DEA) number, or Tax ID.
7 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
8 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Claim

File Name

Claim

Description

A claim for a person.

Children Files

Columns

Index Column Name Required Description
1 claim_id Y An ID that uniquely identifies the claim across all claims for all people.
2 operation Y See General.
3 person_id Y See General.
4 source_claim_id Y An ID that uniquely identifies this claim for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 contributor_id Y See General.
7 payer_claim_identifier N The ID used by the payer to identify and track the claim.
8 provider_claim_identifier N The ID used by the provider to identify and track the claim.
9 payer_replacement_claim_identifier N The ID previously supplied by the payer to be replaced by the payer_claim_identifier.
10 provider_replacement_claim_identifier N The ID previously supplied by the provider to be replaced by the provider_claim_identifier.
11 coverage_identifier N The unique identifier for a member who is responsible for the claim.
12 coverage_plan_name N Name for the payer or plan.
13 coverage_issuer_name N Name of the payer organization or entity that administers the plan.
14 coverage_group_number N The policy or group number. Often a health insurance card displays a policy or group number.
15 coverage_group_name N If a policy or group number is not available, a policy or group name may be provided.
16 coverage_type_raw_display N See General.
17 coverage_type_std_code N The codified representation of the insurance line or benefit type associated with the benefit coverage, such as HMO, PPO, medical, vision, or dental.
18 coverage_type_std_system N See General.
19 coverage_type_std_display N See General.
20 coverage_sub_plan N Used to distinguish the sub-plan products or populations within a particular health plan.
21 coverage_subscriber_id N A number shared by the subscriber and all of their dependents. Ties everyone in a family together. This is not the number uniquely identifying the subscriber. It is merely a mechanism to link members of a family together.
22 coverage_relationship_raw_display N See General.
23 coverage_relationship_std_code N The codified relationship of the person to the benefit subscriber. The subscriber is the individual who elected the benefit and who was eligible to do so due to their association with the sponsor.
24 coverage_relationship_std_system N See General.
25 coverage_relationship_std_display N See General.
26 received_date N The date that the claim was received by the payer. This is a date without time specified. See General.
27 payment_date N The date that a claim is paid. This is a date without time specified. See General.
28 claim_status N An enumerated value to identify the status of a claim. Possible values include A (approved), D (denied), R (rejected), _NOT_VALUED, and _NOT_RECOGNIZED.
29 facility_type_raw_display N See General.
30 facility_type_std_code N The codified type of facility where services were, or may be, performed.
31 facility_type_std_system N See General.
32 facility_type_std_display N See General.
33 type_of_bill N The codified type of bill, including the type of facility where services were performed.
34 frequency_raw_display N See General.
35 frequency_std_code N The codified frequency of the claim.
36 frequency_std_system N See General.
37 frequency_std_display N See General.
38 statement_period_start N Statement from date. This is a date without time specified. See General.
39 statement_period_end N Statement to date. This is a date without time specified. See General.
40 type Y An enumerated value to identify the form or type of claim. Possible values include I (institutional), P (professional), D (dental), and Rx (pharmacy).
41 patient_name_text N The fully-formatted representation of the person name.
42 patient_name_prefix N The prefix portion of the person name.
43 patient_name_suffix N The suffix portion of the person name, such as degrees earned.
44 patient_birth_date N The date of birth of the person. This is a date without time specified. See General.
45 patient_deceased_date_time N The date of death of the person, if known. This is a date without time specified. See General.
46 patient_gender_raw_display N See General.
47 patient_gender_std_code N The codified gender of the person.
48 patient_gender_std_system N See General.
49 patient_gender_std_display N See General.
50 patient_address_city N The city portion of the address. For example, Kansas City.
51 patient_address_state_raw_display N See General.
52 patient_address_state_std_code N The codified state or province portion of the address. For example, MO.
53 patient_address_state_std_system N See General.
54 patient_address_state_std_display N See General.
55 patient_address_postal_code N The postal code or zip code portion of the address. For example, 64117.
56 patient_address_district_raw_display N See General.
57 patient_address_district_std_code N The codified county or parish portion of the address.
58 patient_address_district_std_system N See General.
59 patient_address_district_std_display N See General.
60 patient_address_country_raw_display N See General.
61 patient_address_country_std_code N The codified country portion of the address. For example, USA.
62 patient_address_country_std_system N See General.
63 patient_address_country_std_display N See General.
64 diagnosis_related_group_raw_display N See General.
65 diagnosis_related_group_std_code N The codified diagnosis-related group, which is also referred to as DRG.
66 diagnosis_related_group_std_system N See General.
67 diagnosis_related_group_std_display N See General.
68 admission_date N The date of admission, which is typically only associated with institutional inpatient claims or professional claims involving inpatient medical visits. See General.
69 discharge_date N The date of discharge, which is typically only associated with institutional inpatient claims or professional claims involving inpatient medical visits. See General.
70 admission_type_raw_display N See General.
71 admission_type_std_code N The codified priority of the admission to a medical facility.
72 admission_type_std_system N See General.
73 admission_type_std_display N See General.
74 admission_source_raw_display N See General.
75 admission_source_std_code N The codified source of the admission.
76 admission_source_std_system N See General.
77 admission_source_std_display N See General.
78 patient_status_raw_display N See General.
79 patient_status_std_code N The codified patient status as of the statement covers through date.
80 patient_status_std_system N See General.
81 patient_status_std_display N See General.
82 pregnancy_indicator N A Boolean value that indicates if a person is pregnant. Possible values include TRUE or FALSE.
83 claim_billed_amount N A decimal value that represents the monetary amount billed for the claim.
84 payer_paid_amount N A decimal value that represents the monetary amount paid by the payer.
85 service_facility_name_text N The name of the service facility organization.
86 billing_status N An enumerated value to determine whether the claim is a billed claim or adjudicated claim. Possible values include BILLED, ADJUDICATED, UNKNOWN, _NOT_VALUED, and _NOT_RECOGNIZED.

Claim_CoveragePlanIdentifier

File Name

Claim_CoveragePlanIdentifier

Description

Identifiers of the health benefit payer or plan, which might not be unique to the plan, such as the Electronic Data Interchange (EDI) payer ID, HIPAA national health plan ID (HPID), or external ID.

Parent File

Claim

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 identifier_id Y An ID that uniquely identifies the benefit plan identifier for the person across all people.
4 value Y The value of the health plan identifier, such as the EDI payer ID, HPID, or external ID.
5 type_text Y An enumerated value to represent the type of health plan identifier. Possible values include EXTERNAL, EDI, HPID, and _NOT_RECOGNIZED.

Claim_PatientIdentifier

File Name

Claim_PatientIdentifier

Description

The identifiers of the person.

Parent File

Claim

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 identifier_id Y An ID that uniquely identifies the alias of the person across all people.
4 type_raw_display N See General.
5 type_std_code N The codified type of the alias, such as Social Security Number (SSN) or medical record number (MRN).
6 type_std_system N See General.
7 type_std_display N See General.
8 value Y The value of the alias.
9 system Y The assigning authority of the alias. It is strongly preferred that the assigning authority be an OID.

Claim_PatientNameGiven

File Name

Claim_PatientNameGiven

Description

A list of given name portions of the person name. For example, if a person has a first name and a middle name, the first name has sequence = 0 and the middle name has sequence = 1.

Parent File

Claim

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 given_id Y An ID that uniquely identifies the given name of the person across all people.
4 given Y A given name portion of the person name, such as a first or middle name.
5 sequence Y A zero-based non-negative integer describing the order of this entity within the context of its parent.

Claim_PatientNameFamily

File Name

Claim_PatientNameFamily

Description

A list of family (last) name portions of the person name. Some people have multiple family names.

Parent File

Claim

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 family_id Y An ID that uniquely identifies the family name of the person across all people.
4 family Y A family (last) name portion of the person name.
5 sequence Y A zero-based non-negative integer describing the order of this entity within the context of its parent.

Claim_PatientNameTitle

File Name

Claim_PatientNameTitle

Description

A list of titles associated with the person name.

Parent File

Claim

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 title_id Y An ID that uniquely identifies the title of the person across all people.
4 title Y A title associated with the person name.

Claim_PatientAddressLine

File Name

Claim_PatientAddressLine

Description

A list of line components within an address, such as street address, apartment number, or PO Box. Typically there are between one and three address lines, such as 123 Washington Ave.

Parent File

Claim

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 line_id Y An ID that uniquely identifies the address line across all people.
4 line Y An address line, such as street address (123 Washington Ave), apartment number, or PO Box.
5 sequence Y A zero-based non-negative integer describing the order of this entity within the context of its parent.

Claim_PatientTelecom

File Name

Claim_PatientTelecom

Description

A contact point for the person, such as email address or telephone number.

Parent File

Claim

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 telecom_id Y An ID that uniquely identifies the telecom of the person across all people.
4 value Y The telephone number or email address of the telecom, such as 123-456-7890 or johndoe@gmail.com.
5 system_std_code Y The codified communication form or system required to make use of the contact, such as phone or email.
6 system_std_system Y See General.
7 system_std_display Y See General.

Claim_Provider

File Name

Claim_Provider

Description

Providers associated with the claim.

Parent File

Claim

Children Files

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 provider_id Y An ID that uniquely identifies the provider across all claim providers for all people.
4 name_text N If entity_type is PERSON, this is the fully-formatted name of the provider who is associated with the claim. If entity_type is ORGANIZATION, this is the name of the organization.
5 type Y An enumerated value to identify the type of provider. Possible values include SUPERVISING, REFERRING, RENDERING, OPERATING, OTHER_OPERATING, ATTENDING, and BILLING.
6 entity_type Y An enumerated value to identify whether the provider is a person or organization. Possible values include PERSON, ORGANIZATION, and NOT_RECOGNIZED.

Claim_Provider_Identifier

File Name

Claim_Provider_Identifier

Description

Identifiers of the provider or organization associated with the claim.

Parent File

Claim_Provider

Columns

Index Column Name Required Description
1 claim_id Y The claim_id associated with this record.
2 provider_id Y The provider_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the provider or organization associated with the claim.
5 value Y The value of the provider alias, such as the provider NPI or Tax ID.
6 type_text Y An enumerated value for the type of alias. If the Claim_Provider entity_type is PERSON, then the possible values include NPI, DEA,TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED. If the Claim_Provider entity_type is ORGANIZATION, then the possible values include NPI, TAX, EXTERNAL, NABP, HL7_OID, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Claim_Provider_NameFamily

File Name

Claim_Provider_NameFamily

Description

A list of family (last) name portions of the provider name.

Parent File

Claim_Provider

Columns

Index Column Name Required Description
1 claim_id Y The claim_id associated with this record.
2 provider_id Y The provider_id associated with this record.
3 operation Y See General.
4 family_id Y An ID that uniquely identifies the family name across all claim providers for all people.
5 family Y A family (last) name portion of the provider name.
6 sequence Y A zero-based non-negative integer describing the order of this entity within the context of its parent.

Claim_Provider_NameGiven

File Name

Claim_Provider_NameGiven

Description

A list of given name portions of the provider name.

Parent File

Claim_Provider

Columns

Index Column Name Required Description
1 claim_id Y The claim_id associated with this record.
2 provider_id Y The provider_id associated with this record.
3 operation Y See General.
4 given_id Y An ID that uniquely identifies the given name across all claim providers for all people.
5 given Y A given name portion of the provider name, such as a first or middle name.
6 sequence Y A zero-based non-negative integer describing the order of this entity within the context of its parent.

Claim_Provider_TaxonomyCode

File Name

Claim_Provider_TaxonomyCode

Description

Specialties of the provider or organization associated with the claim.

Parent File

Claim_Provider

Columns

Index Column Name Required Description
1 claim_id Y The claim_id associated with this record.
2 provider_id Y The provider_id associated with this record.
3 operation Y See General.
4 taxonomy_code_id Y An ID that uniquely identifies the provider specialty across all claims for all people.
5 code_raw_display N See General.
6 code_std_code N A codified specialty of the provider or organization.
7 code_std_system N See General.
8 code_std_display N See General.

Claim_Procedure

File Name

Claim_Procedure

Description

Procedures associated with the claim.

Parent File

Claim

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 procedure_id Y An ID that uniquely identifies the procedure across all procedures for all people.
4 code_raw_display N See General.
5 code_std_code Y The codified representation of the procedure. See General.
6 code_std_system Y See General.
7 code_std_display N See General.
8 procedure_date N The date of the procedure. This is a date without time specified. See General.
9 procedure_type Y An enumerated value to identify the type of procedure associated with the claim. Possible values include PRINCIPAL and OTHER.

Claim_Diagnosis

File Name

Claim_Diagnosis

Description

Diagnoses associated with the claim.

Parent File

Claim

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 diagnosis_id Y An ID that uniquely identifies the diagnosis across all claims for all people.
4 code_raw_display N See General.
5 code_std_code Y A codified diagnosis.
6 code_std_system Y See General.
7 code_std_display N See General.
8 present_on_admission_raw_display N See General.
9 present_on_admission_std_code N A codified indication of whether the diagnosis is present on admission, such as yes, no, or unknown.
10 present_on_admission_std_system N See General.
11 present_on_admission_std_display N See General.
12 type Y An enumerated value to identify the type of diagnosis associated with the claim. Possible values include PRINCIPAL, ADMITTING, OTHER, EXTERNAL_INJURY, and REASON_FOR_VISIT.

Claim_ConditionCode

File Name

Claim_ConditionCode

Description

Condition codes associated with the claim.

Parent File

Claim

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 condition_id Y An ID that uniquely identifies the condition code across all claims for all people.
4 code_raw_display N See General.
5 code_std_code N The codified value that identifies the condition, such as acute condition, chronic condition, non-life threatening, or ambulance condition code (for example, patient was moved by stretcher or patient is confined to a bed or chair).
6 code_std_system N See General.
7 code_std_display N See General.

Claim_OccurrenceCode

File Name

Claim_OccurrenceCode

Description

Occurrence codes associated with the claim.

Parent File

Claim

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 occurrence_code_id Y An ID that uniquely identifies the occurrence code across all claims for all people.
4 code_raw_display N See General.
5 code_std_code Y The codified occurrence.
6 code_std_system Y See General.
7 code_std_display N See General.
8 occurrence_date N This field is a date without time specified. See General.

Claim_ValueInfoCode

File Name

Claim_ValueInfoCode

Description

Value info codes associated with the claim.

Parent File

Claim

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 value_info_code_id Y An ID that uniquely identifies the value info code across all claims for all people.
4 code_raw_display N See General.
5 code_std_code N The codified value info code.
6 code_std_system N See General.
7 code_std_display N See General.
8 monetary_amount N A decimal value that represents a monetary amount.

Claim_ServiceFacilityIdentifier

File Name

Claim_ServiceFacilityIdentifier

Description

The identifiers of the service facility associated with the claim.

Parent File

Claim

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 identifier_id Y An ID that uniquely identifies the service facility organization alias.
4 type_text Y An enumerated value to represent the type of alias. Possible values include NPI, TAX, EXTERNAL, NABP, HL7_OID, and _NOT_RECOGNIZED.
5 value Y The value of the organization alias, such as the NPI, NABP, or Tax ID.
6 system N The system that assigned the identifier value, if known. Generally this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Claim_Service

File Name

Claim_Service

Description

Service lines associated with the claim.

Parent File

Claim

Children Files

Rules

At least the adjudicated_revenue_code_std_code field, billed_revenue_code_std_code field, adjudicated_procedure_code_std_code field, or billed_procedure_code_std_code field is populated. However, all may be populated.

Columns

Index Column Name Required Description
1 claim_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 service_id Y An ID that uniquely identifies a service line across all claims for all people.
4 line_number Y A non-negative integer that the payer uses to identify a specific service line on a given claim.
5 service_from_date N The start date of the service line. This is a date without time specified. See General.
6 service_to_date N The end date of the service line. This is a date without time specified. See General.
7 billed_revenue_code_raw_display N See General.
8 billed_revenue_code_std_code N The revenue code billed by the provider. It could be adjudicated by payer.
9 billed_revenue_code_std_system N See General.
10 billed_revenue_code_std_display N See General.
11 billed_procedure_code_raw_display N See General.
12 billed_procedure_code_std_code N The codified procedure billed by the provider.
13 billed_procedure_code_std_system N See General.
14 billed_procedure_code_std_display N See General.
15 billed_amount N A decimal value that represents the monetary amount billed by the provider.
16 billed_unit N A decimal value that represents the unit of service billed by the provider.
17 billed_days N A decimal value that represents the days of service billed by the provider.
18 billed_service_minutes N A non-negative integer that represents the number of service minutes billed by the provider.
19 adjudicated_revenue_code_raw_display N See General.
20 adjudicated_revenue_code_std_code N The revenue code that the payer used to adjudicate the claim service line.
21 adjudicated_revenue_code_std_system N See General.
22 adjudicated_revenue_code_std_display N See General.
23 adjudicated_procedure_code_raw_display N See General.
24 adjudicated_procedure_code_std_code N The codified procedure that the payer used to adjudicate the claim service line.
25 adjudicated_procedure_code_std_system N See General.
26 adjudicated_procedure_code_std_display N See General.
27 adjudicated_amount N A decimal value that represents the monetary amount paid by the payer for a specific service.
28 adjudicated_unit N A decimal value that represents the unit of service adjudicated by the payer.
29 adjudicated_days N A decimal value that represents the days of service adjudicated by the payer.
30 adjudicated_service_minutes N A non-negative integer that represents the number of service minutes adjudicated by the payer.
31 place_of_service_raw_display N See General.
32 place_of_service_std_code N The codified place of service.
33 place_of_service_std_system N See General.
34 place_of_service_std_display N See General.
35 drug_code_raw_display N See General.
36 drug_code_std_code N The codified drug.
37 drug_code_std_system N See General.
38 drug_code_std_display N See General.
39 drug_prescription_number N The drug prescription number.
40 drug_ingredient_cost N A non-negative decimal value that represents the cost of the drug ingredient.
41 drug_quantity_value N A non-negative decimal value that represents the quantity of the drug or drug unit count.
42 drug_quantity_code_raw_display N See General.
43 drug_quantity_code_std_code N The codified unit of measure.
44 drug_quantity_code_std_system N See General.
45 drug_quantity_code_std_display N See General.
46 drug_theraputic_class_raw_display N See General.
47 drug_theraputic_class_std_code N The codified representation of the drug classification based on its chemical characteristics, structure, and how it is used to treat the specific disease.
48 drug_theraputic_class_std_system N See General.
49 drug_theraputic_class_std_display N See General.
50 drug_days_supply N A decimal value that represents the number of days the drug supplies.
51 drug_refill_count N A non-negative integer that represents the total refills for the drug.
52 drug_refill_indicator N A Boolean value that indicates whether the claim represents a prescription refill as indicated by the data source. Possible values include TRUE or FALSE.
53 drug_number_of_scripts_dispensed N A non-negative integer that represents the count of the number of instances of the prescription that were filled by this claim.
54 drug_generic_indicator N An enumerated value to identify whether the drug is generic or brand name. Possible values include G (generic), B (brand), BF (brand formulary), BNF (brand non-formulary), U (unknown), _NOT_VALUED, and _NOT_RECOGNIZED.
55 drug_link_sequence_number N A provider-assigned number to enable the receiver to piece together the components of the compound drug.
56 service_facility_name_text N The name of the organization.

Claim_Service_ProcedureCodeModifier

File Name

Claim_Service_ProcedureCodeModifier

Description

The modifiers of the procedure associated with the claim service line.

Parent File

Claim_Service

Columns

Index Column Name Required Description
1 claim_id Y The claim_id associated with this record.
2 service_id Y The service_id associated with this record.
3 operation Y See General.
4 modifier_id Y An ID that uniquely identifies the procedure modifier across all claims for all people.
5 modifier_raw_display N See General.
6 modifier_std_code N The codified modifier of the procedure associated with the claim service line.
7 modifier_std_system N See General.
8 modifier_std_display N See General.
9 type Y An enumerated value to identify whether the modifier is for a billed or adjudicated procedure. Possible values include BILLED and ADJUDICATED.

Claim_Service_Provider

File Name

Claim_Service_Provider

Description

Providers associated with the claim service line.

Parent File

Claim_Service

Children Files

Columns

Index Column Name Required Description
1 claim_id Y The claim_id associated with this record.
2 service_id Y The service_id associated with this record.
3 operation Y See General.
4 provider_id Y An ID that uniquely identifies the claim service provider across all claims for all people.
5 name_text N If entity_type is PERSON, this is the fully-formatted name of the provider who is associated with the claim. If entity_type is ORGANIZATION, this is the name of the organization.
6 type Y An enumerated value to identify the type of provider. Possible values include RENDERING, REFERRING, OPERATING, OTHER_OPERATING, ORDERING, and SUPERVISING.
7 entity_type Y An enumerated value to identify whether the provider is a person or organization. Possible values include PERSON, ORGANIZATION, and NOT_RECOGNIZED.

Claim_Service_Provider_Identifier

File Name

Claim_Service_Provider_Identifier

Description

Identifiers of the provider or organization associated with the claim service line.

Parent File

Claim_Service_Provider

Columns

Index Column Name Required Description
1 claim_id Y The claim_id associated with this record.
2 service_id Y The service_id associated with this record.
3 provider_id Y The provider_id associated with this record.
4 operation Y See General.
5 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the provider or organization associated with the claim service line.
6 value Y The value of the provider alias, such as the provider NPI or Tax ID.
7 type_text Y An enumerated value for the type of alias. If the Claim_Service_Provider entity_type is PERSON, then the possible values include NPI, DEA,TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED. If the Claim_Service_Provider entity_type is ORGANIZATION, then the possible values include NPI, TAX, EXTERNAL, NABP, HL7_OID, and _NOT_RECOGNIZED.
8 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Claim_Service_Provider_NameGiven

File Name

Claim_Service_Provider_NameGiven

Description

A list of given name portions of the provider name.

Parent File

Claim_Service_Provider

Columns

Index Column Name Required Description
1 claim_id Y The claim_id associated with this record.
2 service_id Y The service_id associated with this record.
3 provider_id Y The provider_id associated with this record.
4 operation Y See General.
5 given_id Y An ID that uniquely identifies the given name across all claim service line providers for all people.
6 given Y A given name portion of the provider name, such as a first or middle name.
7 sequence Y A zero-based non-negative integer describing the order of this entity within the context of its parent.

Claim_Service_Provider_NameFamily

File Name

Claim_Service_Provider_NameFamily

Description

A list of family (last) name portions of the provider name.

Parent File

Claim_Service_Provider

Columns

Index Column Name Required Description
1 claim_id Y The claim_id associated with this record.
2 service_id Y The service_id associated with this record.
3 provider_id Y The provider_id associated with this record.
4 operation Y See General.
5 family_id Y An ID that uniquely identifies the family name across all claim service line providers for all people.
6 family Y A family (last) name portion of the provider name.
7 sequence Y A zero-based non-negative integer describing the order of this entity within the context of its parent.

Claim_Service_Provider_TaxonomyCode

File Name

Claim_Service_Provider_TaxonomyCode

Description

A list of specialties of the provider or organization.

Parent File

Claim_Service_Provider

Columns

Index Column Name Required Description
1 claim_id Y The claim_id associated with this record.
2 service_id Y The service_id associated with this record.
3 provider_id Y The provider_id associated with this record.
4 operation Y See General.
5 taxonomy_code_id Y An ID that uniquely identifies the specialty of the claim service line provider across all claims for all people.
6 code_raw_display N See General.
7 code_std_code N A codified specialty of the provider or organization.
8 code_std_system N See General.
9 code_std_display N See General.

Claim_Service_Diagnosis

File Name

Claim_Service_Diagnosis

Description

Diagnoses associated with the claim service line.

Parent File

Claim_Service

Columns

Index Column Name Required Description
1 claim_id Y The claim_id associated with this record.
2 service_id Y The service_id associated with this record.
3 operation Y See General.
4 diagnosis_id Y An ID that uniquely identifies the service line diagnosis across all claims for all people.
5 code_raw_display N See General.
6 code_std_code N A codified diagnosis.
7 code_std_system N See General.
8 code_std_display N See General.

Claim_Service_Adjustment

File Name

Claim_Service_Adjustment

Description

Adjustment associated with the claim service line.

Parent File

Claim_Service

Columns

Index Column Name Required Description
1 claim_id Y The claim_id associated with this record.
2 service_id Y The service_id associated with this record.
3 operation Y See General.
4 adjustment_id Y An ID that uniquely identifies the service adjustment across all claims for all people.
5 reason_raw_display N See General.
6 reason_std_code N The codified reason for the adjustment.
7 reason_std_system N See General.
8 reason_std_display N See General.
9 amount Y A decimal value that represents the amount of the adjustment. Adjustments decrease the payment when the adjustment amount is positive and increase the payment when the adjustment amount is negative.
10 quantity N A decimal value that represents the quantity of the adjustment to the units of service. A positive value decreases paid units, and a negative value increases paid units.

Claim_Service_ServiceFacilityIdentifier

File Name

Claim_Service_ServiceFacilityIdentifier

Description

The identifiers of the service facility associated with the claim service line.

Parent File

Claim_Service

Columns

Index Column Name Required Description
1 claim_id Y The claim_id associated with this record.
2 service_id Y The service_id associated with this record.
3 operation Y See General.
4 identifier_id Y An ID that uniquely identifies the service facility organization alias.
5 type_text Y An enumerated value to represent the type of alias. Possible values include NPI, TAX, EXTERNAL, NABP, HL7_OID, and _NOT_RECOGNIZED.
6 value Y The value of the organization alias, such as the NPI, NABP, or Tax ID.
7 system N The system that assigned the identifier value, if known. Generally this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Condition

File Name

Condition

Description

The conditions of the patient, which include problems and diagnoses.

Children Files

Rules

At least the code_std_code field, code_raw_display field, or code_text field is populated. However, all three may be populated.

Columns

Index Column Name Required Description
1 condition_id Y An ID that uniquely identifies this condition for a person across all people.
2 operation Y See General.
3 person_id Y See General
4 source_condition_id N An ID that uniquely identifies this condition for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 code_raw_display N See General.
9 code_std_code N The codified value that identifies the condition, such as SNOMED CT, ICD-9-CM, or CPT4 code.
10 code_std_system N See General.
11 code_std_display N See General.
12 sequence N An enumerated value to identify the significance or priority of a billing diagnosis. Possible values include PRIMARY, SECONDARY, _NOT_RANKED, and _NOT_RECOGNIZED.
13 code_text N The textual description of the condition.
14 onset_date_time N The onset date of the condition. See General.
15 category_raw_display N See General.
16 category_std_code N The codified type of condition, such as problem or diagnosis.
17 category_std_system N See General.
18 category_std_display N See General.
19 role_raw_display N See General.
20 role_std_code N The codified role of the condition within the encounter, such as chief complaint, admission diagnosis, discharge diagnosis, or comorbidity.
21 role_std_system N See General.
22 role_std_display N See General.
23 verification_status_raw_display N See General.
24 verification_status_std_code N The codified confirmation status, such as confirmed, differential, possible, probable, complaint of, and rule out.
25 verification_status_std_system N See General.
26 verification_status_std_display N See General.
27 clinical_status_raw_display N See General.
28 clinical_status_std_code N The codified status of the condition, such as active, cancelled, in error, or resolved.
29 clinical_status_std_system N See General.
30 clinical_status_std_display N See General.
31 present_on_admission_raw_display N See General.
32 present_on_admission_std_code N A codified indication of whether the diagnosis is present on admission, such as yes, no, or unknown.
33 present_on_admission_std_system N See General.
34 present_on_admission_std_display N See General.
35 asserter_name_text N The fully-formatted name of the provider who is responsible for the condition.

Condition_AsserterIdentifier

File Name

Condition_AsserterIdentifier

Description

Identifier of the provider who is responsible for the condition.

Parent File

Condition

Columns

Index Column Name Required Description
1 condition_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the provider who is responsible for the condition.
4 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
5 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA,TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
6 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Condition_ManagementDiscipline

File Name

Condition_ManagementDiscipline

Description

The management disciplines of the caregiver responsible for managing the condition.

Parent File

Condition

Columns

Index Column Name Required Description
1 condition_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 management_discipline_id Y An ID that uniquely identifies the discipline of the caregiver responsible for managing the condition.
4 management_discipline_raw_display N See General.
5 management_discipline_std_code N The codified discipline of the caregiver responsible for managing the condition.
6 management_discipline_std_system N See General.
7 management_discipline_std_display N See General.

Condition_Note

File Name

Condition_Note

Description

The comments associated with the condition.

Parent File

Condition

Children Files

Columns

Index Column Name Required Description
1 condition_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 note_id Y An ID that uniquely identifies the note across all condition notes for all people.
4 text Y The text of the comment.
5 time N The date of the comment. See General.
6 author_name_text N The fully-formatted name of the provider who authored the note, if known.

Condition_Note_AuthorIdentifier

File Name

Condition_Note_AuthorIdentifier

Description

Identifiers of the provider who authored the condition note.

Parent File

Condition_Note

Columns

Index Column Name Required Description
1 condition_id Y The condition_id associated with this record.
2 note_id Y The note_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the author of a condition note.
5 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
6 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Contributor

File Name

Contributor

Description

The contributor reference definitions.

Columns

Index Column Name Required Description
1 contributor_id Y A unique ID of the contributor within a data source. Multiple contributors can be associated to a single data source.
2 display Y How the data contributor is displayed.
3 data_source_id Y A unique ID of the data source sending the data to HealtheIntent.

Coverage

File Name

Coverage

Description

Insurance or benefit coverage details for the person.

Children Files

Coverage_PlanIdentifier: Identifiers of the health benefit payer or plan, which might not be unique to the plan, such as the Electronic Data Interchange (EDI) payer ID, HIPAA national health plan ID (HPID), or external ID.

Rules

At least the identifier field, subscriber_id field, plan_name field, issuer_name field, or Coverage_PlanIdentifier file is populated. However, all may be populated.

Columns

Index Column Name Required Description
1 coverage_id Y An ID that uniquely identifies the benefit coverage for a person across all people.
2 operation Y See General.
3 person_id Y See General.
4 source_person_id Y See General.
5 contributor_id Y See General.
6 identifier N The unique member ID assigned to the person by the payer, such as the ID printed on the person’s benefit identification card.
7 relation_to_subscriber_raw_display N See General.
8 relation_to_subscriber_std_code N The codified relationship of the person to the benefit subscriber. The subscriber is the individual who elected the benefit and who was eligible to do so due to their association with the sponsor.
9 relation_to_subscriber_std_system N See General.
10 relation_to_subscriber_std_display N See General.
11 subscriber_id N A number shared by the subscriber and all of their dependents. Ties everyone in a family together. This is not the number uniquely identifying the subscriber.This is not an alias for the person that the enrollment record is associated with. It is merely a mechanism to link members of a family together.
12 plan_name N Name for the payer or plan; for example, CIGNA C5 PLAN, UHC CHOICE EPO SELECT, UHC OPTIONS PPO.
13 issuer_name N Name of the payer organization or entity that administers the plan.
14 group_number N The policy or group number. Often a health insurance card displays a policy or group number.
15 group_name N If a policy or group number is not available, a policy or group name may be provided.
16 type_raw_display N See General.
17 type_std_code N The codified representation of the insurance line or benefit type associated with the benefit coverage, such as HMO, PPO, medical, vision, or dental.
18 type_std_system N See General.
19 type_std_display N See General.
20 sub_plan N Used to distinguish sub-plan products or populations within a particular health plan.
21 period_start N The start date of the benefit coverage. Some payers or sources may not provide the actual start date of the coverage. In some cases, this may be the most recent effective date. This field is a date without time specified. See General.
22 period_end N The end date of the benefit coverage. No period_end typically implies currently active coverage; however, some payers or sources may not provide an explicit end date when coverage terminates. This field is a date without time specified. See General.

Coverage_PlanIdentifier

File Name

Coverage_PlanIdentifier

Description

Identifiers of the health benefit payer or plan, which might not be unique to the plan, such as the Electronic Data Interchange (EDI) payer ID, HIPAA national health plan ID (HPID), or external ID.

Parent File

Coverage

Columns

Index Column Name Required Description
1 coverage_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 plan_id Y An ID that uniquely identifies the benefit plan identifier for the person across all people.
4 value Y The value of the health plan identifier, such as the EDI payer ID, HPID, or external ID.
5 type_text Y An enumerated value to represent the type of health plan identifier. Possible values include EXTERNAL, EDI, HPID, and _NOT_RECOGNIZED.

DocumentReference

File Name

DocumentReference

Description

A reference to a document.

Children Files

DocumentReference_Action: The actions taken on the document by authors, authenticators, and reviewers.

Columns

Index Column Name Required Description
1 document_reference_id Y An ID that uniquely identifies the document reference across all document references for all people.
2 operation Y See General.
3 person_id Y See General.
4 source_document_id N An ID that uniquely identifies this document reference for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 description N The title of the document.
9 type_raw_display N See General.
10 type_std_code N The codified type or kind of document. See General.
11 type_std_system N See General.
12 type_std_display N See General.
13 doc_status_raw_display N See General.
14 doc_status_std_code N The codified status of the document. See General.
15 doc_status_std_system N See General.
16 doc_status_std_display N See General.
17 updated_date N The date and time that the document was updated in a clinically significant way. See General.
18 service_date N The clinically significant date and time associated with the document. See General.

DocumentReference_Action

File Name

DocumentReference_Action

Description

The actions taken on the document by authors, authenticators, and reviewers.

Parent File

DocumentReference

Children Files

DocumentReference_Action_ActorIdentifier: The identifiers of the provider who took the action on the document.

Rules

At least the actor_name_text field, the action_date field, or the DocumentReference_Action_ActorIdentifier file is populated. However, all three may be populated.

Columns

Index Column Name Required Description
1 document_reference_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 action_id Y An ID that uniquely identifies the action across all documents for all people.
4 type_raw_display N See General.
5 type_std_code N The codified action taken on the document. See General.
6 type_std_system N See General.
7 type_std_display N See General.
8 action_date N The date and time the action was taken. See General.
9 actor_name_text N The fully-formatted name of the provider who took this action on the document, if known.

DocumentReference_Action_ActorIdentifier

File Name

DocumentReference_Action_ActorIdentifier

Description

Identifiers of the provider who took an action on the document.

Parent File

DocumentReference_Action

Columns

Index Column Name Required Description
1 document_reference_id Y The document_reference_id associated with this record.
2 action_id Y The action_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the provider who took the action on the document.
5 value Y The value of the provider alias, such as the provider National Provider Identifier (NPI), Drug Enforcement Administration (DEA) number, or Tax ID.
6 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

DRG

File Name

DRG

Description

Diagnosis-related group (DRG).

Children Files

DRG_ActorIdentifier: Identifiers of the provider who is responsible for coding the diagnosis-related group.

Columns

Index Column Name Required Description
1 drg_id Y An ID that uniquely identifies the DRG across all DRGs for all people.
2 operation Y See General.
3 person_id Y See General.
4 source_drg_id N An ID that uniquely identifies this DRG for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 drg_raw_display N See General.
9 drg_std_code N The codified DRG. See General.
10 drg_std_system N See General.
11 drg_std_display N See General.
12 sequence Y An enumerated value to identify the significance or priority of a DRG. Possible values include PRIMARY, SECONDARY, _NOT_RANKED, and _NOT_RECOGNIZED.
13 status_raw_display N See General.
14 status_std_code N The codified status of the DRG, such as draft, final, or working. See General.
15 status_std_system N See General.
16 status_std_display N See General.
17 recorded_date N The date and time when the DRG was recorded or last updated. See General.
18 coding_completed_date N The date and time when the coding of the DRG was completed. See General.
19 weight N A non-negative decimal value that represents the weight of the DRG.
20 gmlos N A non-negative decimal value that represents the geometric mean length of stay, which is used by Centers for Medicare & Medicaid Services (CMS) to develop fractional reimbursement for patients whose medical treatment takes a much longer or shorter time than average.
21 amlos N A non-negative decimal value that represents the arithmetic mean length of stay, which is the sum of the length of stay for the patients divided by the number of patients.
22 estimated_reimbursement N A non-negative decimal value that represents the total estimated reimbursement amount for this DRG.
23 severity_raw_display N See General.
24 severity_std_code N The codified severity of illness, which represents the extent of organ system loss or physiologic decomposition, such as minor, moderate, major, or extreme. See General.
25 severity_std_system N See General.
26 severity_std_display N See General.
27 mortality_risk_raw_display N See General.
28 mortality_risk_std_code N The codified risk of mortality, which represents the likelihood of death for a patient, such as minor, moderate, major, or extreme. See General.
29 mortality_risk_std_system N See General.
30 mortality_risk_std_display N See General.
31 actor_name_text N The fully-formatted name of the provider who coded the DRG.
32 drg_grouper_type N The type of grouper that determined the DRG.

DRG_ActorIdentifier

File Name

DRG_ActorIdentifier

Description

Identifiers of the provider who is responsible for coding the diagnosis-related group (DRG).

Parent File

DRG

Columns

Index Column Name Required Description
1 drg_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the provider who coded the DRG.
4 value Y The value of the provider alias, such as the provider National Provider Identifier (NPI), Drug Enforcement Administration (DEA) number, or Tax ID.
5 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA,TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
6 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Encounter

File Name

Encounter

Description

Patient encounter.

Children Files

Rules

At least the service_period_start field, the actual period_start field, or the estimated_period_start is populated. However, both actual period_start and estimated_period_start may be populated.

Columns

Index Column Name Required Description
1 encounter_id Y An ID that uniquely identifies this encounter for a person across all people.
2 operation Y See General.
3 person_id Y See General.
4 source_person_id Y See General.
5 source_encounter_id N An ID that uniquely identifies this encounter for a person in the data source from which the entity originated.
6 contributor_id Y See General.
7 reason_raw_display N See General.
8 reason_std_code N The codified reason for this encounter.
9 reason_std_system N See General.
10 reason_std_display N See General.
11 reason_text N The textual description of the reason for this encounter.
12 financial_class_raw_display N See General.
13 financial_class_std_code N The codified financial class for the encounter, such as Medicare, Medicaid, or Self-Pay.
14 financial_class_std_system N See General.
15 financial_class_std_display N See General.
16 hospitalization_discharge_disposition_raw_display N See General.
17 hospitalization_discharge_disposition_std_code N The codified disposition of the patient at discharge of the encounter.
18 hospitalization_discharge_disposition_std_system N See General.
19 hospitalization_discharge_disposition_std_display N See General.
20 hospitalization_destination_type_raw_display N See General.
21 hospitalization_destination_type_std_code N The codified location to which the patient was discharged.
22 hospitalization_destination_type_std_system N See General.
23 hospitalization_destination_type_std_display N See General.
24 hospitalization_admit_source_raw_display N See General.
25 hospitalization_admit_source_std_code N The codified place the patient came from before being admitted for this encounter.
26 hospitalization_admit_source_std_system N See General.
27 hospitalization_admit_source_std_display N See General.
28 hospitalization_readmission N A Boolean value that indicates whether this encounter represents a readmission of the patient from a previous encounter. Possible values include TRUE and FALSE.
29 service_period_start N The start date of the encounter. The service_period_start is only populated when neither the actual period_start nor the estimated_period_start is populated. See General.
30 period_end N The date and time the encounter ended, such as an inpatient discharge date or outpatient departure date. See General.
31 priority_raw_display N See General.
32 priority_std_code N The codified urgency of the encounter, such as elective, urgent, or routine.
33 priority_std_system N See General.
34 priority_std_display N See General.
35 status_raw_display N See General.
36 status_std_code N The codified state of the encounter, such as active, discharged, or cancelled.
37 status_std_system N See General.
38 status_std_display N See General.
39 estimated_period_start N The estimated start date and time of the encounter. The encounter can exist before the actual encounter takes place to convey preadmission information, such as the estimated arrival date and time. See General.
40 estimated_period_end N The estimated end date and time of the encounter, such as an expected inpatient discharge date or expected outpatient departure date. See General.
41 period_start N The actual arrival or registration date and time of the encounter. It should indicate that the encounter was activated and the person had the visit. This date should not be set until the visit occurs. See General.
42 hospitalization_period_start N The date and time of the inpatient admission. This can differ from the period_start if, for example, the encounter began in the emergency department and then the patient was admitted to the hospital as an inpatient. See General.
43 service_provider_name N The name of the organization that is in charge of maintaining the information of this encounter. This may not be the service delivery location’s organization, such as when an ambulatory provider uses the ambulatory practice’s EHR to document an encounter with a patient at a nursing home.

Encounter_Participant

File Name

Encounter_Participant

Description

The practitioner associated with the encounter.

Parent File

Encounter

Children Files

Encounter_Participant_Identifier: The identifiers of the providers who participated in the encounter.

Rules

At least the individual_name_text field or Encounter_Participant_Identifier file is populated. However, both may be populated.

Columns

Index Column Name Required Description
1 encounter_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 participant_id Y An ID that uniquely identifies the relationship between a provider and a person in context of an encounter.
4 individual_name_text N The fully-formatted name of the provider.
5 type_raw_display N See General.
6 type_std_code N The codified type of relationship or role the provider has to the person in context of the encounter.
7 type_std_system N See General.
8 type_std_display N See General.
9 period_start N The date when the relationship was established in context of the encounter. See General.
10 period_end N The date when the relationship ended in context of the encounter. See General.

Encounter_Participant_Identifier

File Name

Encounter_Participant_Identifier

Description

A list of identifiers for the providers who participated in the encounter.

Parent File

Encounter_Participant

Columns

Index Column Name Required Description
1 encounter_id Y The encounter_id associated with this record.
2 participant_id Y The participant_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias.
5 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
6 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA,TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Encounter_ServiceProviderIdentifier

File Name

Encounter_ServiceProviderIdentifier

Description

The identifiers for the organization that is in charge of maintaining the information about this encounter. This may not be the same as the organization responsible for the location where services were delivered.

Parent File

Encounter

Columns

Index Column Name Required Description
1 encounter_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 service_provider_id Y An ID that uniquely identifies the service provider organization alias.
4 type_text Y An enumerated value to represent the type of alias. Possible values include NPI, TAX, EXTERNAL, NABP, HL7_OID, and _NOT_RECOGNIZED.
5 value Y The value of the organization alias, such as the NPI, NABP, or Tax ID.
6 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Encounter_Coverage

File Name

Encounter_Coverage

Description

The insurance or benefit coverages for the person in context of the encounter.

Parent File

Encounter

Children Files

Encounter_Coverage_PlanIdentifier: Identifiers of the health benefit payer or plan, which might not be unique to the plan, such as the Electronic Data Interchange (EDI) payer ID, HIPAA national health plan ID (HPID), or external ID.

Rules

At least the identifier field, subscriber_id field, plan_name field, issuer_name field, or Encounter_Coverage_PlanIdentifier file is populated. However, all may be populated.

Columns

Index Column Name Required Description
1 encounter_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 coverage_id Y The ID that uniquely identifies this benefit coverage in context of the encounter across all people.
4 plan_name N The name for the payer or plan, such as CIGNA C5 PLAN, UHC CHOICE EPO SELECT, or UHC OPTIONS PPO.
5 issuer_name N The name of the payer organization or entity that administers the plan.
6 group_number N The policy or group number. Often a health insurance card displays a policy or group number.
7 group_name N If a policy or group number is not available, a policy or group name may be provided.
8 type_raw_display N See General.
9 type_std_code N The codified representation of the insurance line or benefit type associated with the benefit coverage, such as HMO, PPO, medical, vision, or dental.
10 type_std_system N See General.
11 type_std_display N See General.
12 sub_plan N Used to distinguish sub-plan products or populations within a particular health plan.
13 identifier N The unique member ID assigned to the person by the payer, such as the ID printed on the person’s benefit identification card.
14 relation_to_subscriber_raw_display N See General.
15 relation_to_subscriber_std_code N The codified relationship of the person to the benefit subscriber. The subscriber is the individual who elected the benefit and who was eligible to do so due to their association with the sponsor.
16 relation_to_subscriber_std_system N See General.
17 relation_to_subscriber_std_display N See General.
18 subscriber_id N A number shared by the subscriber and all of their dependents. Ties everyone in a family together. This is not the number uniquely identifying the subscriber. This is not an alias for the person member that the enrollment record is associated with. It is merely a mechanism to link members of a family together.
19 sequence N A non-negative integer that represents the priority rank, or order, of this benefit coverage within the context of the encounter.
20 period_start N The start date of the benefit coverage. Some payers or sources may not provide the actual start date of the coverage. In some cases, this may be the most recent effective date. This field is a date without time specified. See General.
21 period_end N The end date of the benefit coverage. No period_end typically implies currently active coverage; however, some payers or sources may not provide an explicit end date when coverage terminates. This field is a date without time specified. See General.

Encounter_Coverage_PlanIdentifier

File Name

Encounter_Coverage_PlanIdentifier

Description

Identifiers of the health benefit payer or plan, which might not be unique to the plan, such as the Electronic Data Interchange (EDI) payer ID, HIPAA national health plan ID (HPID), or external ID.

Parent File

Encounter_Coverage

Columns

Index Column Name Required Description
1 encounter_id Y The encounter_id associated with this record.
2 coverage_id Y The coverage_id associated with this record.
3 operation Y See General.
4 plan_id Y An ID that uniquely identifies the benefit plan identifier across all people.
5 value Y The value of the health plan identifier, such as the EDI payer ID, HPID, or external ID.
6 type_text Y An enumerated value to represent the type of health plan identifier. Possible values include EXTERNAL, EDI, HPID, and _NOT_RECOGNIZED.

Encounter_Location

File Name

Encounter_Location

Description

Locations where the patient has been during this encounter.

Parent File

Encounter

Children Files

Encounter_Location_Location: A location where the encounter took place.

Rules

The file is required.

Columns

Index Column Name Required Description
1 encounter_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 encounter_location_id Y An ID that uniquely identifies the time period during which the patient was at a given location during this encounter.
4 period_start N The date and time when the patient arrived at this location. See General.
5 period_end N The date and time when the patient left this location. See General.

Encounter_Location_Location

File Name

Encounter_Location_Location

Description

A location where the patient has been during this encounter.

Parent File

Encounter_Location

Children Files

Rules

At least the source_location_id field or name field is populated. However, both may be populated.

Columns

Index Column Name Required Description
1 encounter_id Y The encounter_id associated with this record.
2 encounter_location_id Y The encounter_location_id associated with this record.
3 operation Y See General.
4 location_id Y An ID that uniquely identifies the location where this encounter took place across all encounters for all people.
5 source_location_id N An ID that uniquely identifies the location in the data source from which this entity originated.
6 physical_type_std_code N The codified physical form of the location, such as facility, building, nurse unit, room, or bed.
7 physical_type_std_system N See General.
8 physical_type_std_display N See General.
9 name N The display name of the location.
10 time_zone_id N The time zone of the location, such as America/Chicago, America/New_York, or America/Los_Angeles.
11 part_of_id N The ID that uniquely identifies another location that contains this location. For example, if this location is a bed, then the bed is part of a room location. Similarly, a room is part of a nurse unit, a nurse unit is part of a building, and a building is part of a facility.
12 managing_organization_name N The name of the organization that manages the location.

Encounter_Location_Location_Type

File Name

Encounter_Location_Location_Type

Description

Type of function performed at the location.

Parent File

Encounter_Location_Location

Columns

Index Column Name Required Description
1 encounter_id Y The encounter_id associated with this record.
2 encounter_location_id Y The encounter_location_id associated with this record.
3 location_id Y The location_id associated with this record.
4 operation Y See General.
5 type_id Y An ID that uniquely identifies the type of function performed at the location across all encounters for all people.
6 code_raw_display N See General.
7 code_std_code N The codified type of function performed at the location.
8 code_std_system N See General.
9 code_std_display N See General.

Encounter_Location_Location_ManagingOrganizationIdentifier

File Name

Encounter_Location_Location_ManagingOrganizationIdentifier

Description

Identifiers for the managing organization of the encounter location.

Parent File

Encounter_Location_Location

Columns

Index Column Name Required Description
1 encounter_id Y The encounter_id associated with this record.
2 encounter_location_id Y The encounter_location_id associated with this record.
3 location_id Y The location_id associated with this record.
4 operation Y See General.
5 identifier_id Y An ID that uniquely identifies the managing organization alias for this location across all encounters for all people.
6 type_text Y An enumerated value to represent the type of alias. Possible values include NPI, TAX, EXTERNAL, NABP, HL7_OID, and _NOT_RECOGNIZED.
7 value Y The value of the organization alias, such as the NPI, NABP, or Tax ID.
8 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Encounter_HospitalService

File Name

Encounter_HospitalService

Description

Hospital service rendered during the encounter.

Parent File

Encounter

Columns

Index Column Name Required Description
1 encounter_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 hospital_service_id Y An ID that uniquely identifies the hospital service rendered during the encounter across all encounters for all people.
4 service_raw_display N See General.
5 service_std_code Y The codified hospital service rendered during the encounter.
6 service_std_system Y See General.
7 service_std_display N See General.
8 period_start N The date and time when the service started. See General.
9 period_end N The date and time when the service ended. See General.

Encounter_Type

File Name

Encounter_Type

Description

The specific type of the encounter, such as OP Maternity, OP Day Surgery, and ICU.

Parent File

Encounter

Columns

Index Column Name Required Description
1 encounter_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 type_id Y An ID that uniquely identifies the type of encounter across all encounters for all people.
4 type_raw_display N See General.
5 type_std_code Y The codified type of the encounter, such as OP Maternity, OP Day Surgery, ICU, or Pysch Inpatient.
6 type_std_system Y See General.
7 type_std_display N See General.
8 class_raw_display N See General.
9 class_std_code N The codified classification of the encounter, such as inpatient or outpatient.
10 class_std_system N See General.
11 class_std_display N See General.
12 period_start N The start date and time of the encounter type. See General.
13 period_end N The end date and time of the encounter type. See General.

Encounter_Identifier

File Name

Encounter_Identifier

Description

Identifiers by which this encounter is known, such as encounter medical record number or encounter financial number.

Parent File

Encounter

Rules

At least the type_std_code field or system field is populated. However, both may be populated.

Columns

Index Column Name Required Description
1 encounter_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 identifier_id Y An ID that uniquely identifies the encounter alias across all encounters for all people.
4 type_raw_display N See General.
5 type_std_code N The codified type of the alias, such as encounter medical record number (MRN) or encounter financial number (FIN).
6 type_std_system N See General.
7 type_std_display N See General.
8 value Y The value of the alias.
9 system N The system that assigned the identifier value, if known. Generally, this is an OID.

Immunization

File Name

Immunization

Description

Immunization details for a person.

Children Files

Columns

Index Column Name Required Description
1 immunization_id Y An ID that uniquely identifies this immunization across all immunizations for all people.
2 operation Y See General.
3 person_id Y See General.
4 source_immunization_id N An ID that uniquely identifies this immunization for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 vaccine_code_raw_display N See General.
9 vaccine_code_std_code Y The codified value that identifies the vaccine, such as the CVX code.
10 vaccine_code_std_system Y See General.
11 vaccine_code_std_display N See General.
12 vaccine_code_text N The textual description of the vaccine.
13 date_time N The date and time when the vaccine was administered or was to be administered. See General.
14 drug_code_raw_display N See General.
15 drug_code_std_code N The codified value that identifies the drug.
16 drug_code_std_system N See General.
17 drug_code_std_display N See General.
18 route_raw_display N See General.
19 route_std_code N The codified route by which the vaccine was administered, such as oral or intravenous.
20 route_std_system N See General.
21 route_std_display N See General.
22 dose_quantity_value N A non-negative decimal value that represents the amount of the drug that was administered.
23 dose_quantity_code_raw_display N See General.
24 dose_quantity_code_std_code N The codified unit of measure associated with the dose_quantity_value.
25 dose_quantity_code_std_system N See General.
26 dose_quantity_code_std_display N See General.
27 manufacturer_raw_display N See General.
28 manufacturer_std_code N The codified manufacturer of the vaccine, such as the MVX code.
29 manufacturer_std_system N See General.
30 manufacturer_std_display N See General.
31 lot_number N The lot number of the vaccine.
32 status_raw_display N See General.
33 status_std_code N The codified status of the immunization, such as completed.
34 status_std_system N See General.
35 status_std_display N See General.
36 was_not_given N A Boolean value that indicates if the immunization was not given. Possible values include TRUE or FALSE.
37 explanation_reason_not_given_raw_display N See General.
38 explanation_reason_not_given_std_code N The codified reason why the immunization was not given.
39 explanation_reason_not_given_std_system N See General.
40 explanation_reason_not_given_std_display N See General.
41 practitioner_name_text N The fully-formatted name of the provider who performed the immunization.

Immunization_PractitionerIdentifier

File Name

Immunization_PractitionerIdentifier

Description

Identifiers for the provider performing the immunization.

Parent File

Immunization

Columns

Index Column Name Required Description
1 immunization_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 identifier_id Y The ID that uniquely identifies the provider alias.
4 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
5 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
6 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Immunization_Note

File Name

Immunization_Note

Description

Immunization notes

Parent File

Immunization

Children Files

Immunization_Note_AuthorIdentifier: A list of identifiers for the provider who authored the comment.

Columns

Index Column Name Required Description
1 immunization_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 note_id Y An ID that uniquely identifies the note across all immunization notes for all people.
4 text Y The text of the comment.
5 time N The date of the comment. See General.
6 author_name_text N The fully-formatted name of the provider who authored the comment, if known.

Immunization_Note_AuthorIdentifier

File Name

Immunization_Note_AuthorIdentifier

Description

Identifiers of the providers who authored the immunization notes.

Parent File

Immunization_Note

Columns

Index Column Name Required Description
1 immunization_id Y The immunization_id associated with this record.
2 note_id Y The note_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the author of an immunization note.
5 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
6 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA,TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

MedicationDispense

File Name

MedicationDispense

Description

The supply of medication to a person.

Children Files

MedicationDispense_MedicationProductIngredient: The ingredients of the medication that was dispensed.

Columns

Index Column Name Required Description
1 medication_dispense_id Y An ID that uniquely identifies the medication dispense across all medication dispenses for all people.
2 operation Y See General.
3 person_id Y See General.
4 source_medication_dispense_id N An ID that uniquely identifies this medication dispense for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 source_authorizing_prescription_id N The medication order that authorizes the dispense for a person in the data source from which the entity originated.
9 when_handed_over N The date and time the dispensed medication was provided to the person or the person’s representative. See General.
10 type_raw_display N See General.
11 type_std_code N The codified type of dispensing event, such as first fill, refill, and manufacturer sample. See General.
12 type_std_system N See General.
13 type_std_display N See General.
14 status_raw_display N See General.
15 status_std_code N The codified state of the dispense event, such as completed or in-progress. See General.
16 status_std_system N See General.
17 status_std_display N See General.
18 quantity_value N A decimal value that represents the amount of medication that was dispensed.
19 quantity_code_raw_display N See General.
20 quantity_code_std_code N The codified unit of measure associated with the quantity_value. See General.
21 quantity_code_std_system N See General.
22 quantity_code_std_display N See General.
23 dosage_instruction_dose_quantity_value N A decimal value that represents the amount of medication per administration event.
24 dosage_instruction_dose_quantity_code_raw_display N See General.
25 dosage_instruction_dose_quantity_code_std_code N The codified unit of measure associated with the dosage_instruction_dose_quantity_value. See General.
26 dosage_instruction_dose_quantity_code_std_system N See General.
27 dosage_instruction_dose_quantity_code_std_display N See General.
28 days_supply_value N A decimal value that represents the amount of medication expressed as a timing amount.
29 days_supply_code_raw_display N See General.
30 days_supply_code_std_code N The codified unit of measure associated with the days_supply_value. See General.
31 days_supply_code_std_system N See General.
32 days_supply_code_std_display N See General.

MedicationDispense_MedicationProductIngredient

File Name

MedicationDispense_MedicationProductIngredient

Description

The ingredients in the medication that was dispensed.

Parent File

MedicationDispense

Rules

At least the item_code_std_code field, item_code_raw_display field, or the item_code_text field is populated. However, all three may be populated.

Columns

Index Column Name Required Description
1 medication_dispense_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 medication_id Y An ID that uniquely identifies the ingredient across all ingredients for all people.
4 item_code_raw_display N See General.
5 item_code_std_code N The codified drug that identifies the ingredient. See General.
6 item_code_std_system N See General.
7 item_code_std_display N See General.
8 item_code_text N The display of the drug from the activity data in the source system, which often represents the medication name at the time of dispensing. If the reference data, such as the medication display, ever changes, then this text preserves the display from the activity data.
9 amount_numerator_value N A decimal value that represents the quantity of the dose strength for the ingredient.
10 amount_numerator_code_raw_display N See General.
11 amount_numerator_code_std_code N The codified unit of measure associated with the amount_numerator_value, such as mg or tabs. See General.
12 amount_numerator_code_std_system N See General.
13 amount_numerator_code_std_display N See General.
14 amount_denominator_value N A decimal value that represents the quantity of the dose volume for the ingredient.
15 amount_denominator_code_raw_display N See General.
16 amount_denominator_code_std_code N The codified unit of measure associated with the amount_denominator_value, such as ml. See General.
17 amount_denominator_code_std_system N See General.
18 amount_denominator_code_std_display N See General.
19 quantity_value N A decimal value that represents the quantity of the ingredient.
20 quantity_raw_display N See General.
21 quantity_std_code N The codified unit of measure associated with the quantity_value, such as tab. See General.
22 quantity_std_system N See General.
23 quantity_std_display N See General.

MedicationStatement

File Name

MedicationStatement

Description

Medications the patient was prescribed or the patient stated were consumed.

Children Files

Rules

At least the medication_codeable_concept_std_code field, medication_codeable_concept_raw_display field, or the medication_codeable_concept_text field is populated. However, all three may be populated.

Columns

Index Column Name Required Description
1 medication_statement_id Y An ID that uniquely identifies this medication for a person across all medications for all people.
2 operation Y See General.
3 person_id Y See General.
4 source_medication_statement_id N An ID that uniquely identifies this medication for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 medication_codeable_concept_text N The display of the drug from the activity data in the source system, which often represents the medication name at the time of ordering. If the reference data, such as the medication display, ever changes then this text preserves the display from the activity data.
9 medication_codeable_concept_raw_display N See General.
10 medication_codeable_concept_std_code N The codified value that identifies the medication.
11 medication_codeable_concept_std_system N See General.
12 medication_codeable_concept_std_display N See General.
13 dosage_timing_repeat_bounds_period_start N The start date and time of the medication. See General.
14 dosage_timing_repeat_bounds_period_end N The stop date and time of the medication. See General.
15 status_raw_display N See General.
16 status_std_code N The codified status of the medication, such as active, complete, discontinued, or on hold.
17 status_std_system N See General.
18 status_std_display N See General.
19 dosage_text N A text string containing clinically relevant details about the medication order. For example, 20 mg, 1 tab, Route: PO, Drug form: TAB, Daily, Start date: 05/07/11 9:00:00, Duration: 30 day, Stop date: 06/05/11 9:00:00.
20 dosage_route_raw_display N See General.
21 dosage_route_std_code N The codified route that the medication was, or will be, administered, such as orally or intravenously.
22 dosage_route_std_system N See General.
23 dosage_route_std_display N See General.
24 dosage_timing_code_raw_display N See General.
25 dosage_timing_code_std_code N The codified frequency that a dose of the medication is to be administered, such as QD, BID, or TID.
26 dosage_timing_code_std_system N See General.
27 dosage_timing_code_std_display N See General.
28 dosage_additional_instructions_text N The patient instructions for the medication order.
29 intended_administrator N An enumerated value to represent the intended administrator for the medication. Possible values include SELF, PROVIDER, _NOT_VALUED, and _NOT_RECOGNIZED.
30 intended_dispenser N An enumerated value to represent the intended dispenser for the medication. Possible values include HOSPITAL_PHARMACY, INPATIENT_FLOOR_STOCK, RETAIL_PHARMACY, OTC, OFFICE, UNKNOWN, _NOT_VALUED, and _NOT_RECOGNIZED.
31 prescriber_name_text N The fully-formatted name of the provider who prescribed the medication.

MedicationStatement_PrescriberIdentifier

File Name

MedicationStatement_PrescriberIdentifier

Description

Identifiers of the provider who prescribed the medication.

Parent File

MedicationStatement

Columns

Index Column Name Required Description
1 medication_statement_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the provider who prescribed the medication.
4 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
5 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
6 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

MedicationStatement_MedicationProductIngredient

File Name

MedicationStatement_MedicationProductIngredient

Description

The ingredients in the medication.

Parent File

MedicationStatement

Rules

At least the item_code_std_code field, item_code_raw_display field, or the item_code_text field is populated. However, all three may be populated.

Columns

Index Column Name Required Description
1 medication_statement_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 medication_id Y An ID that uniquely identifies the ingredient across all ingredients for all people.
4 item_code_raw_display N See General.
5 item_code_std_code N The codified drug that identifies the ingredient.
6 item_code_std_system N See General.
7 item_code_std_display N See General.
8 item_code_text N The display of the drug from the activity data in the source system, which often represents the medication name at the time of ordering. If the reference data, such as the medication display, ever changes, then this text preserves the display from the activity data.
9 amount_numerator_value N A decimal value that represents the quantity of the dose strength for the ingredient.
10 amount_numerator_code_raw_display N See General.
11 amount_numerator_code_std_code N The codified unit of measure associated with the amount_numerator_value, such as mg or tabs.
12 amount_numerator_code_std_system N See General.
13 amount_numerator_code_std_display N See General.
14 amount_denominator_value N A decimal value that represents the quantity of the dose volume for the ingredient.
15 amount_denominator_code_raw_display N See General.
16 amount_denominator_code_std_code N The codified unit of measure associated with the amount_denominator_value, such as ml.
17 amount_denominator_code_std_system N See General.
18 amount_denominator_code_std_display N See General.
19 quantity_value N A decimal value that represents the quantity of the ingredient.
20 quantity_code_raw_display N See General.
21 quantity_code_std_code N The codified unit of measure associated with the quantity_value, such as tab.
22 quantity_code_std_system N See General.
23 quantity_code_std_display N See General.

MedicationStatement_Note

File Name

MedicationStatement_Note

Description

Medication notes.

Parent File

MedicationStatement

Children Files

MedicationStatement_Note_AuthorIdentifier: A list of identifiers for the provider who authored the comment.

Columns

Index Column Name Required Description
1 medication_statement_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 note_id Y An ID that uniquely identifies the note across all medication notes for all people.
4 text Y The text of the comment.
5 time N The date of the comment. See General.
6 author_name_text N The fully-formatted name of the provider who authored the note, if known.

MedicationStatement_Note_AuthorIdentifier

File Name

MedicationStatement_Note_AuthorIdentifier

Description

Identifiers of the provider who authored the medication statement note.

Parent File

MedicationStatement_Note

Columns

Index Column Name Required Description
1 medication_statement_id Y The medication_statement_id associated with this record.
2 note_id Y The note_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the author of a medication statement note.
5 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
6 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Observation

File Name

Observation

Description

Patient observation.

Children Files

Rules

Only one of the following is populated: value_quantity_value field, value_string field, value_date_time field, or Observation_ValueCodeableConcept file.

Either the reference_range_low_value field or reference_range_low_text field is populated.

Either the reference_range_high_value field or reference_range_high_text field is populated.

Columns

Index Column Name Required Description
1 observation_id Y An ID that uniquely identifies this observation for a person across all people.
2 operation Y See General.
3 person_id Y See General.
4 source_observation_id N An ID that uniquely identifies this observation for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 code_text Y The text name of the observation, such as height, weight, glucose, or cholesterol, as displayed in the source system. The code_std_display could be different from this text. For example, white blood cells (WBC) is commonly used as the text whereas the standard LOINC code for this observation is Leukocytes.
9 code_raw_display N See General.
10 code_std_code Y The codified value that identifies the observation, test, or measurement.
11 code_std_system Y See General.
12 code_std_display N See General.
13 effective_date_time N The clinically significant date and time associated with the observation, such as a specimen collection time or the time the observed value is asserted as being true. See General.
14 interpretation_raw_display N See General.
15 interpretation_std_code N The codified indication whether the observation result value is high, low, or critical.
16 interpretation_std_system N See General.
17 interpretation_std_display N See General.
18 status_raw_display N See General.
19 status_std_code N The codified status of the observation, such as in error, modified, or preliminary.
20 status_std_system N See General.
21 status_std_display N See General.
22 issued N The last date and time that the observation was updated in a clinically-significant way. See General.
23 specimen_accession_identifier_value N The number or identifier associated with laboratory observations. An accession number may be used to group observations for a single lab order or group of orders on the same person, and also uniquely identifies the specimen used for laboratory testing.
24 specimen_type_raw_display N See General.
25 specimen_type_std_code N The codified type of specimen on which the observation was performed, such as blood or urine. Specimen type is usually associated with laboratory observations.
26 specimen_type_std_system N See General.
27 specimen_type_std_display N See General.
28 method_raw_display N See General.
29 method_std_code N A codified method used to perform the measurement.
30 method_std_system N See General.
31 method_std_display N See General.
32 performer_type N An enumerated value to identify the type of performer of this observation. Possible values include SELF, PROVIDER, DEVICE, UNKNOWN, _NOT_VALUED, and _NOT_RECOGNIZED.
33 value_type N An enumerated value to identify the type of observation value. Possible values include NUMERIC, CODIFIED, TEXT, DATE, _NOT_RECOGNIZED, and _NOT_VALUED.
34 value_quantity_value N A decimal value that represents an observation value when the value_type = NUMERIC.
35 value_quantity_comparator N The symbol or characters that modify the value_quantity_value, such as >, <, or >=.
36 value_string N The textual value that represents an observation value when the value_type = TEXT.
37 value_date_time N The date and time value that represents an observation value when the value_type = DATE. See General.
38 value_quantity_code_raw_display N See General.
39 value_quantity_code_std_code N The codified unit of measure.
40 value_quantity_code_std_system N See General.
41 value_quantity_code_std_display N See General.
42 reference_range_low_type N An enumerated value to identify the type of the low reference range. Possible values include NUMERIC and TEXT.
43 reference_range_low_value N A decimal value that represents the low reference range value when reference_range_low_type = NUMERIC.
44 reference_range_low_value_comparator N The symbol or characters that modify the low reference range value, such as >, <, or >=.
45 reference_range_low_text N The textual representation of the low reference value when reference_range_low_type = TEXT.
46 reference_range_high_type N An enumerated value to identify the type of the high reference range. Possible values include NUMERIC and TEXT.
47 reference_range_high_value N A decimal value that represents the high reference range value when reference_range_high_type = NUMERIC.
48 reference_range_high_value_comparator N The symbol or characters that modify the high reference range value, such as >, <, or >=.
49 reference_range_high_text N The textual representation of the high reference value when reference_range_high_type = TEXT.
50 reference_range_text N The textual representation of the combined low and high reference values. Some sources will only send the range as a text value and others may send discrete low and high values that can be combined to create a textual range. For example:
  • If reference_range_low_value = 10 and reference_range_high_value = 20, then the reference_range_text would be 10 - 20.
  • If reference_range_low_value = 10 and reference_range_high_value = null, then the reference_range_text is >=10.
  • If reference_range_low_value = null and reference_range_high_value = 20, then the reference_range_text is <=20.
  • If reference_range_text = Negative and reference_range_high_text = null, then the reference_range_text is Negative.

Observation_ValueCodeableConcept

File Name

Observation_ValueCodeableConcept

Description

Codified values associated with the observation.

Parent File

Observation

Rules

At least the value_codeable_concept_std_code field or the value_codeable_concept_raw_display field is populated. However, both may be populated.

Columns

Index Column Name Required Description
1 observation_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 value_id Y The ID that uniquely identifies the codified value across all observations for all people.
4 value_codeable_concept_raw_display N See General.
5 value_codeable_concept_std_code N The codified observation value.
6 value_codeable_concept_std_system N See General.
7 value_codeable_concept_std_display N See General.
8 sequence N A non-negative integer describing the sequence, order, or priority of the codified value when an observation has multiple codified values.

Observation_Action

File Name

Observation_Action

Description

Action the provider took on the observation.

Parent File

Observation

Children Files

Observation_Action_ActorIdentifier: A list of identifiers for the provider who took the action on the observation.

Rules

At least the actor_name_text field, the action_date field, or the Observation_Action_ActorIdentifier file is populated. However, all three may be populated.

Columns

Index Column Name Required Description
1 observation_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 action_id Y The ID that uniquely identifies the action across all observation actions for all people.
4 actor_name_text N The fully-formatted name of the provider who took the action on the observation.
5 action N An enumerated value to identify the type of action taken. Possible values include PERFORM, AUTHENTICATE, ORDER, _NOT_VALUED, and _NOT_RECOGNIZED.
6 action_date N The date and time the action was taken. See General.

Observation_Action_ActorIdentifier

File Name

Observation_Action_ActorIdentifier

Description

Identifiers of the provider who took an action on the observation.

Parent File

Observation_Action

Columns

Index Column Name Required Description
1 observation_id Y The observation_id associated with this record.
2 action_id Y The action_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the provider who took action on the observation.
5 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
6 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Observation_Note

File Name

Observation_Note

Description

Notes associated with patient observations.

Parent File

Observation

Children Files

Observation_Note_AuthorIdentifier: A list of identifiers for the provider who authored the comment.

Columns

Index Column Name Required Description
1 observation_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 note_id Y An ID that uniquely identifies the note across all observation notes for all people.
4 text Y The text of the comment.
5 time N The date of the comment. See General.
6 author_name_text N The fully-formatted name of the author of the note, if known.

Observation_Note_AuthorIdentifier

File Name

Observation_Note_AuthorIdentifier

Description

Identifiers of the providers who authored patient observation notes.

Parent File

Observation_Note

Columns

Index Column Name Required Description
1 observation_id Y The observation_id associated with this record.
2 note_id Y The note_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the author of an observation note.
5 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
6 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

OrderList

File Name

OrderList

Description

A list of orders associated with a person, such as orders reconciled at discharge or order compliance.

Children Files

Rules

Either the OrderList_Entry file or the empty_reason fields is populated. However, both are not populated for the same order_list_id.

Columns

Index Column Name Required Description
1 order_list_id Y An ID that uniquely identifies the order list across all orders lists for all people.
2 operation Y See General.
3 person_id Y See General.
4 source_order_list_id N An ID that uniquely identifies this order list for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 code_text Y An enumerated value to identify the type or purpose of the order list. Possible values include COMPLIANCE, RECONCILIATION_ON_ADMISSION, RECONCILIATION_ON_TRANSFER, RECONCILIATION_ON_DISCHARGE, RECONCILIATION_ON_SHORT_TERM_LEAVE, and RECONCILIATION_ON_SHORT_TERM_LEAVE_RETURN.
9 source_name_text N The fully-formatted name of the provider who defined the list contents.
10 date_time N The date, or date and time the order list was documented or updated. See General.
11 empty_reason_raw_display N See General.
12 empty_reason_std_code N The codified reason why the OrderList_Entry file is empty, such as no drug therapy prescribed.
13 empty_reason_std_system N See General.
14 empty_reason_std_display N See General.

OrderList_SourceIdentifier

File Name

OrderList_SourceIdentifier

Description

Identifiers for the provider who defined the list contents.

Parent File

OrderList

Columns

Index Column Name Required Description
1 order_list_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the provider who defined the list contents.
4 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
5 type_text Y An enumerated value to represent the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
6 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

OrderList_Entry

File Name

OrderList_Entry

Description

Entries in the order list.

Parent File

OrderList

Columns

Index Column Name Required Description
1 order_list_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 entry_id Y An ID that uniquely identifies the entry across all order list entries for all people.
4 source_item_id Y An ID that uniquely identifies the order for a person in the data source from which the entity originated.
5 flag_raw_display N See General.
6 flag_std_code Y The codified role and significance of the entry in the list. The flag can only be understood in the context of the parent entity OrderList code_text. For example, if the code_text is COMPLIANCE, then the flag_std_code indicates whether the order is not being taken, being taken as prescribed, or taking, but not as prescribed. By contrast, if the code_text is RECONCILIATION_ON_ADMISSION, RECONCILIATION_ON_TRANSFER, RECONCILIATION_ON_DISCHARGE, RECONCILIATION_ON_SHORT_TERM_LEAVE, or RECONCILIATION_ON_SHORT_TERM_LEAVE_RETURN, then the flag_std_code indicates the action the provider took during reconciliation, such as discontinue, complete, or suspend.
7 flag_std_system Y See General.
8 flag_std_display N See General.

Patient

File Name

Patient

Description

Patient demographics.

Children Files

Columns

Index Column Name Required Description
1 patient_demographics_id Y An ID that uniquely identifies the person demographics across all people.
2 operation Y See General.
3 person_id Y See General.
4 source_person_id Y See General.
5 contributor_id Y See General.
6 birth_date N The date of birth of the person. This field is a date without time specified. See General.
7 birth_time N The date and time of birth, in ISO 8601 format, of the person. This field is only populated when the full date and time is available. The birth_date field contains only the date. If the time is not available, then this is null and only birth_date is populated. There is not any instance when birth_date is null and birth_time is not null.
8 gender_raw_display N See General.
9 gender_std_code N The codified value for the gender of the person.
10 gender_std_system N See General.
11 gender_std_display N See General.
12 marital_status_raw_display N See General.
13 marital_status_std_code N The codified value for the marital status of the person.
14 marital_status_std_system N See General.
15 marital_status_std_display N See General.
16 ethnicity_raw_display N See General.
17 ethnicity_std_code N The codified value for the ethnicity of the person.
18 ethnicity_std_system N See General.
19 ethnicity_std_display N See General.
20 religion_raw_display N See General.
21 religion_std_code N The codified value for the religion of the person.
22 religion_std_system N See General.
23 religion_std_display N See General.
24 deceased_boolean N A Boolean value that indicates if a person is deceased. Possible values include TRUE or FALSE.
25 deceased_date_time N Date of death of the person, if known. See General.
26 cause_of_death_raw_display N See General.
27 cause_of_death_std_code N The codified value for the cause of death of the person.
28 cause_of_death_std_system N See General.
29 cause_of_death_std_display N See General.

Patient_Name

File Name

Patient_Name

Description

Names associated with the patient.

Parent File

Patient

Children Files

Rules

At least the text field, Patient_Name_Given file, or Patient_Name_Family file is populated. However, all three may be populated.

Columns

Index Column Name Required Description
1 patient_demographics_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 name_id Y An ID that uniquely identifies the person’s name across all people.
4 use_raw_display N See General.
5 use_std_code N The codified value for the type of name of the person, such as current, maiden, or alternate.
6 use_std_system N See General.
7 use_std_display N See General.
8 text N The fully-formatted representation of the person name.
9 prefix N The prefix portion of the person name.
10 suffix N The suffix portion of the person name, such as degrees earned.

Patient_Name_Given

File Name

Patient_Name_Given

Description

A list of given name portions of the person’s name. For example, if a person has a first name and a middle name, the first name should have a sequence of 1 and the middle name should have a sequence of 2.

Parent File

Patient_Name

Columns

Index Column Name Required Description
1 patient_demographics_id Y The patient_demographics_id associated with this record.
2 name_id Y The name_id associated with this record.
3 operation Y See General.
4 given_id Y An ID that uniquely identifies the given name of the person across all people.
5 given Y A given name portion of the person name, such as a first or middle name.
6 sequence Y A value of 1 or 2 describing the order of this entity in the context of its parent. 1 represents first name. 2 represents middle name.

Patient_Name_Family

File Name

Patient_Name_Family

Description

A list of family name (sometimes referred to as last name or surname) portions of the person name. Some people have multiple family names.

Parent File

Patient_Name

Columns

Index Column Name Required Description
1 patient_demographics_id Y The patient_demographics_id associated with this record.
2 name_id Y The name_id associated with this record.
3 operation Y See General.
4 family_id Y An ID that uniquely identifies the family name of the person across all people.
5 family Y A family name portion of the person name.
6 sequence Y A positive (one-based) integer describing the order of this entity within the context of its parent.

Patient_Name_Title

File Name

Patient_Name_Title

Description

A list of titles associated with the person’s name, such as Mr., Ms., or Dr.

Parent File

Patient_Name

Columns

Index Column Name Required Description
1 patient_demographics_id Y The patient_demographics_id associated with this record.
2 name_id Y The name_id associated with this record.
3 operation Y See General.
4 title_id Y An ID that uniquely identifies the title of the person across all people.
5 title Y A title associated with the person name.

Patient_Identifier

File Name

Patient_Identifier

Description

The identifiers of the person.

Parent File

Patient

Columns

Index Column Name Required Description
1 patient_demographics_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 identifier_id Y An ID that uniquely identifies the alias of the person across all people.
4 type_raw_display N See General.
5 type_std_code N The codified type of the alias, such as Social Security Number (SSN) or medical record number (MRN).
6 type_std_system N See General.
7 type_std_display N See General.
8 value Y The value of the alias.
9 system Y The assigning authority of the alias. It is strongly preferred that the assigning authority be an OID.

Patient_Address

File Name

Patient_Address

Description

Patient’s address

Parent File

Patient

Children Files

Patient_Address_Line: A list of line components within an address, such as street address, apartment number, or PO Box. Typically there are between one and three address lines, such as 123 Washington Ave.

Rules

At least the Patient_Address_Line file, city field, state_std_code field, postal_code field, district_std_code field, or country_std_code field is populated. However, all may be populated.

Columns

Index Column Name Required Description
1 patient_demographics_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 address_id Y An ID that uniquely identifies the address across all people.
4 use_raw_display N See General.
5 use_std_code N The codified type of the address, such as home, business, or previous.
6 use_std_system N See General.
7 use_std_display N See General.
8 city N The city portion of the address. For example, Kansas City.
9 state_raw_display N See General.
10 state_std_code N The codified state or province portion of the address. For example, MO.
11 state_std_system N See General.
12 state_std_display N See General.
13 postal_code N The postal code or zip code portion of the address. For example, 64117.
14 district_raw_display N See General.
15 district_std_code N The codified county or parish portion of the address.
16 district_std_system N See General.
17 district_std_display N See General
18 country_raw_display N See General.
19 country_std_code N The codified country portion of the address. For example, USA.
20 country_std_system N See General.
21 country_std_display N See General.
22 period_start N The begin effective date of the address. See General.
24 period_end N The end effective date of the address. See General.

Patient_Address_Line

File Name

Patient_Address_Line

Description

A list of line components within an address, such as street address, apartment number, or PO Box. Typically there are between one and three address lines, such as 123 Washington Ave.

Parent File

Patient_Address

Columns

Index Column Name Required Description
1 patient_demographics_id Y The patient_demographics_id associated with this record.
2 address_id Y The address_id associated with this record.
3 operation Y See General.
4 line_id Y An ID that uniquely identifies the address line across all people.
5 line Y An address line, such as street address (123 Washington Ave), apartment number, or PO Box.
6 sequence Y A positive (one-based) integer describing the order of this entity within the context of its parent.

Patient_Telecom

File Name

Patient_Telecom

Description

A contact point for the patient, such as email address or telephone number.

Parent File

Patient

Columns

Index Column Name Required Description
1 patient_demographics_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 telecom_id Y An ID that uniquely identifies the telecom of the person across all people.
4 use_raw_display N See General.
5 use_std_code N The codified type of the telecom, such as home, business, or mobile.
6 use_std_system N See General.
7 use_std_display N See General.
8 value Y The telephone number or email address of the telecom, such as 123-456-7890 or johndoe@gmail.com.
9 system_std_code Y The codified communication form or system required to make use of the contact, such as phone or email.
10 system_std_system Y See General.
11 system_std_display Y See General.

Patient_Race

File Name

Patient_Race

Description

Patient race identifiers.

Parent File

Patient

Columns

Index Column Name Required Description
1 patient_demographics_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 race_id Y An ID that uniquely identifies the race of the person across all people.
4 race_raw_display N See General.
5 race_std_code N The codified race of the person.
6 race_std_system N See General.
7 race_std_display N See General.

Patient_Communication

File Name

Patient_Communication

Description

Languages that may be used to communicate with the patient about his or her health.

Parent File

Patient

Columns

Index Column Name Required Description
1 patient_demographics_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 communication_id Y An ID that uniquely identifies the language of the person across all people.
4 language_raw_display N See General.
5 language_std_code N The codified language that may be used to communicate with the patient about his or her health.
6 language_std_system N See General.
7 language_std_display N See General.

Patient_CareProvider

File Name

Patient_CareProvider

Description

The care providers associated with the patient.

Parent File

Patient

Children Files

Patient_CareProvider_Identifier: The identifiers of the care provider.

Rules

At least the care_provider_name_text field or Patient_CareProvider_Identifier file is populated. However, both may be populated.

Columns

Index Column Name Required Description
1 patient_demographics_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 care_provider_id Y An ID that uniquely identifies the relationship between a provider and a person.
4 care_provider_name_text N The fully-formatted name of the provider.
5 type_raw_display N See General.
6 type_std_code N The codified type of relationship or role the provider has to the related patient.
7 type_std_system N See General.
8 type_std_display N See General.
9 period_start N The date when the relationship was established. See General.
10 period_end N The date when the relationship ended. See General.

Patient_CareProvider_Identifier

File Name

Patient_CareProvider_Identifier

Description

A list of identifiers for the patient’s care provider.

Parent File

Patient_CareProvider

Columns

Index Column Name Required Description
1 patient_demographics_id Y The patient_demographics_id associated with this record.
2 care_provider_id Y The care_provider_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias.
5 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
6 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

PreferredDemographics

File Name

PreferredDemographics

Description

Preferred demographics of a patient.

Since the HealtheIntent platform takes in data from many different source systems, situations may occur where multiple systems have sent conflicting information about the same patient. The conflicts range from insignificant (for example, a middle initial included in one version of a patient’s name and not in others) to quite significant (for example, a patient being identified as deceased in one source and not in others). To resolve these conflicts for downstream consumers, HealtheIntent uses a feature called preferred demographics to identify a single, best value in the longitudinal record for each of several patient attributes that are received. For more information, see Understand Preferred Demographics in HealtheIntent in the Reference Pages on uCern Wiki.

Children Files

Columns

Index Column Name Required Description
1 preferred_demographics_id Y An ID that uniquely identifies the preferred demographics.
2 operation Y See General.
3 person_id Y See General.
4 name_source_person_id N See General.
5 name_contributor_id N See General.
6 name_use_raw_display N See General.
7 name_use_std_code N The codified value for the type of name of the person, such as current, maiden, or alternate.
8 name_use_std_system N See General.
9 name_use_std_display N See General.
10 name_text N The fully formatted representation of the person’s name.
11 name_prefix N The prefix portion of the person’s name.
12 name_suffix N The suffix portion of the person name, such as degrees earned.
13 address_source_person_id N See General.
14 address_contributor_id N See General.
15 address_use_raw_display N See General.
16 address_use_std_code N The codified type of the address, such as home, business, or previous.
17 address_use_std_system N See General.
18 address_use_std_display N See General.
19 address_city N The city portion of the address. For example, Kansas City.
20 address_state_raw_display N See General.
21 address_state_std_code N The codified state or province portion of the address. For example, MO.
22 address_state_std_system N See General.
23 address_state_std_display N See General.
24 address_postal_code N The postal code or zip code portion of the address. For example, 64117.
25 address_district_raw_display N See General.
26 address_district_std_code N The codified county or parish portion of the address.
27 address_district_std_system N See General.
28 address_district_std_display N See General.
29 address_country_raw_display N See General.
30 address_country_std_code N The codified country portion of the address. For example, USA.
31 address_country_std_system N See General.
32 address_country_std_display N See General.
33 address_period_start N The begin effective date of the address. See General.
34 address_period_end N The end effective date of the address. See General.
35 birth_date_source_person_id N See General.
36 birth_date_contributor_id N See General.
37 birth_date N The date of birth of the person. This field is a date without time specified. See General.
38 gender_source_person_id N See General.
39 gender_contributor_id N See General.
40 gender_raw_display N See General.
41 gender_std_code N The codified value for the gender of the person.
42 gender_std_system N See General.
43 gender_std_display N See General.
44 deceased_source_person_id N See General.
45 deceased_contributor_id N See General.
46 deceased_date_time N Date of death of the person, if known. See General.
47 deceased_boolean N A Boolean value that indicates if a person is deceased. Possible values include TRUE or FALSE.
48 telecom_source_person_id N See General.
49 telecom_contributor_id N See General.
50 telecom_use_raw_display N See General.
51 telecom_use_std_code N The codified type of the telecom, such as home, business, or mobile.
52 telecom_use_std_system N See General.
53 telecom_use_std_display N See General.
54 telecom_value N The telephone number or email address of the telecom, such as 123-456-7890 or johndoe@gmail.com.
55 telecom_system_std_code N The codified communication form or system required to make use of the contact, such as phone or email.
56 telecom_system_std_system N See General.
57 telecom_system_std_display N See General.

PreferredDemographic_NameGiven

File Name

PreferredDemographic_NameGiven

Description

A list of given name portions of the person name. For example, if a person has a first name and a middle name, the first name has a sequence of 1 and the middle name has a sequence of 2.

Parent File

PreferredDemographics

Columns

Index Column Name Required Description
1 preferred_demographics_id Y The preferred_demographics_id associated with this record.
2 operation Y See General.
3 given_id Y An ID that uniquely identifies the given name of the person across all people.
4 given Y A given name portion of the person name, such as a first or middle name.
5 sequence Y A value of 1 or 2 describing the order of this entity in the context of its parent. 1 represents first name. 2 represents middle name.

PreferredDemographic_NameFamily

File Name

PreferredDemographic_NameFamily

Description

A list of family name (sometimes referred to as last name or surname) portions of the person name. Some people have multiple family names.

Parent File

PreferredDemographics

Columns

Index Column Name Required Description
1 preferred_demographics_id Y The preferred_demographics_id associated with this record.
2 operation Y See General.
3 family_id Y An ID that uniquely identifies the family name across all people.
4 family Y A family name portion of the person name.
5 sequence Y A positive (one-based) integer describing the order of this entity within the context of its parent.

PreferredDemographic_NameTitle

File Name

PreferredDemographic_NameTitle

Description

A list of titles associated with the person’s name, such as Mr., Ms., or Dr.

Parent File

PreferredDemographics

Columns

Index Column Name Required Description
1 preferred_demographics_id Y The preferred_demographics_id associated with this record
2 operation Y See General.
3 title_id Y An ID that uniquely identifies the title of the person across all people.
4 title Y A title associated with the person name.

PreferredDemographic_AddressLine

File Name

PreferredDemographic_AddressLine

Description

A list of line components within an address, such as street address, apartment number, or PO Box. Typically there are between one and three address lines, such as 123 Washington Ave.

Parent File

PreferredDemographics

Columns

Index Column Name Required Description
1 preferred_demographics_id Y The preferred_demographics_id associated with this record.
2 operation Y See General.
3 line_id Y An ID that uniquely identifies the address line across all people.
4 line Y An address line, such as street address (123 Washington Ave), apartment number, or PO Box.
5 sequence Y A positive (one-based) integer describing the order of this entity within the context of its parent.

Procedure

File Name

Procedure

Description

Patient procedures. Procedures can be physical (such as an operation) or noninvasive (such as counseling or hypnotherapy).

Children Files

Columns

Index Column Name Required Description
1 procedure_id Y An ID that uniquely identifies this procedure for a person across all procedures for all people.
2 operation Y See General.
3 person_id Y See General.
4 source_procedure_id N An ID that uniquely identifies this procedure for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 code_raw_display N See General.
9 code_std_code Y The codified representation of the procedure. See General.
10 code_std_system Y See General.
11 code_std_display N See General.
12 sequence N An enumerated value to identify the significance or priority of a billing procedure. Possible values include PRIMARY, SECONDARY, and _NOT_RANKED.
13 code_text N The textual description of the procedure provided by the data source.
14 performed_period_start N The date and time when the procedure started, if known. See General.
15 performed_period_end N The date and time when the procedure ended, if known. See General.

Procedure_Modifier

File Name

Procedure_Modifier

Description

Modifiers associated with patient procedures.

Parent File

Procedure

Columns

Index Column Name Required Description
1 procedure_id Y The parent entity with which the entity is associated.
2 operation Y See General.
3 modifier_id Y An ID that uniquely identifies the modifier across all procedures for all people.
4 modifier_raw_display N See General.
5 modifier_std_code N The codified modifier of the procedure. See General.
6 modifier_std_system N See General.
7 modifier_std_display N See General.

Procedure_Performer

File Name

Procedure_Performer

Description

Providers who performed a patient procedure.

Parent File

Procedure

Children Files

Procedure_Performer_Identifier: A list of identifiers for the provider who performed the procedure.

Rules

At least the actor_name_text field or Procedure_Performer_Identifier file is populated. However, both may be populated.

Columns

Index Column Name Required Description
1 procedure_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 performer_id Y An ID that uniquely identifies the provider relationship to the procedure across all procedure provider relationships for all people.
4 actor_name_text N The fully-formatted name of the provider who performed the procedure.
5 role_raw_display N See General.
6 role_std_code N The codified role of the provider who performed the procedure, such as surgeon or anesthesiologist.
7 role_std_system N See General.
8 role_std_display N See General.
9 period_start N The begin date and time of the provider’s relationship to the procedure. See General.
10 period_end N The end date and time of the provider’s relationship to the procedure. See General.

Procedure_Performer_Identifier

File Name

Procedure_Performer_Identifier

Description

Identifiers of providers who performed patient procedures.

Parent File

Procedure_Performer

Columns

Index Column Name Required Description
1 procedure_id Y The procedure_id associated with this record.
2 performer_id Y The performer_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the provider who performed the procedure.
5 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
6 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

Procedure_Note

File Name

Procedure_Note

Description

Notes associated with patient procedures.

Parent File

Procedure

Children Files

Procedure_Note_AuthorIdentifier: A list of identifiers for the provider who authored the comment.

Columns

Index Column Name Required Description
1 procedure_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 note_id Y An ID that uniquely identifies the note across all procedure notes for all people.
4 text Y The text of the comment.
5 time N The date of the comment. See General.
6 author_name_text N The fully-formatted name of the provider who authored the note, if known.

Procedure_Note_AuthorIdentifier

File Name

Procedure_Note_AuthorIdentifier

Description

Identifiers of the providers who authored patient procedure notes.

Parent File

Procedure_Note

Columns

Index Column Name Required Description
1 procedure_id Y The procedure_id associated with this record.
2 note_id Y The note_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the author of a procedure note.
5 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
6 type_text Y An enumerated value for the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

QuestionnaireResponse

File Name

QuestionnaireResponse

Description

A questionnaire that contains a set of questions and their answers.

Children Files

Rules

The QuestionnaireResponse_QuestionGroup file is required.

Columns

Index Column Name Required Description
1 questionnaire_response_id Y An ID that uniquely identifies the questionnaire across all questionnaires for all people.
2 operation Y See General.
3 person_id Y See General.
4 source_questionnaire_response_id N An ID that uniquely identifies this questionnaire for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 questionnaire_concept_raw_display N See General.
9 questionnaire_concept_std_code N The codified name of the questionnaire.
10 questionnaire_concept_std_system N See General.
11 questionnaire_concept_std_display N See General.
12 status_raw_display N See General.
13 status_std_code N The codified status of the questionnaire, such as in progress, completed, or amended.
14 status_std_system N See General.
15 status_std_display N See General.
16 author Y An enumerated value to indicate who recorded the answers of the questionnaire. Possible values include SELF, PROVIDER, and _NOT_RECOGNIZED.
17 authored N The date when the questionnaire was recorded. See General.

QuestionnaireResponse_Action

File Name

QuestionnaireResponse_Action

Description

The actions taken on the questionnaire.

Parent File

QuestionnaireResponse

Children Files

QuestionnaireResponse_Action_ActorIdentifier: A list of identifiers for the provider who took the action on the questionnaire.

Rules

At least the actor_name_text field, the date_time field, or the QuestionnaireResponse_Action_ActorIdentifier file is populated. However, all three may be populated

Columns

Index Column Name Required Description
1 questionnaire_response_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 action_id Y An ID that uniquely identifies the action across all questionnaire actions for all people.
4 type_raw_display N See General.
5 type_std_code N The codified type of action taken on the questionnaire, such as create, review, and modify.
6 type_std_system N See General.
7 type_std_display N See General.
8 date_time N The date and time the action was taken. See General.
9 actor_name_text N The fully-formatted name of the provider who took the action on the questionnaire.

QuestionnaireResponse_Action_ActorIdentifier

File Name

QuestionnaireResponse_Action_ActorIdentifier

Description

Identifiers for the provider who took the action on the questionnaire.

Parent File

QuestionnaireResponse_Action

Columns

Index Column Name Required Description
1 questionnaire_response_id Y The questionnaire_response_id associated with this record.
2 action_id Y The action_id associated with this record.
3 operation Y See General.
4 identifier_id Y The ID that uniquely identifies the provider alias. The identifier belongs to the provider who took action on the questionnaire.
5 value Y The value of the provider alias, such as the provider NPI, DEA, or Tax ID.
6 type_text Y An enumerated value to represent the type of alias. Possible values include NPI, DEA, TAX, SL, EXTERNAL, UPIN, EI, and _NOT_RECOGNIZED.
7 system N The system that assigned the identifier value, if known. Generally, this is an OID (for example, 2.16.840.1.113883.4.6 for NPI).

QuestionnaireResponse_QuestionGroup

File Name

QuestionnaireResponse_QuestionGroup

Description

A group or section of questions within a questionnaire.

Parent File

QuestionnaireResponse

Children Files

QuestionnaireResponse_QuestionGroup_Question: A question within a questionnaire response group

Rules

The QuestionnaireResponse_QuestionGroup_Question file is required.

Columns

Index Column Name Required Description
1 questionnaire_response_id Y The parent entity with which this record is associated.
2 operation Y See General.
3 group_id Y An ID that uniquely identifies the group of questions across all questionnaire groups for all people.
4 source_group_id N An ID that uniquely identifies this group of questions within a questionnaire for a person in the data source from which the entity originated.
5 concept_raw_display N See General.
6 concept_std_code N The codified name of the section or group of questions. See General.
7 concept_std_system N See General.
8 concept_std_display N See General.
9 title N The display name of the section or group of questions as it is shown to the user.

QuestionnaireResponse_QuestionGroup_Question

File Name

QuestionnaireResponse_QuestionGroup_Question

Description

A question within a questionnaire response group.

Parent File

QuestionnaireResponse_QuestionGroup

Children Files

QuestionnaireResponse_QuestionGroup_Question_Answer: The answer to a question within a questionnaire response.

Rules

At least the text field or concept_std_code field is populated. However, both may be populated. The QuestionnaireResponse_QuestionGroup_Question_Answer is required.

Columns

Index Column Name Required Description
1 questionnaire_response_id Y The questionnaire_response_id associated with this record.
2 group_id Y The group_id associated with this record.
3 operation Y See General.
4 question_id Y An ID that uniquely identifies the question within the questionnaire across all questionnaires for all people.
6 concept_raw_display N See General.
7 concept_std_code N The codified value for the name of the question. See General.
8 concept_std_system N See General.
9 concept_std_display N See General.
10 text N The display name of the question as it is shown to the user.

QuestionnaireResponse_QuestionGroup_Question_Answer

File Name

QuestionnaireResponse_QuestionGroup_Question_Answer

Description

Answer to a question within a questionnaire response.

Parent File

QuestionnaireResponse_QuestionGroup_Question

Rules

Only one of the following fields is populated: value_quantity_value, value_string, value_date_time, or value_code_std_code. * If the value_type is NUMERIC, then the value_quantity_value field is populated. * If the value_type is CODIFIED, then the value_code_std_code field is populated. * If the value_type is TEXT, then the value_string field is populated. * If the value_type is DATE, then the value_date_time field is populated.

Columns

Index Column Name Required Description
1 questionnaire_response_id Y The questionnaire_response_id associated with this record.
2 group_id Y The group_id associated with this record.
3 question_id Y The question_id associated with this record.
4 operation Y See General.
5 answer_id Y The ID that uniquely identifies the answer across all questionnaires for all people.
6 value_type N An enumerated value to identify the type of answer. Possible values include NUMERIC, CODIFIED, TEXT, DATE, _NOT_RECOGNIZED, and _NOT_VALUED.
7 value_quantity_code_raw_display N See General.
8 value_quantity_code_std_code N The codified unit of measure associated with the value, such as mg/dL, lbs, or seconds. See General.
9 value_quantity_code_std_system N See General.
10 value_quantity_code_std_display N See General.
11 value_quantity_value N A decimal value that represents an answer when the value_type = NUMERIC.
12 value_quantity_comparator N The symbol or characters that modify the quantity_value, such as >, <, or >= .
13 value_string N The textual value that represents an answer when the value_type = TEXT.
14 value_date_time N The date and time value that represents an answer when the value_type = DATE. See General.
15 value_code_raw_display N See General.
16 value_code_std_code N The codified value of the answer when the value_type = CODIFIED. See General.
17 value_code_std_system N See General.
18 value_code_std_display N See General.
19 sequence N A non-negative integer describing the sequence, order, or priority of the codified value when a question has multiple codified answers.

RiskAssessment

File Name

RiskAssessment

Description

A risk score for a patient, such as a readmission risk score.

Children Files

RiskAssessment_Basis: Information used in the risk assessment.

Rules

At least the prediction_probability_decimal field or prediction_relative_risk field is populated. However, both may be populated.

Columns

Index Column Name Required Description
1 risk_assessment_id Y An ID that uniquely identifies the risk assessment across all risk assessments for all people.
2 operation Y See General.
3 person_id Y See General.
4 source_risk_assessment_id N An ID that uniquely identifies this risk assessment for a person in the data source from which the entity originated.
5 source_person_id Y See General.
6 source_encounter_id N See General.
7 contributor_id Y See General.
8 type Y An enumerated value for the type of the risk assessment. Possible values include READMISSION, BMI, CHOLESTEROL, BLOOD_PRESSURE, EXERCISE, BLOOD_GLUCOSE, DRUG_ALCOHOL, EMOTIONAL, NUTRITIONAL, PREVENTIVE_HEALTH, SAFETY, TOBACCO, MARA_TOTAL, HRA, ACUITY, and _NOT_RECOGNIZED.
9 prediction_probability_decimal N A decimal value that represents the risk score.
10 prediction_relative_risk N A decimal value that represents the normalized risk score.
11 prediction_probability_codeable_concept_raw_display N See General.
12 prediction_probability_codeable_concept_std_code N The codified interpretation of the risk score, such as high, moderate, or low. See General.
13 prediction_probability_codeable_concept_std_system N See General.
14 prediction_probability_codeable_concept_std_display N See General.
15 date_time N The date and time when the risk assessment was performed. See General.

RiskAssessment_Basis

File Name

RiskAssessment_Basis

Description

Information used in the risk assessment.

Parent File

RiskAssessment

Columns

Index Column Name Required Description
1 risk_assessment_id Y The parent entity with which this entity is associated.
2 operation Y See General.
3 basis_id Y An ID that uniquely identifies the basis across all risk assessments for all people.
4 source_basis_id Y An ID that uniquely identifies this basis for a risk assessment in the data source from which the entity originated. For example, if the type is QUESTION, then the source_basis_id is the source_question_id. By contrast, if the type is QUESTIONNAIRE, then the source_basis_id is the source_questionnaire_response_id.
5 type Y An enumerated value that identifies the type of the basis of the risk score, such as QUESTIONNAIRE, QUESTIONNAIREGROUP, QUESTION, CONDITION, CLAIM, SERVICELINE, REFERRALREQUEST, or SUMMARYPERSONRECORD.
6 source_entity_id N An ID that uniquely identifies the top level entity of the basis for a risk assessment in the data source from which the entity originated. For example, if the type is QUESTION, QUESTIONNAIREGROUP, or QUESTION, then the source_entity_id is the source_questionnaire_response_id. By contrast, if the type is CLAIM or SERVICELINE, then the source_entity_id is the source_claim_id.

SummaryofExtract

File Name

SummaryofExtract

Description

A summary of the file extracts, which includes the total number of records in each file per operation (Insert or Delete). The complete extract file includes the full list of configured data sets. The incremental extracts include only the files that qualified for extraction.

Columns

Index Column Name Required Description
1 Entity Name Y The name of the entity, which corresponds to a file name.
2 I Y The number of records with an ‘operation’ value of ‘I’ (insert/update).
3 D Y The number of records with an ‘operation’ value of ‘D’ (delete).