North West Genomics Testing Workflow (GTW)
0.0.1 - ci-build United Kingdom flag

DRAFT Implementation Guide

This is for collaboration and discussion purposes and is subject to change.

North West Genomics Testing Workflow (GTW) - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: CapabilityStatement for MFT Regional Integration Engine for Genomics

Official URL: https://hl7.mft.nhs.uk/CapabilityStatement/CapabilityStatementRIE Version: 0.0.1
Draft as of 2025-01-30 Computable Name: CapabilityStatement-RIE

Is based on FHIR Messaging to handle transformation of HL7 FHIR and v2 Messages to FHIR Workflow.

The OpenAPISwagger Definition file below, can be viewed using Swagger Editor

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement CapabilityStatementRIE

CapabilityStatement for MFT Regional Integration Engine for Genomics

  • Implementation Guide Version: 0.0.1
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2025-01-30
  • Published by: Manchester University NHS Foundation Trust

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Security
Enable CORS: no
Security services supported: OAuth

Recommend IHE-IUA

Summary of System-wide Interactions
  • Supports the transactioninteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Bundlehttp://hl7.org/fhir/StructureDefinition/Bundleyyymessage.receiver:identifier, _lastUpdated
Patienthttps://hl7.mft.nhs.uk/StructureDefinition/Patienty
PractitionerRolehttps://hl7.mft.nhs.uk/StructureDefinition/PractitionerRoley

Resource Conformance: SHALL Bundle

Base System Profile
Bundle
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type, create.
  • SHOULD support read.

Documentation

Search (Poll for Messages)

The Order Placer (or TIE) will poll for new messages using a FHIR RESTful query.

GET [base]/Bundle?message.receiver:identifier=[odsCode]&_lastUpdated=[date]

Example

GET [base]/Bundle?message.receiver:identifier=R0A&_lastUpdated=gt2025-02-01

Example returned search results Bundle 'SearchSet' - Genomics Order

Update (Acknowledge Message)

This is used to acknowledge the message and is the original message sent back to the server with the source and destination reversed.

PUT [base]/Bundle?identifier=[identifier]

Example

PUT [base]/Bundle?identifier=9612365d-52a4-4fab-87e7-8a09d753f095

The acknowledgement may be sent via a FHIR Transaction

  POST [base]/
Search Parameters
ConformanceParameterTypeDocumentation
SHALLmessage.receiver:identifiertoken

The ODS code of the message recipient

SHALL_lastUpdateddate

The data the message was last updated

 

Resource Conformance: SHALL Patient

Base System Profile
Patient
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support update.

Documentation

Update

This is used to update the laboratory order. See also IHE PIXm - Patient Identity Feed FHIR [ITI-104] The IHE PIX/NHS England HL7 ADT equivalent is ADT_A31 and ADT_A40.

PUT [base]/Patient?identifier=[identifier]

Resource Conformance: SHALL PractitionerRole

Base System Profile
PractitionerRole
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support update.

Documentation

Update

This is used to update the laboratory order. The HL7 equivalent is MFN_M02 - Master files notification - Staff/practitioner master file

PUT [base]/PractitionerRole?identifier=[identifier]

Operations

Use

FHIR Messaging Capabilities

Messaging Capability

Supported Message(s)

ModeDefinition
receiverMessage Definition - Laboratory Order
senderMessage Definition - Unsolicited Observation
senderMessage Definition - Laboratory Order Acknowledgement