FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/CapabilityStatementRIE

Packagenorth-west.england.nhs.uk
TypeCapabilityStatement
IdCapabilityStatementRIE
FHIR VersionR4
Sourcehttps://fhir.north-west.england.nhs.uk/https://build.fhir.org/ig/Interop-NWEngland/LTW-Genomics/CapabilityStatement-CapabilityStatementRIE.html
URLhttps://fhir.north-west.england.nhs.uk/CapabilityStatement/CapabilityStatementRIE
Version0.0.1
Statusdraft
Date2025-01-30
NameCapabilityStatement-RIE
TitleCapabilityStatement for NW GMSA Regional Integration Engine for Genomics
Realmuk
DescriptionIs based on [FHIR Messaging](https://hl7.org/fhir/R4/messaging.html) to handle transformation of HL7 FHIR and v2 Messages to FHIR Workflow. The `OpenAPISwagger Definition file` below, can be viewed using [Swagger Editor](https://editor.swagger.io/)
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

OperationDefinition
ProcessMessageProcess Message
StructureDefinition
PatientPatient
PractitionerRolePractitionerRole

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement CapabilityStatementRIE

CapabilityStatement for NW GMSA 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: NHS England North West GMSA

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 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


Source

{
  "resourceType": "CapabilityStatement",
  "id": "CapabilityStatementRIE",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://fhir.north-west.england.nhs.uk/CapabilityStatement/CapabilityStatementRIE",
  "version": "0.0.1",
  "name": "CapabilityStatement-RIE",
  "title": "CapabilityStatement for NW GMSA Regional Integration Engine for Genomics",
  "status": "draft",
  "experimental": false,
  "date": "2025-01-30",
  "publisher": "NHS England North West GMSA",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "https://mft.nhs.uk/"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "email",
          "value": "pressoffice@mft.nhs.uk"
        }
      ]
    },
    {
      "name": "Press Office",
      "telecom": [
        {
          "system": "email",
          "value": "pressoffice@mft.nhs.uk"
        }
      ]
    }
  ],
  "description": "Is based on [FHIR Messaging](https://hl7.org/fhir/R4/messaging.html) to handle transformation of HL7 FHIR and v2 Messages to FHIR Workflow.\n\nThe `OpenAPISwagger Definition file` below, can be viewed using [Swagger Editor](https://editor.swagger.io/)",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "GB",
          "display": "United Kingdom of Great Britain and Northern Ireland"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest": [
    {
      "mode": "server",
      "security": {
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "OAuth"
              }
            ]
          }
        ],
        "description": "Recommend [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html)"
      },
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Bundle",
          "profile": "http://hl7.org/fhir/StructureDefinition/Bundle",
          "documentation": "## Search (Poll for Messages)\n\nThe Order Placer (or TIE) will [poll](https://www.enterpriseintegrationpatterns.com/patterns/messaging/PollingConsumer.html) for new messages using a FHIR RESTful query.\n\n```\nGET [base]/Bundle?message.receiver:identifier=[odsCode]&_lastUpdated=[date]\n```\n\n### Example\n\n```\nGET [base]/Bundle?message.receiver:identifier=R0A&_lastUpdated=gt2025-02-01\n```\n\nExample returned search results [Bundle 'SearchSet' - Genomics Order](Bundle-GenomicsOrderSearchSet.html)\n\n## Update (Acknowledge Message)\n\nThis is used to acknowledge the message and is the original message sent back to the server with the source and destination reversed.\n\n```\nPUT [base]/Bundle?identifier=[identifier]\n```\n\n### Example\n\n```\nPUT [base]/Bundle?identifier=9612365d-52a4-4fab-87e7-8a09d753f095\n```\n\nThe acknowledgement may be sent via a [FHIR Transaction](https://hl7.org/fhir/R4/http.html#transaction)\n\n```\n  POST [base]/\n```\n\n",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create"
            }
          ],
          "conditionalUpdate": true,
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "message.receiver:identifier",
              "type": "token",
              "documentation": "The ODS code of the message recipient"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_lastUpdated",
              "type": "date",
              "documentation": "The data the message was last updated"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Patient",
          "profile": "https://fhir.north-west.england.nhs.uk/StructureDefinition/Patient",
          "documentation": "## Update\n\n  This is used to update the `laboratory order`. See also [IHE PIXm - Patient Identity Feed FHIR [ITI-104]](https://profiles.ihe.net/ITI/PIXm/ITI-104.html)\n  The IHE PIX/[NHS England HL7 ADT](https://drive.google.com/drive/folders/1FRkyZvWpZB1nCKbvQbo-eW_q9VtlR3Ws) equivalent is ADT_A31 and ADT_A40.\n\n  ```\n  PUT [base]/Patient?identifier=[identifier]\n  ```",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update"
            }
          ],
          "conditionalUpdate": true
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "PractitionerRole",
          "profile": "https://fhir.north-west.england.nhs.uk/StructureDefinition/PractitionerRole",
          "documentation": "## Update\n\n  This is used to update the `laboratory order`. The HL7 equivalent is [MFN_M02 - Master files notification - Staff/practitioner master file](https://hl7-definition.caristix.com/v2/HL7v2.5.1/TriggerEvents/MFN_M02)\n\n  ```\n  PUT [base]/PractitionerRole?identifier=[identifier]\n  ```",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "update"
            }
          ],
          "conditionalUpdate": true
        }
      ],
      "interaction": [
        {
          "code": "transaction"
        }
      ],
      "operation": [
        {
          "name": "$process-message",
          "definition": "https://fhir.north-west.england.nhs.uk/OperationDefinition/ProcessMessage"
        }
      ]
    }
  ],
  "messaging": [
    {
      "supportedMessage": [
        {
          "mode": "receiver",
          "definition": "https://fhir.north-west.england.nhs.uk/MessageDefinition/laboratory-order"
        },
        {
          "mode": "sender",
          "definition": "https://fhir.north-west.england.nhs.uk/MessageDefinition/unsolicited-observation"
        }
      ]
    }
  ]
}