How nhsdigital/mesh-client works
Main Components
a) Core Components:
• MESH Client Library
• NHS MESH API Service (External)
• SSL Certificate Management
• Message Handling System
b) Integration Points:
• Client Applications
• MESH Sandbox (for testing)
• NHS Digital Endpoints (INT/LIVE)
[Client Applications]
• ↓
[MESH Client Library]
• ↙ ↓ ↘
[Auth] [IO] [Message Handling]
• ↓
[SSL/Certificates]
• ↓
[NHS MESH API]
Key Elements to Highlight
a) Client Library Components:
• Authentication Module (mesh_auth.py)
• I/O Helpers (io_helpers.py)
• Key Management (key_helper.py)
• Type Definitions (types.py)
b) Security Layer:
• SSL Certificate Management
• CA Bundles for different environments (DEP/INT/LIVE)
• Authentication mechanisms
c) Message Flow:
• Message Sending
• Message Retrieval
• Message Acknowledgment
• Handshake Process
Specific Implementation Details
• Rectangles: Core components
• Blue: Core MESH client components
• Green: External NHS Digital services
• Yellow: Security components
• Gray: Testing/Development components
Testing Infrastructure
• MESH Sandbox connection
• Test certificates
• Docker environment (Squid proxy)
Top Section:
[Client Application Layer]
• Shows how applications integrate with the library
Middle Section:
[MESH Client Core]
• Authentication
• Message Operations
• Certificate Management
Bottom Section:
[External Services]
• NHS MESH API
• Different environments (INT/LIVE)
Important Flows
• Authentication flow
• Message sending flow
• Message retrieval flow
• Handshake process
• Error handling and retries
Technical Details
• SSL/TLS connection points
• API endpoint variations (INT/LIVE)
• Certificate paths and requirements
• Message acknowledgment flow