This directory contains the technical design and interface specifications. For high-level business context, clinical safety documentation, and project roadmaps, please refer to our Confluence Space.

The service uses OpenAPI 3.0 and HL7 FHIRv4 standards for data exchange.

• home-test-consumer-api.yaml: The primary API definition for the HomeTest Service. It covers:
  • Order Management: Creating test orders and retrieving order history using NHS numbers and date of birth for patient verification.
  • Result Service: Viewing test results for completed orders with patient identity verification.
  • FHIR Resources: Utilizes ServiceRequest for orders, Observation for results, and Bundle for search result collections.

The schemas and specifications for external supplier integrations are hosted centrally in the HomeTest Supplier Integration Framework.

• Home Test Supplier API: Defines the interface for supplier-side operations.
• Supplier API Spec: The core specification for supplier integration requirements.

• AWS_Component_Diagram.drawio.png: A technical diagram showing the AWS resource layout. It illustrates how the Lambda functions, API Gateway, and PostgreSQL database interact within the cloud environment.

1. FHIR Compliant: All medical data (orders, results, patients) follows FHIR standards to ensure interoperability across the NHS ecosystem.
2. Supplier Agnostic: The core service acts as an orchestrator, delegating fulfillment to multiple suppliers through a standardised adapter pattern.
3. Serverless First: Built on AWS Lambda to provide scalability and cost-efficiency.