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
Draft as of 2024-10-24 |
@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 "UpdateNationalRecordLocator"] ; #
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 UpdateNationalRecordLocator</b></p><a name=\"UpdateNationalRecordLocator\"> </a><a name=\"hcUpdateNationalRecordLocator\"> </a><a name=\"UpdateNationalRecordLocator-en-US\"> </a><p><b>url</b>: <a href=\"ExampleScenario-UpdateNationalRecordLocator.html\">UpdateNationalRecordLocator</a></p><p><b>version</b>: 0.0.1-current</p><p><b>name</b>: UpdateNationalRecordLocator</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>: docRecipient</p><p><b>type</b>: System</p><p><b>name</b>: Document Recipient/Repository XDS</p><p><b>description</b>: </p><div><p>The <strong>Document Recipient</strong> receives documents and metadata sent by the Document Source. The <a href=\"ActorDefinition-DocumentRepository.html\">Document Repository</a> is responsible for both the persistent storage of these documents as well as for their registration with the appropriate Document Registry. It assigns a uniqueId to documents for subsequent retrieval by a Document Consumer.</p>\n</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: translation</p><p><b>type</b>: System</p><p><b>name</b>: Transformation Service</p><p><b>description</b>: </p><div><p>This provides conversion between the different data models used in each <a href=\"https://martinfowler.com/bliki/BoundedContext.html\">context</a>. This may include filtering events, code conversions - concept mapping, data model mapping, removing elements from the model, etc.</p>\n</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: nrl</p><p><b>type</b>: System</p><p><b>name</b>: Document Registry - NHS England NRL</p><p><b>description</b>: </p><div><p>NHS England National Record Locator, a <a href=\"ActorDefinition-DocumentRegistry.html\">Document Registry</a></p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: IHEStoreDocument</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: IHE MHD ITI-65 minimal document metadata</p><p><b>description</b>: </p><div><p><a href=\"https://profiles.ihe.net/ITI/MHD/ITI-65.html\">IHE MHD - Provide Document Bundle [ITI-65] minimal document metadata</a></p>\n</div><blockquote><p><b>version</b></p><p><b>Extension Definition for ExampleScenario.instance.version.title for Version 5.0</b>: Bundle</p><p><b>Extension Definition for ExampleScenario.instance.version.content for Version 5.0</b>: <a href=\"Bundle-IHETransactionBundle.html\">Bundle: type = transaction; timestamp = 2023-10-22 09:31:45+0000</a></p><p><b>versionId</b>: 1</p></blockquote></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: IHETransactionFeed</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: Event Feed</p><p><b>description</b>: </p><div><p>Feed type is not specified, this is for illustration purposes. ITI-65 generally contains the actual documents, so <a href=\"https://profiles.ihe.net/ITI/DSUBm/ITI-112.html\">IHE DSUBm - Resource Notify [ITI-112]</a> or <a href=\"https://profiles.ihe.net/ITI/TF/Volume1/ch-26.html\">IHE Document Metadata Subscription (DSUB)</a> may be more suitable.</p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLTransactionFeed</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: NRL version of IHE ITI-65</p><p><b>description</b>: </p><div><p>This is a <a href=\"https://hl7.org/fhir/R4/http.html#transaction\">FHIR Transaction</a> version of <a href=\"https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir/v3/producer#put-/DocumentReference\">NRL FHIR API - Create document pointers with a specific id</a>. It has been designed with ITI-65 minimal metadata compatability in mind, but does not containing a List/SubmissionSet, a document (Binary) and neither an embedded document in the DocumentReference.</p>\n</div><blockquote><p><b>version</b></p><p><b>Extension Definition for ExampleScenario.instance.version.title for Version 5.0</b>: Bundle</p><p><b>Extension Definition for ExampleScenario.instance.version.content for Version 5.0</b>: <a href=\"Bundle-NRLTransactionBundle.html\">Bundle: type = transaction; timestamp = 2023-10-22 09:31:45+0000</a></p><p><b>versionId</b>: 1</p></blockquote></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: NRLRegisterDocument</p><p><b>resourceType</b>: DocumentReference</p><p><b>name</b>: Register Document Entry</p><blockquote><p><b>version</b></p><p><b>Extension Definition for ExampleScenario.instance.version.title for Version 5.0</b>: DocumentReference</p><p><b>Extension Definition for ExampleScenario.instance.version.content for Version 5.0</b>: <a href=\"DocumentReference-DocumentReferenceImagingReportIHE.html\">DocumentReference: masterIdentifier = https://tools.ietf.org/html/rfc4122#f3f7920b-3b91-4e3e-afdc-8791e2095fbe; identifier = f3f7920b-3b91-4e3e-afdc-8791e2095fbe; status = current; type = MRA Upper limb Rt; category = Imaging report; securityLabel = unrestricted</a></p><p><b>versionId</b>: 1</p></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Document Entry Event Feed</p><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 1</p><p><b>type</b>: create</p><p><b>name</b>: Event Feed e.g. IHE DSUBm Resource Notify</p><p><b>initiator</b>: docRecipient</p><p><b>receiver</b>: translation</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>IHETransactionFeed</td></tr></table></blockquote></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Update NRL</p><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 1</p><p><b>type</b>: create</p><p><b>name</b>: NRL Transaction Feed</p><p><b>initiator</b>: translation</p><p><b>receiver</b>: nrl</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>NRLTransactionFeed</td></tr></table></blockquote></blockquote></blockquote></div>"
] ; #
fhir:url [ fhir:v "https://fhir.nhs.uk/England/RAD/ExampleScenario/UpdateNationalRecordLocator"^^xsd:anyURI] ; #
fhir:version [ fhir:v "0.0.1-current"] ; #
fhir:name [ fhir:v "UpdateNationalRecordLocator"] ; #
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 "docRecipient" ] ;
fhir:type [ fhir:v "entity" ] ;
fhir:name [ fhir:v "Document Recipient/Repository XDS" ] ;
fhir:description [ fhir:v "The **Document Recipient** receives documents and metadata sent by the Document Source. The [Document Repository](ActorDefinition-DocumentRepository.html) is responsible for both the persistent storage of these documents as well as for their registration with the appropriate Document Registry. It assigns a uniqueId to documents for subsequent retrieval by a Document Consumer. " ]
] [
fhir:actorId [ fhir:v "translation" ] ;
fhir:type [ fhir:v "entity" ] ;
fhir:name [ fhir:v "Transformation Service" ] ;
fhir:description [ fhir:v "This provides conversion between the different data models used in each [context](https://martinfowler.com/bliki/BoundedContext.html). This may include filtering events, code conversions - concept mapping, data model mapping, removing elements from the model, etc." ]
] [
fhir:actorId [ fhir:v "nrl" ] ;
fhir:type [ fhir:v "entity" ] ;
fhir:name [ fhir:v "Document Registry - NHS England NRL" ] ;
fhir:description [ fhir:v "NHS England National Record Locator, a [Document Registry](ActorDefinition-DocumentRegistry.html) " ]
] ) ; #
fhir:instance ( [
fhir:resourceId [ fhir:v "IHEStoreDocument" ] ;
fhir:resourceType [ fhir:v "Bundle" ] ;
fhir:name [ fhir:v "IHE MHD ITI-65 minimal document metadata" ] ;
fhir:description [ fhir:v " [IHE MHD - Provide Document Bundle [ITI-65] minimal document metadata](https://profiles.ihe.net/ITI/MHD/ITI-65.html) " ] ;
( 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 "Bundle" ] ] [
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/IHETransactionBundle" ] ] ] ) ;
fhir:versionId [ fhir:v "1" ] ] )
] [
fhir:resourceId [ fhir:v "IHETransactionFeed" ] ;
fhir:resourceType [ fhir:v "Bundle" ] ;
fhir:name [ fhir:v "Event Feed" ] ;
fhir:description [ fhir:v " Feed type is not specified, this is for illustration purposes. ITI-65 generally contains the actual documents, so [IHE DSUBm - Resource Notify [ITI-112]](https://profiles.ihe.net/ITI/DSUBm/ITI-112.html) or [IHE Document Metadata Subscription (DSUB)](https://profiles.ihe.net/ITI/TF/Volume1/ch-26.html) may be more suitable. " ]
] [
fhir:resourceId [ fhir:v "NRLTransactionFeed" ] ;
fhir:resourceType [ fhir:v "Bundle" ] ;
fhir:name [ fhir:v "NRL version of IHE ITI-65" ] ;
fhir:description [ fhir:v " This is a [FHIR Transaction](https://hl7.org/fhir/R4/http.html#transaction) version of [NRL FHIR API - Create document pointers with a specific id](https://digital.nhs.uk/developer/api-catalogue/national-record-locator-fhir/v3/producer#put-/DocumentReference). It has been designed with ITI-65 minimal metadata compatability in mind, but does not containing a List/SubmissionSet, a document (Binary) and neither an embedded document in the DocumentReference. " ] ;
( 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 "Bundle" ] ] [
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/NRLTransactionBundle" ] ] ] ) ;
fhir:versionId [ fhir:v "1" ] ] )
] [
fhir:resourceId [ fhir:v "NRLRegisterDocument" ] ;
fhir:resourceType [ fhir:v "DocumentReference" ] ;
fhir:name [ fhir:v "Register Document Entry" ] ;
( 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 "DocumentReference" ] ] [
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 "DocumentReference/DocumentReferenceImagingReportIHE" ] ] ] ) ;
fhir:versionId [ fhir:v "1" ] ] )
] ) ; #
fhir:process ( [
fhir:title [ fhir:v "Document Entry Event Feed" ] ;
( fhir:step [
fhir:operation [
fhir:number [ fhir:v "1" ] ;
fhir:type [ fhir:v "create" ] ;
fhir:name [ fhir:v "Event Feed e.g. IHE DSUBm Resource Notify" ] ;
fhir:initiator [ fhir:v "docRecipient" ] ;
fhir:receiver [ fhir:v "translation" ] ;
fhir:request [
fhir:resourceId [ fhir:v "IHETransactionFeed" ] ] ] ] )
] [
fhir:title [ fhir:v "Update NRL" ] ;
( fhir:step [
fhir:operation [
fhir:number [ fhir:v "1" ] ;
fhir:type [ fhir:v "create" ] ;
fhir:name [ fhir:v "NRL Transaction Feed" ] ;
fhir:initiator [ fhir:v "translation" ] ;
fhir:receiver [ fhir:v "nrl" ] ;
fhir:request [
fhir:resourceId [ fhir:v "NRLTransactionFeed" ] ] ] ] )
] ) . #
IG © 2024+ NHS England. Package nhs.england.rad#0.0.1-current based on FHIR 4.0.1. Generated 2024-10-24
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change