| Package | nw-gmsa.github.io |
| Resource Type | CapabilityStatement |
| Id | RegionalIntegrationEngine |
| FHIR Version | R4 |
| Source | https://nw-gmsa.github.io/https://build.fhir.org/ig/nw-gmsa/R4/CapabilityStatement-RegionalIntegrationEngine.html |
| URL | https://nw-gmsa.github.io/CapabilityStatement/RegionalIntegrationEngine |
| Version | 0.0.7 |
| Status | draft |
| Date | 2025-01-30 |
| Name | CapabilityStatement-RIE |
| Title | CapabilityStatement for NW GMSA Regional Integration Engine for Genomics |
| Realm | 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. The `OpenAPISwagger Definition file` below, can be viewed using [Swagger Editor](https://editor.swagger.io/) |
| Kind | requirements |
No resources found
| OperationDefinition | |
| ProcessMessage | Process Message |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement RegionalIntegrationEngine
application/fhir+xml, application/fhir+jsonNote 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.
serverOAuthRecommend IHE-IUA
transactioninteraction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Bundle | http://hl7.org/fhir/StructureDefinition/Bundle | y | y | y | message.receiver:identifier, _lastUpdated |
search-type, create.read.Process Message
See Submit Test Order Form (Send HL7 FHIR Message Laboratory Order)
POST [base]/$process-messageSearch (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-01Example 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
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | message.receiver:identifier | token | The ODS code of the message recipient |
| SHALL | _lastUpdated | date | The data the message was last updated |
| Mode | Definition |
|---|---|
| receiver | Message Definition - Laboratory Order |
| sender | Message Definition - Unsolicited Observation |
{
"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-1.html#asynchronous-message-response)\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"
}
]
}
]
}