Healthcare: Patient Demographics Query Supplier pattern

Use the Healthcare: Patient Demographics Query Supplier pattern with IBM® InfoSphere® Master Data Management (MDM) to create a Patient Demographics Supplier that you can use with the Integrating the Healthcare Enterprise (IHE) Patient Demographics Query (PDQ) profile. You can then integrate your clinical applications with the pattern, to act as a Patient Demographics Consumer actors, as defined in the PDQ profile.

Solution

You can use the Healthcare: Patient Demographics Query Supplier pattern to create an integration solution that receives QBP HL7 messages over MLLP from a clinical application (the Patient Demographics Consumer in the PDQ profile). The integration solution then returns an appropriate response to the clinical application, as specified by transaction ITI-21 of the PDQ profile. If the message is valid then the integration solution uses SOAP request/response messages to 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 integration solution completes the following tasks:

If the incoming message is a QBP message of type Q22, the integration solution retrieves a list of demographic information from the EMPI for patients that match the search data that is specified in the incoming message. The query results are returned in an RSP (response) message.
For successful queries, an AA RSP (response) message of type K22 is returned. This message contains the list of demographic information for the patients that match the search data that is specified in the incoming message.
For unsuccessful queries, an AE RSP, AE ACK, or AR ACK message is returned, depending on the reason for the failure. Additional information about the failure is contained in the ERR segment of the response.

When you generate an instance of the Healthcare: Patient Demographics Query Supplier 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.

Acknowledgments

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 QBP messages if there is an error because the EMPI server was not contacted.

MSH

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 Supplier Application pattern parameter, in the Patient Demographics Supplier pattern parameters group
MSH.4.SendingFacility	The value that is specified by the Supplier Facility pattern parameter, in the Patient Demographics Supplier pattern parameters group
MSH.5.ReceivingApplication	The value that is specified by the Application pattern parameter, in the Patient Demographics Consumer pattern parameters group
MSH.6.ReceivingFacility	The value that is specified by the Facility pattern parameter, in the Patient Demographics Consumer 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'

MSA

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'

ERR

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

Responses

The following tables describe the values in the response (RSP) messages that are returned by the pattern.

MSH

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 Supplier Application pattern parameter, in the Patient Demographics Supplier pattern parameters group
MSH.4.SendingFacility	The value that is specified by the Supplier Facility pattern parameter, in the Patient Demographics Supplier pattern parameters group
MSH.5.ReceivingApplication	The value that is specified by the Application pattern parameter, in the Patient Demographics Consumer pattern parameters group
MSH.6.ReceivingFacility	The value that is specified by the Facility pattern parameter, in the Patient Demographics Consumer pattern parameters group
MSH.7.DateTimeOfMessage	Current date time in the format YYYYMMddHHmmss
MSH.9.MessageType	'RSP^K22^RSP_K21'
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'

MSA

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'

ERR

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

QAK

Field name	Field value in response message
QAK.1	The query tag, as supplied in the incoming QBP message.
QAK.2	The query response status: OK if data is found and there are no errors NF if no data is found and there are no errors AE if no domain specified in the input message is recognized

QPD

This segment is a copy of the QPD segment that was provided in the incoming QBP message.

PID

One PID segment is returned for each matching patient record that is found.

Field name	Field value in response message
PID.3	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	The patient name.
PID.7	The date and time of birth.
PID.8	The sex of the patient.
PID.11	The patient address.
PID.18	The patient account number.

Related tasks

Read the following section for information about how to apply and use this pattern.

Constraints on the use of the pattern

Tasks to complete before applying the pattern

Parameters for the pattern