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

ExampleScenario: Finding Imaging Reports and Images - Central Registry (NRL)

Official URL: https://fhir.nhs.uk/England/RAD/ExampleScenario/FindingImagingReportsStudiesAndImagesCentralRegistry Version: 0.0.1-current
Draft as of 2024-10-24 Computable Name: FindingImagingReportsStudiesAndImagesCentralRegistry

Actors

Generated Narrative: ExampleScenario FindingImagingReportsStudiesAndImagesCentralRegistry

NameTypeDescription
Document Consumer System

The Document Consumer Actor queries for documents meeting certain criteria, and may retrieve selected documents.

Document Registry System

The Document Registry Actor maintains metadata about each registered document in a document entry. This includes a link to the Document in the Repository where it is stored. The Document Registry responds to queries from Document Consumer actors about documents meeting specific criteria.

Document Repository System

The Document Repository is responsible for both the persistent storage of these documents (e.g. Imaging Report)

Imaging Repository System

The Imaging Repository is responsible for both the persistent storage of DICOM Images and Imaging Studies, these may also contain Imaging Reports. This is also known as a PACS.

Diagram

PlantUML 1.2023.9 <b>This version of PlantUML is 498 days old, so you should<b>consider upgrading from https://plantuml.com/download[From string (line 18) ] @startumlTitle FindingImagingReportsStudiesAndImagesCentralRegistry participant "[[#a_user{The [Document Consumer](ActorDefinition-DocumentConsumer.html) Actor queries for documents meetin ...participant "[[#a_xds{The [Document Registry](ActorDefinition-DocumentRegistry.html) Actor maintains metadata about each ...participant "[[#a_docs{The [Document Repository](ActorDefinition-DocumentRepository.html) is responsible for both the pe ...participant "[[#a_image{The [Imaging Repository](ActorDefinition-ImagingRepository.html) is responsible for both the per ... group Query patient image and/or report [[#p_1 details]]user -> xds: [[#s_1.1 Search for Documents]] ([[#i_NRLSearchDocumentEntries payload]])activate xdsxds --> user: [[#s_1.1 response]] ([[#i_NRLReturnDocumentEntries payload]])deactivate xdsend group Option - Retrieve selected imaging report [[#p_2{This is an optional step. The **Document Consumer** may choose to ... Other options are being discussed by HL7 Europe such as a [EU Medical imaging studies and reports](https://health.ec.eu ...Syntax Error?

Processes

Generated Narrative: ExampleScenario FindingImagingReportsStudiesAndImagesCentralRegistry

Process: Query patient image and/or report
StepNameDescriptionInitiatorReceiverRequestResponse
1 Search for Documents - search-type (Details: FHIR Restful Interactions code search-type) Document Consumer Document Registry Query for Document Entries Return Document Entry results
Process: Option - Retrieve selected imaging report

This is an optional step. The Document Consumer may choose to retrieve the Imaging Report. At present this is a Royal College of Radiologists HL7 ORU converted to a FHIR DiagnosticReport profile as Imaging Report, this also contains mappings between HL7 ORU and FHIR DiagnosticReport.

Other options are being discussed by HL7 Europe such as a EU Medical imaging studies and reports which is likely to be a derivative of HL7 IPS, like the HL7 Europe Laboratory Report.

StepNameDescriptionInitiatorReceiverRequestResponse
1 Retrieve Imaging Report by searching on a _id - search-type (Details: FHIR Restful Interactions code search-type) Document Consumer Document Repository Query for DiagnosticReport Return DiagnosticReport results
Process: Option - Retrieve selected imaging study

This is an optional step. The Document Consumer may choose to retrieve the Imaging Study. At present this is a DICOM KOS which contains DICOM modalities to used for retrieval of the Image Instances.

Other options include using FHIR ImagingStudy which is a FHIR version of the DICOM KOS.

Process: Retrieve selected image (optional)
StepNameDescriptionInitiatorReceiverRequestResponse
1 Retrieve Imaging Study - read (Details: FHIR Restful Interactions code read) Document Consumer Imaging Repository Read ImagingStudy Return Imaging Study
2 See subprocess below
StepNameDescriptionInitiatorReceiverRequestResponse
2.1 Retrieve Image - read (Details: FHIR Restful Interactions code read) Document Consumer Imaging Repository Read Image Instance Return Image

Instances

Generated Narrative: ExampleScenario FindingImagingReportsStudiesAndImagesCentralRegistry

NameTypeContentDescription
Query for Document Entries Binary

See Finding and Retrieving Document Entries (NRL) for API base contract. E.g.

GET https://example.nhs.uk/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888
Return Document Entry results Bundle
  • Search Results NRL
here
Query for DiagnosticReport Binary

See Find and Retrieve Imaging Reports for API base contract. E.g.

GET https://example.nhs.uk/FHIR/R4/DiagnosticReport?_id=ABCD
Return DiagnosticReport results Bundle
  • Search Diagnostic Report by _id
here
Read ImagingStudy Binary

See Retrieve Imaging Study for API overview

Return Imaging Study Binary

DICOM KOS

Read Image Instance Binary

See Retrieve Image Instances for API overview

Return Image Binary

DICOM Image Instance