Updated "Fhir Data Pipes" concepts documentation #1242
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1242 +/- ##
=========================================
Coverage 51.48% 51.48%
Complexity 716 716
=========================================
Files 95 95
Lines 5907 5907
Branches 787 787
=========================================
Hits 3041 3041
Misses 2578 2578
Partials 288 288 ☔ View full report in Codecov by Sentry. |
bashir2
approved these changes
Nov 29, 2024
| continuously transform FHIR data into an analytics friendly Parquet on FHIR | ||
| format. | ||
| continuously transform FHIR data into an analytics friendly "Parquet-on-FHIR" | ||
| schema. |
There was a problem hiding this comment.
nit: consider adding a link to schema.md.
| materialized) which can then be queried using simpler SQL statements. | ||
|
|
||
| ## Parquet-on-FHIR schema | ||
| The output of the _FHIR Data Pipes ETL Pipelines_ is conversion of raw FHIR |
There was a problem hiding this comment.
Suggested change
| The output of the _FHIR Data Pipes ETL Pipelines_ is conversion of raw FHIR | |
| The _FHIR Data Pipes ETL Pipelines_ convert raw FHIR |
| ## Parquet-on-FHIR schema | ||
| The output of the _FHIR Data Pipes ETL Pipelines_ is conversion of raw FHIR | ||
| resources to a _Parquet-on-FHIR_ schema representation. This takes place for | ||
| each resource type and follows the [FHIR Data Pipes Schema Mapping Rules](https://github.com/google/fhir-data-pipes/blob/master/doc/schema.md){:.external}. |
There was a problem hiding this comment.
Suggested change
| each resource type and follows the [FHIR Data Pipes Schema Mapping Rules](https://github.com/google/fhir-data-pipes/blob/master/doc/schema.md){:.external}. | |
| each resource type and follows the [Schema Mapping Rules](https://github.com/google/fhir-data-pipes/blob/master/doc/schema.md). |
| resources to a _Parquet-on-FHIR_ schema representation. This takes place for | ||
| each resource type and follows the [FHIR Data Pipes Schema Mapping Rules](https://github.com/google/fhir-data-pipes/blob/master/doc/schema.md){:.external}. | ||
|
|
||
| The generated columnar Parquet files provide the 'base data warehouse' that can |
There was a problem hiding this comment.
Suggested change
| The generated columnar Parquet files provide the 'base data warehouse' that can | |
| The generated columnar Parquet files provide the *"base data warehouse"* that can |
| @@ -179,12 +190,14 @@ Using the ViewDefinition editor you can: | |||
|
|
|||
| ## Output Data Formats | |||
|
|
|||
| ### Conversion to PostgreSQL | |||
| Applying the FHIR ViewDefinition resources to the "base dwh" will generate materialized views which represent a "constrained" set of data to be used for downstream analytics applications (such as dashboards or reporting). | |||
There was a problem hiding this comment.
nit1: please fix the style, e.g., break the lines at 80 chars.
nit2: consider adding a reference to the config param for enabling this, i.e., viewDefinitionsDir
|
|
||
| ### Conversion to Parquet | ||
| The resulting database tables can be loaded into a commonly used relational database management system such as [PostgresSQL](https://www.postgresql.org/) or [MySQL](https://www.mysql.com/). |
There was a problem hiding this comment.
nit: Consider adding a reference to the config param that enables this, i.e., sinkDbConfigPath.
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of what I changed
Made changes to the Concepts documentation to bring up to speed with latest features
E2E test
TESTED: on local
Checklist: I completed these to help reviewers :)
I have read and will follow the review process.
I am familiar with Google Style Guides for the language I have coded in.
No? Please take some time and review Java and Python style guides.
My IDE is configured to follow the Google code styles.
No? Unsure? -> configure your IDE.
I have added tests to cover my changes. (If you refactored existing code that was well tested you do not have to add tests)
I ran
mvn clean packageright before creating this pull request and added all formatting changes to my commit.All new and existing tests passed.
My pull request is based on the latest changes of the master branch.
No? Unsure? -> execute command
git pull --rebase upstream master