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

FHIR IG Statistics: CapabilityStatement/RegionalIntegrationEngine

Packagenw-gmsa.github.io
Resource TypeCapabilityStatement
IdRegionalIntegrationEngine
FHIR VersionR4
Sourcehttps://nw-gmsa.github.io/https://build.fhir.org/ig/nw-gmsa/R4/CapabilityStatement-RegionalIntegrationEngine.html
URLhttps://nw-gmsa.github.io/CapabilityStatement/RegionalIntegrationEngine
Version0.0.7
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

Narrative

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

Generated Narrative: CapabilityStatement RegionalIntegrationEngine

CapabilityStatement for NW GMSA Regional Integration Engine for Genomics

  • Implementation Guide Version: 0.0.7
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2025-01-30
  • Published by: NHS 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 TypeProfileRSUCSearches_include_revincludeOperations
Bundlehttp://hl7.org/fhir/StructureDefinition/Bundleyyymessage.receiver:identifier, _lastUpdated

Resource Conformance: SHALL Bundle

Base System Profile
Bundle
Profile Conformance
SHALL
Reference Policy

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

Documentation

Process Message

See Submit Test Order Form (Send HL7 FHIR Message Laboratory Order)

POST [base]/$process-message

Search (Poll for Messages)

See Asynchronous Message Delivery

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]

or

Using a FHIR Transaction

  POST [base]/

Example

PUT [base]/Bundle?identifier=9612365d-52a4-4fab-87e7-8a09d753f095
Search Parameters
ConformanceParameterTypeDocumentation
SHALLmessage.receiver:identifiertoken

The ODS code of the message recipient

SHALL_lastUpdateddate

The data the message was last updated

 

Operations

Use

FHIR Messaging Capabilities

Messaging Capability


Source

{
  "resourceType": "CapabilityStatement",
  "id": "RegionalIntegrationEngine",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://nw-gmsa.github.io/CapabilityStatement/RegionalIntegrationEngine",
  "version": "0.0.7",
  "name": "CapabilityStatement-RIE",
  "title": "CapabilityStatement for NW GMSA Regional Integration Engine for Genomics",
  "status": "draft",
  "experimental": false,
  "date": "2025-01-30",
  "publisher": "NHS North West GMSA",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "https://www.nw-gmsa.nhs.uk/contact-us"
        }
      ]
    }
  ],
  "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": "## Process Message\n\nSee [Submit Test Order Form (Send HL7 FHIR Message Laboratory Order)](LAB-1.html#submit-test-order-form-send-hl7-fhir-message-laboratory-order)\n\n```\nPOST [base]/$process-message\n```\n\n## Search (Poll for Messages)\n\nSee [Asynchronous Message Delivery](LAB-3.html#asynchronous-message-delivery)\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\nor\n\nUsing a [FHIR Transaction](https://hl7.org/fhir/R4/http.html#transaction)\n\n```\n  POST [base]/\n```\n\n### Example\n\n```\nPUT [base]/Bundle?identifier=9612365d-52a4-4fab-87e7-8a09d753f095\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"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "transaction"
        }
      ],
      "operation": [
        {
          "name": "$process-message",
          "definition": "https://nw-gmsa.github.io/OperationDefinition/ProcessMessage"
        }
      ]
    }
  ],
  "messaging": [
    {
      "supportedMessage": [
        {
          "mode": "receiver",
          "definition": "https://nw-gmsa.github.io/MessageDefinition/laboratory-order"
        },
        {
          "mode": "sender",
          "definition": "https://nw-gmsa.github.io/MessageDefinition/unsolicited-observation"
        }
      ]
    }
  ]
}