EHI Export Implementation Guide
0.1.0 - ci-build

EHI Export Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

All Assessments Export

As part of the Electronic Health Information (EHI) Bulk Data Export, all Assessments data is included. The Assessments data is exported in tabular Comma Separated Value (CSV) files. These files are generated in the following directory structure:

  • [Patient ID]
    • [Patient ID].json
    • [Patient ID]-manifest.json
      • non_mds_assessments
        • [Assessment ID]
          • assessment.csv
          • sections.csv
          • score.csv
          • responses.csv
          • sdoh_and_health_status_responses.csv

All assessments that are not contained in MDS are included in the "non_mds_assessments" directory for the corresponding patient.

File Description
assessment.csv Generated one file per Assessment. Contains name and description of the Assessment and other top-level information. All other files generated in the folder pertain to the assessment referenced in this file.
sections.csv References and identifiers pertaining to individual sections of the Assessment. The sections depend on the assessment.
score.csv Scoring for the assessment
responses.csv Individual responses were captured per question.
sdoh_and_health_status_responses.csv Detailed response data for Social Determinants of Health (SDOH) and Health Status Evaluation assessments for the assessment.

CSV Schema

assessment.csv

Column Type Nullable Description
assess_id Int No Primary Key for the Assessment
name String No Name of the facility where Patient's Assessment was captured
std_assess_id Int No The key of the Assessment Type
description String No The Assessment Type name
created_by String No The EHR User who created the Assessment
created_date Date Time No The date and time when the Assessment was created
revision_by String No The EHR User who last updated the Assessment
revision_date Date Time No The date and time when the Assessment was last updated
client_id Int No The key of the facility resident of the Assessment
is_mds String No Yes/No is this an MDS Assessment
assess_type_code String No Item Set Code (ISC) for the Assessment
assess_date Date Time No Assessment creation Date
status String No Assessment completion status code
adl_score Int Yes The RUG Activities of Daily Living (ADL) index score of the Assessment
adl_date Date Time Yes The date and time when the ADL Score was last computed for the Assessment
raps_date Date Time Yes The date and time when the Care Area Triggers (CAT) were last computed for the Comprehensive Assessment
rugs_index Int Yes The Medicare/Insurance RUG Score index for the Assessment
rugs_date Date Time Yes The date and time when the RUG Score was last computed for the Assessment
rugs_error String Yes The error message when the RUG Score was last computed for the Assessment
prov_state String Yes The facility's State abbreviation code assigned when the Assessment was created
batch_id Int Yes The key of the submission batch for the Assessment
edited_by String No The EHR User who last edited the Assessment
edited_date Date Time No The date and time when the Assessment was last edited
locked_date Date Time Yes The date and time when the Assessment was last locked
incorrect_assess_id Int Yes The key of Modified or Canceled Assessment
cmi_set_fed String Yes The Federal CMI Weight Set model code used for RUG Score calculation of the Assessment
cmi_set_state String Yes The State CMI Weight Set model code used for RUG Score calculation of the Assessment
rugs_index_state Int Yes The State Medicaid RUG Score index for the Assessment
rugs_error_state String Yes The error message when the state Medicaid RUG Score was last computed for the Assessment
cmi_fed Double Yes The Federal CMI Weight result from RUG Score calculation of the Assessment
cmi_state Double Yes The State CMI Weight result from RUG Score calculation of the Assessment
calc_type_fed String Yes The Federal RUG Score classification method for the Assessment
calc_type_state String Yes The State RUG Score classification method for the Assessment
rugs_date_state Date Time Yes The date and time when the State Medicaid RUG code was last computed for the Assessment
score2 String Yes The Alternate State Medicaid RUG HIPPS code for the Assessment
score3 String Yes The Alternate State Medicaid RUG index for the Assessment
cmi_code_fed String Yes The Federal RUG HIPPS code for the Assessment
cmi_code_state String Yes The State Medicaid RUG HIPPS code for the Assessment
submit_by_date Date Time Yes The date by when the Assessment must be submitted
mpaf String Yes Is a Medicare Prospective Payment System Assessment Form assessment
assess_ref_date Date Time No The Assessment Reference Date
primary_reason_code String Yes Always null for non MDS assessment
secondary_reason_code String Yes Always null for non MDS assessment
facesheet String Yes Always null for non MDS assessment
doublescore1 Double Yes The Alternate State RUG CMI Weight result from RUG Score calculation of the Assessment
tertiary_reason_code String Yes Always null for non MDS assessment
cps Int Yes The RUG calculation Cognitive Performance Scale (CPS) function score for the Assessment
pain_scale Int Yes The RUG calculation Pain Scale function score for the Assessment
drs Int Yes The RUG calculation Depression Rating Scale (DRS) function score for the Assessment
communication_scale Int Yes The RUG calculation Communication Scale function score for the Assessment
adl_short Int Yes The RUG ADL Short function score of the Assessment
adl_long Int Yes The RUG ADL Long function score of the Assessment
adl_hier Int Yes The RUG ADL Hierarchy function score of the Assessment
ise Int Yes The RUG calculation Index of Social Engagement (ISE) function score for the Assessment
maple_date Date Time Yes The date when the CIHI Method for Assigning Priority Levels (MAPLe) determination was made
consent_status String Yes Assessment Consent status level
consent_reason String Yes Assessment Consent status reason
import_process_id Int Yes The key of the Import Assessment batch
import_status String Yes The imported status of the Assessment
verify_id Int Yes The key of the verification log for the Assessment
sub_req Int Yes Submission Required status for the Assessment
prod_assess_id Int Yes The external key of the production Assessment migrated into PointClickCare system
migrate_error String Yes The migration error status description for the Assessment
include_cmi_state_flag String Yes Yes/No to include State cmi value
include_cmi_fed_flag String Yes Yes/No to include Federal cmi value
raps_type String Yes Always null for non MDS assessment
completed_date Date Time Yes The date and time when the Assessment status was set to Complete
effective_cmi_date Date Time Yes The start date and time for the CMI Value of the Assessment
reg_id Int Yes The key of the Facility's Region assignemnt for the Assessment
export_filter_date Date Time Yes The CIHI Consent Export date and time of the Assessment
version_code String Yes Assessment print eletronic signatures indicator
confirmed_by String Yes The EHR User who validated/confirmed the Assessment
confirmed_date Date Time Yes The date and time when the Assessment was validated/confirmed
temp_cmi_fed Double Yes Always null for non MDS assessment
temp_cmi_code_fed String Yes Always null for non MDS assessment
temp_rugs_index Int Yes Always null for non MDS assessment
chess_score Int Yes The Clinical Hepatic Encephalopathy Staging Scale (CHESS) function score for the Assessment
inquiry_id Int Yes The key of the Referal Inquiry request for the Assessment
effective_date Date Time Yes The start date and time of the Assessment
ineffective_date Date Time Yes The stop date and time of the Assessment
hipps_modifier String Yes The RUG/PDPM Assessment Indicator (AI) code also known as HIPPS Modifier for the Assessment
strikeout_flag String Yes Yes/No indicator denoting the Assessment was struck from the chart
strikeout_desc String Yes The reason the Assessment was struck from the chart
strikeout_by String Yes The EHR User who struck out the Assessment from the chart
strikeout_date Date Time Yes The start date and time when User struck out the Assessment from the chart
abs Int Yes The RUG calculation Aggressive Behavior Scale (ABS) function score for the Assessment
alt_cmi_set_state String Yes The Alternate State CMI Weight Set model code used for RUG Score calculation of the Assessment
alt_calc_type_state String Yes The Alternate State RUG Score classification method for the Assessment
used_for_payment Int No Indicator that the Assessment will be used for payment purposes
submission_req String Yes Yes/No indicator that submission is required for the Assessment

sections.csv

Column Type Nullable Description
section_code String No Primary Key for the Assessment
title String No The Assessment Section name
sequence Int No The Assessment Section order indicator
description String Yes Additional Section name information
complete String Yes Section complete status of the Assessment
created_by String No The EHR User who created the Assessment
created_title String Yes The EHR User's title who created the Assessment
created_date Date Time No The date and time when the Assessment Section was created
notes String Yes Comment and notation for the Assessment section

score.csv

Column Type Nullable Description
description String No The RUG or PDPM calculation score type title
score String Yes The RUG or PDPM calculation score value

responses.csv

Column Type Nullable Description
assess_response_id Int No Primary Key for the Assessment Response
question_key String No The Question Key assigned to the response value
control_type String No The Question Key user interface data entry control assigned to the response value
title String Yes The Question Title assigned to the Question Key
question_text String No The Question Text assigned to the Question Key
item_value String Yes The last entered assessment Response value assigned to the Question Key
item_description String Yes The text description assigned to the Question Key Response value
revision_by String No The EHR User who last edited the question key response value
revision_date Date Time No The date and time when the question response was last updated

sdoh_and_health_status_responses.csv

Column Type Nullable Description
question_key String No The unique key assigned to the question in the assessment
item_value String Yes The response value for the question; formatted as MM/dd/yyyy for date type questions
long_username String Yes The full name of the EHR user who entered or updated the response
assess_id String No The unique identifier for the assessment
assess_date Date No The date when the assessment was performed
question_code String Yes The terminology code assigned to the question
question_display String Yes The display text for the question code
question_system String Yes The code system for the question terminology
group_type String Yes The group type classification for the question
response_code String Yes The terminology code assigned to the response
response_display String Yes The display text for the response code
response_system String Yes The code system for the response terminology
question_text String No The text of the question as defined in the assessment
control_type String No The user interface control type for the question (e.g., text, date, checkbox, radio)