Radiology (Sandbox)
0.0.1-current - ci-build International flag

Requirement Specification

This is for collaboration and discussion purposes and is subject to change.

This is not an Implementation Guide

Radiology (Sandbox) - Local Development build (v0.0.1-current) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: Find and Retrieve Imaging Reports

Official URL: https://fhir.nhs.uk/England/RAD/CapabilityStatement/FindAndRetrieveImagingReports Version: 0.0.1-current
Draft as of 2024-04-20 Computable Name: FindAndRetrieveImagingReports

This is a capture of requirements coming from this project.

Although this is classed here as a Document Repository, it may often be implemented as a Clinical Data Repository and so the actual API may be more expressive e.g. IHE Query for Existing Data for Mobile (QEDm).

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement FindAndRetrieveImagingReports

Find and Retrieve Imaging Reports

  • Implementation Guide Version: 0.0.1-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2024-04-20
  • Published by: NHS England

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Security
Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
DiagnosticReporthttps://fhir.nhs.uk/England/RAD/StructureDefinition/ImagingReport
Additional supported profiles:
  UK Core DiagnosticReport		yy_id
Base System Profile
Imaging Report (FHIR DiagnosticReport)
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core DiagnosticReport

Interaction summary
  • Supports read, search-type.

Documentation

Read

GET /DiagnosticReport/{id}

Example

GET /DiagnosticReport/ABCD

Example API response:

Search

GET /DiagnosticReport?{parameters}

Example

GET /DiagnosticReport?_id=ABCD

Example response:

Implementers SHALL also conform to UKCore-DocumentReference and conformance to all profiles SHOULD be tested via FHIR Validation.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

logical identifier of resource