Radiology (Sandbox)
0.0.1-current - ci-build
Radiology (Sandbox)
0.0.1-current - ci-build
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 |
{
"resourceType" : "ExampleScenario",
"id" : "UpdateNationalRecordLocator",
"text" : {
"status" : "extensions",
"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>"
},
"url" : "https://fhir.nhs.uk/England/RAD/ExampleScenario/UpdateNationalRecordLocator",
"version" : "0.0.1-current",
"name" : "UpdateNationalRecordLocator",
"status" : "draft",
"date" : "2024-10-24T15:09:54+00:00",
"publisher" : "NHS England",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
}
]
},
{
"telecom" : [
{
"system" : "email",
"value" : "iti@ihe.net"
}
]
},
{
"name" : "NHS England",
"telecom" : [
{
"system" : "email",
"value" : "iti@ihe.net"
}
]
}
],
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"actor" : [
{
"actorId" : "docRecipient",
"type" : "entity",
"name" : "Document Recipient/Repository XDS",
"description" : "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. "
},
{
"actorId" : "translation",
"type" : "entity",
"name" : "Transformation Service",
"description" : "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."
},
{
"actorId" : "nrl",
"type" : "entity",
"name" : "Document Registry - NHS England NRL",
"description" : "NHS England National Record Locator, a [Document Registry](ActorDefinition-DocumentRegistry.html) "
}
],
"instance" : [
{
"resourceId" : "IHEStoreDocument",
"resourceType" : "Bundle",
"name" : "IHE MHD ITI-65 minimal document metadata",
"description" : " [IHE MHD - Provide Document Bundle [ITI-65] minimal document metadata](https://profiles.ihe.net/ITI/MHD/ITI-65.html) ",
"version" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title",
"valueString" : "Bundle"
},
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content",
"valueReference" : {
🔗 "reference" : "Bundle/IHETransactionBundle"
}
}
],
"versionId" : "1"
}
]
},
{
"resourceId" : "IHETransactionFeed",
"resourceType" : "Bundle",
"name" : "Event Feed",
"description" : " 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. "
},
{
"resourceId" : "NRLTransactionFeed",
"resourceType" : "Bundle",
"name" : "NRL version of IHE ITI-65",
"description" : " 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. ",
"version" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title",
"valueString" : "Bundle"
},
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content",
"valueReference" : {
🔗 "reference" : "Bundle/NRLTransactionBundle"
}
}
],
"versionId" : "1"
}
]
},
{
"resourceId" : "NRLRegisterDocument",
"resourceType" : "DocumentReference",
"name" : "Register Document Entry",
"version" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title",
"valueString" : "DocumentReference"
},
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content",
"valueReference" : {
🔗 "reference" : "DocumentReference/DocumentReferenceImagingReportIHE"
}
}
],
"versionId" : "1"
}
]
}
],
"process" : [
{
"title" : "Document Entry Event Feed",
"step" : [
{
"operation" : {
"number" : "1",
"type" : "create",
"name" : "Event Feed e.g. IHE DSUBm Resource Notify",
"initiator" : "docRecipient",
"receiver" : "translation",
"request" : {
"resourceId" : "IHETransactionFeed"
}
}
}
]
},
{
"title" : "Update NRL",
"step" : [
{
"operation" : {
"number" : "1",
"type" : "create",
"name" : "NRL Transaction Feed",
"initiator" : "translation",
"receiver" : "nrl",
"request" : {
"resourceId" : "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