ca.uhn.hl7v2.model.v24.segment
Class QRD

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.QRD

All Implemented Interfaces:

Segment, Structure, Serializable

public class QRD
extends AbstractSegment

Represents an HL7 QRD message segment (Original-Style Query Definition). This segment has the following fields:

• QRD-1: Query Date/Time (TS)
• QRD-2: Query Format Code (ID)
• QRD-3: Query Priority (ID)
• QRD-4: Query ID (ST)
• QRD-5: Deferred Response Type (ID) optional
• QRD-6: Deferred Response Date/Time (TS) optional
• QRD-7: Quantity Limited Request (CQ)
• QRD-8: Who Subject Filter (XCN) repeating
• QRD-9: What Subject Filter (CE) repeating
• QRD-10: What Department Data Code (CE) repeating
• QRD-11: What Data Code Value Qual. (VR) optional repeating
• QRD-12: Query Results Level (ID) optional

See Also:

Serialized Form

Constructor Summary

QRD(Group parent, ModelClassFactory factory)
Creates a new QRD segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
TS	getDeferredResponseDateTime() Returns QRD-6: "Deferred Response Date/Time" - creates it if necessary
ID	getDeferredResponseType() Returns QRD-5: "Deferred Response Type" - creates it if necessary
TS	getQrd1_QueryDateTime() Returns QRD-1: "Query Date/Time" - creates it if necessary
CE	getQrd10_WhatDepartmentDataCode(int rep) Returns a specific repetition of QRD-10: "What Department Data Code" - creates it if necessary
int	getQrd10_WhatDepartmentDataCodeReps() Returns a count of the current number of repetitions of What Department Data Code (QRD-10).
VR	getQrd11_WhatDataCodeValueQual(int rep) Returns a specific repetition of QRD-11: "What Data Code Value Qual." - creates it if necessary
int	getQrd11_WhatDataCodeValueQualReps() Returns a count of the current number of repetitions of What Data Code Value Qual.
ID	getQrd12_QueryResultsLevel() Returns QRD-12: "Query Results Level" - creates it if necessary
ID	getQrd2_QueryFormatCode() Returns QRD-2: "Query Format Code" - creates it if necessary
ID	getQrd3_QueryPriority() Returns QRD-3: "Query Priority" - creates it if necessary
ST	getQrd4_QueryID() Returns QRD-4: "Query ID" - creates it if necessary
ID	getQrd5_DeferredResponseType() Returns QRD-5: "Deferred Response Type" - creates it if necessary
TS	getQrd6_DeferredResponseDateTime() Returns QRD-6: "Deferred Response Date/Time" - creates it if necessary
CQ	getQrd7_QuantityLimitedRequest() Returns QRD-7: "Quantity Limited Request" - creates it if necessary
XCN	getQrd8_WhoSubjectFilter(int rep) Returns a specific repetition of QRD-8: "Who Subject Filter" - creates it if necessary
int	getQrd8_WhoSubjectFilterReps() Returns a count of the current number of repetitions of Who Subject Filter (QRD-8).
CE	getQrd9_WhatSubjectFilter(int rep) Returns a specific repetition of QRD-9: "What Subject Filter" - creates it if necessary
int	getQrd9_WhatSubjectFilterReps() Returns a count of the current number of repetitions of What Subject Filter (QRD-9).
CQ	getQuantityLimitedRequest() Returns QRD-7: "Quantity Limited Request" - creates it if necessary
TS	getQueryDateTime() Returns QRD-1: "Query Date/Time" - creates it if necessary
ID	getQueryFormatCode() Returns QRD-2: "Query Format Code" - creates it if necessary
ST	getQueryID() Returns QRD-4: "Query ID" - creates it if necessary
ID	getQueryPriority() Returns QRD-3: "Query Priority" - creates it if necessary
ID	getQueryResultsLevel() Returns QRD-12: "Query Results Level" - creates it if necessary
VR[]	getWhatDataCodeValueQual() Returns all repetitions of What Data Code Value Qual.
VR	getWhatDataCodeValueQual(int rep) Returns a specific repetition of QRD-11: "What Data Code Value Qual." - creates it if necessary
int	getWhatDataCodeValueQualReps() Returns a count of the current number of repetitions of What Data Code Value Qual.
CE[]	getWhatDepartmentDataCode() Returns all repetitions of What Department Data Code (QRD-10).
CE	getWhatDepartmentDataCode(int rep) Returns a specific repetition of QRD-10: "What Department Data Code" - creates it if necessary
int	getWhatDepartmentDataCodeReps() Returns a count of the current number of repetitions of What Department Data Code (QRD-10).
CE[]	getWhatSubjectFilter() Returns all repetitions of What Subject Filter (QRD-9).
CE	getWhatSubjectFilter(int rep) Returns a specific repetition of QRD-9: "What Subject Filter" - creates it if necessary
int	getWhatSubjectFilterReps() Returns a count of the current number of repetitions of What Subject Filter (QRD-9).
XCN[]	getWhoSubjectFilter() Returns all repetitions of Who Subject Filter (QRD-8).
XCN	getWhoSubjectFilter(int rep) Returns a specific repetition of QRD-8: "Who Subject Filter" - creates it if necessary
int	getWhoSubjectFilterReps() Returns a count of the current number of repetitions of Who Subject Filter (QRD-8).
CE	insertQrd10_WhatDepartmentDataCode(int rep) Inserts a repetition of QRD-10: "What Department Data Code" at a specific index
VR	insertQrd11_WhatDataCodeValueQual(int rep) Inserts a repetition of QRD-11: "What Data Code Value Qual." at a specific index
XCN	insertQrd8_WhoSubjectFilter(int rep) Inserts a repetition of QRD-8: "Who Subject Filter" at a specific index
CE	insertQrd9_WhatSubjectFilter(int rep) Inserts a repetition of QRD-9: "What Subject Filter" at a specific index
VR	insertWhatDataCodeValueQual(int rep) Inserts a repetition of QRD-11: "What Data Code Value Qual." at a specific index
CE	insertWhatDepartmentDataCode(int rep) Inserts a repetition of QRD-10: "What Department Data Code" at a specific index
CE	insertWhatSubjectFilter(int rep) Inserts a repetition of QRD-9: "What Subject Filter" at a specific index
XCN	insertWhoSubjectFilter(int rep) Inserts a repetition of QRD-8: "Who Subject Filter" at a specific index
CE	removeQrd10_WhatDepartmentDataCode(int rep) Removes a repetition of QRD-10: "What Department Data Code" at a specific index
VR	removeQrd11_WhatDataCodeValueQual(int rep) Removes a repetition of QRD-11: "What Data Code Value Qual." at a specific index
XCN	removeQrd8_WhoSubjectFilter(int rep) Removes a repetition of QRD-8: "Who Subject Filter" at a specific index
CE	removeQrd9_WhatSubjectFilter(int rep) Removes a repetition of QRD-9: "What Subject Filter" at a specific index
VR	removeWhatDataCodeValueQual(int rep) Removes a repetition of QRD-11: "What Data Code Value Qual." at a specific index
CE	removeWhatDepartmentDataCode(int rep) Removes a repetition of QRD-10: "What Department Data Code" at a specific index
CE	removeWhatSubjectFilter(int rep) Removes a repetition of QRD-9: "What Subject Filter" at a specific index
XCN	removeWhoSubjectFilter(int rep) Removes a repetition of QRD-8: "Who Subject Filter" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QRD

public QRD(Group parent,
           ModelClassFactory factory)

Creates a new QRD segment

Method Detail

getQueryDateTime

public TS getQueryDateTime()

Returns QRD-1: "Query Date/Time" - creates it if necessary

getQrd1_QueryDateTime

public TS getQrd1_QueryDateTime()

Returns QRD-1: "Query Date/Time" - creates it if necessary

getQueryFormatCode

public ID getQueryFormatCode()

Returns QRD-2: "Query Format Code" - creates it if necessary

getQrd2_QueryFormatCode

public ID getQrd2_QueryFormatCode()

Returns QRD-2: "Query Format Code" - creates it if necessary

getQueryPriority

public ID getQueryPriority()

Returns QRD-3: "Query Priority" - creates it if necessary

getQrd3_QueryPriority

public ID getQrd3_QueryPriority()

Returns QRD-3: "Query Priority" - creates it if necessary

getQueryID

public ST getQueryID()

Returns QRD-4: "Query ID" - creates it if necessary

getQrd4_QueryID

public ST getQrd4_QueryID()

Returns QRD-4: "Query ID" - creates it if necessary

getDeferredResponseType

public ID getDeferredResponseType()

Returns QRD-5: "Deferred Response Type" - creates it if necessary

getQrd5_DeferredResponseType

public ID getQrd5_DeferredResponseType()

Returns QRD-5: "Deferred Response Type" - creates it if necessary

getDeferredResponseDateTime

public TS getDeferredResponseDateTime()

Returns QRD-6: "Deferred Response Date/Time" - creates it if necessary

getQrd6_DeferredResponseDateTime

public TS getQrd6_DeferredResponseDateTime()

Returns QRD-6: "Deferred Response Date/Time" - creates it if necessary

getQuantityLimitedRequest

public CQ getQuantityLimitedRequest()

Returns QRD-7: "Quantity Limited Request" - creates it if necessary

getQrd7_QuantityLimitedRequest

public CQ getQrd7_QuantityLimitedRequest()

Returns QRD-7: "Quantity Limited Request" - creates it if necessary

getWhoSubjectFilter

public XCN[] getWhoSubjectFilter()

Returns all repetitions of Who Subject Filter (QRD-8).

getWhoSubjectFilterReps

public int getWhoSubjectFilterReps()

Returns a count of the current number of repetitions of Who Subject Filter (QRD-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getWhoSubjectFilter

public XCN getWhoSubjectFilter(int rep)

Returns a specific repetition of QRD-8: "Who Subject Filter" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getQrd8_WhoSubjectFilter

public XCN getQrd8_WhoSubjectFilter(int rep)

Returns a specific repetition of QRD-8: "Who Subject Filter" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getQrd8_WhoSubjectFilterReps

public int getQrd8_WhoSubjectFilterReps()

Returns a count of the current number of repetitions of Who Subject Filter (QRD-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertWhoSubjectFilter

public XCN insertWhoSubjectFilter(int rep)
                           throws HL7Exception

Inserts a repetition of QRD-8: "Who Subject Filter" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertQrd8_WhoSubjectFilter

public XCN insertQrd8_WhoSubjectFilter(int rep)
                                throws HL7Exception

Inserts a repetition of QRD-8: "Who Subject Filter" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeWhoSubjectFilter

public XCN removeWhoSubjectFilter(int rep)
                           throws HL7Exception

Removes a repetition of QRD-8: "Who Subject Filter" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeQrd8_WhoSubjectFilter

public XCN removeQrd8_WhoSubjectFilter(int rep)
                                throws HL7Exception

Removes a repetition of QRD-8: "Who Subject Filter" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

getWhatSubjectFilter

public CE[] getWhatSubjectFilter()

Returns all repetitions of What Subject Filter (QRD-9).

getWhatSubjectFilterReps

public int getWhatSubjectFilterReps()

Returns a count of the current number of repetitions of What Subject Filter (QRD-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getWhatSubjectFilter

public CE getWhatSubjectFilter(int rep)

Returns a specific repetition of QRD-9: "What Subject Filter" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getQrd9_WhatSubjectFilter

public CE getQrd9_WhatSubjectFilter(int rep)

Returns a specific repetition of QRD-9: "What Subject Filter" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getQrd9_WhatSubjectFilterReps

public int getQrd9_WhatSubjectFilterReps()

Returns a count of the current number of repetitions of What Subject Filter (QRD-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertWhatSubjectFilter

public CE insertWhatSubjectFilter(int rep)
                           throws HL7Exception

Inserts a repetition of QRD-9: "What Subject Filter" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertQrd9_WhatSubjectFilter

public CE insertQrd9_WhatSubjectFilter(int rep)
                                throws HL7Exception

Inserts a repetition of QRD-9: "What Subject Filter" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeWhatSubjectFilter

public CE removeWhatSubjectFilter(int rep)
                           throws HL7Exception

Removes a repetition of QRD-9: "What Subject Filter" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeQrd9_WhatSubjectFilter

public CE removeQrd9_WhatSubjectFilter(int rep)
                                throws HL7Exception

Removes a repetition of QRD-9: "What Subject Filter" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

getWhatDepartmentDataCode

public CE[] getWhatDepartmentDataCode()

Returns all repetitions of What Department Data Code (QRD-10).

getWhatDepartmentDataCodeReps

public int getWhatDepartmentDataCodeReps()

Returns a count of the current number of repetitions of What Department Data Code (QRD-10). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getWhatDepartmentDataCode

public CE getWhatDepartmentDataCode(int rep)

Returns a specific repetition of QRD-10: "What Department Data Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getQrd10_WhatDepartmentDataCode

public CE getQrd10_WhatDepartmentDataCode(int rep)

Returns a specific repetition of QRD-10: "What Department Data Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getQrd10_WhatDepartmentDataCodeReps

public int getQrd10_WhatDepartmentDataCodeReps()

Returns a count of the current number of repetitions of What Department Data Code (QRD-10). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertWhatDepartmentDataCode

public CE insertWhatDepartmentDataCode(int rep)
                                throws HL7Exception

Inserts a repetition of QRD-10: "What Department Data Code" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertQrd10_WhatDepartmentDataCode

public CE insertQrd10_WhatDepartmentDataCode(int rep)
                                      throws HL7Exception

Inserts a repetition of QRD-10: "What Department Data Code" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeWhatDepartmentDataCode

public CE removeWhatDepartmentDataCode(int rep)
                                throws HL7Exception

Removes a repetition of QRD-10: "What Department Data Code" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeQrd10_WhatDepartmentDataCode

public CE removeQrd10_WhatDepartmentDataCode(int rep)
                                      throws HL7Exception

Removes a repetition of QRD-10: "What Department Data Code" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

getWhatDataCodeValueQual

public VR[] getWhatDataCodeValueQual()

Returns all repetitions of What Data Code Value Qual. (QRD-11).

getWhatDataCodeValueQualReps

public int getWhatDataCodeValueQualReps()

Returns a count of the current number of repetitions of What Data Code Value Qual. (QRD-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getWhatDataCodeValueQual

public VR getWhatDataCodeValueQual(int rep)

Returns a specific repetition of QRD-11: "What Data Code Value Qual." - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getQrd11_WhatDataCodeValueQual

public VR getQrd11_WhatDataCodeValueQual(int rep)

Returns a specific repetition of QRD-11: "What Data Code Value Qual." - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getQrd11_WhatDataCodeValueQualReps

public int getQrd11_WhatDataCodeValueQualReps()

Returns a count of the current number of repetitions of What Data Code Value Qual. (QRD-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertWhatDataCodeValueQual

public VR insertWhatDataCodeValueQual(int rep)
                               throws HL7Exception

Inserts a repetition of QRD-11: "What Data Code Value Qual." at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertQrd11_WhatDataCodeValueQual

public VR insertQrd11_WhatDataCodeValueQual(int rep)
                                     throws HL7Exception

Inserts a repetition of QRD-11: "What Data Code Value Qual." at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeWhatDataCodeValueQual

public VR removeWhatDataCodeValueQual(int rep)
                               throws HL7Exception

Removes a repetition of QRD-11: "What Data Code Value Qual." at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeQrd11_WhatDataCodeValueQual

public VR removeQrd11_WhatDataCodeValueQual(int rep)
                                     throws HL7Exception

Removes a repetition of QRD-11: "What Data Code Value Qual." at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

getQueryResultsLevel

public ID getQueryResultsLevel()

Returns QRD-12: "Query Results Level" - creates it if necessary

getQrd12_QueryResultsLevel

public ID getQrd12_QueryResultsLevel()

Returns QRD-12: "Query Results Level" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment