Topics: |
The Omni-HealthData Relational OnRamp is a set of relational tables and protocols used to load data into an Omni system. This section describes how data can be integrated with the Relational OnRamp.
Any subject of an Omni system is logically represented as a hierarchy of documents described by the IDS: the top-level subject document and child instance documents, or collections. For each such document, parent or child, there is a corresponding ROR table with name, nameOfSubjectOrCollection_r. For example, the Facility subject contains a Facility parent and an Address child, which are represented and loaded using the facility_r and facility_address_r tables, respectively.
When a new bundle is deployed, this will initialize empty OnRamp tables.
Omni products provide an Excel workbook for each IDS subject, which describes the layout of the ramp and model tables. In the Excel workbook, the top-level subject and each child collection are described by separate tabs. Table mappings can be obtained from the Deployment area of the Omni Console, where a Download Documentation option is available.
Each OnRamp table has a group of identifying columns, which taken together, map to the source record. These columns will be part of the primary key.
For top-level subjects, the identifying columns are:
For child collections, the identifying columns are:
Equivalently, the identifying columns of a child collection may be defined recursively as the combination of the following:
Finally, the full primary key for any of these tables, whether top-level subject, or child collection, is comprised of the identifying columns described above and the batch_id column, which is present in each ROR table.
The following are conventions for forming OnRamp fields from their IDS names, based on their type.
<lower_case> + _src <lower_case> + _set <lower_case> + _val
<lower_case> + _subjectName + _snm <lower_case> + _subjectName + _sid
<lower_case> + _subjectName +_sbj <lower_case> + _subjectName + _snm <lower_case> + _subjectName + _sid
<CamelCase>
becomes
<grp_id> + <lower_case>
Additional Columns
Source Codes and Source Code Sets are loaded through the OnRamp tables like other subjects. The top-level subject to use when submitting a batch with either or both is SourceCodeSet. However, the IDS structure for SourceCode and SourceCodeSet is slightly different from standard subjects, so the following considerations apply.