How department-of-veterans-affairs/health-apis-smart-cards works
Main Components
a. External Components:
• API Gateway/Kong (Authentication & Rate Limiting)
• Data Query API (FHIR-compliant health data)
• Datamart/Corporate Data Warehouse (Source data storage)
b. Internal Components:
• Smart Cards Core Service
• PEM to JWK Converter
• Mock Services (for development/testing)
• Integration Tests
Client Layer
Gateway Layer (Kong)
Application Layer (Smart Cards)
Integration Layer (Data Query)
Data Layer (Datamart)
Component Details to Highlight
a. Smart Cards Core Service:
• Controllers Package (MetadataController, PatientController, WellKnownController)
• Security Components (PayloadSigner, JwksProperties)
• Data Processing (ImmunizationMinimizer, PatientMinimizer)
• FHIR Client Integration (DataQueryFhirClient)
b. Supporting Services:
• PEM-to-JWK Converter utility
• Mock Services for testing
• Integration test suite
Flow Representation
• Incoming requests through Kong
• Authentication flow
• Data retrieval path from Datamart through Data Query
• Health card issuance flow
Additional Elements
Specific annotations for:
• SMART-on-FHIR OAuth scope enforcement points
• Verifiable credential generation points
• Data minimization processing
• Key conversion processes
Technical Details to Note
• Spring Boot application context
• FHIR compliance points
• JWT/JWK handling
• Health Cards Framework compliance
Key Considerations: