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

• Narrative Content
• XML
• JSON

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

Draft as of 2024-10-24

Raw xml | Download

<ExampleScenario xmlns="http://hl7.org/fhir">
  <id value="FindingImagingReportsStudiesAndImagesCentralRegistry"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: ExampleScenario FindingImagingReportsStudiesAndImagesCentralRegistry</b></p><a name="FindingImagingReportsStudiesAndImagesCentralRegistry"> </a><a name="hcFindingImagingReportsStudiesAndImagesCentralRegistry"> </a><a name="FindingImagingReportsStudiesAndImagesCentralRegistry-en-US"> </a><p><b>url</b>: <a href="ExampleScenario-FindingImagingReportsStudiesAndImagesCentralRegistry.html">FindingImagingReportsStudiesAndImagesCentralRegistry</a></p><p><b>version</b>: 0.0.1-current</p><p><b>name</b>: FindingImagingReportsStudiesAndImagesCentralRegistry</p><p><b>status</b>: Draft</p><p><b>date</b>: 2024-10-24 15:09:54+0000</p><p><b>publisher</b>: NHS England</p><p><b>contact</b>: <a href="https://www.ihe.net/ihe_domains/it_infrastructure/">https://www.ihe.net/ihe_domains/it_infrastructure/</a>, <a href="mailto:iti@ihe.net">iti@ihe.net</a>, NHS England: <a href="mailto:iti@ihe.net">iti@ihe.net</a></p><p><b>jurisdiction</b>: <span title="Codes:{http://unstats.un.org/unsd/methods/m49/m49.htm 001}">Global (Whole world)</span></p><blockquote><p><b>actor</b></p><p><b>actorId</b>: user</p><p><b>type</b>: System</p><p><b>name</b>: Document Consumer</p><p><b>description</b>: </p><div><p>The <a href="ActorDefinition-DocumentConsumer.html">Document Consumer</a> Actor queries for documents meeting certain criteria, and may retrieve selected documents.</p>
</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: xds</p><p><b>type</b>: System</p><p><b>name</b>: Document Registry</p><p><b>description</b>: </p><div><p>The <a href="ActorDefinition-DocumentRegistry.html">Document Registry</a> 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.</p>
</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: docs</p><p><b>type</b>: System</p><p><b>name</b>: Document Repository</p><p><b>description</b>: </p><div><p>The <a href="ActorDefinition-DocumentRepository.html">Document Repository</a> is responsible for both the persistent storage of these documents (e.g. Imaging Report)</p>
</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: image</p><p><b>type</b>: System</p><p><b>name</b>: Imaging Repository</p><p><b>description</b>: </p><div><p>The <a href="ActorDefinition-ImagingRepository.html">Imaging Repository</a> 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.</p>
</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLSearchDocumentEntries</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Query for Document Entries</p><p><b>description</b>: </p><div><p>See <a href="CapabilityStatement-FindDocumentsNRL.html">Finding and Retrieving Document Entries (NRL)</a> for API base contract. E.g.</p>
<pre><code>GET https://example.nhs.uk/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888
</code></pre>
</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLReturnDocumentEntries</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: Return Document Entry results</p><blockquote><p><b>version</b></p><p><b>Extension Definition for ExampleScenario.instance.version.title for Version 5.0</b>: Search Results NRL</p><p><b>Extension Definition for ExampleScenario.instance.version.content for Version 5.0</b>: <a href="Bundle-NRLSearchResultsDocuments.html">Bundle: type = searchset; total = 1</a></p><p><b>versionId</b>: 1</p></blockquote></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLSearchDiagnosticReports</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Query for DiagnosticReport</p><p><b>description</b>: </p><div><p>See <a href="CapabilityStatement-FindAndRetrieveImagingReports.html">Find and Retrieve Imaging Reports</a> for API base contract. E.g.</p>
<pre><code>GET https://example.nhs.uk/FHIR/R4/DiagnosticReport?_id=ABCD
</code></pre>
</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLReturnDiagnosticReports</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: Return DiagnosticReport results</p><blockquote><p><b>version</b></p><p><b>Extension Definition for ExampleScenario.instance.version.title for Version 5.0</b>: Search Diagnostic Report by _id </p><p><b>Extension Definition for ExampleScenario.instance.version.content for Version 5.0</b>: <a href="Bundle-NRLSearchDiagnosticReports.html">Bundle: type = searchset; total = 1</a></p><p><b>versionId</b>: 1</p></blockquote></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLRetrieveImagingStudy</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Read ImagingStudy</p><p><b>description</b>: </p><div><p>See <a href="CapabilityStatement-RetrieveImagingStudy.html">Retrieve Imaging Study</a> for API overview</p>
</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLRetrieveImagingStudyResult</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Return Imaging Study</p><p><b>description</b>: </p><div><p>DICOM KOS</p>
</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLRetrieveImage</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Read Image Instance</p><p><b>description</b>: </p><div><p>See <a href="CapabilityStatement-RetrieveImageInstances.html">Retrieve Image Instances</a> for API overview</p>
</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLRetrieveImageResult</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Return Image</p><p><b>description</b>: </p><div><p>DICOM Image Instance</p>
</div></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Query patient image and/or report</p><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 1</p><p><b>type</b>: search-type</p><p><b>name</b>: Search for Documents</p><p><b>initiator</b>: user</p><p><b>receiver</b>: xds</p><h3>Requests</h3><table class="grid"><tr><td style="display: none">-</td><td><b>ResourceId</b></td></tr><tr><td style="display: none">*</td><td>NRLSearchDocumentEntries</td></tr></table><h3>Responses</h3><table class="grid"><tr><td style="display: none">-</td><td><b>ResourceId</b></td></tr><tr><td style="display: none">*</td><td>NRLReturnDocumentEntries</td></tr></table></blockquote></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Option - Retrieve selected imaging report</p><p><b>description</b>: </p><div><p>This is an optional step. The <strong>Document Consumer</strong> may choose to retrieve the <strong>Imaging Report</strong>. At present this is a <a href="https://www.rcr.ac.uk/media/wwtp2mif/rcr-publications_radiology-reporting-networks-understanding-the-technical-options_march-2022.pdf">Royal College of Radiologists HL7 ORU</a> converted to a FHIR DiagnosticReport profile as <a href="StructureDefinition-ImagingReport.html">Imaging Report</a>, this also contains mappings between HL7 ORU and FHIR DiagnosticReport.</p>
<p>Other options are being discussed by HL7 Europe such as a <a href="https://health.ec.europa.eu/document/download/0079ad26-8f8f-435b-9472-3cd8625f4220_en?filename=ehn_mi_guidelines_en.pdf">EU Medical imaging studies and reports</a> which is likely to be a derivative of <a href="https://build.fhir.org/ig/HL7/fhir-ips/index.html">HL7 IPS</a>, like the <a href="https://build.fhir.org/ig/hl7-eu/laboratory/">HL7 Europe Laboratory Report</a>.</p>
</div><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 1</p><p><b>type</b>: search-type</p><p><b>name</b>: Retrieve Imaging Report by searching on a _id </p><p><b>initiator</b>: user</p><p><b>receiver</b>: docs</p><h3>Requests</h3><table class="grid"><tr><td style="display: none">-</td><td><b>ResourceId</b></td></tr><tr><td style="display: none">*</td><td>NRLSearchDiagnosticReports</td></tr></table><h3>Responses</h3><table class="grid"><tr><td style="display: none">-</td><td><b>ResourceId</b></td></tr><tr><td style="display: none">*</td><td>NRLReturnDiagnosticReports</td></tr></table></blockquote></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Option - Retrieve selected imaging study</p><p><b>description</b>: </p><div><p>This is an optional step. The <strong>Document Consumer</strong> may choose to retrieve the Imaging Study. At present this is a <a href="https://dicom.nema.org/dicom/supps/sup59_lb.pdf">DICOM KOS</a> which contains DICOM modalities to used for retrieval of the Image Instances.</p>
<p>Other options include using FHIR ImagingStudy which is a FHIR version of the DICOM KOS.</p>
</div><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 1</p><p><b>type</b>: read</p><p><b>name</b>: Retrieve Imaging Study</p><p><b>initiator</b>: user</p><p><b>receiver</b>: image</p><h3>Requests</h3><table class="grid"><tr><td style="display: none">-</td><td><b>ResourceId</b></td></tr><tr><td style="display: none">*</td><td>NRLRetrieveImagingStudy</td></tr></table><h3>Responses</h3><table class="grid"><tr><td style="display: none">-</td><td><b>ResourceId</b></td></tr><tr><td style="display: none">*</td><td>NRLRetrieveImagingStudyResult</td></tr></table></blockquote></blockquote><blockquote><p><b>step</b></p><blockquote><p><b>process</b></p><p><b>title</b>: Retrieve selected image (optional)</p><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 1</p><p><b>type</b>: read</p><p><b>name</b>: Retrieve Image</p><p><b>initiator</b>: user</p><p><b>receiver</b>: image</p><h3>Requests</h3><table class="grid"><tr><td style="display: none">-</td><td><b>ResourceId</b></td></tr><tr><td style="display: none">*</td><td>NRLRetrieveImage</td></tr></table><h3>Responses</h3><table class="grid"><tr><td style="display: none">-</td><td><b>ResourceId</b></td></tr><tr><td style="display: none">*</td><td>NRLRetrieveImageResult</td></tr></table></blockquote></blockquote></blockquote></blockquote></blockquote></div>
  </text>
  <url
       value="https://fhir.nhs.uk/England/RAD/ExampleScenario/FindingImagingReportsStudiesAndImagesCentralRegistry"/>
  <version value="0.0.1-current"/>
  <name value="FindingImagingReportsStudiesAndImagesCentralRegistry"/>
  <status value="draft"/>
  <date value="2024-10-24T15:09:54+00:00"/>
  <publisher value="NHS England"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="https://www.ihe.net/ihe_domains/it_infrastructure/"/>
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="email"/>
      <value value="iti@ihe.net"/>
    </telecom>
  </contact>
  <contact>
    <name value="NHS England"/>
    <telecom>
      <system value="email"/>
      <value value="iti@ihe.net"/>
    </telecom>
  </contact>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
    </coding>
  </jurisdiction>
  <actor>
    <actorId value="user"/>
    <type value="entity"/>
    <name value="Document Consumer"/>
    <description
                 value="The [Document Consumer](ActorDefinition-DocumentConsumer.html) Actor queries for documents meeting certain criteria, and may retrieve selected documents."/>
  </actor>
  <actor>
    <actorId value="xds"/>
    <type value="entity"/>
    <name value="Document Registry"/>
    <description
                 value="The [Document Registry](ActorDefinition-DocumentRegistry.html) 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."/>
  </actor>
  <actor>
    <actorId value="docs"/>
    <type value="entity"/>
    <name value="Document Repository"/>
    <description
                 value="The [Document Repository](ActorDefinition-DocumentRepository.html) is responsible for both the persistent storage of these documents (e.g. Imaging Report)"/>
  </actor>
  <actor>
    <actorId value="image"/>
    <type value="entity"/>
    <name value="Imaging Repository"/>
    <description
                 value="The [Imaging Repository](ActorDefinition-ImagingRepository.html) 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."/>
  </actor>
  <instance>
    <resourceId value="NRLSearchDocumentEntries"/>
    <resourceType value="Binary"/>
    <name value="Query for Document Entries"/>
    <description
                 value=" See [Finding and Retrieving Document Entries (NRL)](CapabilityStatement-FindDocumentsNRL.html) for API base contract. E.g. 
```
GET https://example.nhs.uk/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888
```
 "/>
  </instance>
  <instance>
    <resourceId value="NRLReturnDocumentEntries"/>
    <resourceType value="Bundle"/>
    <name value="Return Document Entry results"/>
    <version>
      <extension
                 url="http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title">
        <valueString value="Search Results NRL"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content">
        <valueReference>🔗 
          <reference value="Bundle/NRLSearchResultsDocuments"/>
        </valueReference>
      </extension>
      <versionId value="1"/>
    </version>
  </instance>
  <instance>
    <resourceId value="NRLSearchDiagnosticReports"/>
    <resourceType value="Binary"/>
    <name value="Query for DiagnosticReport"/>
    <description
                 value=" See [Find and Retrieve Imaging Reports](CapabilityStatement-FindAndRetrieveImagingReports.html) for API base contract. E.g. 
```
GET https://example.nhs.uk/FHIR/R4/DiagnosticReport?_id=ABCD
```
 "/>
  </instance>
  <instance>
    <resourceId value="NRLReturnDiagnosticReports"/>
    <resourceType value="Bundle"/>
    <name value="Return DiagnosticReport results"/>
    <version>
      <extension
                 url="http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title">
        <valueString value="Search Diagnostic Report by _id "/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content">
        <valueReference>🔗 
          <reference value="Bundle/NRLSearchDiagnosticReports"/>
        </valueReference>
      </extension>
      <versionId value="1"/>
    </version>
  </instance>
  <instance>
    <resourceId value="NRLRetrieveImagingStudy"/>
    <resourceType value="Binary"/>
    <name value="Read ImagingStudy"/>
    <description
                 value="See [Retrieve Imaging Study](CapabilityStatement-RetrieveImagingStudy.html) for API overview "/>
  </instance>
  <instance>
    <resourceId value="NRLRetrieveImagingStudyResult"/>
    <resourceType value="Binary"/>
    <name value="Return Imaging Study"/>
    <description value=" DICOM KOS "/>
  </instance>
  <instance>
    <resourceId value="NRLRetrieveImage"/>
    <resourceType value="Binary"/>
    <name value="Read Image Instance"/>
    <description
                 value="See [Retrieve Image Instances](CapabilityStatement-RetrieveImageInstances.html) for API overview "/>
  </instance>
  <instance>
    <resourceId value="NRLRetrieveImageResult"/>
    <resourceType value="Binary"/>
    <name value="Return Image"/>
    <description value=" DICOM Image Instance "/>
  </instance>
  <process>
    <title value="Query patient image and/or report"/>
    <step>
      <operation>
        <number value="1"/>
        <type value="search-type"/>
        <name value="Search for Documents"/>
        <initiator value="user"/>
        <receiver value="xds"/>
        <request>
          <resourceId value="NRLSearchDocumentEntries"/>
        </request>
        <response>
          <resourceId value="NRLReturnDocumentEntries"/>
        </response>
      </operation>
    </step>
  </process>
  <process>
    <title value="Option - Retrieve selected imaging report"/>
    <description
                 value="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](https://www.rcr.ac.uk/media/wwtp2mif/rcr-publications_radiology-reporting-networks-understanding-the-technical-options_march-2022.pdf) converted to a FHIR DiagnosticReport profile as [Imaging Report](StructureDefinition-ImagingReport.html), 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](https://health.ec.europa.eu/document/download/0079ad26-8f8f-435b-9472-3cd8625f4220_en?filename=ehn_mi_guidelines_en.pdf) which is likely to be a derivative of [HL7 IPS](https://build.fhir.org/ig/HL7/fhir-ips/index.html), like the [HL7 Europe Laboratory Report](https://build.fhir.org/ig/hl7-eu/laboratory/)."/>
    <step>
      <operation>
        <number value="1"/>
        <type value="search-type"/>
        <name value="Retrieve Imaging Report by searching on a _id "/>
        <initiator value="user"/>
        <receiver value="docs"/>
        <request>
          <resourceId value="NRLSearchDiagnosticReports"/>
        </request>
        <response>
          <resourceId value="NRLReturnDiagnosticReports"/>
        </response>
      </operation>
    </step>
  </process>
  <process>
    <title value="Option - Retrieve selected imaging study"/>
    <description
                 value="This is an optional step. The **Document Consumer** may choose to retrieve the Imaging Study. At present this is a [DICOM KOS](https://dicom.nema.org/dicom/supps/sup59_lb.pdf) 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."/>
    <step>
      <operation>
        <number value="1"/>
        <type value="read"/>
        <name value="Retrieve Imaging Study"/>
        <initiator value="user"/>
        <receiver value="image"/>
        <request>
          <resourceId value="NRLRetrieveImagingStudy"/>
        </request>
        <response>
          <resourceId value="NRLRetrieveImagingStudyResult"/>
        </response>
      </operation>
    </step>
    <step>
      <process>
        <title value="Retrieve selected image (optional)"/>
        <step>
          <operation>
            <number value="1"/>
            <type value="read"/>
            <name value="Retrieve Image"/>
            <initiator value="user"/>
            <receiver value="image"/>
            <request>
              <resourceId value="NRLRetrieveImage"/>
            </request>
            <response>
              <resourceId value="NRLRetrieveImageResult"/>
            </response>
          </operation>
        </step>
      </process>
    </step>
  </process>
</ExampleScenario>