How stanfordspezi/spezifhir works
Project Type and Purpose
• SpeziFHIR is a Swift Package (see Package.swift) providing reusable modules for FHIR data handling, HealthKit integration, and mock patient data.
• It’s intended to be embedded into a mobile app built on the Spezi framework to manage FHIR resources locally, convert HealthKit samples to FHIR, handle attachments, and support testing.
Core Components
A. SpeziFHIR (Core FHIR Library)
– FHIRResource submodule
• Category, Copy, Search, Stringify, LockManager, ResourceProxy
– FHIRAttachment submodule
• Base64Decoding, ContentExtractor, PDFDocumentProviding, FHIRAttachmentService
– FHIRStore
• Local store for reading/writing FHIR resources
– Extensions
• Convenience date extensions for various FHIR resource types
B. SpeziFHIRHealthKit
– Maps HealthKit samples → FHIRResource models
– Extends FHIRStore to load attachments and persist HealthKit‐derived data
C. SpeziFHIRMockPatients
– Supplies FHIRBundle “mock patients” resources + selectors
– Testing‐support extensions on FHIRStore for injecting mock data
D. Tests
– Unit tests for each submodule under Tests/SpeziFHIRTests
– UI tests (Tests/UITests/TestApp) demonstrating package in a dummy app
External Services / Frameworks
• HealthKit (iOS API) – data source for FHIRHealthKit module
• PDFKit / Base64 – for attachment decoding & extraction
• Spezi application (host app) – uses package modules via SwiftPM
Relationships & Data Flows
• Host App → imports SpeziFHIR & configures FHIRStore
• SpeziFHIRHealthKit reads HealthKit samples → transforms into FHIRResource → persists via FHIRStore
• Host App reads from FHIRStore → drives UI
• Host App / SpeziFHIRAttachmentService handles attachments (e.g., fetch embedded base64, decode, extract PDF/text)
• In tests, SpeziFHIRMockPatients injects mock FHIRBundle into FHIRStore → UI Tests reuse same FHIRStore interface
Architectural Patterns & Principles
• Modular layering: Core FHIR logic is independent of HealthKit & Mock data modules
• Dependency injection: Host app provides FHIRStore instance to submodules
• Single responsibility: each submodule focuses on one domain (resources, attachments, HealthKit, mocking)
• Extensibility: extension files under Sources/SpeziFHIR/Extensions demonstrate open‐extension points