Export Consent Forms (Markdown) #40

philippzagar · 2023-10-03T21:39:47Z

Export Consent Forms (Markdown)

♻️ Current situation & Problem

Until now, users could view and sign a consent document in the Spezi template application using the SpeziOnboarding package. However, the app did not offer any provision to save or export the signed consent document.
In the medical domain, the consent form collection is especially important in order to serve as legal cover.
See StanfordSpezi/SpeziOnboarding#7.

Utilizes: StanfordSpezi/SpeziFirebase#17

⚙️ Release Notes

The template application now utilizes the OnboardingConsentView of SpeziOnboarding, providing an export and share functionality of the signed consent form as a PDF.

📚 Documentation

Incorporated where necessary.
Associated with StanfordSpezi/SpeziOnboarding#26

✅ Testing

--

📝 Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

I agree to follow the Code of Conduct and Contributing Guidelines.

philippzagar · 2023-10-03T21:51:43Z

@PSchmiedmayer PR ready for review, keep in mind that the feat/export-consent-forms branch of SpeziOnboarding is currently set as a dependency so that you are able to test locally / Pipeline succeeds. As soon as StanfordSpezi/SpeziOnboarding#26 is merged and tagged, I'll update the dependency to a tagged version.

philippzagar · 2023-10-03T22:05:00Z

@PSchmiedmayer Seems like the pipeline is running into some issues:

Error: Encountered a fatal error while running "/Users/runner/hostedtoolcache/CodeQL/2.14.6/x64/codeql/codeql database finalize --finalize-dataset --threads=4 --ram=13004
/Users/runner/work/SpeziTemplateApplication/SpeziTemplateApplication/.codeql/swift". 
Exit code was 32 and error was: CodeQL detected code written in Swift but could not process any of it. Review our troubleshooting guide at https://gh.io/troubleshooting-code-scanning/no-source-code-seen-during-build.

codecov · 2023-10-03T22:13:14Z

Codecov Report

Merging #40 (adf0e97) into main (692c7c9) will decrease coverage by 0.23%.
The diff coverage is 84.79%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #40      +/-   ##
==========================================
- Coverage   82.03%   81.79%   -0.23%     
==========================================
  Files          32       32              
  Lines         840      873      +33     
==========================================
+ Hits          689      714      +25     
- Misses        151      159       +8

Files	Coverage Δ
TemplateApplication/Onboarding/Consent.swift	`94.12% <100.00%> (-1.53%)`	⬇️
...emplateApplication/Onboarding/OnboardingFlow.swift	`97.23% <100.00%> (ø)`
TemplateApplication/Onboarding/Welcome.swift	`100.00% <100.00%> (ø)`
TemplateApplication/TemplateAppDelegate.swift	`97.83% <100.00%> (+0.10%)`	⬆️
...n/Onboarding/OnboardingFlow+PreviewSimulator.swift	`0.00% <0.00%> (ø)`
...plateApplication/TemplateApplicationStandard.swift	`51.24% <83.34%> (+13.60%)`	⬆️

... and 1 file with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 692c7c9...adf0e97. Read the comment docs.

PSchmiedmayer · 2023-10-04T06:49:07Z

@philippzagar Thank you for the PR. I will give StanfordSpezi/SpeziOnboarding#26 a review and then we can merge this one here. Also took a look at the build errors in #39 & #41, that should also fix the CI in this PR 👍

…feat/export-consent-forms

philippzagar · 2023-10-10T19:46:56Z

@PSchmiedmayer Ready for review after you reviewed StanfordSpezi/SpeziOnboarding#26 :)

…forms

PSchmiedmayer

Thank you for the great additions, looking forward to see this PR being merged!

I had a small comment regarding the functionality to upload the consent document to Firebase Cloud Storage. Apart from this the PR looks great and the code is well structured 🚀

TemplateApplication/TemplateApplicationStandard.swift

philippzagar · 2023-10-12T19:48:37Z

Note to ourselves: We need to merge StanfordSpezi/SpeziFirebase#17 first and adjust the dependencies within this branch

PSchmiedmayer

Nice, thank you for the changes; looks great and happy to merge it once we have the related PRs merged and ready 👍

TemplateApplication.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

PSchmiedmayer · 2023-10-16T12:05:17Z

Nice, great job @philippzagar! 🚀

Until now, users could view and sign a consent document in the Spezi template application using the `SpeziOnboarding` package. However, the app did not offer any provision to save or export the signed consent document. In the medical domain, the consent form collection is especially important in order to serve as legal cover. See StanfordSpezi/SpeziOnboarding#7. Utilizes: StanfordSpezi/SpeziFirebase#17 - The template application now utilizes the `OnboardingConsentView` of `SpeziOnboarding`, providing an export and share functionality of the signed consent form as a PDF. Incorporated where necessary. Associated with StanfordSpezi/SpeziOnboarding#26 -- By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [X] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md). --------- Co-authored-by: Paul Schmiedmayer <PSchmiedmayer@users.noreply.github.com>

# *Export Consent Forms (Markdown)* ## ♻️ Current situation & Problem Until now, users could view and sign a consent document in the Spezi template application using the `SpeziOnboarding` package. However, the app did not offer any provision to save or export the signed consent document. In the medical domain, the consent form collection is especially important in order to serve as legal cover. See StanfordSpezi/SpeziOnboarding#7. Utilizes: StanfordSpezi/SpeziFirebase#17 ## ⚙️ Release Notes - The template application now utilizes the `OnboardingConsentView` of `SpeziOnboarding`, providing an export and share functionality of the signed consent form as a PDF. ## 📚 Documentation Incorporated where necessary. Associated with StanfordSpezi/SpeziOnboarding#26 ## ✅ Testing -- ## 📝 Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [X] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md). --------- Co-authored-by: Paul Schmiedmayer <PSchmiedmayer@users.noreply.github.com>

Until now, users could view and sign a consent document in the Spezi template application using the `SpeziOnboarding` package. However, the app did not offer any provision to save or export the signed consent document. In the medical domain, the consent form collection is especially important in order to serve as legal cover. See StanfordSpezi/SpeziOnboarding#7. Utilizes: StanfordSpezi/SpeziFirebase#17 - The template application now utilizes the `OnboardingConsentView` of `SpeziOnboarding`, providing an export and share functionality of the signed consent form as a PDF. Incorporated where necessary. Associated with StanfordSpezi/SpeziOnboarding#26 -- By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [X] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md). --------- Co-authored-by: Paul Schmiedmayer <PSchmiedmayer@users.noreply.github.com>

philippzagar added 7 commits August 9, 2023 22:16

Local package versions

ed590a7

Merge branch 'main' into feat/export-consent-forms

152ef81

speedy onboarding flow

17291da

Merge branch 'main' into feat/export-consent-forms

9426f65

Incorporate new export consent onboarding

8cbd6a5

Cleanup

575b17a

Finishing touches

dca03fd

philippzagar requested a review from PSchmiedmayer October 3, 2023 21:50

Firebase minor version dependency upgradability

3fa3e56

Merge branch 'main' into feat/export-consent-forms

205728d

PSchmiedmayer assigned philippzagar Oct 4, 2023

PSchmiedmayer added the enhancement New feature or request label Oct 4, 2023

philippzagar added 7 commits October 4, 2023 08:54

Improved Docs and contributions

ad31b17

Merge branch 'main' into feat/export-consent-forms

ff90869

Merge remote-tracking branch 'origin/feat/export-consent-forms' into …

592ac14

…feat/export-consent-forms

Adjustments to new Consent view

3da5a6f

Move file

5ce5ca6

Doc fix

9a6a417

Remove unncessary error enum

7615af6

philippzagar added 5 commits October 10, 2023 12:56

Increase used xcode version to v15 for CodeQL job

a396e04

Fix UI tests

7125f75

Revert used Xcode version

278343b

Disable CodeQL job until Swift 5.9 is supported

a53a82d

Merge branch 'fix/disable-codeql-swift-5.9' into feat/export-consent-…

6cac1ca

…forms

PSchmiedmayer requested changes Oct 11, 2023

View reviewed changes

TemplateApplication/TemplateApplicationStandard.swift Outdated Show resolved Hide resolved

philippzagar added 4 commits October 11, 2023 21:39

Firebase storage of consent form

03263e9

Merge branch 'main' into feat/export-consent-forms

9680a98

Add Firebase Storage component

42b459b

linter

f2e3a39

philippzagar requested a review from PSchmiedmayer October 12, 2023 20:57

File renamings

145208d

PSchmiedmayer approved these changes Oct 14, 2023

View reviewed changes

TemplateApplication.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved Outdated Show resolved Hide resolved

TemplateApplication.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved Outdated Show resolved Hide resolved

philippzagar added 3 commits October 14, 2023 14:21

Set proper onboarding dependency

142821c

Proper dependencies + minor fixes

c2b9a34

Remove comments

adf0e97

philippzagar enabled auto-merge (squash) October 16, 2023 06:16

philippzagar merged commit 5f4e95c into main Oct 16, 2023
6 checks passed

philippzagar deleted the feat/export-consent-forms branch October 16, 2023 06:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Export Consent Forms (Markdown) #40

Export Consent Forms (Markdown) #40

philippzagar commented Oct 3, 2023 •

edited

Loading

philippzagar commented Oct 3, 2023

philippzagar commented Oct 3, 2023

codecov bot commented Oct 3, 2023 •

edited

Loading

PSchmiedmayer commented Oct 4, 2023

philippzagar commented Oct 10, 2023

PSchmiedmayer left a comment

philippzagar commented Oct 12, 2023

PSchmiedmayer left a comment

PSchmiedmayer commented Oct 16, 2023

Export Consent Forms (Markdown) #40

Export Consent Forms (Markdown) #40

Conversation

philippzagar commented Oct 3, 2023 • edited Loading

Export Consent Forms (Markdown)

♻️ Current situation & Problem

⚙️ Release Notes

📚 Documentation

✅ Testing

📝 Code of Conduct & Contributing Guidelines

philippzagar commented Oct 3, 2023

philippzagar commented Oct 3, 2023

codecov bot commented Oct 3, 2023 • edited Loading

Codecov Report

PSchmiedmayer commented Oct 4, 2023

philippzagar commented Oct 10, 2023

PSchmiedmayer left a comment

Choose a reason for hiding this comment

philippzagar commented Oct 12, 2023

PSchmiedmayer left a comment

Choose a reason for hiding this comment

PSchmiedmayer commented Oct 16, 2023

philippzagar commented Oct 3, 2023 •

edited

Loading

codecov bot commented Oct 3, 2023 •

edited

Loading