Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Non-Functional Requirements (Care Connect)

Details of non-functional requirements (NFRs) that describe system attributes such as security, reliability, maintainability, scalability, and usability

The non-functional requirements for systems assured for booking using the NHS FHIR Scheduling specification are detailed here. For the equivalent requirements for booking using the GP Connect standard, please see here: GP Connect non-functional requirements.

Security

Provider systems SHALL resist unauthorized, accidental or unintended usage and provide access only to legitimate users.

Volume and performance

  • Volumetric
    • Provider systems MUST meet the agreed volumetric performance targets.
  • Performance
    • Provider systems MUST meet the agreed response time performance targets.

Capacity

Provider systems MUST meet the agreed capacity requirements.

Scalability

Provider systems SHALL be designed to accommodate increased volumes, workloads and users.

Availability

Provider systems SHALL meet the agreed availability targets (service time and/or hours and planned downtime).

Recoverability

Provider systems SHALL meet the agreed recoverability targets

Audit & provenance

Provider systems SHALL audit all API access and actions.

Maintainability

Provider systems SHALL be designed to optimise the ability of maintenance personnel to revise or enhance it.

Serviceability

Provider systems SHALL be designed so that technical support personnel are able to monitor and manage it in operation. In particular error messages presented to the end user MUST be clear, understandable and helpful.

Clinical Risk Management

Provider and consumer systems MUST comply with NHS Digital Clinical Risk Management Standards, in particular 0129 (IT Supplier) and 0160 (Trust/Provider).

Data retention

Provider systems SHALL retain data in line with existing relevant Informational Governance and data protection regulation.

Usability

Provider and consumer systems SHOULD follow the ISO 13407 / ISO 9241-210

Accessibility

Provider and consumer systems MUST maintain a compliance of minimum Double “A” of the WCAG 1.0 (or equivalent in WCAG 2.0) or, as stipulated by UK Government guidelines, for all user interfaces. Please see the ,Web Accessibility Initiative for more details.

Deployment

Provider systems SHALL release a new major version of their Booking and Referral APIs alongside a previous major version, until such time as consumers have migrated to the new major version. Alternatively, there must be support for backward compatibility of requests to support consumers.

Provider systems SHOULD release a new minor or patch version, replacing the previous minor or patch version.

The Booking and Referral (ITK) API Endpoints SHOULD be independently deployable against different FQDNs. This ensure support for limitations around sending and receiving CDA messages over ITK in Path-to-Live and Production environments.

To increase availability, during upgrades and maintenance, the Booking and Referral APIs SHOULD be load balanced across multiple servers.

In multi tenanted deployments, the activity of individial tenants MUST be readily retrievable.


All content is available under the Open Government Licence v3.0, except where otherwise stated