Documentation Index
Fetch the complete documentation index at: https://help.elationhealth.com/llms.txt
Use this file to discover all available pages before exploring further.
Current entity relation diagram is located at https://dbdocs.io/hosteddb_support/hosted_database_snowflake
Pre-release entity relation diagram is located at https://dbdocs.io/hosteddb_support/hosted_database_snowflake_prerelease
Release 12-16-2025
[1.9]
office_messages
- Added
- report_id
- If a report is attached to the message this will join to the report table
office_messages_recipients
-
Added
- removed_from_thread
- If the recipient was removed from the thread
- removed_at
- timestamp the recipient was removed at
appointment
patient_problem
- fixed a bug where a duplicate row with its own unique key would show up due to incorrect fields being included.
- All unique keys for this table will change due to this fix.
med_order
-
Added
- supervising_physician_id
- fulfillment_state - state of the prescription
- options are: new failure error sent complete pending_complete denied sending
- num_sample
- If the medication is a sample this will be filled
- patient_adherence
provider_letter
- Added
- viewed_at - timestamp it was initially viewed
referral_order
- Removed
- clinical_reason
- It is recommended to use the body column since it is pulled from the body of the referral.
patient_phone
- fixed bug where deletions would be hidden.
- When someone went into the chart and manually removed a phone number it was filtered out. It will now show up as an empty phone number and not deleted.
New Elation Note Tables!
- Note these are still beta and may be altered without notification
- The old visit note tables (vn2_*)will be removed.
-
elation_note
- This is the table where you can find the cleaned related data to reconstruct the custom blocks by note.
- Pre-made blocks that you did not specifically make will not be here but can be found in the visit_note table.
- A comprehensive copy of the note will be in the existing visit_note table. This can be found by joining on visit_note_id.
| Column Name | Column Type |
|---|
| VISIT_NOTE_ID | NUMBER(38,0) |
| EL8_NOTE_ID | NUMBER(38,0) |
| PRACTICE_ID | NUMBER(38,0) |
| PATIENT_ID | NUMBER(38,0) |
| CUSTOM_BLOCK_SNAPSHOT_ID | NUMBER(38,0) |
| QUESTION_ID | NUMBER(38,0) |
| FIELD_NAME | VARCHAR(1024) |
| QUESTION_TYPE | VARCHAR(255) |
| QUESTION_TEXT | VARCHAR(65535) |
| RESPONSE | VARCHAR(16777216) |
| REQUIRED | BOOLEAN |
| IS_VISIBLE | BOOLEAN |
| WAREHOUSE_ID | NUMBER(38,0) |
| IS_DELETED | BOOLEAN |
| HDB_LAST_SYNC | TIMESTAMP_TZ(9) |
-
elation_note_structured_data
- This contains more granular data about the form data and links to other tables for additional data on the question etc
- This will not change when the questions or blocks are updated and will continue to reflect what is present in the note
| Column Name | Column Type |
|---|
| ID | NUMBER(38,0) |
| VERSIONED_CUSTOM_BLOCK_ID | NUMBER(38,0) |
| EL8_NOTE_ID | NUMBER(38,0) |
| PRACTICE_ID | NUMBER(38,0) |
| QUESTION_ID | NUMBER(38,0) |
| VISIBLE | BOOLEAN |
| FIELD_NAME | VARCHAR(1024) |
| FIELD_VALUE | VARCHAR(16777216) |
| CREATED_AT | TIMESTAMP_NTZ(9) |
| EDITED_AT | TIMESTAMP_NTZ(9) |
| DELETED_AT | TIMESTAMP_NTZ(9) |
| IS_DELETED | BOOLEAN |
| WAREHOUSE_ID | NUMBER(38,0) |
| HDB_LAST_SYNC | TIMESTAMP_TZ(9) |
-
elation_note_response_option
-
details on the response options for each individual question
- If the question_type is one of checkbox, dropdown, radio buttons then the entered response will be located under elation_note_response_option.response_text.
- All other question responses are located in the elation_note_structured_data.field_value and do not populate a response option row.
-
This may drift from the elation_note table as the responses are updated.
| Column Name | Column Type |
|---|
| ID | NUMBER(38,0) |
| PRACTICE_ID | NUMBER(38,0) |
| QUESTION_ID | NUMBER(38,0) |
| RESPONSE_VALUE | VARCHAR(65535) |
| RESPONSE_TEXT | VARCHAR(65535) |
| CREATED_AT | TIMESTAMP_NTZ(9) |
| EDITED_AT | TIMESTAMP_NTZ(9) |
| DELETED_AT | TIMESTAMP_NTZ(9) |
| IS_DELETED | BOOLEAN |
| WAREHOUSE_ID | NUMBER(38,0) |
| HDB_LAST_SYNC | TIMESTAMP_TZ(9) |
-
elation_note_question
- Detailed information on the current state of a question.
- This may drift from the elation_note table as the question is updated.
| Column Name | Column Type |
|---|
| ID | NUMBER(38,0) |
| PRACTICE_ID | NUMBER(38,0) |
| FIELD_NAME | VARCHAR(1024) |
| QUESTION_TYPE | VARCHAR(255) |
| QUESTION_TEXT | VARCHAR(65535) |
| REQUIRED | BOOLEAN |
| CREATED_AT | TIMESTAMP_NTZ(9) |
| EDITED_AT | TIMESTAMP_NTZ(9) |
| DELETED_AT | TIMESTAMP_NTZ(9) |
| IS_DELETED | BOOLEAN |
| WAREHOUSE_ID | NUMBER(38,0) |
| HDB_LAST_SYNC | TIMESTAMP_TZ(9) |
-
elation_note_custom_block_snapshot
- This is the metadata of the custom block at the elation note is created. It will always match the the elation note that points at it and is static
- The custom_block_id foreign key references the custom_block it was originally created from. The custom block it was created from may have been altered numerous times since the snapshot was created and therefor may not have any similarities.
| Column Name | Column Type |
|---|
| ID | NUMBER(38,0) |
| CUSTOM_BLOCK_ID | NUMBER(38,0) |
| PRACTICE_ID | NUMBER(38,0) |
| CUSTOM_BLOCK_SNAPSHOT | VARIANT |
| CREATED_AT | TIMESTAMP_NTZ(9) |
| EDITED_AT | TIMESTAMP_NTZ(9) |
| DELETED_AT | TIMESTAMP_NTZ(9) |
| WAREHOUSE_ID | NUMBER(38,0) |
| HDB_LAST_SYNC | TIMESTAMP_TZ(9) |
-
elation_note_custom_block
- This may drift from the elation_note table as the responses are updated.
- This is the current active state of the custom block. When a custom block is updated by any method, this will change and therefore will not necessarily reflect what is in each note.
| Column Name | Column Type |
|---|
| ID | NUMBER(38,0) |
| PRACTICE_ID | NUMBER(38,0) |
| LABEL | VARCHAR(65535) |
| CURRENT_STATE_SNAPSHOT | VARIANT |
| COPIED_FROM_BLOCK_ID | NUMBER(38,0) |
| CREATED_AT | TIMESTAMP_NTZ(9) |
| CREATED_BY_USER_ID | NUMBER(38,0) |
| EDITED_AT | TIMESTAMP_NTZ(9) |
| DELETED_AT | TIMESTAMP_NTZ(9) |
| WAREHOUSE_ID | NUMBER(38,0) |
| HDB_LAST_SYNC | TIMESTAMP_TZ(9) |
Release 01-15-2025
[1.8]
physician_license
-
added to provide more insight into multi-state licensing details
- dea
- rx_auth
- credentials
- supervising_physician_id
visit_note_document_tag
- added
- is_deleted
- This is a bug that has been fixed. Tags that are deleted will show up as ‘true’
non_visit_note_document_tag
- added
- is_deleted
- This is a bug that has been fixed. Tags that are deleted will show up as ‘true’
clinical_form_collection
-
The clinical_form_collection table now maintains its’ own loinc code. The table has been updated to reflect this.
passport
- added
- chart_feed_date
- where the record is located in the patients chronological record
patient
-
added
- last_patient_status_change
- primary_ethnicity
- detailed_primary_ethnicity
- secondary_ethnicity
- detailed_secondary_ethnicity
-
removed
- ethnicity
- This has been renamed to primary_ethnicity to accommodate the detailed the secondary ethnicity fields
Release 07-29-2024
[1.7]
Infrastructure changes only.
No schema changes.
Release 02-13-2024
[1.6]
<https://dash.readme.com/project/elationhdb/v1.6/refs/2023-02-13>
medication_rxnorm
- is_deleted flag added
- This allows filtering out deleted medications and shows why there are a few duplicates
patient
-
Updated the Sexual Orientation values
-
Old values
- Unknown / Don’t Know
- Straight or heterosexual
- Lesbian, gay or homosexual
- Bisexual
- Something else, please describe
- Choose Not to Disclose
- N
-
New values
- Unknown
- Straight
- Gay
- Bisexual
- Option not listed
- Prefer not to say
- Lesbian
- Queer
- Asexual
- null
-
Updated sex options
-
Old values
-
New values
- Male
- Female
- Intersex/Other
- Unknown
- null
appointment
- in_person_or_virtual added
- This represents which button was chosen when an appointment was made in person or virtual
- instructions added
Release 11-07-2023
[1.5]
med_order
- days_supply added
- This days_supply refers to non-surescripts user created prescriptions
patient
-
pref_service_location_id added
- patient.pref_service_location_id => service_location.id
-
full_name added
-
consent added
- whether patient consented to external data sharing
-
gender_identity updated
-
previously the options were
- Unknown/Don’t Know
- Identifies as Male
- Identifies as Female
- Female-to-Male (FTM) / Transgender Male / Trans Man
- Male-to-Female (MTF) / Transgender Female / Trans Woman
- Genderqueer, neither exclusively male nor female
- Additional gender category or other, please describe
- Choose Not to Disclose
- N
-
Options now correlate with the app
- Unknown
- Man
- Woman
- Transgender man / trans masculine
- Transgender woman / trans feminine
- Non-binary / genderqueer / gender fluid
- Option not listed
- Prefer not to say
- Two spirit
- N
master_patient
- duplicate column canonical_physician_id removed
- use primary_care_provider_id
patient_insurance
passport
- minor bug where there was an issue showing deleted unsigned records
referral_order_dx
-
"UQ_REFERRAL_ORDER_DX" VARCHAR(32)
"ID" "NUMBER(38, 0)" [pk]
"ICD10CODE_ID" "NUMBER(38, 0)"
"REFERRALORDER_ID" "NUMBER(38, 0)"
"WAREHOUSE_ID" "NUMBER(38, 0)"
"IS_DELETED" BOOLEAN
"HDB_LAST_SYNC" timestamp(9)
Release 10-05-2023
[1.4]
Physician_license
Provider_availability
Patient
Visit_note
-
Added
- time_with_patient
- time_documenting
Release 09-06-2023
[1.3]
Patient
-
Added
- primary_care_provider_id
- primary_care_provider_npi
- pronouns
Release 08-01-2023
[1.2]
Patient
Referral_Order
- Fixed
- uq_referral_order
- uq_referral_order column logic was updated to fix incremental issue.
Visit_Note_Bullet
- Added
- is_deleted
- added is_deleted field to account for hard and soft deletes.
User
- Added
- direct_message_address
- customers can easily pull a list of all the direct message addresses that have been set-up for them.
Report_Document_Tag
- Added
- is_deleted
- added is_deleted field to account for hard and soft deletes
Patient_Insurance
Hot Fix 6-7-2023
Patient_Employer
- Added
- is_deleted
- Practice can know if the order is deleted or not.
Release 5-12-2023
[1.1.1]
Referral_order
-
Added
- processing_status
- Practice wants to be able to view the processing status of their referrals
- resolution_state
- Practices can easily pull a list of all referrals that are marked as outstanding vs fulfilled vs. canceled
- is_deleted
- Practice can know if the order is deleted or not.
-
Fixed
- fax_status
- This column had not been updating due to a backend change, this is now fixed
Misc_orders
-
Added
- is_deleted
- Practice can know if the order is deleted or not.
- resolution_state
- Practices can easily pull a list of order that are marked as outstanding vs fulfilled vs. canceled
Deprecated [1.1.1]
Patient_tag
- Removed
- is_deleted
- To follow coding standards we added deletion_time column, therefore is_deleted column was no longer needed
Document_tag
- Removed
- is_deleted
- To follow coding standards we added deletion_time column, therefore is_deleted column was no longer needed
Patient
- Removed
- primary_practice_provider_user_id (duplicate column)
Patient_HCC
- Removed
- valid_till has been updated to last_calculated which is a more accurate description
Released 4-14-2023
[1.1]
Patient_tag
-
Added
- creation_time
- created_by_user_id
- deletion_time
- deleted_by_user_id
-
Removed
- is_deleted
- To follow coding standards we added deletion_time column, therefore is_deleted column was no longer needed
Document_tag
-
Added
- creation_time
- created_by_user_id
- deletion_time
- deleted_by_user_id
-
Removed
- is_deleted
- To follow coding standards we added deletion_time column, therefore is_deleted column was no longer needed
Patient_HCC
- Column Name Changed
- valid_till has been updated to last_calculated which is a more accurate description
Patient
- Added
- Removed
- primary_practice_provider_user_id (duplicate column)
Released 4-7-2023
[1.0.1]
Appointments
- Added service_location_id
- foreign key to service_location_id
Service_location
Released 3-9-2023
[1.4beta][1.0]
bill_item_dx
-
Deleted
- icd10_id
- icd9_id
- is_deleted
-
Added
- icd9_code
- icd10_code
- bill_item_deletion_time
- deletelog_id
visit_note_bullet
- Added
- replaced_by_visit_note_bullet_id
Released 2-13-2023
[1.3beta]
clinical_form_collection
- is_deleted [True/False] added
visit_note_bullet
-
Added
- last_modified
- visit_note_deletion_time
- visit_note_deleted_by_user_id
Release 12/21/2022
[1.2beta]
UML for this change is located at https://dbdocs.io/hosteddb_support/hosted_database_snowflake_v1_2
Unique Keys have been updated and will need a full rebuild for those doing incremental updates.
Added the field ‘is_deleted’ (boolean) to the following tables. (Add the timestamps on the roadmap)
- bill_item_dx
- canonical_physician
- document_tag
- imo
- lab_result
- med_order_fill
- non_visit_note_bullet
- patient_phone
- patient_tag
- patient_insurance
Added columns to the following tables
-
patient_vendor_identifier
-
patient_problem_code
- creation_time
- created_by_user_id
- deletion_time
- deleted_by_user_id
-
other_vital_item
-
appointment
- removed status column
- to get status join appointment_status.appointment_id = appointment.id
Released 12/12/2022 hotfix
[1.1beta]**
UML for this change is located at https://dbdocs.io/hosteddb_support/hosted_database_snowflake_inc
- Added column for unique key to each table “uq_{tablename}”
- Added column for when column was synced “hdb_last_sync”
Version 1.0beta
The current beta UML is located at https://dbdocs.io/hosteddb_support/hosted_database_snowflake_beta
-
View lab_report has been removed and replaced by table report
-
View lab_report_addendum has been removed and replaced by table report_addendum
-
View lab_report_document_tag has been removed and replaced by table report_document_tag
-
passport_messages has been removed and replaced by passport_message_thread
ID NUMBER,
PASSPORT_ID NUMBER,
MESSAGE VARCHAR,
SENT_FROM VARCHAR(407),
USER_TYPE VARCHAR(9),
USER_ID NUMBER,
MESSAGE_THREAD_CREATION_TIME TIMESTAMPNTZ,
CREATION_TIME TIMESTAMPNTZ,
CREATED_BY_USER_ID NUMBER,
SIGNED_TIME TIMESTAMPNTZ,
SIGNED_BY_USER_ID NUMBER,
WAREHOUSE_ID NUMBER
-
med_order_fill.medication_ strength column has been removed please use medication_strength
-
visit_note_bullet columns imo_code, icd9, and icd10 have been removed
Can you grant me write permissions?
2023-02-13 [Ver 1.6]