Intended audience
This documentation is intended for teams integrating with national services to support clinical and patient-facing journeys for proxy access.
Primary Audience
The primary audience is:
- Software engineers
- QAs / Test engineers
- Solution and technical architects
These readers are expected to:
- Implement authentication and token exchange flows
- Integrate with REST APIs and event mechanisms
- Design system-to-system interactions
- Ensure environment configuration and security requirements are met
- Solutions assurance through functional and non-functional testing
The documentation assumes familiarity with:
- OAuth2 and OpenID Connect
- RESTful APIs
- JSON and FHIR-based payloads
- Secure service-to-service integration patterns
Secondary Audience
This documentation is also relevant to:
- Product owners
- Delivery managers
- Technical business analysts
For these roles, the documentation provides:
- An understanding of available platform capabilities
- Constraints and integration patterns
- Governance and clinical safety considerations
- Dependencies that may influence delivery planning
It is not intended to define product strategy, user interface design, or local operational policy, but it does highlight areas where product and governance decisions are required.
Clinical and Information Governance Stakeholders
Certain sections - particularly those relating to clinical workflows and patient facing journeys - are relevant to:
- Clinical safety officers
- Information governance leads
- Safeguarding teams
These stakeholders should be engaged where services enable access to patient data on behalf of another individual.
Edit this page on GitHub