Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update BQ Documentation: new tables added #203

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions content/awell-orchestration/docs/data/bigquery/data-schema.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,41 @@ Table name: `activities`.

<ActivityTableSpecs />


<Alert type="info">
<p className="mb-1">Following tables extract specific objects from the activities table, allowing for easier and more detailed analytics:</p>
<ul>
<li>Actions</li>
<li>Steps</li>
<li>Tracks</li>
</ul>
</Alert>




#### Actions
Table name: `actions`.

The `actions` table captures data about orchestrated actions within care flows. It consolidates information including action definition ID and type, final state of the action, primary object details (e.g., form name), associations with care flows, steps, and tracks, and timing information.
<ActionsTableSpecs />


#### Steps
Table name: `steps`.

The `steps` table captures data about orchestrated steps within care flows. It contains information about each step's definition ID, start and completion times, current status, and its associations with care flows and tracks. This table allows for detailed analysis of step execution and progression within care flows.

<StepsTableSpecs />


#### Tracks
Table name: `tracks`.

The `tracks` table captures data about orchestrated tracks within care flows. It includes information about each track's definition ID, start and completion times, current status, and its association with the care flow it's a part of. This table enables analysis of track progression and helps in understanding the structure and execution of care flows at a higher level.

<TracksTableSpecs />

### Patient data

#### Patients
Expand All @@ -106,3 +141,4 @@ Table name: `patients`
Table name: `patient_profiles`

<PatientProfileTableSpecs />

45 changes: 45 additions & 0 deletions src/components/DataRepository/ActionsTableSpecs.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import { actions } from '@/config/bq-tables'

export const ActionsTableSpecs = () => {
return (
<div className="flex flex-col">
<table className="table-fixed ignore-default-style divide-y divide-slate-300 dark:divide-slate-500">
<thead>
<tr className="text-slate-900 dark:text-white text-base font-semibold">
<th
scope="col"
className="py-3.5 pl-4 pr-3 text-left sm:pl-6 md:pl-0"
>
Column
</th>
<th scope="col" className="py-3.5 px-3 text-left">
Type
</th>
<th scope="col" className="py-3.5 px-3 text-left">
Description
</th>
</tr>
</thead>
<tbody className="divide-y divide-slate-200 dark:divide-slate-700">
{actions.map(({ property, type, description }) => (
<tr
key={property}
className="text-slate-900 dark:text-slate-100"
>
<td className="font-semibold py-4 pl-4 pr-3 sm:pl-6 md:pl-0">
{property}
</td>
<td className="py-4 px-3 text-base">
{type}
</td>
<td className="py-4 px-3 text-base">
{description}
</td>
</tr>
))}
</tbody>
</table>
</div>
)
}

45 changes: 45 additions & 0 deletions src/components/DataRepository/StepsTableSpecs.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import { steps } from '@/config/bq-tables'

export const StepsTableSpecs = () => {
return (
<div className="flex flex-col">
<table className="table-fixed ignore-default-style divide-y divide-slate-300 dark:divide-slate-500">
<thead>
<tr className="text-slate-900 dark:text-white text-base font-semibold">
<th
scope="col"
className="py-3.5 pl-4 pr-3 text-left sm:pl-6 md:pl-0"
>
Column
</th>
<th scope="col" className="py-3.5 px-3 text-left">
Type
</th>
<th scope="col" className="py-3.5 px-3 text-left">
Description
</th>
</tr>
</thead>
<tbody className="divide-y divide-slate-200 dark:divide-slate-700">
{steps.map(({ property, type, description }) => (
<tr
key={property}
className="text-slate-900 dark:text-slate-100"
>
<td className="font-semibold py-4 pl-4 pr-3 sm:pl-6 md:pl-0">
{property}
</td>
<td className="py-4 px-3 text-base">
{type}
</td>
<td className="py-4 px-3 text-base">
{description}
</td>
</tr>
))}
</tbody>
</table>
</div>
)
}

45 changes: 45 additions & 0 deletions src/components/DataRepository/TracksTableSpecs.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import { tracks } from '@/config/bq-tables'

export const TracksTableSpecs = () => {
return (
<div className="flex flex-col">
<table className="table-fixed ignore-default-style divide-y divide-slate-300 dark:divide-slate-500">
<thead>
<tr className="text-slate-900 dark:text-white text-base font-semibold">
<th
scope="col"
className="py-3.5 pl-4 pr-3 text-left sm:pl-6 md:pl-0"
>
Column
</th>
<th scope="col" className="py-3.5 px-3 text-left">
Type
</th>
<th scope="col" className="py-3.5 px-3 text-left">
Description
</th>
</tr>
</thead>
<tbody className="divide-y divide-slate-200 dark:divide-slate-700">
{tracks.map(({ property, type, description }) => (
<tr
key={property}
className="text-slate-900 dark:text-slate-100"
>
<td className="font-semibold py-4 pl-4 pr-3 sm:pl-6 md:pl-0">
{property}
</td>
<td className="py-4 px-3 text-base">
{type}
</td>
<td className="py-4 px-3 text-base">
{description}
</td>
</tr>
))}
</tbody>
</table>
</div>
)
}

3 changes: 3 additions & 0 deletions src/components/DataRepository/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export * from './ActionsTableSpecs'
export * from './ActivityIndexSpecs'
export * from './ActivityTableSpecs'
export * from './CareFlowTableSpecs'
Expand All @@ -8,4 +9,6 @@ export * from './PathwayIndexSpecs'
export * from './PatientProfileTableSpecs'
export * from './PatientTableSpecs'
export * from './StepIndexSpecs'
export * from './StepsTableSpecs'
export * from './TracksTableSpecs'

Loading