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

Locate and access patient information shared by other healthcare organisations using the National Imaging Registry XCA (Consumer) API.

Help and tips for completing this section

The following resources provide more details on how to complete technical conformance for the National Imaging Registry API:

NIR-CO-NF

As an NIR consumer, I need the service to be performant, so end users get responses back within an appropriate timeframe

NFT-01 - As a clinician querying patient's data, I want to measure the system’s response time when querying a patient’s record, so that I can verify that NIR meets performance requirements and service-level agreements (SLAs).

Supporting information

Supporting guidance:

Measure response time for patient's query - Add any datasets

Acceptance criteria:

  • Given that I entered a valid patient ID with available records
  • When I initiate a patient data query
  • Then the system should return the query results within the defined SLA threshold
  • And the response time should be logged for audit and analysis purpose

Test Data:

  • A known patient with a valid, complete NHS number.
  • Patient has multiple records (demographics, imaging history, and reports)
  • Network connections are stable and operational.

Preconditions:

  • Test environment is fully connected to all relevant networks
  • Performance logging tools or timers are available to capture response times
  • SLA threshold for query response is defined.

Expected result:

  • The system successfully retrieves the patient’s records within the SLA threshold, and the actual response time is accurately recorded in the performance logs for reporting and compliance verification.
You can enter up to 2000 characters

Do you want to upload the requirement evidence now?

You can upload one file that is smaller than 250MB. If you need to provide multiple files you should zip them up and upload them as a single .zip file.
NIR-CO-NF

As an NIR consumer, I need the service to be performant, so end users get responses back within an appropriate timeframe

NFT-02 - As a clinician retrieving imaging reports, I want to measure the system’s response time for retrieving reports, so I can review findings quickly and make timely clinical decisions and also verify that NIR meets performance requirements and service-level agreements (SLAs).

Supporting information

Supporting guidance:

Measure response time for Report Retrieval - One KOS document + one PDF report

Acceptance criteria:

  • Given that I opened a known patient’s chart and selects a final imaging report
  • When I requests to open the report
  • Then the full report content is displayed within the SLA
  • And the report patient header matches the currently selected patient (no mismatch)
  • And the entire report renders (structured sections) with no truncation or placeholder text
  • And the retrieval event is audit-logged (user, patient, report ID, source network, start/end time, duration, outcome)

Test Data:

  • A known patient with a valid, complete NHS number:
  • Available reports data for testing purposes
  • Network connections are stable and operational.

Preconditions:

  • Clinician is authenticated and has permission to view patient documents
  • Patient is positively identified (correct demographics visible in header).
  • Report(s) exist and are final (not “preliminary” or “pending”).
  • Viewing application is available and can render structured text.
  • SLA for report retrieval is defined clinically (e.g., ≤ 4 seconds from open request to full report display).
  • Network connections to A and B are operational

Expected result:

  • The selected report opens completely and correctly within the defined SLA.
  • The patient identity is clearly consistent, any critical flag is visible, and an audit entry captures retrieval metadata and total duration
You can enter up to 2000 characters

Do you want to upload the requirement evidence now?

You can upload one file that is smaller than 250MB. If you need to provide multiple files you should zip them up and upload them as a single .zip file.
NIR-CO-NF

As an NIR consumer, I need the service to be performant, so end users get responses back within an appropriate timeframe

NFT-03 - As a clinician, I want to measure the system’s response time for retrieving image data, so I can review key images, and make timely decisions and also verify that NIR meets performance requirements and service-level agreements (SLAs).

Supporting information

Supporting guidance:

Measure response time for Image Retrieval - Large document + small file size

Acceptance criteria:

  • Given I am an authorised user and the viewer is available
  • And monitoring is enabled for NIR image retrieval
  • When I try to retrieve an imaging data with typical series count and size
  • Then both metrics are logged with timestamp, exam identifier (pseudonymised), network/source, and correlation ID

Test Data:

  • A known patient with a valid, complete NHS number:
  • Available imaging data for testing purposes

Preconditions:

  • Network connections are stable and operational.
  • Authorised clinical user logged in from their local system.
  • Imaging viewer available and integrated with NIR
  • Performance monitoring & logging enabled
  • SLA for image retrieval is defined clinically (e.g. 4 seconds from open request to full image display).

Expected results:

  • Images appear quickly enough to support urgent and routine care without delaying decisions.
  • Clear indication of partial data when a network is slow/offline, without blocking available content.
  • Performance evidence available for NIR service reporting and continuous improvement.
You can enter up to 2000 characters

Do you want to upload the requirement evidence now?

You can upload one file that is smaller than 250MB. If you need to provide multiple files you should zip them up and upload them as a single .zip file.