NHS North West Genomics
2.1.4 - ci-build
NHS North West Genomics - Local Development build (v2.1.4) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The following artifacts define the types of individuals and/or systems that will interact as part of the use cases covered by this implementation guide.
| Automation Manager |
Manages the Order. This is the function of Genomic Order Management Service and/or GLH LIMS |
| Clinical Document |
From ISO-13606 The set of information committed to one EHR as a result of a clinical encounter or a record documentation session. Examples of COMPOSITION are Progress note, Laboratory test result form, Radiology report, Referral letter, Clinic visit, Clinic letter, Discharge summary, Functional health assessment, Diabetes review. |
| Intermediary |
North West GLH Regional Orchestration Engine (RIE) This is a Trust Integration Engine (TIE) working at a regional level |
| Order Filler |
Fulfils the Order. The Order Filler Actor is implemented by laboratory information management systems. |
| Order Placer |
Creates the Order. The Order Placer Actor is implemented by the systems used by the clinical practice. |
| Order Result Tracker |
Allows practitioners to view the Genomics Test Report (e.g. Patient Pass or EPR) |
| Patient Identity Source |
Source of the patient demographics change. The Patient Identity Source is implemented by the systems used for patient administration (e.g. PAS or EPR). |
| Provider Information Source |
Source of the provider information change. The Provider Information Source is implemented by the systems used for patient administration (e.g. PAS or EPR) or Organisation Directories (LDAP/X.500). |
| Requestor (ILW) |
The Actor ran by a private or hospital laboratory that subcontracts a part of an Order or of an Order Group to another laboratory. This actor may also be referred to as Order Placer |
| Subcontractor (ILW) |
The Actor ran by a laboratory performing tests upon request from other laboratories. This actor may also be referred to as Order Filler |
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
| CapabilityStatement for NW GMSA Regional Orchestration Engine for Genomics |
Is based on FHIR Messaging to handle transformation of HL7 FHIR and v2 Messages to FHIR Workflow. The |
| CapabilityStatement for NW Genomics Genomic Data Platform (EURIDICE Health Data API) |
Is based on EURIDICE Health Data API, which we are using as FHIR R4 version of Care Connect API The |
These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.
| Process Message |
This is documentation on the version of HL7 FHIR process-message to be used for regional FHIR Messaging, this HL7 FHIR definition SHALL be followed. |
These define the types of messages that can be sent and/or received by systems conforming to this implementation guide.
| Message Definition - Acknowledgement |
OperationOutcome is required for rejected messages. |
| Message Definition - Document and Document Notification | |
| Message Definition - Laboratory Order | |
| Message Definition - Unsolicited Observation |
These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.
| assigner |
Search parameter for searching resource identifier for assigning authority |
These define forms used by systems conforming to this implementation guide to capture or expose data to end users.
| Master HL7 genetic variant reporting panel | |
| North West Genomics Test Order |
NHS England North West Genomics Test Order (Draft) |
| North West Genomics Test Report |
The aim of this is to support conversion of Genomic Report (HL7 v2 ORU) for use by several NHS Trusts (as HL7 v2 or FHIR). |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| AuditEvent |
|
| Binary |
|
| Bundle - FHIR Document | |
| Bundle - FHIR Messaging | |
| Composition Genomic Report |
|
| Condition |
|
| Diagnostic Implication (Observation) |
|
| Diagnostic Report |
|
| Document Message (MessageHeader) |
|
| DocumentReference |
|
| Encounter |
|
| Event Notification (MessageHeader) |
|
| FamilyMemberHistory |
|
| Genomic Observation |
|
| Genomic Study Panel |
|
| Genotype (Observation) |
|
| Haplotype (Observation) |
|
| Hospital Spell |
|
| Laboratory Analyte Result (Observation) |
|
| Molecular Biomarker |
|
| Observation |
|
| Observation Order |
|
| Observation Panel |
|
| OperationOutcome |
DRAFT Extension of OperationOutcome |
| Organization |
|
| Patient |
|
| Practitioner |
|
| PractitionerRole |
|
| Procedure |
|
| Questionnaire |
|
| QuestionnaireResponse |
|
| RelatedPerson |
|
| ServiceRequest |
|
| Specimen |
|
| Task |
|
| Therapeutic Implication (Observation) |
|
| Variant (Observation) |
|
| Visit |
|
| WorkOrder |
|
These define constraints on FHIR data types for systems conforming to this implementation guide.
| Attachment |
DRAFT: Additional conformance on FHIR Attachment data type. |
| CodeableReference |
DRAFT Extension to FHIR Reference to include Codes (i.e. SNOMED Concepts) |
| Correlation Identifier |
Core Data Contract for FHIR Identifier, v2 CX and EI |
| GS1 Global Service Relation Number (GSRN) |
|
| GS1 Serial Shipping Container Code (SSCC) |
|
| GS1 Service Relation Instance Number (SRIN) |
|
| Genomics Pedigree Number |
|
| Hospital Provider Spell Identifier |
|
| Medical Record Number |
|
| NHS Identifier |
|
| Order Group Number |
|
| Order Identifier |
|
| Organisation Code |
|
| Organisation Site Identifier |
|
| Patient Identifier |
|
| Practitioner Identifier |
'Care Directory' 'NHS Data Model and Dictionary' CONSULTANT CODE and GENERAL MEDICAL PRACTITIONER PPD CODE. |
| Report Identifier |
|
| Shipment Tracking Number |
|
| Specimen Accession Number |
|
| Visit Number |
|
These define constraints on FHIR data types for systems conforming to this implementation guide.
| ExtCodeableReference |
(copied from BE eHealth Platform Federal Core Profiles) Extension able to hold a reference and a concept (Temporary solution until https://jira.hl7.org/browse/FHIR-44661 is solved and see Zulip: https://chat.fhir.org/#narrow/stream/179280-fhir.2Finfrastructure-wg/topic/Backporting.20CodeableReference ) |
These define sets of codes used by systems conforming to this implementation guide.
| Admission Method |
|
| Admission Source |
|
| Discharge Destination |
|
| Discharge Disposition |
|
| DocumentEntry Class | |
| DocumentEntry Type |
|
| DocumentEntry mimeType | |
| Ethnicity |
|
| Facility Type |
|
| Genomic Cancer Test Directory |
|
| Genomic Clinical Indication Codes |
1st level classification of NHS England Genomic Test Directory codes |
| Genomic Disorder Carrier |
Genomic Disorder Carrier |
| Genomic Finding |
Genomic Finding |
| Genomic Finding Detected |
Genomic Finding Detected |
| Genomic Rare and Inherited Disease Test Directory |
|
| Genomic Test Codes |
|
| Genomic Test Outcome Codes |
Test Outcome Codes from NHS England Genomic Test Outcome Codes |
| NW IdentifierType |
IdentifierType work around to bypass lack of NH in based definition |
| Order Category |
Top level classification of Genomic Test Directory |
| Patient Encounter Trigger | |
| Patient Identity Trigger |
A28/A31/A40 |
| Practitioner Identifiers |
PractitionerIdentifiers |
| Pregnancy |
ValueSet for Pregnancy answers |
| ReportType |
Copy of UKCoreReportCode |
| Request Priority |
ValueSet for Request Priority |
| Service |
DRAFT
|
| Specialty |
|
| Specimen Body Site |
Intent is to use SNOMED CT H:7 ValueSet Body Site |
| Specimen Tracking Events | |
| Specimen Type |
A subset of HL7 Europe Laboratory Report ValueSet: Specimen Types Local codes are provided for backward compatability, SNOMED codes are preferred. |
| UK National Health Identifiers |
NHS Number, CHI Number and Health and Care Number |
| Yes/No |
ValueSet for Yes/No answers |
| Yes/No/Unknown |
ValueSet for Yes/No/Unknown answers |
These define new code systems used by systems conforming to this implementation guide.
| CodeSystem for Analyser |
TODO |
| CodeSystem not defined or to be determined |
TODO |
| MFT EPIC Question Ids |
Bucket for local codes |
| NHS England Genomic Clinical Indication Code |
1st level Genomic Test Directory Codes |
| NHS England Genomic Test Code |
HL7 v2 CodeSystem : England-GenomicTestDirectory |
| NHS England Genomic Test Outcome Code |
Test Outcome Code from NHS England Genomics Test Reporting Specification |
| NW GMSA Codes |
Bucket for local codes |
| North West Genomics Test Code |
HL7 v2 CodeSystem : NWTestCode |
| Task Input/Output Parameter Type |
TODO Placeholder |
| UK National Health Identifiers |
England/Wales NHS Number, Scotland CHI Number and Northern Ireland Health and Care Number |
| UK Professional License |
UK Professional License |
| iGene Codes |
iGene Codes |
| iGene Sample Sub Type |
iGene Sample Sub Type |
| iGene Test Codes |
iGene Test Codes |
These define identifier and/or code system identities used by systems conforming to this implementation guide.
| GMC Number |
General Medical Council Consultant Code. For more details see: NHS Data Model Dictionary |
| GMP Number |
General Practitioner (GMP) number. For more details see: NHS Data Model Dictionary |
| NHS Number |
NHS Number allocated to the patient in England and Wales. For more details see: NHS Data Model Dictionary |
| ODS Code |
The identifier system for an Organisation registered with the Organisation Data Service (ODS). |
| ODS Site Code |
The identifier system for an Organisation site registered with the Organisation Data Service (ODS). |
These define transformations to convert between codes by systems conforming with this implementation guide.
| Sample Body Site (SNOMED) to iGene Specimen Sub Type |
Sample Body Site (SNOMED) to iGene Specimen Sub Type |
| Sample Type (SNOMED) to iGene Specimen Type |
Sample Type (SNOMED) to iGene Specimen Type |
These define groups of interrelated examples that demonstrate one or more of the workflows supported by this implementation guide.
| Clinical and Genomic Workflow |
Overview Clinical Workflow including Genomic Diagnostic Testing |
| Collect Specimen - Biopsy Procedure for obtaining a specimen, part of a diagnostic pathway. Day case admission. |
This is for background information around the specimen collection process, it is not considered part of this genomic specification. |
| Genomic Test Order Process including order entry and transmission of the order |
This is for background information for genomic test ordering. |
| Genomic Test Report Process |
This is for background information for genomic test reporting. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
Laboratory Order Examples
| Bundle 'Message' - Filler Order Message |
Example Filler Order Message for internal or external LIMS |
| Bundle 'Message' - Genomics Order Reply |
Influenced by HL7 v2 OML_O22 |
| Bundle 'Message' - Genomics Order with Attachment |
Influenced by HL7 v2 OML_O21 |
| Bundle 'Message' - Genomics Order with Coded Entries |
Influenced by HL7 v2 OML_O21 |
| Bundle 'SearchSet' - Genomics Order |
FHIR Message Query Example for use with Asynchronous Message Delivery |
| Document Reference Laboratory Order |
TODO |
| Encounter 'episode/stay' Example |
TODO |
| Message Header - Genomic Order |
TODO |
| Message Header - Genomic Order Reply ok |
TODO |
| Patient - OctaviaCHISLETT NHS Number: 9449305552 |
Example NHS England PDS Test Pack |
| PractitionerRole C3456789 Example |
TODO |
| ServiceRequest Attachment Example |
TODO |
| ServiceRequest Coded Entries Example |
TODO |
| Specimen Example |
TODO |
Laboratory Report Examples
| Bundle 'Message' - Genomics Report |
Influenced by HL7 v2 ORU_R01 |
| Diagnostic Report Example. |
First draft is based on Royal College of Radiologists HL7 v2 ORU converted to HL7 FHIR. Will be converted to a Genomics example |
| Document Reference Laboratory Report |
TODO |
| Message Header - Genomic Report |
TODO |
ctDNA Examples
| Bundle 'Message' - Genomics Order ctDNA O21 |
Genomics Order ctDNA |
| Bundle 'Message' - Genomics Report ctDNA R01 |
Genomics Report ctDNA |
| Bundle `Document` - Genomics Report ctDNA |
FHIR Document Genomics Report ctDNA for Theon Sheffield |
Laboratory Report Structured Examples
| Bundle `Document` - Genomics Report Inherited MMR deficiency (Lynch syndrome) |
FHIR Document Genomics Report for Ned Liverpool |
| Bundle `Document` - Genomics Report Targeted Variant |
FHIR Document Genomics Report for Jack Dawkins |
| Composition - Genomics Report LynchSyndrome |
Composition - Genomics Report LynchSyndrome |
| Composition - Genomics Report Octavia CHISLETT |
Composition - Genomics Report Octavia CHISLETT |
| DiagnosticImplication - Cystic Fibrosis Carrier |
Based on HL7 LRI Example 2 (Ref 5.9.1.2) |
| DiagnosticImplication - Lynch Syndrome |
Based on HL7 LRI Example 3 (Ref 5.9.1.3) |
| Genomic Study - Cystic Fibrosis |
Based on HL7 LRI Example 1 (Ref 5.9.1.2) |
| Genomic Study - Lynch Syndrome |
Based on HL7 LRI Example 3 (Ref 5.9.1.3) |
| Variant - CFTR |
Based on HL7 LRI Example 2 (Ref 5.9.1.2) |
| Variant - NTHL1 |
Based on HL7 LRI Example 3 (Ref 5.9.1.3) |
Ask at Order Entry questions and prior results
| 748683741 | |
| EPIC-OBR-1 Example |
TODO |
| EPIC-OBX-10 Example |
TODO |
| EPIC-OBX-11 Example |
TODO |
| EPIC-OBX-2 Example |
TODO |
| EPIC-OBX-4 Example |
TODO |
| EPIC-OBX-6 Example |
TODO |
| EPIC-OBX-7 Example |
TODO |
| EPIC-OBX-8 Example |
TODO |
| Genomic Referral Category |
TODO |
| High infection risk sample |
TODO |
| Informed Consent |
TODO |
| OBX Pregnancy |
TODO |
| Supervising Clinician |
TODO |
NHS England Genomics Order Management Service
| Bundle-Bundle-NonWGSTestOrderForm-Reanalysis-Example | |
| Bundle-NonWGSTestOrderForm-CancerSolidTumor-Example | |
| Bundle-NonWGSTestOrderForm-FetalScenario-Example |
NHS England National Record Locator Service
| NRL Genomic Report for Cersei LONDON (Test NHS Number 9737383230). Original order electronic from EPIC system |
Proof of concept example. Type, category, custodian and author are currently incorrect values |
| NRL Genomic Report for Tommen BIRMINGHAM (Test NHS Number 9737383249). Original order not electronic |
Proof of concept example. Type, category, custodian and author are currently incorrect values |