Adds a FHIR Standard, HealthKit Adapter, Mock Patient, and Interpreta…

…tion Target (#11)

# Adds a FHIR Standard, HealthKit Adapter, Mock Patient, and
Interpretation Target


## ⚙️ Release Notes 
- New FHIR Standard: Integrated a new standard for developing FHIR-based
digital health applications, ensuring compliance and ease of use with
FHIR protocols.
- HealthKit Adapter: Introduced an adapter for HealthKit, allowing for
seamless integration and data exchange between HealthKit and FHIR
resources.
- Mock Patient Model: Added a mock patient model for testing and
development purposes, enabling developers to simulate patient data and
interactions based on FHIR R4 `Bundle`s.
- Interpretation Target: Implemented an interpretation target to enhance
the processing and analysis of FHIR resources including LLM-based
interactions.


## 📝 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).

.github/workflows/build-and-test.yml

@@ -1,7 +1,7 @@
 #
 # This source file is part of the Stanford Spezi open-source project
 #
-# SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
+# SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
 #
 # SPDX-License-Identifier: MIT
 #
@@ -20,9 +20,9 @@ jobs:
     name: Build and Test Swift Package
     uses: StanfordSpezi/.github/.github/workflows/xcodebuild-or-fastlane.yml@v2
     with:
-      artifactname: SpeziFHIR.xcresult
+      artifactname: SpeziFHIR-Package.xcresult
       runsonlabels: '["macOS", "self-hosted"]'
-      scheme: SpeziFHIR
+      scheme: SpeziFHIR-Package
   buildandtestuitests:
     name: Build and Test UI Tests
     uses: StanfordSpezi/.github/.github/workflows/xcodebuild-or-fastlane.yml@v2
@@ -36,4 +36,4 @@ jobs:
     needs: [buildandtest, buildandtestuitests]
     uses: StanfordSpezi/.github/.github/workflows/create-and-upload-coverage-report.yml@v2
     with:
-      coveragereports: SpeziFHIR.xcresult TestApp.xcresult
+      coveragereports: SpeziFHIR-Package.xcresult TestApp.xcresult

.github/workflows/monthly-markdown-link-check.yml

@@ -0,0 +1,19 @@
+#
+# 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
+#
+
+name: Monthly Markdown Link Check
+
+on:
+  # Runs at midnight on the first of every month
+  schedule:
+    - cron: "0 0 1 * *"
+
+jobs:
+  markdown_link_check:
+    name: Markdown Link Check
+    uses: StanfordBDHG/.github/.github/workflows/markdown-link-check.yml@v2

.github/workflows/pull_request.yml

@@ -1,7 +1,7 @@
 #
 # This source file is part of the Stanford Spezi open-source project
 #
-# SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
+# SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
 #
 # SPDX-License-Identifier: MIT
 #
@@ -19,3 +19,6 @@ jobs:
   swiftlint:
     name: SwiftLint
     uses: StanfordSpezi/.github/.github/workflows/swiftlint.yml@v2
+  markdown_link_check:
+    name: Markdown Link Check
+    uses: StanfordBDHG/.github/.github/workflows/markdown-link-check.yml@v2

.gitignore

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

.spi.yml

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

.swiftlint.yml

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

CITATION.cff

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

CONTRIBUTORS.md

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

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
+Copyright (c) 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

LICENSES/MIT.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
+Copyright (c) 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

Package.swift

@@ -3,7 +3,7 @@
 //
 // This source file is part of the Stanford Spezi open-source project
 //
-// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
+// SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
 //
 // SPDX-License-Identifier: MIT
 //
@@ -18,18 +18,55 @@ let package = Package(
         .iOS(.v17)
     ],
     products: [
-        .library(name: "SpeziFHIR", targets: ["SpeziFHIR"])
+        .library(name: "SpeziFHIR", targets: ["SpeziFHIR"]),
+        .library(name: "SpeziFHIRHealthKit", targets: ["SpeziFHIRHealthKit"]),
+        .library(name: "SpeziFHIRInterpretation", targets: ["SpeziFHIRInterpretation"]),
+        .library(name: "SpeziFHIRMockPatients", targets: ["SpeziFHIRMockPatients"])
     ],
     dependencies: [
         .package(url: "https://github.com/apple/FHIRModels", .upToNextMinor(from: "0.5.0")),
-        .package(url: "https://github.com/StanfordSpezi/Spezi", .upToNextMinor(from: "0.8.0"))
+        .package(url: "https://github.com/StanfordBDHG/HealthKitOnFHIR", .upToNextMinor(from: "0.2.4")),
+        .package(url: "https://github.com/StanfordSpezi/Spezi", .upToNextMinor(from: "0.8.0")),
+        .package(url: "https://github.com/StanfordSpezi/SpeziHealthKit.git", .upToNextMinor(from: "0.4.0")),
+        .package(url: "https://github.com/StanfordSpezi/SpeziML.git", .upToNextMinor(from: "0.3.1"))
     ],
     targets: [
         .target(
             name: "SpeziFHIR",
             dependencies: [
                 .product(name: "Spezi", package: "Spezi"),
-                .product(name: "ModelsR4", package: "FHIRModels")
+                .product(name: "ModelsR4", package: "FHIRModels"),
+                .product(name: "ModelsDSTU2", package: "FHIRModels"),
+                .product(name: "HealthKitOnFHIR", package: "HealthKitOnFHIR")
+            ]
+        ),
+        .target(
+            name: "SpeziFHIRHealthKit",
+            dependencies: [
+                .target(name: "SpeziFHIR"),
+                .product(name: "HealthKitOnFHIR", package: "HealthKitOnFHIR"),
+                .product(name: "SpeziHealthKit", package: "SpeziHealthKit")
+            ]
+        ),
+        .target(
+            name: "SpeziFHIRInterpretation",
+            dependencies: [
+                .target(name: "SpeziFHIR"),
+                .product(name: "Spezi", package: "Spezi"),
+                .product(name: "ModelsR4", package: "FHIRModels"),
+                .product(name: "SpeziOpenAI", package: "SpeziML")
+            ],
+            resources: [
+                .process("Resources")
+            ]
+        ),
+        .target(
+            name: "SpeziFHIRMockPatients",
+            dependencies: [
+                .target(name: "SpeziFHIR")
+            ],
+            resources: [
+                .process("Resources")
             ]
         ),
         .testTarget(

README.md

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

Sources/SpeziFHIR/FHIR+Identifiable.swift → Sources/SpeziFHIR/Extensions/FHIR+Identifiable.swift

@@ -1,7 +1,7 @@
 //
-// This source file is part of the Stanford Spezi open-source project
+// This source file is part of the Stanford Spezi open source project
 //
-// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
+// SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
 //
 // SPDX-License-Identifier: MIT
 //

Sources/SpeziFHIR/FHIR.swift

@@ -0,0 +1,53 @@
+//
+// 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
+//
+
+import Spezi
+
+
+/// Spezi standard to support the development of FHIR-based digital health applications.
+///
+/// > 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) setup the core Spezi infrastructure.
+///
+/// The standard needs to be registered in a Spezi-based application using the [`configuration`](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/speziappdelegate/configuration)
+/// in a [`SpeziAppDelegate`](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/speziappdelegate):
+/// ```swift
+/// class ExampleAppDelegate: SpeziAppDelegate {
+///     override var configuration: Configuration {
+///         Configuration(standard: FHIR()) {
+///             // ...
+///         }
+///     }
+/// }
+/// ```
+/// > Tip: You can learn more about a [`Standard` in the Spezi documentation](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/standard).
+///
+///
+/// ## Usage
+///
+/// The ``FHIR`` standard injects an ``FHIRStore`` instance in the SwiftUI environment to handle the storage and management of FHIR resources.
+///
+/// ```swift
+/// class ContentView: View {
+///     @Environment(FHIRStore.self) var store
+///
+///
+///     var body: some View {
+///         // ...
+///     }
+/// }
+/// ```
+///
+/// > Tip: You can learn more about how to use the store in the ``FHIRStore`` documentation.
+public actor FHIR: Standard {
+    @Model public private(set) var store: FHIRStore
+
+
+    public init() {
+        self._store = Model(wrappedValue: FHIRStore())
+    }
+}