Demonstrate technical conformance for the National Imaging Registry XCA API (Consumer)

Supporting guidance:

Query a known patient with complete identifier - All Networks

Acceptance Criteria:

• Given I have a valid patient ID,
• When I query for imaging history with a known patient
• Then the system should return the patient's full imaging history

Test Data:

• A known patient with a valid, complete NHS number - All networks

Preconditions:

• User is authenticated and system is connected to all networks
• Patient exists in system with complete identifier and imaging history

Expected results:

• To test the validity of NHS numbers and no error found.
• Test no error is found in a single network - To confirm the test patient is known to a local network.
• Test no errors are found in all networks
• Local imaging history is displayed with no errors when querying remotely

Supporting guidance:

Query multiple reports from a single network. Return multiple reports from a single network. This must include one Key Object Selection (KOS) document.

AC 1 – Single-network scope

• Given the patient has reports in one network only and I am authorised,
• When I search by NHS number and open the Reports
• Then the system lists all patient reports from one network and no reports from other networks.

AC 2 – KOS linkage

• Given at least one report has an associated KOS
• When I choose View images / Key images from that report
• Then the correct study/series referenced by the KOS, and the source is displayed from a single network.

Test Data:

• A known patient with a valid, complete NHS number
• Network under test:

Local report available and imaging data available, 2 reports and exams from a single remote network

Preconditions:

• Clinician is authenticated and authorised to view documents.
• One network is online

Expected results:

• This shows all reports from the local network and one remote network only, nothing returned from other remote network.
• Each report opens successfully; patient header matches; metadata (status, source) is correct.
• Ability to view reports and images from a remote network.

Supporting guidance:

Query a patient's report from multiple networks with results - one report each from 2 different networks.

Acceptance Criteria:

• Given the patient has reports in different networks
• When I search by NHS number and open reports,
• Then the system lists all reports from multiple networks

Test Data:

• A known patient with a valid, complete NHS number:
• One report each from 2 different networks

Preconditions:

• Clinician is authenticated and authorised to view documents.
• 2 Networks are online and reachable;

Expected results:

• All reports from multiple networks in a single results list.
• Each report shows correct source network, status, date/time, and Report ID.
• Each report opens fully

Supporting guidance:

Retrieve a report from multiple networks/ one report per network - different reports from each network - 1 report per network, different reports from each network.

Acceptance criteria:

AC1 – Cross-network

• Given the patient has one report in each of the networks,
• When I search by NHS number and open reports,
• Then the system lists two reports from 2 different networks—one per network.

AC2 – Metadata completeness

• Given the report list is displayed,
• When I view the list of the reports,
• Then each report shows source network, status, date/time, and Report ID

Test Data:

• A known patient with a valid, complete NHS number,
• One report each from 2 different networks.

Preconditions:

• Clinician is authenticated and authorised to view documents.
• 2 Networks are online and reachable;

Expected results:
All reports from multiple networks in a single results list - one report per network - different reports from each network

• Each report shows correct source network, status, date/time, and Report ID.
• Each report opens fully

Supporting guidance:

Retrieve multiple reports from a single network - Multiple reports from a single network

Acceptance Criteria:

• Given the patient has multiple reports from one network
• When I request for multiple reports from a single network
• Then NIR should retrieve all reports from that single network.

Test Data:
A test patient with:

• With a valid, complete NHS number,
• At least one imaging report from different networks.

Preconditions:

• Clinician is authenticated and authorised in their local system.
• Patient has multiple reports stored in a single network
• Test patient exists with valid NHS number in a single network
• Test data exists in a single network and is accessible under normal conditions
• The patient exists in the selected network with multiple reports.

Expected results:

• Reports from a single network appears with correct metadata and open successfully.
• All reports from the single network are displayed correctly.

Supporting guidance:

Confirm a report is linked to the correct imaging data - Each report links to its study

Acceptance criteria:

• Given the report has linked image metadata
• When I view the report.
• Then it should open the correct associated image.

Test Data:

• A known patient with a valid, complete NHS number:
• Reports ID with linked image ID

Preconditions:

• Reports have associated image metadata

Expected results:

• Report correctly linked to its corresponding image.
• Clicking on a report launches the exact associated imaging study in the viewer

Supporting guidance:

Retrieve imaging data from multiple networks - 2 studies in 1 network and 1 in another

Acceptance Criteria:

• Given the patient has imaging in two or more networks,
• When I search by NHS number and open imaging data,
• Then the system lists all imaging data from the contributing networks.

Test Data

• A known patient with a valid, complete NHS number
• Patient has imaging in multiple networks

Preconditions

• Clinician is authenticated and authorised to access imaging.
• All participating networks are online and reachable.

Expected Result:

• Images from all networks are displayed

Supporting guidance:

Retrieve imaging data from a single network - One imaging data is required and one report is required

Acceptance Criteria:

• Given the patient has imaging in one network
• When I retrieve images
• Then the system should return the available images.

Test Data:

• A known patient with a valid, complete NHS number:
• A test patient with imaging data in a single network

Preconditions:

• Connectivity to the target network is available and functioning.
• The patient exists in the target network with at least one imaging study and an associated report.

Expected result:

• Images from a single network are displayed

Supporting guidance:

Failure with all responding gateways - Minimal dataset; simulate all gateways down

Acceptance criteria:

• All gateways to return server errors.
• Given that I have a valid request,
• And all configured gateways return 5xx errors (or equivalent fatal failures)
• When I submit a patient query
• Then the system must stop processing and surface a consolidated failure banner: “No networks available. Unable to retrieve data.”
• And the status shows each gateway as Unavailable

Test Data:

• A known patient with a valid, complete NHS number:
• Gateway configuration
• Error response templates

Preconditions:

• All gateways are down or not responding

Expected result:

• All responding gateways fail; three errors are returned, and no results are available

Supporting guidance:

Partial failure with responding gateways - Out of 3 networks, 2 are unavailable because their gateways are switched off, for the purpose of UAT and 1 is available because its gateway is online for UAT.

Acceptance criteria:

• Given I submit a patient query and one gateway fails while others succeed,
• When results are returned
• Then the system must display available results from successful gateways immediately
• And show a “Partial results—some networks unavailable"
• And list failed gateways with a non-technical status reason (Gateway is down) Unavailable

Test Data:

• A known patient with a valid, complete NHS number:

Data available in all networks, and ;

• Network failure in one responding gateway
• Another responding gateway with returned data.
• One of the networks will turn off their gateway (Network down)

Preconditions:

• Simulate network failure in one gateway by shutting down its connection
• Other gateways remain operational and able to return data.

Expected results:

• The failed gateway is clearly identified by its Home Community ID, with wording indicating that the gateway is down
• Other responding gateway will return data.

Supporting guidance:

System response to unknown patient ID - No images/reports exist due to unknown patient ID

Acceptance criteria:

• Given that I entered an unknown or invalid patient ID
• When I submit a patient data query
• Then the system should return a clear “No patient found” message
• And no patient details or partial results should be displayed.

Test Data:

• A test patient ID that is guaranteed not to exist in the connected networks or test database
• No demographic, imaging, or report data associated with this ID

Preconditions:

• Test environment is connected to all relevant networks and operational
• No network contains the specified patient ID

Expected result:

• The system displays no result.

Supporting guidance:

NIR Gateway is down - Other networks available; NIR gateway unavailable

Acceptance criteria:
NIR gateway is down when querying patient data:

• Given I am logged into the clinical system (local system) with the correct permissions
• And I have entered a valid NHS Number for a patient
• And the NIR gateway is currently unavailable
• When I submit the patient query
• Then the system should display a clear message "National Imaging Registry gateway is unavailable, unable to retrieve data.

Test Data:

• A known patient with a valid, complete NHS number,
• Patient has imaging/report records available locally or in at least one alternative network (to verify when NIR gateway is down.)

Preconditions:

• NIR gateway is deliberately unavailable in UAT.
• Other data sources (local system and/or another connected network) are online and healthy.

Expected results:

• Network(s) displays information to users that the responding gateway is down.
• There is no specific error code, since it's down, but standard AWS logging will be able to detect the down time of the system, such as health checks failing.