spezifhir

The Spezi FHIR Standard & Related Modules

https://github.com/stanfordspezi/spezifhir

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.3%) to scientific vocabulary

Keywords

fhir ios spezi stanford swift xcode
Last synced: 6 months ago · JSON representation ·

Repository

The Spezi FHIR Standard & Related Modules

Basic Info
Statistics
  • Stars: 12
  • Watchers: 10
  • Forks: 3
  • Open Issues: 6
  • Releases: 26
Topics
fhir ios spezi stanford swift xcode
Created about 3 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

Spezi FHIR

Build and Test codecov DOI

Build FHIR-based healthcare applications with Spezi.

Overview

The Spezi FHIR Swift Package provides essential building blocks for developing FHIR-based mobile healthcare applications using the Spezi framework. It includes comprehensive tools for FHIR resource management, HealthKit integration, and mock patient data for testing and development.

Setup

Add SpeziFHIR as a Dependency

You need to add the SpeziFHIR Swift package to your app in Xcode or Swift package.

[!IMPORTANT]
If your application is not yet configured to use Spezi, follow the Spezi setup article to set up the core Spezi infrastructure.

Targets

Spezi FHIR provides a number of targets to help developers integrate FHIR functionality in their Spezi-based applications:

  • SpeziFHIR: Core FHIR resource management, storage, and utilities for working with FHIR R4 and DSTU2 resources.
  • SpeziFHIRHealthKit: Seamless integration between HealthKit data and FHIR resources, enabling conversion of health data to FHIR format.
  • SpeziFHIRMockPatients: Mock patient data and FHIR bundles for testing and development purposes.

SpeziFHIR

The core module provides essential FHIR functionality including the FHIRStore, an observable store for managing and organizing FHIR resources by category. The FHIRResource type serves as a wrapper for FHIR resources with additional metadata and utilities. Combined, they provide tools for searching, copying, and manipulating FHIR resources that are compatible with both FHIR R4 and DSTU2 specifications.

FHIRStore

Configure the FHIRStore in your SpeziAppDelegate to manage FHIR resources in your application:

```swift import Spezi import SpeziFHIR

class ExampleAppDelegate: SpeziAppDelegate { override var configuration: Configuration { Configuration { FHIRStore() } } } ```

Use the FHIRStore to manage FHIR resources in your application as well as adding and removing FHIRResources in the FHIRStore.

```swift import SpeziFHIR import SwiftUI

struct ExampleView: View { @Environment(FHIRStore.self) private var fhirStore

var body: some View {
    List {
        Section("Observations") {
            ForEach(fhirStore.observations) { observation in
                Text(observation.displayName)
            }
        }

        Section("Conditions") {
            ForEach(fhirStore.conditions) { condition in
                Text(condition.displayName)
            }
        }
    }
}

} ```

SpeziFHIRHealthKit

Seamlessly integrate HealthKit data with FHIR resources including easy ways to add HKSamples to the FHIRStore while loading attachments from the FHIR resources stored in HealthKit or attached information such as voltage information of symptoms for electrocardiograms. For more information, please refer to the API documentation.

SpeziFHIRMockPatients

The target offers easily loadable mock patient data for testing and development. For more information, please refer to the API documentation.

Contributing

Contributions to this project are welcome. Please make sure to read the contribution guidelines and the contributor covenant code of conduct first.

License

This project is licensed under the MIT License. See Licenses for more information.

Spezi Footer Spezi Footer

Owner

  • Name: Stanford Spezi
  • Login: StanfordSpezi
  • Kind: organization

Citation (CITATION.cff)

#
# This source file is part of the Stanford Spezi open-source project
#
# SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
#
# SPDX-License-Identifier: MIT
#

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Schmiedmayer"
  given-names: "Paul"
  orcid: "https://orcid.org/0000-0002-8607-9148"
- family-names: "Ravi"
  given-names: "Vishnu"
  orcid: "https://orcid.org/0000-0003-0359-1275"
- family-names: "Aalami"
  given-names: "Oliver"
  orcid: "https://orcid.org/0000-0002-7799-2429"
title: "SpeziFHIR"
doi: 10.5281/zenodo.7803123
url: "https://github.com/StanfordSpezi/SpeziFHIR"

GitHub Events

Total
  • Create event: 24
  • Issues event: 11
  • Release event: 10
  • Watch event: 2
  • Delete event: 14
  • Member event: 2
  • Issue comment event: 47
  • Push event: 74
  • Pull request review comment event: 40
  • Pull request review event: 54
  • Pull request event: 28
Last Year
  • Create event: 24
  • Issues event: 11
  • Release event: 10
  • Watch event: 2
  • Delete event: 14
  • Member event: 2
  • Issue comment event: 47
  • Push event: 74
  • Pull request review comment event: 40
  • Pull request review event: 54
  • Pull request event: 28

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 13
  • Total pull requests: 37
  • Average time to close issues: 5 months
  • Average time to close pull requests: 7 days
  • Total issue authors: 5
  • Total pull request authors: 7
  • Average comments per issue: 1.62
  • Average comments per pull request: 2.3
  • Merged pull requests: 31
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 6
  • Pull requests: 26
  • Average time to close issues: 5 months
  • Average time to close pull requests: 9 days
  • Issue authors: 3
  • Pull request authors: 5
  • Average comments per issue: 1.17
  • Average comments per pull request: 2.85
  • Merged pull requests: 21
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • PSchmiedmayer (5)
  • jdisho (3)
  • philippzagar (2)
  • advatar (1)
  • LeonNissen (1)
  • Supereg (1)
Pull Request Authors
  • jdisho (14)
  • PSchmiedmayer (10)
  • philippzagar (7)
  • Supereg (3)
  • lukaskollmer (2)
  • AdritRao (1)
  • LeonNissen (1)
Top Labels
Issue Labels
enhancement (9) help wanted (4) good first issue (3) documentation (2) bug (1)
Pull Request Labels
enhancement (29) bug (1) documentation (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 27
swiftpackageindex.com: github.com/StanfordSpezi/SpeziFHIR

The Spezi FHIR Standard & Related Modules

  • Versions: 27
  • Dependent Packages: 0
  • Dependent Repositories: 1
Rankings
Dependent repos count: 14.3%
Dependent packages count: 16.7%
Average: 37.0%
Forks count: 47.4%
Stargazers count: 69.6%
Last synced: 6 months ago

Dependencies

.github/workflows/build-and-test.yml actions
.github/workflows/pull_request.yml actions
Package.swift swiftpm
Tests/UITests/UITests.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved swiftpm
  • github.com/StanfordBDHG/XCTRuntimeAssertions 0.2.5
  • github.com/StanfordSpezi/Spezi 0.7.1
  • github.com/apple/FHIRModels 0.5.0