Package ca.uhn.hl7v2.model.v251.segment

Class QRF

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

Represents an HL7 QRF message segment (Original style query filter). This segment has the following fields:

  • QRF-1: Where Subject Filter (ST) repeating
  • QRF-2: When Data Start Date/Time (TS) optional
  • QRF-3: When Data End Date/Time (TS) optional
  • QRF-4: What User Qualifier (ST) optional repeating
  • QRF-5: Other QRY Subject Filter (ST) optional repeating
  • QRF-6: Which Date/Time Qualifier (ID) optional repeating
  • QRF-7: Which Date/Time Status Qualifier (ID) optional repeating
  • QRF-8: Date/Time Selection Qualifier (ID) optional repeating
  • QRF-9: When Quantity/Timing Qualifier (TQ) optional
  • QRF-10: Search Confidence Threshold (NM) optional
See Also:

  • Constructor Details

  • Method Details

    • getWhereSubjectFilter

      public ST[] getWhereSubjectFilter()
      Returns all repetitions of Where Subject Filter (QRF-1).

    • getQrf1_WhereSubjectFilter

      public ST[] getQrf1_WhereSubjectFilter()
      Returns all repetitions of Where Subject Filter (QRF-1).

    • getWhereSubjectFilterReps

      public int getWhereSubjectFilterReps()
      Returns a count of the current number of repetitions of Where Subject Filter (QRF-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getWhereSubjectFilter

      public ST getWhereSubjectFilter(int rep)
      Returns a specific repetition of QRF-1: "Where Subject Filter" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQrf1_WhereSubjectFilter

      public ST getQrf1_WhereSubjectFilter(int rep)
      Returns a specific repetition of QRF-1: "Where Subject Filter" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQrf1_WhereSubjectFilterReps

      public int getQrf1_WhereSubjectFilterReps()
      Returns a count of the current number of repetitions of Where Subject Filter (QRF-1). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertWhereSubjectFilter

      public ST insertWhereSubjectFilter(int rep) throws HL7Exception
      Inserts a repetition of QRF-1: "Where 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)

    • insertQrf1_WhereSubjectFilter

      public ST insertQrf1_WhereSubjectFilter(int rep) throws HL7Exception
      Inserts a repetition of QRF-1: "Where 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)

    • removeWhereSubjectFilter

      public ST removeWhereSubjectFilter(int rep) throws HL7Exception
      Removes a repetition of QRF-1: "Where 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)

    • removeQrf1_WhereSubjectFilter

      public ST removeQrf1_WhereSubjectFilter(int rep) throws HL7Exception
      Removes a repetition of QRF-1: "Where 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)

    • getWhenDataStartDateTime

      public TS getWhenDataStartDateTime()
      Returns QRF-2: "When Data Start Date/Time" - creates it if necessary

    • getQrf2_WhenDataStartDateTime

      public TS getQrf2_WhenDataStartDateTime()
      Returns QRF-2: "When Data Start Date/Time" - creates it if necessary

    • getWhenDataEndDateTime

      public TS getWhenDataEndDateTime()
      Returns QRF-3: "When Data End Date/Time" - creates it if necessary

    • getQrf3_WhenDataEndDateTime

      public TS getQrf3_WhenDataEndDateTime()
      Returns QRF-3: "When Data End Date/Time" - creates it if necessary

    • getWhatUserQualifier

      public ST[] getWhatUserQualifier()
      Returns all repetitions of What User Qualifier (QRF-4).

    • getQrf4_WhatUserQualifier

      public ST[] getQrf4_WhatUserQualifier()
      Returns all repetitions of What User Qualifier (QRF-4).

    • getWhatUserQualifierReps

      public int getWhatUserQualifierReps()
      Returns a count of the current number of repetitions of What User Qualifier (QRF-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getWhatUserQualifier

      public ST getWhatUserQualifier(int rep)
      Returns a specific repetition of QRF-4: "What User Qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQrf4_WhatUserQualifier

      public ST getQrf4_WhatUserQualifier(int rep)
      Returns a specific repetition of QRF-4: "What User Qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQrf4_WhatUserQualifierReps

      public int getQrf4_WhatUserQualifierReps()
      Returns a count of the current number of repetitions of What User Qualifier (QRF-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertWhatUserQualifier

      public ST insertWhatUserQualifier(int rep) throws HL7Exception
      Inserts a repetition of QRF-4: "What User 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)

    • insertQrf4_WhatUserQualifier

      public ST insertQrf4_WhatUserQualifier(int rep) throws HL7Exception
      Inserts a repetition of QRF-4: "What User 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)

    • removeWhatUserQualifier

      public ST removeWhatUserQualifier(int rep) throws HL7Exception
      Removes a repetition of QRF-4: "What User 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)

    • removeQrf4_WhatUserQualifier

      public ST removeQrf4_WhatUserQualifier(int rep) throws HL7Exception
      Removes a repetition of QRF-4: "What User 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)

    • getOtherQRYSubjectFilter

      public ST[] getOtherQRYSubjectFilter()
      Returns all repetitions of Other QRY Subject Filter (QRF-5).

    • getQrf5_OtherQRYSubjectFilter

      public ST[] getQrf5_OtherQRYSubjectFilter()
      Returns all repetitions of Other QRY Subject Filter (QRF-5).

    • getOtherQRYSubjectFilterReps

      public int getOtherQRYSubjectFilterReps()
      Returns a count of the current number of repetitions of Other QRY Subject Filter (QRF-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getOtherQRYSubjectFilter

      public ST getOtherQRYSubjectFilter(int rep)
      Returns a specific repetition of QRF-5: "Other QRY Subject Filter" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQrf5_OtherQRYSubjectFilter

      public ST getQrf5_OtherQRYSubjectFilter(int rep)
      Returns a specific repetition of QRF-5: "Other QRY Subject Filter" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQrf5_OtherQRYSubjectFilterReps

      public int getQrf5_OtherQRYSubjectFilterReps()
      Returns a count of the current number of repetitions of Other QRY Subject Filter (QRF-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertOtherQRYSubjectFilter

      public ST insertOtherQRYSubjectFilter(int rep) throws HL7Exception
      Inserts a repetition of QRF-5: "Other QRY 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)

    • insertQrf5_OtherQRYSubjectFilter

      public ST insertQrf5_OtherQRYSubjectFilter(int rep) throws HL7Exception
      Inserts a repetition of QRF-5: "Other QRY 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)

    • removeOtherQRYSubjectFilter

      public ST removeOtherQRYSubjectFilter(int rep) throws HL7Exception
      Removes a repetition of QRF-5: "Other QRY 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)

    • removeQrf5_OtherQRYSubjectFilter

      public ST removeQrf5_OtherQRYSubjectFilter(int rep) throws HL7Exception
      Removes a repetition of QRF-5: "Other QRY 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)

    • getWhichDateTimeQualifier

      public ID[] getWhichDateTimeQualifier()
      Returns all repetitions of Which Date/Time Qualifier (QRF-6).

    • getQrf6_WhichDateTimeQualifier

      public ID[] getQrf6_WhichDateTimeQualifier()
      Returns all repetitions of Which Date/Time Qualifier (QRF-6).

    • getWhichDateTimeQualifierReps

      public int getWhichDateTimeQualifierReps()
      Returns a count of the current number of repetitions of Which Date/Time Qualifier (QRF-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getWhichDateTimeQualifier

      public ID getWhichDateTimeQualifier(int rep)
      Returns a specific repetition of QRF-6: "Which Date/Time Qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQrf6_WhichDateTimeQualifier

      public ID getQrf6_WhichDateTimeQualifier(int rep)
      Returns a specific repetition of QRF-6: "Which Date/Time Qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQrf6_WhichDateTimeQualifierReps

      public int getQrf6_WhichDateTimeQualifierReps()
      Returns a count of the current number of repetitions of Which Date/Time Qualifier (QRF-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertWhichDateTimeQualifier

      public ID insertWhichDateTimeQualifier(int rep) throws HL7Exception
      Inserts a repetition of QRF-6: "Which Date/Time 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)

    • insertQrf6_WhichDateTimeQualifier

      public ID insertQrf6_WhichDateTimeQualifier(int rep) throws HL7Exception
      Inserts a repetition of QRF-6: "Which Date/Time 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)

    • removeWhichDateTimeQualifier

      public ID removeWhichDateTimeQualifier(int rep) throws HL7Exception
      Removes a repetition of QRF-6: "Which Date/Time 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)

    • removeQrf6_WhichDateTimeQualifier

      public ID removeQrf6_WhichDateTimeQualifier(int rep) throws HL7Exception
      Removes a repetition of QRF-6: "Which Date/Time 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)

    • getWhichDateTimeStatusQualifier

      public ID[] getWhichDateTimeStatusQualifier()
      Returns all repetitions of Which Date/Time Status Qualifier (QRF-7).

    • getQrf7_WhichDateTimeStatusQualifier

      public ID[] getQrf7_WhichDateTimeStatusQualifier()
      Returns all repetitions of Which Date/Time Status Qualifier (QRF-7).

    • getWhichDateTimeStatusQualifierReps

      public int getWhichDateTimeStatusQualifierReps()
      Returns a count of the current number of repetitions of Which Date/Time Status Qualifier (QRF-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getWhichDateTimeStatusQualifier

      public ID getWhichDateTimeStatusQualifier(int rep)
      Returns a specific repetition of QRF-7: "Which Date/Time Status Qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQrf7_WhichDateTimeStatusQualifier

      public ID getQrf7_WhichDateTimeStatusQualifier(int rep)
      Returns a specific repetition of QRF-7: "Which Date/Time Status Qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQrf7_WhichDateTimeStatusQualifierReps

      public int getQrf7_WhichDateTimeStatusQualifierReps()
      Returns a count of the current number of repetitions of Which Date/Time Status Qualifier (QRF-7). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertWhichDateTimeStatusQualifier

      public ID insertWhichDateTimeStatusQualifier(int rep) throws HL7Exception
      Inserts a repetition of QRF-7: "Which Date/Time Status 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)

    • insertQrf7_WhichDateTimeStatusQualifier

      public ID insertQrf7_WhichDateTimeStatusQualifier(int rep) throws HL7Exception
      Inserts a repetition of QRF-7: "Which Date/Time Status 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)

    • removeWhichDateTimeStatusQualifier

      public ID removeWhichDateTimeStatusQualifier(int rep) throws HL7Exception
      Removes a repetition of QRF-7: "Which Date/Time Status 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)

    • removeQrf7_WhichDateTimeStatusQualifier

      public ID removeQrf7_WhichDateTimeStatusQualifier(int rep) throws HL7Exception
      Removes a repetition of QRF-7: "Which Date/Time Status 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)

    • getDateTimeSelectionQualifier

      public ID[] getDateTimeSelectionQualifier()
      Returns all repetitions of Date/Time Selection Qualifier (QRF-8).

    • getQrf8_DateTimeSelectionQualifier

      public ID[] getQrf8_DateTimeSelectionQualifier()
      Returns all repetitions of Date/Time Selection Qualifier (QRF-8).

    • getDateTimeSelectionQualifierReps

      public int getDateTimeSelectionQualifierReps()
      Returns a count of the current number of repetitions of Date/Time Selection Qualifier (QRF-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getDateTimeSelectionQualifier

      public ID getDateTimeSelectionQualifier(int rep)
      Returns a specific repetition of QRF-8: "Date/Time Selection Qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQrf8_DateTimeSelectionQualifier

      public ID getQrf8_DateTimeSelectionQualifier(int rep)
      Returns a specific repetition of QRF-8: "Date/Time Selection Qualifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getQrf8_DateTimeSelectionQualifierReps

      public int getQrf8_DateTimeSelectionQualifierReps()
      Returns a count of the current number of repetitions of Date/Time Selection Qualifier (QRF-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertDateTimeSelectionQualifier

      public ID insertDateTimeSelectionQualifier(int rep) throws HL7Exception
      Inserts a repetition of QRF-8: "Date/Time Selection 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)

    • insertQrf8_DateTimeSelectionQualifier

      public ID insertQrf8_DateTimeSelectionQualifier(int rep) throws HL7Exception
      Inserts a repetition of QRF-8: "Date/Time Selection 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)

    • removeDateTimeSelectionQualifier

      public ID removeDateTimeSelectionQualifier(int rep) throws HL7Exception
      Removes a repetition of QRF-8: "Date/Time Selection 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)

    • removeQrf8_DateTimeSelectionQualifier

      public ID removeQrf8_DateTimeSelectionQualifier(int rep) throws HL7Exception
      Removes a repetition of QRF-8: "Date/Time Selection 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)

    • getWhenQuantityTimingQualifier

      public TQ getWhenQuantityTimingQualifier()
      Returns QRF-9: "When Quantity/Timing Qualifier" - creates it if necessary

    • getQrf9_WhenQuantityTimingQualifier

      public TQ getQrf9_WhenQuantityTimingQualifier()
      Returns QRF-9: "When Quantity/Timing Qualifier" - creates it if necessary

    • getSearchConfidenceThreshold

      public NM getSearchConfidenceThreshold()
      Returns QRF-10: "Search Confidence Threshold" - creates it if necessary

    • getQrf10_SearchConfidenceThreshold

      public NM getQrf10_SearchConfidenceThreshold()
      Returns QRF-10: "Search Confidence Threshold" - creates it if necessary

    • createNewTypeWithoutReflection

      protected Type createNewTypeWithoutReflection(int field)
      Overrides:
      createNewTypeWithoutReflection in class AbstractSegment