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

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
: Finding Imaging Reports and Images - Central Registry (NRL) - TTL Representation

Draft as of 2024-10-24
Raw ttl | Download
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

 a fhir:ExampleScenario ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "FindingImagingReportsStudiesAndImagesCentralRegistry"] ; # 
  fhir:text [
fhir:status [ fhir:v "extensions" ] ;
fhir:div "<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>\n</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>\n</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>\n</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>\n</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>\n<pre><code>GET https://example.nhs.uk/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888\n</code></pre>\n</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>\n<pre><code>GET https://example.nhs.uk/FHIR/R4/DiagnosticReport?_id=ABCD\n</code></pre>\n</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>\n</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>\n</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>\n</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>\n</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>\n<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>\n</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>\n<p>Other options include using FHIR ImagingStudy which is a FHIR version of the DICOM KOS.</p>\n</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>"
  ] ; # 
  fhir:url [ fhir:v "https://fhir.nhs.uk/England/RAD/ExampleScenario/FindingImagingReportsStudiesAndImagesCentralRegistry"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "0.0.1-current"] ; # 
  fhir:name [ fhir:v "FindingImagingReportsStudiesAndImagesCentralRegistry"] ; # 
  fhir:status [ fhir:v "draft"] ; # 
  fhir:date [ fhir:v "2024-10-24T15:09:54+00:00"^^xsd:dateTime] ; # 
  fhir:publisher [ fhir:v "NHS England"] ; # 
  fhir:contact ( [
    ( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "https://www.ihe.net/ihe_domains/it_infrastructure/" ]     ] )
  ] [
    ( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "iti@ihe.net" ]     ] )
  ] [
fhir:name [ fhir:v "NHS England" ] ;
    ( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "iti@ihe.net" ]     ] )
  ] ) ; # 
  fhir:jurisdiction ( [
    ( fhir:coding [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm"^^xsd:anyURI ] ;
fhir:code [ fhir:v "001" ]     ] )
  ] ) ; # 
  fhir:actor ( [
fhir:actorId [ fhir:v "user" ] ;
fhir:type [ fhir:v "entity" ] ;
fhir:name [ fhir:v "Document Consumer" ] ;
fhir:description [ fhir:v "The [Document Consumer](ActorDefinition-DocumentConsumer.html) Actor queries for documents meeting certain criteria, and may retrieve selected documents." ]
  ] [
fhir:actorId [ fhir:v "xds" ] ;
fhir:type [ fhir:v "entity" ] ;
fhir:name [ fhir:v "Document Registry" ] ;
fhir:description [ fhir:v "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." ]
  ] [
fhir:actorId [ fhir:v "docs" ] ;
fhir:type [ fhir:v "entity" ] ;
fhir:name [ fhir:v "Document Repository" ] ;
fhir:description [ fhir:v "The [Document Repository](ActorDefinition-DocumentRepository.html) is responsible for both the persistent storage of these documents (e.g. Imaging Report)" ]
  ] [
fhir:actorId [ fhir:v "image" ] ;
fhir:type [ fhir:v "entity" ] ;
fhir:name [ fhir:v "Imaging Repository" ] ;
fhir:description [ fhir:v "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." ]
  ] ) ; # 
  fhir:instance ( [
fhir:resourceId [ fhir:v "NRLSearchDocumentEntries" ] ;
fhir:resourceType [ fhir:v "Binary" ] ;
fhir:name [ fhir:v "Query for Document Entries" ] ;
fhir:description [ fhir:v " See [Finding and Retrieving Document Entries (NRL)](CapabilityStatement-FindDocumentsNRL.html) for API base contract. E.g. \n```\nGET https://example.nhs.uk/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888\n```\n " ]
  ] [
fhir:resourceId [ fhir:v "NRLReturnDocumentEntries" ] ;
fhir:resourceType [ fhir:v "Bundle" ] ;
fhir:name [ fhir:v "Return Document Entry results" ] ;
    ( fhir:version [
      ( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title"^^xsd:anyURI ] ;
fhir:value [ fhir:v "Search Results NRL" ]       ] [
fhir:url [ fhir:v "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content"^^xsd:anyURI ] ;
fhir:value [
a fhir:Reference ;
fhir:reference [ fhir:v "Bundle/NRLSearchResultsDocuments" ]         ]       ] ) ;
fhir:versionId [ fhir:v "1" ]     ] )
  ] [
fhir:resourceId [ fhir:v "NRLSearchDiagnosticReports" ] ;
fhir:resourceType [ fhir:v "Binary" ] ;
fhir:name [ fhir:v "Query for DiagnosticReport" ] ;
fhir:description [ fhir:v " See [Find and Retrieve Imaging Reports](CapabilityStatement-FindAndRetrieveImagingReports.html) for API base contract. E.g. \n```\nGET https://example.nhs.uk/FHIR/R4/DiagnosticReport?_id=ABCD\n```\n " ]
  ] [
fhir:resourceId [ fhir:v "NRLReturnDiagnosticReports" ] ;
fhir:resourceType [ fhir:v "Bundle" ] ;
fhir:name [ fhir:v "Return DiagnosticReport results" ] ;
    ( fhir:version [
      ( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title"^^xsd:anyURI ] ;
fhir:value [ fhir:v "Search Diagnostic Report by _id " ]       ] [
fhir:url [ fhir:v "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content"^^xsd:anyURI ] ;
fhir:value [
a fhir:Reference ;
fhir:reference [ fhir:v "Bundle/NRLSearchDiagnosticReports" ]         ]       ] ) ;
fhir:versionId [ fhir:v "1" ]     ] )
  ] [
fhir:resourceId [ fhir:v "NRLRetrieveImagingStudy" ] ;
fhir:resourceType [ fhir:v "Binary" ] ;
fhir:name [ fhir:v "Read ImagingStudy" ] ;
fhir:description [ fhir:v "See [Retrieve Imaging Study](CapabilityStatement-RetrieveImagingStudy.html) for API overview " ]
  ] [
fhir:resourceId [ fhir:v "NRLRetrieveImagingStudyResult" ] ;
fhir:resourceType [ fhir:v "Binary" ] ;
fhir:name [ fhir:v "Return Imaging Study" ] ;
fhir:description [ fhir:v " DICOM KOS " ]
  ] [
fhir:resourceId [ fhir:v "NRLRetrieveImage" ] ;
fhir:resourceType [ fhir:v "Binary" ] ;
fhir:name [ fhir:v "Read Image Instance" ] ;
fhir:description [ fhir:v "See [Retrieve Image Instances](CapabilityStatement-RetrieveImageInstances.html) for API overview " ]
  ] [
fhir:resourceId [ fhir:v "NRLRetrieveImageResult" ] ;
fhir:resourceType [ fhir:v "Binary" ] ;
fhir:name [ fhir:v "Return Image" ] ;
fhir:description [ fhir:v " DICOM Image Instance " ]
  ] ) ; # 
  fhir:process ( [
fhir:title [ fhir:v "Query patient image and/or report" ] ;
    ( fhir:step [
fhir:operation [
fhir:number [ fhir:v "1" ] ;
fhir:type [ fhir:v "search-type" ] ;
fhir:name [ fhir:v "Search for Documents" ] ;
fhir:initiator [ fhir:v "user" ] ;
fhir:receiver [ fhir:v "xds" ] ;
fhir:request [
fhir:resourceId [ fhir:v "NRLSearchDocumentEntries" ]         ] ;
fhir:response [
fhir:resourceId [ fhir:v "NRLReturnDocumentEntries" ]         ]       ]     ] )
  ] [
fhir:title [ fhir:v "Option - Retrieve selected imaging report" ] ;
fhir:description [ fhir:v "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. \n\n 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/)." ] ;
    ( fhir:step [
fhir:operation [
fhir:number [ fhir:v "1" ] ;
fhir:type [ fhir:v "search-type" ] ;
fhir:name [ fhir:v "Retrieve Imaging Report by searching on a _id " ] ;
fhir:initiator [ fhir:v "user" ] ;
fhir:receiver [ fhir:v "docs" ] ;
fhir:request [
fhir:resourceId [ fhir:v "NRLSearchDiagnosticReports" ]         ] ;
fhir:response [
fhir:resourceId [ fhir:v "NRLReturnDiagnosticReports" ]         ]       ]     ] )
  ] [
fhir:title [ fhir:v "Option - Retrieve selected imaging study" ] ;
fhir:description [ fhir:v "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. \n\nOther options include using FHIR ImagingStudy which is a FHIR version of the DICOM KOS." ] ;
    ( fhir:step [
fhir:operation [
fhir:number [ fhir:v "1" ] ;
fhir:type [ fhir:v "read" ] ;
fhir:name [ fhir:v "Retrieve Imaging Study" ] ;
fhir:initiator [ fhir:v "user" ] ;
fhir:receiver [ fhir:v "image" ] ;
fhir:request [
fhir:resourceId [ fhir:v "NRLRetrieveImagingStudy" ]         ] ;
fhir:response [
fhir:resourceId [ fhir:v "NRLRetrieveImagingStudyResult" ]         ]       ]     ] [
      ( fhir:process [
fhir:title [ fhir:v "Retrieve selected image (optional)" ] ;
        ( fhir:step [
fhir:operation [
fhir:number [ fhir:v "1" ] ;
fhir:type [ fhir:v "read" ] ;
fhir:name [ fhir:v "Retrieve Image" ] ;
fhir:initiator [ fhir:v "user" ] ;
fhir:receiver [ fhir:v "image" ] ;
fhir:request [
fhir:resourceId [ fhir:v "NRLRetrieveImage" ]             ] ;
fhir:response [
fhir:resourceId [ fhir:v "NRLRetrieveImageResult" ]             ]           ]         ] )       ] )     ] )
  ] ) . #