How cdcgov/recordlinker works
Main Components
a. API Layer
• FastAPI application (evident from the main.py and routes structure)
• Route handlers for algorithms, linking, patients, and seeding
• OpenAPI/Swagger documentation endpoint
b. Core Services
• Record Linking Engine (src/recordlinker/linking)
• Algorithm Service
• MPI (Master Patient Index) Service
• HL7/FHIR Integration Service
c. Data Layer
• Database Services
• Data Models
• Schema Validators
d. External Integrations
• Splunk logging
• Docker containerization
• Kubernetes deployment
┌─────────────────────────────────────────────────────────┐
• Client Applications │
• ┘
• ↓ HTTP/REST
┌─────────────────────────────────────────────────────────┐
• API Gateway │
• ┌─────────────┐ ┌──────────┐ ┌────────────────┐ │
• Patient │ │ Link │ │ Algorithm │ │
• Router │ │ Router │ │ Router │ │
• ┘ └──────────┘ └────────────────┘ │
• ┘
• ↓
┌─────────────────────────────────────────────────────────┐
• Service Layer │
• ┌─────────────┐ ┌──────────┐ ┌────────────────┐ │
• MPI │ │ Record │ │ Algorithm │ │
• Service │ │ Linker │ │ Service │ │
• ┘ └──────────┘ └────────────────┘ │
• ┘
• ↓
┌─────────────────────────────────────────────────────────┐
• Data Layer │
• ┌─────────────┐ ┌──────────┐ ┌────────────────┐ │
• MPI │ │ Algorithm │ │ FHIR │ │
• Models │ │ Models │ │ Models │ │
• ┘ └──────────┘ └────────────────┘ │
• ┘
• ↓
┌─────────────────────────────────────────────────────────┐
• Infrastructure Layer │
• ┌─────────────┐ ┌──────────┐ ┌────────────────┐ │
• Docker │ │ Database │ │ Splunk │ │
• Containers │ │ │ │ Logging │ │
• ┘ └──────────┘ └────────────────┘ │
• ┘
Important Details to Highlight
a. Integration Points
• HL7/FHIR integration points
• Database connections
• Logging and monitoring touchpoints
b. Key Workflows
• Record linking process flow
• Algorithm configuration flow
• Patient data ingestion flow
Deployment View
• Docker container organization
• Kubernetes deployment structure (based on ops/manifests)
• Network boundaries and security zones
• Load balancing and scaling points