NHS North West Genomics
0.0.8 - ci-build
NHS North West Genomics
0.0.8 - ci-build
NHS North West Genomics, published by NHS North West Genomics. This guide is not an authorized publication; it is the continuous build for version 0.0.8 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nw-gmsa/nw-gmsa.github.com/ and changes regularly. See the Directory of published versions
| Draft as of 2025-10-30 |
{
"resourceType" : "ExampleScenario",
"id" : "GenomicTestOrderProcess",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ExampleScenario GenomicTestOrderProcess</b></p><a name=\"GenomicTestOrderProcess\"> </a><a name=\"hcGenomicTestOrderProcess\"> </a><p><b>url</b>: <a href=\"ExampleScenario-GenomicTestOrderProcess.html\">Genomic Test Order</a></p><p><b>version</b>: 0.0.8</p><p><b>name</b>: Genomic Test Order</p><p><b>status</b>: Draft</p><p><b>date</b>: 2025-10-30 11:13:25+0000</p><p><b>publisher</b>: NHS North West Genomics</p><p><b>contact</b>: <a href=\"https://www.nwgenomics.nhs.uk/contact-us\">https://www.nwgenomics.nhs.uk/contact-us</a></p><p><b>jurisdiction</b>: <span title=\"Codes:{urn:iso:std:iso:3166 GB}\">United Kingdom of Great Britain and Northern Ireland</span></p><blockquote><p><b>actor</b></p><p><b>actorId</b>: placer</p><p><b>type</b>: System</p><p><b>name</b>: Order Placer</p><p><b>description</b>: </p><div><p><a href=\"ActorDefinition-OrderPlacer.html\">Order Placer</a></p>\n</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: forms</p><p><b>type</b>: System</p><p><b>name</b>: Form Manager</p><p><b>description</b>: </p><div><p>This may be part of the EPR or be paper based</p>\n</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: epr</p><p><b>type</b>: System</p><p><b>name</b>: Electronic Patient Record</p><p><b>description</b>: </p><div><p>NHS Trust <a href=\"ActorDefinition-ProviderInformationSource.html\">Provider Information Source</a></p>\n</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: tie</p><p><b>type</b>: System</p><p><b>name</b>: Trust Integration Engine</p><p><b>description</b>: </p><div><p><a href=\"ActorDefinition-ProviderInformationSource.html\">Provider Information Source</a></p>\n</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: rie</p><p><b>type</b>: System</p><p><b>name</b>: Regional Integration Engine</p><p><b>description</b>: </p><div><p><a href=\"ActorDefinition-ProviderInformationSource.html\">Provider Information Source</a></p>\n</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: filler</p><p><b>type</b>: System</p><p><b>name</b>: Order Filler</p><p><b>description</b>: </p><div><p><a href=\"ActorDefinition-OrderFiller.html\">Order Filler</a></p>\n</div></blockquote><blockquote><p><b>actor</b></p><p><b>actorId</b>: cdr</p><p><b>type</b>: System</p><p><b>name</b>: Regional Clinical Data Repository</p><p><b>description</b>: </p><div><p>Clinical Data Repository</p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: Request1</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Search for Order Genomic Test Order Form</p><p><b>description</b>: </p><div><p>Query for Froms: <code>GET https://example.nhs.uk/FHIR/R4/Questionnaire?id=GenomicTestOrder</code></p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: Reply1</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: Search results</p><blockquote><p><b>version</b></p><p><b>Extension Definition for ExampleScenario.instance.version.title for Version 5.0</b>: Search Results</p><p><b>Extension Definition for ExampleScenario.instance.version.content for Version 5.0</b>: <a href=\"Bundle-SDCSearchResults.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>: Request2</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Pre-Populate form request</p></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: Request4</p><p><b>resourceType</b>: QuestionnaireResponse</p><p><b>name</b>: Completed Form</p></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: Request5</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: HL7 v2 ORM_O01 - supplier</p></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: Request6</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: HL7 FHIR Message O21 - regional</p><p><b>description</b>: </p><div><p>This is equivalent to HL7 v2.5 OML_O21, it may be advisable to use this message in the previous step to reduce transforms.</p>\n</div><blockquote><p><b>version</b></p><p><b>Extension Definition for ExampleScenario.instance.version.title for Version 5.0</b>: HL7 FHIR Message O21</p><p><b>Extension Definition for ExampleScenario.instance.version.content for Version 5.0</b>: <a href=\"Bundle-GenomicsOrderMessageCodedEntries.html\">Bundle: identifier = UUID:9612365d-52a4-4fab-87e7-8a09d753f095; type = message; timestamp = 2024-10-13 10:33:00+0000</a></p><p><b>versionId</b>: 6</p></blockquote></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: Request7</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: HL7 v2 OML_O21 - regional</p><p><b>description</b>: </p><div><p><a href=\"hl7v2.html#oml_o21-laboratory-order-1\">Regional HL7 v2 OML_O21</a></p>\n</div></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: Request8</p><p><b>resourceType</b>: Binary</p><p><b>name</b>: Collect Sample</p></blockquote><blockquote><p><b>instance</b></p><p><b>resourceId</b>: Request9</p><p><b>resourceType</b>: Bundle</p><p><b>name</b>: HL7 FHIR Message O21 - regional</p><p><b>description</b>: </p><div><p>TODO</p>\n</div><blockquote><p><b>version</b></p><p><b>Extension Definition for ExampleScenario.instance.version.title for Version 5.0</b>: HL7 FHIR Message O21</p><p><b>Extension Definition for ExampleScenario.instance.version.content for Version 5.0</b>: <a href=\"Bundle-GenomicsOrderMessageCodedEntries.html\">Bundle: identifier = UUID:9612365d-52a4-4fab-87e7-8a09d753f095; type = message; timestamp = 2024-10-13 10:33:00+0000</a></p><p><b>versionId</b>: 9</p></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Complete Genomic Test Order Form</p><p><b>description</b>: </p><div><p>Creates Test Order Form. Details on what questions and answers should be in the form are listed here <a href=\"Questionnaire-GenomicTestOrder.html\">Questionnaire: North West Genomics Test Order</a>. This is also designed to work with <a href=\"https://build.fhir.org/ig/HL7/sdc/\">HL7 Structured Data Capture</a>, however in most cases this form based data capture be part of the EPR.</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>: Select Genomic Test Order Form</p><p><b>initiator</b>: placer</p><p><b>receiver</b>: forms</p><p><b>description</b>: </p><div><p>This may be part of the EPR and not implemented in HL7 FHIR. If not using FHIR, the clinical coding and valuesets in the FHIR Questionnaire should be implemented in the EPR Order Form</p>\n</div><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>Request1</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>Reply1</td></tr></table></blockquote></blockquote><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 2</p><p><b>type</b>: create</p><p><b>name</b>: Pre-populate Order Form</p><p><b>initiator</b>: forms</p><p><b>receiver</b>: epr</p><p><b>description</b>: </p><div><p>If using electronic forms and their is a connection to an EPR or Health Information Exchange - the forms may be pre-populated</p>\n</div><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>Request2</td></tr></table></blockquote></blockquote><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 4</p><p><b>type</b>: create</p><p><b>name</b>: Complete Genomic Test Order Form. </p><p><b>initiator</b>: placer</p><p><b>receiver</b>: epr</p><p><b>description</b>: </p><div><p>Enter answers to questions in the forms. The end of this process is likely to be signalled via a <strong>IHE Patient Administration</strong> HL7 v2 ADT Admission event.</p>\n</div><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>Request4</td></tr></table></blockquote></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Submit Genomic Test Order Form</p><p><b>description</b>: </p><div><p>The order is sent from the EPR using HL7 ORM_O21 and this is sent to the Order Filler/Laboratory Information Management System (LIMS) via middleware</p>\n</div><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 5</p><p><b>type</b>: create</p><p><b>name</b>: Send Laboratory Order ORM_O01 v2</p><p><b>initiator</b>: epr</p><p><b>receiver</b>: tie</p><p><b>description</b>: </p><div><p>In NHS Trusts will this will often be HL7 v2 ORM_O01 from the EPR, the region is using HL7 v2/FHIR OML_O21 which may involve some message transformation especially around v2 SPM/FHIR Specimen. Note: the region is using a common (canonical) data model for both v2 and FHIR. Most coded questions and answer should be be supplied in v2 OBX segments which have a simple transform to FHIR Observations.</p>\n</div><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>Request5</td></tr></table></blockquote></blockquote><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 6</p><p><b>type</b>: create</p><p><b>name</b>: Send Laboratory Order O21 FHIR</p><p><b>initiator</b>: tie</p><p><b>receiver</b>: rie</p><p><b>description</b>: </p><div><p>Message routing is done using the FHIR Message, this is where future routing to other GMSA/GLH will be performed using the NHS England Genomic Order Management Service.</p>\n</div><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>Request6</td></tr></table></blockquote></blockquote><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 7</p><p><b>type</b>: create</p><p><b>name</b>: Send Laboratory Order OML_O21 v2</p><p><b>initiator</b>: rie</p><p><b>receiver</b>: filler</p><p><b>description</b>: </p><div><p>The FHIR Message is transformed by the RIE into a v2 Message</p>\n</div><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>Request7</td></tr></table></blockquote></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Send Order to Regional Genomic CDR</p><p><b>description</b>: </p><div><p>The order is sent to the regional Clinical Data Repository which shares the order using FHIR RESTful readonly APIs</p>\n</div><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 9</p><p><b>type</b>: create</p><p><b>name</b>: Send Laboratory Order O21 FHIR</p><p><b>initiator</b>: rie</p><p><b>receiver</b>: cdr</p><p><b>description</b>: </p><div><p>TODO</p>\n</div><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>Request9</td></tr></table></blockquote></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Collect Sample</p><p><b>description</b>: </p><div><p>This process is not required if the sample has already been collected (and this is a reflex order). For an example process see <a href=\"ExampleScenario-BiopsyProcedure.html\">ExampleScenario: Biopsy Procedure</a>.</p>\n</div><blockquote><p><b>step</b></p><blockquote><p><b>operation</b></p><p><b>number</b>: 8</p><p><b>type</b>: create</p><p><b>name</b>: Collect sample</p><p><b>initiator</b>: rie</p><p><b>receiver</b>: filler</p><p><b>description</b>: </p><div><p>See Biopsy and Blood scenarios for more details</p>\n</div><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>Request8</td></tr></table></blockquote></blockquote></blockquote><blockquote><p><b>process</b></p><p><b>title</b>: Perform Genomic Tests</p><p><b>description</b>: </p><div><p>See <a href=\"ExampleScenario-GenomicTestReportProcess.html\">ExampleScenario: Genomic Report Process</a></p>\n</div></blockquote></div>"
},
"url" : "https://fhir.nwgenomics.nhs.uk/ExampleScenario/GenomicTestOrderProcess",
"version" : "0.0.8",
"name" : "Genomic Test Order",
"status" : "draft",
"date" : "2025-10-30T11:13:25+00:00",
"publisher" : "NHS North West Genomics",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "https://www.nwgenomics.nhs.uk/contact-us"
}
]
}
],
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "GB",
"display" : "United Kingdom of Great Britain and Northern Ireland"
}
]
}
],
"actor" : [
{
"actorId" : "placer",
"type" : "entity",
"name" : "Order Placer",
"description" : " [Order Placer](ActorDefinition-OrderPlacer.html) "
},
{
"actorId" : "forms",
"type" : "entity",
"name" : "Form Manager",
"description" : "This may be part of the EPR or be paper based"
},
{
"actorId" : "epr",
"type" : "entity",
"name" : "Electronic Patient Record",
"description" : " NHS Trust [Provider Information Source](ActorDefinition-ProviderInformationSource.html) "
},
{
"actorId" : "tie",
"type" : "entity",
"name" : "Trust Integration Engine",
"description" : " [Provider Information Source](ActorDefinition-ProviderInformationSource.html) "
},
{
"actorId" : "rie",
"type" : "entity",
"name" : "Regional Integration Engine",
"description" : " [Provider Information Source](ActorDefinition-ProviderInformationSource.html) "
},
{
"actorId" : "filler",
"type" : "entity",
"name" : "Order Filler",
"description" : " [Order Filler](ActorDefinition-OrderFiller.html) "
},
{
"actorId" : "cdr",
"type" : "entity",
"name" : "Regional Clinical Data Repository",
"description" : " Clinical Data Repository "
}
],
"instance" : [
{
"resourceId" : "Request1",
"resourceType" : "Binary",
"name" : "Search for Order Genomic Test Order Form",
"description" : "Query for Froms: `GET https://example.nhs.uk/FHIR/R4/Questionnaire?id=GenomicTestOrder`"
},
{
"resourceId" : "Reply1",
"resourceType" : "Bundle",
"name" : "Search results",
"version" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title",
"valueString" : "Search Results"
},
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content",
"valueReference" : {
🔗 "reference" : "Bundle/SDCSearchResults"
}
}
],
"versionId" : "1"
}
]
},
{
"resourceId" : "Request2",
"resourceType" : "Binary",
"name" : "Pre-Populate form request"
},
{
"resourceId" : "Request4",
"resourceType" : "QuestionnaireResponse",
"name" : "Completed Form"
},
{
"resourceId" : "Request5",
"resourceType" : "Binary",
"name" : "HL7 v2 ORM_O01 - supplier"
},
{
"resourceId" : "Request6",
"resourceType" : "Bundle",
"name" : "HL7 FHIR Message O21 - regional",
"description" : " This is equivalent to HL7 v2.5 OML_O21, it may be advisable to use this message in the previous step to reduce transforms. ",
"version" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title",
"valueString" : "HL7 FHIR Message O21"
},
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content",
"valueReference" : {
🔗 "reference" : "Bundle/GenomicsOrderMessageCodedEntries"
}
}
],
"versionId" : "6"
}
]
},
{
"resourceId" : "Request7",
"resourceType" : "Binary",
"name" : "HL7 v2 OML_O21 - regional",
"description" : " [Regional HL7 v2 OML_O21](hl7v2.html#oml_o21-laboratory-order-1) "
},
{
"resourceId" : "Request8",
"resourceType" : "Binary",
"name" : "Collect Sample"
},
{
"resourceId" : "Request9",
"resourceType" : "Bundle",
"name" : "HL7 FHIR Message O21 - regional",
"description" : " TODO ",
"version" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title",
"valueString" : "HL7 FHIR Message O21"
},
{
"url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content",
"valueReference" : {
🔗 "reference" : "Bundle/GenomicsOrderMessageCodedEntries"
}
}
],
"versionId" : "9"
}
]
}
],
"process" : [
{
"title" : "Complete Genomic Test Order Form",
"description" : "Creates Test Order Form. Details on what questions and answers should be in the form are listed here [Questionnaire: North West Genomics Test Order](Questionnaire-GenomicTestOrder.html). This is also designed to work with [HL7 Structured Data Capture](https://build.fhir.org/ig/HL7/sdc/), however in most cases this form based data capture be part of the EPR.",
"step" : [
{
"operation" : {
"number" : "1",
"type" : "search-type",
"name" : "Select Genomic Test Order Form",
"initiator" : "placer",
"receiver" : "forms",
"description" : "This may be part of the EPR and not implemented in HL7 FHIR. If not using FHIR, the clinical coding and valuesets in the FHIR Questionnaire should be implemented in the EPR Order Form",
"request" : {
"resourceId" : "Request1"
},
"response" : {
"resourceId" : "Reply1"
}
}
},
{
"operation" : {
"number" : "2",
"type" : "create",
"name" : "Pre-populate Order Form",
"initiator" : "forms",
"receiver" : "epr",
"description" : "If using electronic forms and their is a connection to an EPR or Health Information Exchange - the forms may be pre-populated ",
"request" : {
"resourceId" : "Request2"
}
}
},
{
"operation" : {
"number" : "4",
"type" : "create",
"name" : "Complete Genomic Test Order Form. ",
"initiator" : "placer",
"receiver" : "epr",
"description" : "Enter answers to questions in the forms. The end of this process is likely to be signalled via a **IHE Patient Administration** HL7 v2 ADT Admission event. ",
"request" : {
"resourceId" : "Request4"
}
}
}
]
},
{
"title" : "Submit Genomic Test Order Form",
"description" : "The order is sent from the EPR using HL7 ORM_O21 and this is sent to the Order Filler/Laboratory Information Management System (LIMS) via middleware",
"step" : [
{
"operation" : {
"number" : "5",
"type" : "create",
"name" : "Send Laboratory Order ORM_O01 v2",
"initiator" : "epr",
"receiver" : "tie",
"description" : "In NHS Trusts will this will often be HL7 v2 ORM_O01 from the EPR, the region is using HL7 v2/FHIR OML_O21 which may involve some message transformation especially around v2 SPM/FHIR Specimen. Note: the region is using a common (canonical) data model for both v2 and FHIR. Most coded questions and answer should be be supplied in v2 OBX segments which have a simple transform to FHIR Observations.",
"request" : {
"resourceId" : "Request5"
}
}
},
{
"operation" : {
"number" : "6",
"type" : "create",
"name" : "Send Laboratory Order O21 FHIR",
"initiator" : "tie",
"receiver" : "rie",
"description" : "Message routing is done using the FHIR Message, this is where future routing to other GMSA/GLH will be performed using the NHS England Genomic Order Management Service.",
"request" : {
"resourceId" : "Request6"
}
}
},
{
"operation" : {
"number" : "7",
"type" : "create",
"name" : "Send Laboratory Order OML_O21 v2",
"initiator" : "rie",
"receiver" : "filler",
"description" : "The FHIR Message is transformed by the RIE into a v2 Message",
"request" : {
"resourceId" : "Request7"
}
}
}
]
},
{
"title" : "Send Order to Regional Genomic CDR",
"description" : "The order is sent to the regional Clinical Data Repository which shares the order using FHIR RESTful readonly APIs",
"step" : [
{
"operation" : {
"number" : "9",
"type" : "create",
"name" : "Send Laboratory Order O21 FHIR",
"initiator" : "rie",
"receiver" : "cdr",
"description" : "TODO",
"request" : {
"resourceId" : "Request9"
}
}
}
]
},
{
"title" : "Collect Sample",
"description" : "This process is not required if the sample has already been collected (and this is a reflex order). For an example process see [ExampleScenario: Biopsy Procedure](ExampleScenario-BiopsyProcedure.html).",
"step" : [
{
"operation" : {
"number" : "8",
"type" : "create",
"name" : "Collect sample",
"initiator" : "rie",
"receiver" : "filler",
"description" : " See Biopsy and Blood scenarios for more details ",
"request" : {
"resourceId" : "Request8"
}
}
}
]
},
{
"title" : "Perform Genomic Tests",
"description" : "See [ExampleScenario: Genomic Report Process](ExampleScenario-GenomicTestReportProcess.html)"
}
]
}
IG © 2024+ NHS North West Genomics. Package fhir.nwgenomics.nhs.uk#0.0.8 based on FHIR 4.0.1. Generated 2025-10-30
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change