Use the Healthcare: Patient Identifier Cross-reference Manager pattern with IBM® InfoSphere® Master Data Management (MDM) to create a Patient Identifier Cross-reference Manager that you can use with the Integrating the Healthcare Enterprise (IHE) Patient Identifier Cross Referencing (PIX) profile. You can then integrate your clinical applications with the pattern, to act as Patient Identity Source and Patient Identifier Cross-reference Consumer actors, as defined in the PIX profile.
You can use the Healthcare: Patient Identifier Cross-reference Manager pattern to create an integration solution that receives ADT or QBP HL7 messages over MLLP from a clinical application (the Patient Identity Source in the PIX profile). The integration solution then returns an appropriate acknowledgment to the clinical application, as specified by the PIX profile (transaction ITI-8 for ADT messages, or transaction ITI-9 for QBP messages). If the message is valid then the integration solution uses SOAP request/response messages to update or retrieve information from the enterprise master patient index (EMPI) as specified by the content of the message. The EMPI runs in IBM InfoSphere MDM.
The behavior of the integration solution depends on the type of the incoming message. For ADT messages, the integration solution completes the following tasks:
For QBP messages, the integration solution completes the following tasks:
When you generate an instance of the Healthcare: Patient Identifier Cross-reference Manager pattern, a library named IHEHL7DFDLLibrary is created automatically. The library contains a DFDL version 2.5.1 model, which is used to define the HL7 messages that are used by the pattern.
The following tables describe the values in the acknowledgment (ACK) messages that are returned by the pattern. ACK messages are returned by the pattern in response to ADT messages and in response to QBP messages if there is an error because the EMPI server was not contacted.
Field name | Field value in acknowledgment message | If not present in the input message |
---|---|---|
MSH.1.FieldSeparator | MSH.1.FieldSeparator from the input message | '|' |
MSH.2.ServiceString | MSH.2.ServiceString from the input message | '^~\&' |
MSH.3.SendingApplication | The value that is specified by the Application pattern parameter, in the PIX Manager pattern parameters group | |
MSH.4.SendingFacility | The value that is specified by the Facility pattern parameter, in the PIX Manager pattern parameters group | |
MSH.5.ReceivingApplication | The value that is specified by the Application pattern parameter, in the Patient Identity Source pattern parameters group | |
MSH.6.ReceivingFacility | The value that is specified by the Facility pattern parameter, in the Patient Identity Source pattern parameters group | |
MSH.7.DateTimeOfMessage | Current date time in the format YYYYMMddHHmmss | |
MSH.9.MessageType | 'ACK^ACK^ACK' | |
MSH.10.MessageControlID | New unique identifier | |
MSH.11.ProcessingID | MSH.11.ProcessingID from the input message | 'P' |
MSH.12.VersionID | MSH.12.VersionID from the input message | '2.5' |
Field name | Field value in acknowledgment message | If not present in the input message |
---|---|---|
MSA.1.AcknowledgmentCode | On successful receipt of the message, the MSA acknowledgment code is set to AA. Otherwise, the MSA acknowledgment code is set to AR or AE, depending on the error. | |
MSA.2.MessageControlID | MSH.10.MessageControlID from the input message | '123456789' |
Field name | Field value in acknowledgment message |
---|---|
ERR.2.ErrorLocation | The HL7 message field that contains the error |
ERR.3.HL7ErrorCode | The HL7 (communication) error code |
ERR.4.Severity | The severity of an application error |
ERR.7.DiagnosticInformation | Additional error information for SOAP faults |
The following tables describe the values in the response (RSP) messages that are returned by the pattern. RSP messages are returned by the pattern in response to QBP messages.
Field name | Field value in response message | If not present in the input message |
---|---|---|
MSH.1.FieldSeparator | MSH.1.FieldSeparator from the input message | '|' |
MSH.2.ServiceString | MSH.2.ServiceString from the input message | '^~\&' |
MSH.3.SendingApplication | The value that is specified by the Application pattern parameter, in the PIX Manager pattern parameters group | |
MSH.4.SendingFacility | The value that is specified by the Facility pattern parameter, in the PIX Manager pattern parameters group | |
MSH.5.ReceivingApplication | The value that is specified by the Application pattern parameter, in the Patient Identity Source pattern parameters group | |
MSH.6.ReceivingFacility | The value that is specified by the Facility pattern parameter, in the Patient Identity Source pattern parameters group | |
MSH.7.DateTimeOfMessage | Current date time in the format YYYYMMddHHmmss | |
MSH.9.MessageType | 'RSP^K23^RSP_K23' | |
MSH.10.MessageControlID | New unique identifier | |
MSH.11.ProcessingID | MSH.11.ProcessingID from the input message | 'P' |
MSH.12.VersionID | MSH.12.VersionID from the input message | '2.5' |
Field name | Field value in response message | If not present in the input message |
---|---|---|
MSA.1.AcknowledgmentCode | On a successful query, the MSA acknowledgment code is set to AA. Otherwise, the MSA acknowledgment code is set to AR or AE, depending on the error. | |
MSA.2.MessageControlID | MSH.10.MessageControlID from the input message | '123456789' |
Field name | Field value in response message |
---|---|
ERR.2.ErrorLocation | The HL7 message field that contains the error |
ERR.3.HL7ErrorCode | The HL7 (communication) error code |
ERR.4.Severity | The severity of an application error |
ERR.7.DiagnosticInformation | Additional error information for SOAP faults |
Field name | Field value in response message |
---|---|
QAK.1 | The query tag |
QAK.2 | The query response status:
|
This segment is a copy of the QPD segment that was provided in the incoming QBP message.
Field name | Field value in response message |
---|---|
PID.3.PatientIdentifierList | The unique identifier for the patient. If the patient is in multiple domains, one copy of this field is present for each domain and each copy contains the identifier for a domain. |
PID.5.PatientName | The patient name. There are two copies of this field. The first copy is empty and the second contains only the value S in component seven of the field. |
A fully qualified assigning authority is the combination of namespace ID, universal ID, and universal ID type. By default, in response (RSP) messages, the PID 3 field contains only the namespace ID, in field PID.3.4.1. If you require your integration solution to provide a fully qualified assigning authority, you can create a configurable service that will add the universal ID to field PID.3.4.2 and the universal ID type to field PID.3.4.3.
The configurable service contains a list of namespace IDs, together with the associated universal IDs and universal ID types for each namespace ID. When the integration solution is running, the PID.3.4.1 field in RSP messages is checked against the list of namespace IDs in the configurable service. If field PID.3.4.1 matches a namespace ID in the configurable service, the associated universal ID is added to field PID.3.4.2 and the associated universal ID type is added to field 3.4.3 of the RSP message. You can update and redeploy the configurable service to update the list while the integration solution is running.
To use a configurable service to provide a fully qualified assigning authority, complete the following steps: