Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stanfordspezi/speziquestionnaire
Spezi Questionnaire Module
https://github.com/stanfordspezi/speziquestionnaire
fhir questionnaire researchkit spezi stanford survey swift swiftui xcode
Last synced: 2 months ago
JSON representation
Spezi Questionnaire Module
- Host: GitHub
- URL: https://github.com/stanfordspezi/speziquestionnaire
- Owner: StanfordSpezi
- License: mit
- Created: 2023-03-06T07:33:03.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-29T13:05:58.000Z (4 months ago)
- Last Synced: 2024-10-29T11:21:08.628Z (2 months ago)
- Topics: fhir, questionnaire, researchkit, spezi, stanford, survey, swift, swiftui, xcode
- Language: Swift
- Homepage: https://swiftpackageindex.com/StanfordSpezi/SpeziQuestionnaire/documentation/
- Size: 1.37 MB
- Stars: 6
- Watchers: 11
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Spezi Questionnaire
[](https://github.com/StanfordSpezi/SpeziQuestionnaire/actions/workflows/build-and-test.yml)
[](https://codecov.io/gh/StanfordSpezi/SpeziQuestionnaire)
[](https://doi.org/10.5281/zenodo.7706903)
[](https://swiftpackageindex.com/StanfordSpezi/SpeziQuestionnaire)
[](https://swiftpackageindex.com/StanfordSpezi/SpeziQuestionnaire)
Enables apps to display and collect responses from [HL7® FHIR® questionnaires](http://hl7.org/fhir/R4/questionnaire.html).
## Overview
The Spezi Questionnaire package enables [HL7® FHIR® Questionnaires](http://hl7.org/fhir/R4/questionnaire.html) to be displayed in your Spezi application.
Questionnaires are displayed using [ResearchKit](https://github.com/ResearchKit/ResearchKit) and the [ResearchKitOnFHIR](https://github.com/StanfordBDHG/ResearchKitOnFHIR) package.
|   |
|:---:|
|An HL7® FHIR® Questionnaire is rendered using the [`QuestionnaireView`](https://swiftpackageindex.com/stanfordspezi/speziquestionnaire/documentation/speziquestionnaire/questionnaireview)|
## Setup
You need to add the Spezi Questionnaire Swift package to
[your app in Xcode](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app#) or
[Swift package](https://developer.apple.com/documentation/xcode/creating-a-standalone-swift-package-with-xcode#Add-a-dependency-on-another-Swift-package).
> [!IMPORTANT]
> If your application is not yet configured to use Spezi, follow the [Spezi setup article](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/initial-setup) and set up the core Spezi infrastructure.
## Example
In the following example, we create a SwiftUI view with a button that displays a sample questionnaire from the `FHIRQuestionnaires` package using [`QuestionnaireView`](https://swiftpackageindex.com/stanfordspezi/speziquestionnaire/documentation/speziquestionnaire/questionnaireview).
```swift
import FHIRQuestionnaires
import SpeziQuestionnaire
import SwiftUI
struct ExampleQuestionnaireView: View {
@State var displayQuestionnaire = false
var body: some View {
Button("Display Questionnaire") {
displayQuestionnaire.toggle()
}
.sheet(isPresented: $displayQuestionnaire) {
QuestionnaireView(
questionnaire: Questionnaire.gcs
) { result in
guard case let .completed(response) = result else {
return // user cancelled
}
// ... save the FHIR response to your data store
}
}
}
}
```
For more information, please refer to the [API documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziQuestionnaire/documentation).
## The Spezi Template Application
The [Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication) provides a great starting point and example using the Spezi Questionnaire module.
## Contributing
Contributions to this project are welcome. Please make sure to read the [contribution guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md) and the [contributor covenant code of conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) first.
## Notices
FHIR is a registered trademark of Health Level Seven International.
## License
This project is licensed under the MIT License. See [Licenses](https://github.com/StanfordSpezi/SpeziQuestionnaire/tree/main/LICENSES) for more information.
