org.eclipse.ohf.ihe.pix.consumer
Class PixConsumerQuery

java.lang.Object
  org.eclipse.ohf.hl7v2.core.utilities.Worker
      org.eclipse.ohf.hl7v2.core.message.model.Node
          org.eclipse.ohf.hl7v2.core.message.model.ModelProvider
              org.eclipse.ohf.hl7v2.core.message.model.Message
                  org.eclipse.ohf.ihe.common.hl7v2.message.PixPdqMessage
                      org.eclipse.ohf.ihe.pix.consumer.PixConsumerQuery

All Implemented Interfaces:

HL7_Constants

public class PixConsumerQuery
extends PixPdqMessage

QBP^Q23 Request for Corresponding Patient Identifiers

IHE HL7 Segments: MSH,QPD,RCP
IHE HL7 Standard: HL7 2.5

Author:

Sondra Renly

Field Summary

static java.lang.String	MSH_9_1_PIXC IHE PDQ Message Type
static java.lang.String	MSH_9_2_PIXC
static java.lang.String	MSH_9_3_PIXC
static java.lang.String	QPD_1_1_PIXC IHE PDQ Query Tag
static java.lang.String	QPD_1_2_PIXC

Fields inherited from class org.eclipse.ohf.hl7v2.core.message.model.Node

MODE_TYPE_SEGMENT, NODE_TYPE_COMPONENT, NODE_TYPE_FIELD, NODE_TYPE_LIST, NODE_TYPE_MESSAGE, NODE_TYPE_SUBCOMPONENT

Fields inherited from class org.eclipse.ohf.hl7v2.core.utilities.Worker

hecAccepted, hecApplicationError, hecBadField, hecBadMessage, hecBadSegCode, hecConformance, hecDataTypeError, hecDefinitionError, hecDuplicateKey, hecDuplicateMsgId, hecHL7LibraryError, hecInternalError, hecNoDefinitions, hecNoTableValue, hecRecordLocked, hecRequiredField, hecRequiredSeg, hecSequenceError, hecSuperfluousSeg, hecUnknownKey, hecUnsEvntCode, hecUnsMsgType, hecUnsProcID, hecUnsVersion, hecValidationFailed, hecXML

Fields inherited from interface org.eclipse.ohf.ihe.common.hl7v2.message.HL7_Constants

DSC, DSC_1, DSC_2, ERR, EVN, EVN_2_1, MRG, MRG_1_1, MRG_1_4_1, MRG_1_4_2, MRG_1_4_3, MSA, MSH, MSH_10, MSH_11_1, MSH_11_1_PRODUCTION, MSH_12, MSH_18_1, MSH_18_1_ASCII, MSH_3_1, MSH_3_1_DEFAULT, MSH_3_2, MSH_3_3, MSH_4_1, MSH_4_1_DEFAULT, MSH_4_2, MSH_4_3, MSH_5_1, MSH_5_1_DEFAULT, MSH_5_2, MSH_5_3, MSH_6_1, MSH_6_1_DEFAULT, MSH_6_2, MSH_6_3, MSH_7, PD1, PID, PID_11_1, PID_11_10, PID_11_2, PID_11_3, PID_11_4, PID_11_5, PID_11_6, PID_11_7, PID_11_8, PID_11_9, PID_13_1, PID_14_1, PID_18_1, PID_18_4_1, PID_18_4_2, PID_18_4_3, PID_3_1, PID_3_4_1, PID_3_4_1_DEFAULT, PID_3_4_2, PID_3_4_2_DEFAULT, PID_3_4_3, PID_3_4_3_DEFAULT, PID_5_1, PID_5_2, PID_5_3, PID_5_4, PID_5_5, PID_5_6, PID_7_1, PID_8, PV1, PV1_2, PV1_2_INPATIENT, PV1_2_OUTPATIENT, QAK, QPD, QPD_1_1, QPD_1_2, QPD_1_3, QPD_1_4, QPD_1_5, QPD_1_6, QPD_2, QPD_3_1, QPD_3_4_1, QPD_3_4_2, QPD_3_4_3, QPD_8_4_1, QPD_8_4_2, QPD_8_4_3, RCP, RCP_1, RCP_1_IMMEDIATE, RCP_2_1, RCP_2_2_1, RCP_2_2_1_RECORDS

Constructor Summary

PixConsumerQuery(org.eclipse.ohf.hl7v2.core.message.MessageManager globalFactory, org.eclipse.ohf.hl7v2.core.conformance.model.CPConformanceProfile cpProfile, java.lang.String patientId)
Constructs a PIX "QBP_Q23" message object.

PixConsumerQuery(org.eclipse.ohf.hl7v2.core.message.MessageManager globalFactory, org.eclipse.ohf.hl7v2.core.conformance.model.CPConformanceProfile cpProfile, java.lang.String patientId, java.lang.String namespaceId, java.lang.String universalId, java.lang.String universalIdType)
Constructs a PIX "QBP_Q23" message object.

Method Summary

void	addOptionalDomainRestriction(java.lang.String namespaceId, java.lang.String universalId, java.lang.String universalIdType) QPD-4-4 What Domains Returned The list of domains (assigningAuthority) to restrict the query.
void	changeDefaultAssigningAuthority(java.lang.String namespaceId, java.lang.String universalId, java.lang.String universalIdType) QPD-3-4 Person Identifier, Assigning Authority (patient_id^^^namespace&id&idtype) The initiating system's value to identify the query.
void	changeDefaultMessageQueryName(java.lang.String identifier, java.lang.String text, java.lang.String codingSystem, java.lang.String alternateIdentifier, java.lang.String alternateText, java.lang.String alternateCodingSystem) QPD-1 Message Query Name Query name for this message.
void	changeDefaultQueryTag(java.lang.String tag) QPD-2 Query Tag The initiating system's value to identify the query.

Methods inherited from class org.eclipse.ohf.ihe.common.hl7v2.message.PixPdqMessage

changeDefaultCharacterSet, changeDefaultControlId, changeDefaultProcessEnvironment, changeDefaultReceivingApplication, changeDefaultRecievingFacility, changeDefaultSendingApplication, changeDefaultSendingFacility, getCharacterSet, getMessageControlID, getProcessEnvironment, getReceivingApplication, getReceivingFacility, getSendingApplication, getSendingFacility, setField, setNonNullElement

Methods inherited from class org.eclipse.ohf.hl7v2.core.message.model.Message

addMSHFromFields, addMSHFromFields, bindToMSH, clear, clearContent, elementName, equals, forceElement, getDefaultFormat, getDelimiters, getElement, getEvent, getMessageId, getMessageType, getSegments, getStructId, getStructure, hasStructId, resolveVariableTypes, setDefaultFormat, setDelimiters, setEvent, setMessageId, setMessageType, setStructId, testIsElement

Methods inherited from class org.eclipse.ohf.hl7v2.core.message.model.ModelProvider

getDefinitions, getVersion, getVersionDefinition, setDefinitions, setVersion

Methods inherited from class org.eclipse.ohf.hl7v2.core.message.model.Node

getOwner, hasOwner, isElement, setOwner

Methods inherited from class org.eclipse.ohf.hl7v2.core.utilities.Worker

condition

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MSH_9_1_PIXC

public static final java.lang.String MSH_9_1_PIXC

IHE PDQ Message Type

See Also:

Constant Field Values

MSH_9_2_PIXC

public static final java.lang.String MSH_9_2_PIXC

See Also:

Constant Field Values

MSH_9_3_PIXC

public static final java.lang.String MSH_9_3_PIXC

See Also:

Constant Field Values

QPD_1_1_PIXC

public static final java.lang.String QPD_1_1_PIXC

IHE PDQ Query Tag

See Also:

Constant Field Values

QPD_1_2_PIXC

public static final java.lang.String QPD_1_2_PIXC

See Also:

Constant Field Values

Constructor Detail

PixConsumerQuery

public PixConsumerQuery(org.eclipse.ohf.hl7v2.core.message.MessageManager globalFactory,
                        org.eclipse.ohf.hl7v2.core.conformance.model.CPConformanceProfile cpProfile,
                        java.lang.String patientId)
                 throws PixConsumerException

Constructs a PIX "QBP_Q23" message object. INTERNAL CONSTRUCTOR ONLY - use PixConsumer.createQuery(patientId);

Parameters:

globalFactory - - message manager from hl7v2.core

cpProfile - - conformance profile for validation (ex. resources > conf > QBP-Q23(get corresponding IDs).XML)

patientId -

Throws:

PixConsumerException

PixConsumerQuery

public PixConsumerQuery(org.eclipse.ohf.hl7v2.core.message.MessageManager globalFactory,
                        org.eclipse.ohf.hl7v2.core.conformance.model.CPConformanceProfile cpProfile,
                        java.lang.String patientId,
                        java.lang.String namespaceId,
                        java.lang.String universalId,
                        java.lang.String universalIdType)
                 throws PixConsumerException

Constructs a PIX "QBP_Q23" message object. INTERNAL CONSTRUCTOR ONLY - use PixConsumer.createQuery(patientId, namespaceId, universalId, universalIdType);

Parameters:

globalFactory - - message manager from hl7v2.core

cpProfile - - conformance profile for validation (ex. resources > conf > QBP-Q23(get corresponding IDs).XML)

patientId -

namespaceId - (assigningAuthority > namespaceId)

universalId - (assigningAuthority > universalId)

universalIdType - (assigningAuthority > universalIdType)

Throws:

PixConsumerException

Method Detail

changeDefaultMessageQueryName

public void changeDefaultMessageQueryName(java.lang.String identifier,
                                          java.lang.String text,
                                          java.lang.String codingSystem,
                                          java.lang.String alternateIdentifier,
                                          java.lang.String alternateText,
                                          java.lang.String alternateCodingSystem)
                                   throws PixConsumerException

QPD-1 Message Query Name Query name for this message. The default is Q23^Get Corresponding IDs^HL7 (ie identifier^text^codingSystem).

Parameters:

identifier -

text -

codingSystem -

alternateIdentifier -

alternateText -

alternateCodingSystem -

Throws:

PdqConsumerException

PixConsumerException

changeDefaultQueryTag

public void changeDefaultQueryTag(java.lang.String tag)
                           throws PixConsumerException

QPD-2 Query Tag The initiating system's value to identify the query. The default is a random generated ID.

Parameters:

tag -

Throws:

PixConsumerException

changeDefaultAssigningAuthority

public void changeDefaultAssigningAuthority(java.lang.String namespaceId,
                                            java.lang.String universalId,
                                            java.lang.String universalIdType)
                                     throws PixConsumerException

QPD-3-4 Person Identifier, Assigning Authority (patient_id^^^namespace&id&idtype) The initiating system's value to identify the query. The default is ^^^XREF&&.

Parameters:

namespaceId - (assigningAuthority > namespaceId)

universalId - (assigningAuthority > universalId)

universalIdType - (assigningAuthority > universalIdType)

Throws:

PixConsumerException

addOptionalDomainRestriction

public void addOptionalDomainRestriction(java.lang.String namespaceId,
                                         java.lang.String universalId,
                                         java.lang.String universalIdType)
                                  throws PixConsumerException

QPD-4-4 What Domains Returned The list of domains (assigningAuthority) to restrict the query. Supports repeats for restricting to multiple domains. The default is null (no restriction).

Parameters:

namespaceId - (assigningAuthority > namespaceId)

universalId - (assigningAuthority > universalId)

universalIdType - (assigningAuthority > universalIdType)

Throws:

PixConsumerException