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

Support storing multiple signed consent documents #50

Closed
1 task done
vishnuravi opened this issue Jun 10, 2024 · 0 comments · Fixed by #51
Closed
1 task done

Support storing multiple signed consent documents #50

vishnuravi opened this issue Jun 10, 2024 · 0 comments · Fixed by #51
Labels
enhancement New feature or request

Comments

@vishnuravi
Copy link
Member

Problem

Research studies often require users to sign multiple consent documents during onboarding. Currently SpeziOnboarding can only be used to store one signed consent document, as the store method defined by the OnboardingConstraint receives a PDFDocument which does not include any identifier that could be used to distinguish between different consent documents being used within the same onboarding flow and store them with separate file names.

Solution

An identifier should be passed either to the store method as an argument, or within the PDFDocument's attributes such that multiple documents signed within the same onboarding flow can be distinguished and stored appropriately.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct and Contributing Guidelines
@vishnuravi vishnuravi added the enhancement New feature or request label Jun 10, 2024
@vishnuravi vishnuravi changed the title Minor feature request: Support storing multiple signed consent documents Support storing multiple signed consent documents Jun 10, 2024
@PSchmiedmayer PSchmiedmayer moved this from Backlog to In Progress in Project Planning Jun 29, 2024
PSchmiedmayer added a commit that referenced this issue Aug 14, 2024
…a an identifier (#50) (#51)

# *Support for storing multiple consent forms (#50)*

## ♻️ Current situation & Problem
Closes #50 
In the case of multiple `OnboardingConsentView`, it was impossible to
distinguish the individual consent forms when storing in the `Standard`,
as the "store" function of the `OnboardingConstraint` only receives a
`PDFDocument` as a parameter and no additional information.

## ⚙️ Release Notes 
* Added a parameter "identifier" to `OnboardingConsentView` and
`OnboardingConstraint`.
* If an identifier is specified when creating an
`OnboardingConsentView', then the store function will be called with
that identifier; otherwise the identifier is set to the default value
"DefaultConsentDocument".
* UITests/TestApp has been changed accordingly to test the new
functionality of having multiple (in this case two) consent forms.
    * Added "First" and "Second" Test View and Rendering View 
* `ExampleStandard` has been changed to distinguish the two consent
forms based on their identifiers "FirstConsentDocument" and
"SecondConsentDocument"


## 📚 Documentation
*Documented changes in the appropriate Markdown files.


## ✅ Testing
* Adapted UI Test app to include a second `OnboardingConsentView` with
an identifier different from the first one.

If you accept this PR, there are implications for
[SpeziTemplateApplication](https://github.com/StanfordSpezi/SpeziTemplateApplication)
and
[SpeziStudyApplication](https://github.com/StanfordSpezi/SpeziStudyApplication),
as both use an `OnboardingConsentView` and require to add the
"identifier" parameter to the respective `Standard`. I am happy to make
those changes if this PR gets accepted.


## 📝 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 <[email protected]>
@github-project-automation github-project-automation bot moved this from In Progress to Done in Project Planning Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
1 participant