Detailed System Requirements
Abstract
This document outlines the transport protocols, message mappings, and definitions for integration of IBM Pathway Signal Management with Watson with another system. The intended use of the interface is to receive events, orders, observations, and clinical documentation by using Health Level 7 International (HL7).
This document is intended for system integrators, third-party suppliers, and potential customers. The reader is assumed to be familiar with the HL7 standard.
Content
IBM Pathway Signal Management with Watson, a cloud based service, integrates with one or more applications that can send and receive HL7 v2 messages. The customer system sends HL7 messages to create or update events, orders, observations, and clinical documentation. As each incoming message is processed by the Cloud Service, an application layer acknowledgment is generated and returned to Customer system.
Messages flow from the Customer system to the Cloud Service using IBM Cloud Satellite Link. Application level acknowledgment flow from the IBM Pathway signal Management with Watson by using the IBM Cloud Satellite Link to Customer system. All messages are transmitted over TCP/IP by using HL7 MLLP
All messages referenced in this document conform to version 2.5.1 of the HL7 standard
Related documents
The following documents are related to this document and are to be used in the order shown:
- This document
- Standard for use of HL7 Version 2 in the UK
- HL7 Standard
Supported message types
The Cloud Service supports the following message types
ADT messages
- Admit a patient (event code ADT^A01)
- Transfer a patient (event code ADT^A02)
- Discharge a patient (event code ADT^A03)
- Register a patient (event code ADT^A04)
- Pre-admit a patient (event code ADT^A05)
- Update patient information (event code ADT^A08)
- Patient departing (event code ADT^A09)
- Patient arriving (event code ADT^A10)
- Cancel admit (event code ADT^A11)
- Cancel transfer (event code ADT^A12)
- Cancel discharge (event code ADT^A13)
- Pending transfer (event code ADT^A15)
- Patient goes on a “leave of absence” (event code ADT^A21)
- Patient returns from a “leave of absence” (event code ADT^A22)
- Add person information (event code ADT^A28)
- Update person information (event code ADT^A31)
- Merge Patient (event code ADT^A40)
- Change internal ID (event code ADT^A47)
- Cancel “leave of absence” for a patient (event code ADT^A52)
- Cancel patient returns from a “leave of absence” (event code A53)
Orders and Results
- General Clinical Order (event code OMG^019)
- General Clinical Order (event code ORM^O01)
- Laboratory Clinical Order (event code OML^O21)
- Laboratory Clinical Order (event code OML^O33)
- Observations (event code ORU^R01)
Referrals
- Patient referral (event code REF^I12)
- Modify patient referral (event code REF^I13)
- Cancel patient referral (event code REF^I14)
Problems
- Add Problem (event code PPR^PC1)
- Update Problem (event code PPR^PC2)
- Delete Problem (event code PPR^PC3)
Clinical Documents
- Original document notification and content (event code MDM^T02)
Supported Document Types for event code MDM^T02
| TXA.2 | Document Type | Data extracted by using Watson Natural Language Processing |
|---|---|---|
| CD | Cardio-diagnostics | Assessment, Recommendation |
| CN | Consultation, Clinic Note, Clinic Letter | Recommendation |
| DS | Discharge summary | Recommendation |
| ED | Emergency department report | Background, Assessment, Recommendation |
| HP | History and physical examination | Background, Assessment |
| OP | Operative report | Assessment, Recommendation |
| PN | Procedure note | Assessment, Recommendation |
| PR | Progress note | Assessment, Recommendation |
| SP | Surgical pathology | Assessment, Recommendation |
| TS | Transfer summary | Background, Assessment |
| RL | Referral Letter | Background |
| IPL | Inpatient Letter | Recommendation |
| OPL | Outpatient Letter | Recommendation |
| MDTP | MDT Outcome | Recommendation |
| CNS | CNS Contact | Background, Assessment, Recommendation |
| HNA | HNA, Care Plan | Background, Assessment, Recommendation |
| TREAT | Treatment Summary | Assessment, Recommendation |
Data Mapping
The Cloud Service uses the following HL7 elements as primary keys.
MSH Segment
| Element | Name | Requirement | Example |
|---|---|---|---|
| MSH.4 | Sending Facility | The ODS code of Customer | RC9 |
| MSH.9.1 | Message Code | Specifies the message type code | ADT |
| MSH.9.2 | Trigger Event | Specifies the trigger event code | A05 |
| MSH.10 | Message Control ID | A number or other identifier that uniquely identifies the message |
20230129180956.9721 |
PID Segment
| Element | Name | Requirement | Example |
|---|---|---|---|
| PID.3.1 | Identifier | This field contains the list of identifiers (one or more) used by the healthcare facility to uniquely identify a patient |
2934852463 |
| PID.3.2 | Assigning Authority | The assigning authority is the unique organization that issued the ID. One per ID in the list. |
NHS |
| PID.3.3 | Identifier Type Code | Use NH for NHS/CHI numbers Use PI for local hospital numbers |
NH |
| PID.11.1 | Street Address |
9701 Rose Farm Fold |
|
| PID.11.2 | Other Designation | ||
| PID.11.3 | City |
Chelmsford |
|
| PID.11.4 | State or Province | Essex | |
| PID.11.5 | Zip or Postal Code |
CM2 6UU |
|
| PID.11.6 | Country | UK |
PD1 Segment
| Element | Name | Requirement | Example |
|---|---|---|---|
| PD1.3.3 | Identifier | The ODS code of Primary Care Facility |
Y06601 |
| PD1.4.1 | Identifier | This field contained the ID of the primary care provider |
G5612908 |
| PD1.4.9 | Assigning Authority | The assigning authority is the unique organization that issued the ID. | GMC |
PV1 Segment
| Element | Name | Requirement | Example |
|---|---|---|---|
| PV1.3.1 | Identifier | This field contained the ID of the Assigned Patient Location |
WCOB |
| PV1.3.5 | Location Status | This component specifies the code for the status or availability of the location |
Occupied |
| PV1.6.1 | Identifier | Prior Patient Location |
W10B |
| PV1.6.5 | Location Status | This component specifies the code for the status or availability of the location | Unoccupied |
| PV1.7.1 | Identifier | This field contained the ID of the Attending Doctor |
C6154995 |
| PV1.7.9 | Assigning Authority | The assigning authority is the unique organization that issued the ID | GMC |
| PV1.8.1 | Identifier | This field contained the ID of the Referring Doctor |
C7264368 |
| PV1.8.9 | Assigning Authority | The assigning authority is the unique organization that issued the ID | GMC |
| PV1.9.1 | Identifier | This field contained the ID of the Consulting Doctor |
C319495 |
| PV1.9.9 | Assigning Authority | The assigning authority is the unique organization that issued the ID | GMC |
| PV1.10 | Hospital Service | The hospital service that is associated with the message | 320 |
| PV1.11.1 | Identifier | This field contained the ID of the Temporary Patient Location |
W25H |
| PV1.11.5 | Location Status | This component specifies the code for the status or availability of the location | Housekeeping |
| PV1.17.1 | Identifier | This field contained the ID of the Admitting Doctor | C6154995 |
| PV1.17.9 | Assigning Authority | The assigning authority is the unique organization that issued the ID | GMC |
AL1 Segment
| Element | Name | Requirement | Example |
|---|---|---|---|
| AL1.3.1 | Identifier | This field uniquely identifies a particular allergen | C0030824 |
| AL1.3.3 | Name of Coding System | Identifies the coding scheme being used in the identifier component | UMLS |
DG1 Segment
| Element | Name | Requirement | Example |
|---|---|---|---|
| DG1.3.1 | Identifier | This field uniquely identifies a particular disease or syndrome | C3531771 |
| DG1.3.3 | Name of Coding System | Identifies the coding scheme being used in the identifier component | UMLS |
| DG1.16.1 | Identifier | This field contained the ID of the diagnosing doctor | C6154995 |
| DG1.16.9 | Assigning Authority | The assigning authority is the unique organization that issued the ID | GMC |
| DG1.17 | Diagnosis Classification | This field indicates whether the disease or syndrome is a diagnosis, a symptom or otherwise. Use D for Diagnosis, S for Symptom. (Default: "D") | D |
PR1 Segment
| Element | Name | Requirement | Example |
|---|---|---|---|
| PR1.3.1 | Identifier | This field uniquely identifies a particular procedure | C3509486 |
| PR1.3.3 | Name of Coding System | Identifies the coding scheme being used in the identifier component | UMLS |
| PR1.6 | Procedure Functional Type | This field contains the code that defines the type of procedure. (Default: "P") | P |
| PR1.8.1 | Identifier | This field contained the ID of the Anesthesiologist | C6154995 |
| PR1.8.9 | Assigning Authority | The assigning authority is the unique organization that issued the ID | GMC |
| PR1.11.1 | Identifier | This field contained the ID of the Surgeon | C319495 |
| PR1.11.9 | Assigning Authority | The assigning authority is the unique organization that issued the ID | GMC |
PRB Segment
| Element | Name | Requirement | Example |
|---|---|---|---|
| PRB.3.1 | Identifier | This field uniquely identifies a particular problem | C3807726 |
| PR1.3.3 | Name of Coding System | Identifies the coding scheme being used in the identifier component | UMLS |
PRD Segment
| Element | Name | Requirement | Example |
|---|---|---|---|
| PRD.1.1 | Provider Role | This field contains the contact role that defines the relationship of the person described in this segment to the patient being referred | RP |
| PRD.7.1 | Identifier | Identifies the provider | G5612908 |
| PRD7.2 | Type Of Id Number | Practitioner ID number type | GMC |
PTH Segment
| Element | Name | Requirement | Example |
|---|---|---|---|
| PTH.2.1 | Identifier | This field uniquely identifies a particular pathway | Thoracic cancer |
| PTH.2.3 | Name of Coding System | Identifies the coding scheme being used in the identifier component | PSM |
ORC Segment
| Element | Name | Requirement | Example |
|---|---|---|---|
| ORC.1 | Order Control | Determines the function of the order segment | NW |
| ORC.2 | Placer Order Number | This field uniquely identifies the placers order number | 1186897484.21 |
| ORC.5 | Order Status | This field specifies the status of an order | SC |
| ORC,12,1 | Identifier | This field contained the ID of the Ordering Provider | C6154995 |
| ORC.12..9 | Assigning Authority | The assigning authority is the unique organization that issued the ID | GMC |
OBR Segment
| Element | Name | Requirement | Example |
|---|---|---|---|
| OBR.2 | Placer Order Number | This field uniquely identifies the placers order number | 1186897484.21 |
| OBR.4.1 | Identifier | This field contained the ID of the ordered procedure | XCHES |
| OBR.4.3 | Name of Coding System | Identifies the coding scheme being used in the identifier component | NICIP |
| OBR.24 | Diagnostic Serv Sect ID | This field is the section of the diagnostic service where the observation was performed | RAD |
| OBR.25 | Results Status | This field contains the status of results for this order. | O |
| OBR.32.1 | Identifier | This field contained the ID of the Principal Result Interpreter | C456874 |
| OBR.32.2 | Assigning Authority | The assigning authority is the unique organization that issued the ID | GMC |
| OBR.33.9 | Identifier | This field contained the ID of the Assistant Result Interpreter | C147964 |
| OBR.33.9 | Assigning Authority | The assigning authority is the unique organization that issued the ID | GMC |
| OBR.34.1 | Identifier | This field contained the ID of the Technician | C198563 |
| OBR.34.9 | Assigning Authority | The assigning authority is the unique organization that issued the ID | GMC |
OBX Segment
| Element | Name | Requirement | Example |
|---|---|---|---|
| OBX.2 | Value Type | This field contains the format of the observation value in OBX | FT |
| OBX.3.1 | Identifier | This field uniquely identifies the observation | XCHES |
| OBX.3.3 | Name of Coding System | Identifies the coding scheme being used in the identifier component | NICIP |
| OBX.11 | Observation Result Status | This field contains the observation result status | F |
| OBX.16.1 | Identifier | This field contained the ID of the Responsible Observer | C456874 |
| OBX.16.2 | Assigning Authority | The assigning authority is the unique organization that issued the ID | GMC |
TXA Segment
| Element | Name | Requirement | Example |
|---|---|---|---|
| TXA.2 | Document Type | This field identifies the type of document | FT |
[{"Type":"MASTER","Line of Business":{"code":"LOB10","label":"Data and AI"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSY8T2D","label":"IBM Pathway Signal Management with Watson"},"ARM Category":[{"code":"a8m3p000000oLvwAAE","label":"IBM Pathway Signal Management with Watson Docs-\u003EGetting started-\u003EIntegrating Healthcare Applications"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]
Was this topic helpful?
Document Information
Modified date:
09 December 2022
UID
ibm16846551