Package ca.uhn.hl7v2.model.v22.segment

Class QRD

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v22.segment.QRD
All Implemented Interfaces:
Segment, Structure, Visitable, Serializable
public class QRD extends AbstractSegment

Represents an HL7 QRD message segment (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_QUANTITY)
  • QRD-8: Who Subject Filter (ST) repeating
  • QRD-9: What Subject Filter (ID) repeating
  • QRD-10: What Department Data Code (ST) repeating
  • QRD-11: What data code value qualifier (CM_VR) optional repeating
  • QRD-12: Query Results Level (ID) optional
See Also:

  • Constructor Details

  • Method Details

    • 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_QUANTITY getQuantityLimitedRequest()
      Returns QRD-7: "Quantity Limited Request" - creates it if necessary

    • getQrd7_QuantityLimitedRequest

      public CQ_QUANTITY getQrd7_QuantityLimitedRequest()
      Returns QRD-7: "Quantity Limited Request" - creates it if necessary

    • getWhoSubjectFilter

      public ST[] getWhoSubjectFilter()
      Returns all repetitions of Who Subject Filter (QRD-8).

    • getQrd8_WhoSubjectFilter

      public ST[] getQrd8_WhoSubjectFilter()
      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 ST 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 ST 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 ST 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 ST 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 ST 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 ST 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 ID[] getWhatSubjectFilter()
      Returns all repetitions of What Subject Filter (QRD-9).

    • getQrd9_WhatSubjectFilter

      public ID[] getQrd9_WhatSubjectFilter()
      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 ID 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 ID 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 ID 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 ID 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 ID 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 ID 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 ST[] getWhatDepartmentDataCode()
      Returns all repetitions of What Department Data Code (QRD-10).

    • getQrd10_WhatDepartmentDataCode

      public ST[] getQrd10_WhatDepartmentDataCode()
      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 ST 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 ST 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 ST 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 ST 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 ST 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 ST 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)

    • getWhatDataCodeValueQualifier

      public CM_VR[] getWhatDataCodeValueQualifier()
      Returns all repetitions of What data code value qualifier (QRD-11).

    • getQrd11_WhatDataCodeValueQualifier

      public CM_VR[] getQrd11_WhatDataCodeValueQualifier()
      Returns all repetitions of What data code value qualifier (QRD-11).

    • getWhatDataCodeValueQualifierReps

      public int getWhatDataCodeValueQualifierReps()
      Returns a count of the current number of repetitions of What data code value qualifier (QRD-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getWhatDataCodeValueQualifier

      public CM_VR getWhatDataCodeValueQualifier(int rep)
      Returns a specific repetition of QRD-11: "What data code value qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQrd11_WhatDataCodeValueQualifier

      public CM_VR getQrd11_WhatDataCodeValueQualifier(int rep)
      Returns a specific repetition of QRD-11: "What data code value qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQrd11_WhatDataCodeValueQualifierReps

      public int getQrd11_WhatDataCodeValueQualifierReps()
      Returns a count of the current number of repetitions of What data code value qualifier (QRD-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertWhatDataCodeValueQualifier

      public CM_VR insertWhatDataCodeValueQualifier(int rep) throws HL7Exception
      Inserts a repetition of QRD-11: "What data code value qualifier" 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_WhatDataCodeValueQualifier

      public CM_VR insertQrd11_WhatDataCodeValueQualifier(int rep) throws HL7Exception
      Inserts a repetition of QRD-11: "What data code value qualifier" 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)

    • removeWhatDataCodeValueQualifier

      public CM_VR removeWhatDataCodeValueQualifier(int rep) throws HL7Exception
      Removes a repetition of QRD-11: "What data code value qualifier" 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_WhatDataCodeValueQualifier

      public CM_VR removeQrd11_WhatDataCodeValueQualifier(int rep) throws HL7Exception
      Removes a repetition of QRD-11: "What data code value qualifier" 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