ClarityTableMetad
This table contains a list of table (E0B) records that exist in the Clarity Compass along with pertinent information including the name, how often the table is loaded, how the table is loaded, related master file details, and Oracle®-related settings.
| Column Name | Type | Description |
|---|---|---|
| AllowsIncrementalLoad | VARCHAR | Indicates whether this derived table can load in incremental mode. |
| TableDescriptor | VARCHAR | This is the descriptor value for the table. The descriptor is used by other database records as pointers to table records. |
| TrackRowUpdateIndicator | VARCHAR | Tracks if a table is enabled for tracking in CR_STAT_ALTER at the table level (does not include Clarity system settings). This column can be used to evaluate the impact of turning off row update tracking globally. The TRACK_ROW_UPDATE_GLOBAL_YN column in this table includes Clarity system settings in its calculation. |
| OrganizationFilterAllowNullPatientIdentifierUpgradeSettingIndicator | VARCHAR | This is the Epic-released value of the setting for whether or not to allow rows with null patient IDs to be returned in the organization filter view. This value is only set if the table is primary for the master file and the organization filter method is patient-based. This value is copied from the Epic-released record at the most recent Clarity data model upgrade, and is copied even if the table is marked as preserved. Changes to the record in the Clarity Compass do not affect this value. |
| IsValidationTableIndicator | VARCHAR | This column specifies whether the table is a validation table. Y indicates the table is a validation table, N indicates it is not. |
| ElectronicHealthInformationPrimaryWhereClauseIndicator | VARCHAR | Indicates whether or not the table/view is the primary table/view to provide where clause filtering for the master file, for the purposes of EHI export. The where clause filter text associated with this item is present in E0B 27004. |
| TableCategoryIdentifier | INTEGER | The category value indicating whether the table is an Extracted Table, View, or Derived Table. |
| DeprecatedFutureVersionNumber | NUMERIC | This is the Epic version in which the table will be deprecated. You can link this column to the VERSION_C column in ZC_VERSION to get the non-numeric representation of the version. |
| DatabaseObjectScriptIdentifier | NUMERIC | The ID of the database object script (E0F) that the table or view uses. This column is only populated for derived tables and views. |
| DisableColumnBackfillIndicator | VARCHAR | Set this item to determine whether the table should have column-level backfills disabled. If set to Yes, then column-level backfills are disabled. If set to No or unset (null), then column-level backfills are allowed. |
| TableExtractAddTypeOverrideCategory | INTEGER | If a table's add type cannot be determined programmatically, this column will contain the table's extract add type override category value. This information is only needed if you have archiving enabled in the environment. |
| ExtractFlatFileName | VARCHAR | This column contains the file name that is used when the records are extracted into a flat file. |
| RecordPhysicalOwnerCommunityIdentifier | VARCHAR | The Community ID (CID) of the instance that owns this record or line. This is only populated if you use IntraConnect. |
| IsElectronicHealthInformationDependency | VARCHAR | Whether Clarity Table is a dependency of an EHI table |
| TableDescriptorOverride | VARCHAR | This is the override descriptor value for the table. The descriptor is used by other database records as pointers to table records. If the override table descriptor is filled in for a particular record, the record is an override of the standard system released record. |
| IsTableValidationDisabledByCustomer | VARCHAR | Indicates whether this table has been explicitly disabled for validation by your organization. |
| TableExtractPriorityLevel | INTEGER | The priority that this table should have when performing ETL. When this value is not set on the table, the table will default to a priority of Normal. |
| CommunityLogicalOwnerIdentification | VARCHAR | The Community ID (CID) of the instance from which this record or line was extracted. This is only populated if you use IntraConnect. |
| ClarityTableIdentifier | VARCHAR | The unique identifier (.1 item) for the table record. |
| ChroniclesMasterFileInitials | VARCHAR | For standard Chronicles-based tables, this item stores the master file initials the table is extracted from. For non-Chronicles-based tables, this item may be null. |
| DerivedTableCleanupScriptIdentifier | NUMERIC | The derived table cleanup script that the table will use to perform any cleanup when the derived table is finished or aborted. |
| EpicValidationDisabledReason | VARCHAR | Indicates the reason why this table has been explicitly disabled for validation by Epic. |
| StagingDeleteQueryHintOverride | INTEGER | This is a table-level override to add a query hint to the LBT staging delete query on Oracle. If this number is smaller than the number of rows in the staging table, a hash join hint will be added. Otherwise, a loop join hint will be added. |
| IsExtractAllLinesModeEnabled | VARCHAR | This item determines if a Clarity table needs to extract all lines when it is marked for delayed extract, or has changed between the build and the extract. It's only useful if the table uses line-based tracking and item atomicity is required. |
| IsPreemptivelyExtractedIndicator | VARCHAR | Indicates whether this table will be pre-emptively extracted. Even if it is possible for a table to be pre-emptively extracted, it may not be configured to do so. In order for a table to actually be pre-emptively extracted, the following must be true: - The table must be able to be pre-emptively extracted (see E0B item 25000). - The table must have a customer record (C record), meaning that it was upgraded. |
| IsColumnLevelChangeTrackingDisabledIndicator | VARCHAR | This column contains "Y" if a table is disabled for column level change tracking. This column does not take Clarity system settings into account. |
| TableSupportsArchivingIndicator | VARCHAR | Indicates whether the table supports archiving. If a table supports archiving and the related archiving area is enabled in the environment, the archived data will not be deleted from the Clarity table during the Clarity Console ETL process. |
| ExtractTemplateIdentifier | NUMERIC | The category ID of the extract template associated with this table that is used to classify how the table detects and extracts changed, new, and deleted records. |
| TableFilterLogicExpression | VARCHAR | An expression that describes how filtering logic on this table should be applied during ETL. |
| IsDataChroniclesRetainedIndicator | VARCHAR | Y indicates the data stored in the corresponding table is permanently retained in Chronicles. N for this column indicates the data is not permanently stored in Chronicles and will be purged at some point after the extract. |
| LastEpicModificationDateTime | DATETIME | This item shows the last modified instant of a table by Epic. This will be used to determine if the table needs to be upgraded or not. |
| ClarityConsoleExtractRoutineName | VARCHAR | The tag that is called by the Clarity Console to run the extract, if the table is not extracted using a KB_SQL query. |
| TableSubPartitionValue | VARCHAR | A comma-delimited list that determines how the table partitions will be sub-divided. If the PARTITION_TYPE is RANGE-HASH, this will be a list of unique value buckets, if it is RANGE-LIST, this will be a list of category IDs. This is only applicable if you use Oracle as your RDBMS. |
| DerivedTableSmartDateRangeDisabledIndicator | VARCHAR | Indicates whether this table has been explicitly disabled for the "smart" date range feature that allows derived tables to pick up where they left off the previous day and avoid reprocessing the same data from day to day. |
| TablePartitionRange | VARCHAR | A comma-delimited list that determines how the table will be partitioned. If the PARTITION_TYPE is RANGE, this will be a list of dates, if it is LIST, this will be a list of category IDs, if it is HASH, this will be a list of unique value buckets. This is only applicable if you use Oracle as your RDBMS. |
| CanBePreemptivelyExtractedIndicator | VARCHAR | Indicates whether it is possible for this table to be pre-emptively extracted, regardless of whether it is currently configured to do so. A table can only be pre-emptively extracted if each of the following are true: 1. The table must use a build (specified in E0B item 10010). 2. The table's load type must be incremental (REQ). |
| PhysicalRecordOwnerCommunityIdentifier | VARCHAR | The Community ID (CID) of the instance that owns this record or line. This is only populated if you use IntraConnect. |
| IsEnabledForExtractionIndicator | VARCHAR | This flag is used to tell if a table is enabled to extract data. A null or N value indicates that the table is not enabled to extract data. Y indicates that the table is enabled to extract data. |
| AllowsFullTableLoad | VARCHAR | Indicates whether this table can load in full mode. This is only applicable for derived tables and generic extract routine tables. |
| AllowIncrementalLoadStartDateSpecification | VARCHAR | Indicates whether a from date can be specified in the Console execution file. This is only applicable for derived tables and generic extract routine tables that can load incrementally. |
| IsPreemptiveExtractDisabled | VARCHAR | Indicates whether the pre-emptive extract functionality is disabled for a table. If this is set to yes, then a pre-emptive extract will not be attempted for that table even if the pre-emptive extract functionality is turned on for the execution. |
| DefaultLoadStartDate | VARCHAR | The default from date to use, if incremental loads are allowed and from dates are allowed. Stored in normalized format. This is only applicable for derived tables and generic extract routine tables. |
| ValidationTableJobCount | INTEGER | This column will only be populated for validation tables. It specifies the number of jobs the validation table uses. |
| TableExportMasterfileIdentifier | VARCHAR | The master file to which the table/view belongs, for the purposes of EHI export. |
| OrganizationFilterViewTypeIdentifier | INTEGER | The category ID indicating whether the organization filter view for this table/view is patient-based, service area lookup, direct pull (no filter), or custom. You can link this column to the ORG_FILTER_VIEW_TYPE_C column in ZC_ORG_FILTER_VIEW_TYPE to get the non-numeric representation of the organization filter view type. |
| SubPartitionKeyName | VARCHAR | The value from this column will be used, along with the PARITION_KEY and PARTITION_RANGE, to determine which table partition the data should go in. This is only applicable if you use Oracle as your RDBMS. |
| TablePartitionMethodType | VARCHAR | Determines the method you wish to use to create separate partitions for this table. RANGE will partition the table by date, LIST will partition the table by category ID, HASH will partition the table by unique column value, as determined by the comma-delimited list in PARTITION_RANGE. This is only applicable if you use Oracle as your RDBMS. |
| StagingCodePreemptiveLoadSafeIndicator | VARCHAR | Whether the staging override code for this table has been confirmed to be safe for use in the pre-emptive load execution. Any table with custom staging code which is different from the Epic-released staging override code (for that table) and does not have this item set will be banned from pre-emptive loads. |
| TableLoadFrequency | VARCHAR | This contains the frequency in which the table gets loaded. This column will contain the title of the category list value stored in E0B 10030. |
| TableSummaryDescription | VARCHAR | This column contains a brief but poignant description for the specified table. |
| DependentExtractIdentifier | VARCHAR | This column contains the INI an incremental extract is dependent upon. During ETL, this information is necessary so the extracts wait for the build process of that corresponding INI to complete. |
| TableSqlServerFilegroup | VARCHAR | The custom filegroup this table is stored on. If blank, the table is stored on the default filegroup. |
| TableAnnotation | VARCHAR | This column, which will be preserved during upgrades, contains any customer-created notes for the table record. |
| ReplacedTableDescription | VARCHAR | For a view that has replaced a table, this column shows the name that the table was renamed to before creating the view. |
| TableIdentifier | VARCHAR | The unique identifier (.1 item) for the table record. |
| IsRecordPreservedDuringUpgrade | VARCHAR | This field contains whether or not the table record is preserved during a Compass data model upgrade. If this field is set to Y and a Compass data model upgrade is run on this table, then no changes will be applied to this record. A null or blank value indicates that the table is not preserved. |
| OrganizationFilterUpgradeSettingValue | VARCHAR | This is the Epic-released value of the setting for the master file to which the table belongs, for the purposes of organization filtering. The value is copied from the Epic-released record at the most recent Clarity data model upgrade, and is copied even if the table is marked as preserved. Changes to the record in the Clarity Compass do not affect this value. |
| TableValidationDisabledByCustomerReason | VARCHAR | Indicates the reason why this table has been explicitly disabled for validation by your organization. |
| TableStagingAlgorithmOverride | INTEGER | Stores the staging algorithm this table prefers to use in Clarity ETL. If no override is supplied, the system level default algorithm from Clarity Settings will be used. |
| TableInitialReleaseVersion | NUMERIC | This is the Epic Version in which the table was initially released. You can link this column to the VERSION_C column in ZC_VERSION to get the non-numeric representation of the version. NOTE: All tables released before July 2000 have had their versions defaulted to 2000. |
| TableRecordStatusCategory | INTEGER | The record status category number for the table record. |
| IsTableFilteredByExtension | VARCHAR | Indicates whether the table filters out any data, as determined by a Table Filter Extension (E0K) record. Currently these E0K records are only used if the table is Near-Real-Time enabled. A null value for this column means that no filtering is done. |
| ClarityTableEHIDocumentDefinitionId | NUMERIC | This is the document definition (HDD) record used for this table's EHI exports. |
| OrganizationFilterUpgradeMethodCode | INTEGER | This is the Epic-released value of the setting for the organization filter method for the table. The value is copied from the Epic-released record at the most recent Clarity data model upgrade, and is copied even if the table is marked as preserved. Changes to the record in the Clarity Compass do not affect this value. |
| ElectronicHealthInformationExportEnabledIndicator | INTEGER | This category value indicates whether the table is enabled for EHI export. |
| IsPrimaryTableForOrganizationFilter | VARCHAR | Indicates whether or not the table is the primary table for the master file, for the purposes of organization filtering. |
| DerivedTableSupportsRowUpdateTrackingIndicator | VARCHAR | Indicates whether the associated derived table script supports row update tracking. A value of Y indicates that the associated derived table script supports row update tracking. A value of N or null indicates that the associated derived table script does not support row update tracking. This column is only populated for derived tables. This column does not indicate whether row update tracking is enabled for the derived table. The TRACK_ROW_UPDATE_YN and TRACK_ROW_UPDATE_GLOBAL_YN columns indicate if row update tracking will be used. |
| ArchiveEnabledIndicator | VARCHAR | Indicates whether any archiving area related to the table is enabled in the environment. Y indicates that there is at least one area of archiving enabled. For these tables, the archived data will not be deleted from the Clarity table during the Clarity Console ETL process. The table ARCH_LVL_ENABLED has information on the levels enabled for each table. N indicates that none of the related archiving areas are enabled in the environment or that there are no levels of archiving supported for this table. |
| LastModifiedVersionCode | NUMERIC | This is the Epic version in which the table was last modified. You can link this column to the VERSION_C column in ZC_VERSION to get the non-numeric representation of the version. |
| CommunityLogicalOwnerIdentifier | VARCHAR | The Community ID (CID) of the instance from which this record or line was extracted. This is only populated if you use IntraConnect. |
| CanExtractAdhocPreEmptiveLoadIndicator | VARCHAR | This item indicates whether or not this table can support running ad hoc pre-emptive load. |
| IsTablePartitionedIndicator | VARCHAR | Whether or not the table is broken up into logical divisions. For example, the CLARITY_TDL table can be broken up into logical divisions based on POST_DATE. Y indicates the table is partitioned. N or null indicates that the table is not partitioned. |
| TableFilterExtensionIdentifier | VARCHAR | The Table Filter Extension (E0K) record this table uses to determine what data should be filtered out and not loaded. Currently these E0K records are only used if the table is Near-Real-Time enabled. |
| IsGlobalChangeTrackingDisabled | VARCHAR | This column contains "Y" if a table is disabled for column level change tracking at the global level, which includes Clarity system settings. The IS_CLCT_DISABLED_YN column in this table does not include Clarity system settings in its calculation. |
| GroupedTableSourceDescriptor | VARCHAR | This is the table descriptor of the source table that this table is grouped with. A grouped table is created when a source table's row size or number of columns reaches a defined maximum limit. Attempting to add additional columns, or increase the table size beyond the maximum, will create a new subsequent table based on the same KB_SQL table. This subsequent table is considered to be grouped with the source table. Example: The PATIENT_2, PATIENT_3 and PATIENT_4 tables are all part of the same group that has PATIENT as a source table. The GRP_TBL_DESCRIPTOR for these three tables will be 'PATIENT'. |
| IsIndexOrganizedIndicator | VARCHAR | This indicates whether or not the table is index organized. |
| IsRowUpdateTrackingGloballyEnabledIndicator | VARCHAR | Tracks if a table is enabled for tracking in CR_STAT_ALTER at the global level (includes Clarity system settings). Use this column to determine if data will be loaded into CR_STAT_ALTER for a particular table. The TRACK_ROW_UPDATE_YN column in this table does not include Clarity system settings in its calculation. |
| TablePartitionKey | VARCHAR | The value from this column will be used, along with the PARTITION_RANGE, to determine which table partition the data should go in. This is only applicable if you use Oracle as your RDBMS. |