Class ARQ

All Implemented Interfaces:
Segment, Structure, Visitable, Serializable

public class ARQ extends AbstractSegment

Represents an HL7 ARQ message segment (Appointment Request). This segment has the following fields:

  • ARQ-1: Placer Appointment ID (EI)
  • ARQ-2: Filler Appointment ID (EI) optional
  • ARQ-3: Occurrence Number (NM) optional
  • ARQ-4: Placer Group Number (EI) optional
  • ARQ-5: Schedule ID (CE) optional
  • ARQ-6: Request Event Reason (CE) optional
  • ARQ-7: Appointment Reason (CE) optional
  • ARQ-8: Appointment Type (CE) optional
  • ARQ-9: Appointment Duration (NM) optional
  • ARQ-10: Appointment Duration Units (CE) optional
  • ARQ-11: Requested Start Date/Time Range (DR) optional repeating
  • ARQ-12: Priority-ARQ (ST) optional
  • ARQ-13: Repeating Interval (RI) optional
  • ARQ-14: Repeating Interval Duration (ST) optional
  • ARQ-15: Placer Contact Person (XCN) repeating
  • ARQ-16: Placer Contact Phone Number (XTN) optional repeating
  • ARQ-17: Placer Contact Address (XAD) optional repeating
  • ARQ-18: Placer Contact Location (PL) optional
  • ARQ-19: Entered By Person (XCN) repeating
  • ARQ-20: Entered By Phone Number (XTN) optional repeating
  • ARQ-21: Entered by Location (PL) optional
  • ARQ-22: Parent Placer Appointment ID (EI) optional
  • ARQ-23: Parent Filler Appointment ID (EI) optional
  • ARQ-24: Placer Order Number (EI) optional repeating
  • ARQ-25: Filler Order Number (EI) optional repeating
See Also:
  • Constructor Details

  • Method Details

    • getPlacerAppointmentID

      Returns ARQ-1: "Placer Appointment ID" - creates it if necessary
    • getArq1_PlacerAppointmentID

      Returns ARQ-1: "Placer Appointment ID" - creates it if necessary
    • getFillerAppointmentID

      Returns ARQ-2: "Filler Appointment ID" - creates it if necessary
    • getArq2_FillerAppointmentID

      Returns ARQ-2: "Filler Appointment ID" - creates it if necessary
    • getOccurrenceNumber

      Returns ARQ-3: "Occurrence Number" - creates it if necessary
    • getArq3_OccurrenceNumber

      Returns ARQ-3: "Occurrence Number" - creates it if necessary
    • getPlacerGroupNumber

      Returns ARQ-4: "Placer Group Number" - creates it if necessary
    • getArq4_PlacerGroupNumber

      Returns ARQ-4: "Placer Group Number" - creates it if necessary
    • getScheduleID

      public CE getScheduleID()
      Returns ARQ-5: "Schedule ID" - creates it if necessary
    • getArq5_ScheduleID

      Returns ARQ-5: "Schedule ID" - creates it if necessary
    • getRequestEventReason

      Returns ARQ-6: "Request Event Reason" - creates it if necessary
    • getArq6_RequestEventReason

      Returns ARQ-6: "Request Event Reason" - creates it if necessary
    • getAppointmentReason

      Returns ARQ-7: "Appointment Reason" - creates it if necessary
    • getArq7_AppointmentReason

      Returns ARQ-7: "Appointment Reason" - creates it if necessary
    • getAppointmentType

      Returns ARQ-8: "Appointment Type" - creates it if necessary
    • getArq8_AppointmentType

      Returns ARQ-8: "Appointment Type" - creates it if necessary
    • getAppointmentDuration

      Returns ARQ-9: "Appointment Duration" - creates it if necessary
    • getArq9_AppointmentDuration

      Returns ARQ-9: "Appointment Duration" - creates it if necessary
    • getAppointmentDurationUnits

      Returns ARQ-10: "Appointment Duration Units" - creates it if necessary
    • getArq10_AppointmentDurationUnits

      Returns ARQ-10: "Appointment Duration Units" - creates it if necessary
    • getRequestedStartDateTimeRange

      Returns all repetitions of Requested Start Date/Time Range (ARQ-11).
    • getArq11_RequestedStartDateTimeRange

      Returns all repetitions of Requested Start Date/Time Range (ARQ-11).
    • getRequestedStartDateTimeRangeReps

      Returns a count of the current number of repetitions of Requested Start Date/Time Range (ARQ-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getRequestedStartDateTimeRange

      Returns a specific repetition of ARQ-11: "Requested Start Date/Time Range" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq11_RequestedStartDateTimeRange

      Returns a specific repetition of ARQ-11: "Requested Start Date/Time Range" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq11_RequestedStartDateTimeRangeReps

      Returns a count of the current number of repetitions of Requested Start Date/Time Range (ARQ-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertRequestedStartDateTimeRange

      Inserts a repetition of ARQ-11: "Requested Start Date/Time Range" 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)
    • insertArq11_RequestedStartDateTimeRange

      Inserts a repetition of ARQ-11: "Requested Start Date/Time Range" 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)
    • removeRequestedStartDateTimeRange

      Removes a repetition of ARQ-11: "Requested Start Date/Time Range" 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)
    • removeArq11_RequestedStartDateTimeRange

      Removes a repetition of ARQ-11: "Requested Start Date/Time Range" 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)
    • getPriorityARQ

      public ST getPriorityARQ()
      Returns ARQ-12: "Priority-ARQ" - creates it if necessary
    • getArq12_PriorityARQ

      Returns ARQ-12: "Priority-ARQ" - creates it if necessary
    • getRepeatingInterval

      Returns ARQ-13: "Repeating Interval" - creates it if necessary
    • getArq13_RepeatingInterval

      Returns ARQ-13: "Repeating Interval" - creates it if necessary
    • getRepeatingIntervalDuration

      Returns ARQ-14: "Repeating Interval Duration" - creates it if necessary
    • getArq14_RepeatingIntervalDuration

      Returns ARQ-14: "Repeating Interval Duration" - creates it if necessary
    • getPlacerContactPerson

      Returns all repetitions of Placer Contact Person (ARQ-15).
    • getArq15_PlacerContactPerson

      Returns all repetitions of Placer Contact Person (ARQ-15).
    • getPlacerContactPersonReps

      Returns a count of the current number of repetitions of Placer Contact Person (ARQ-15). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getPlacerContactPerson

      public XCN getPlacerContactPerson(int rep)
      Returns a specific repetition of ARQ-15: "Placer Contact Person" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq15_PlacerContactPerson

      Returns a specific repetition of ARQ-15: "Placer Contact Person" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq15_PlacerContactPersonReps

      Returns a count of the current number of repetitions of Placer Contact Person (ARQ-15). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertPlacerContactPerson

      public XCN insertPlacerContactPerson(int rep) throws HL7Exception
      Inserts a repetition of ARQ-15: "Placer Contact Person" 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)
    • insertArq15_PlacerContactPerson

      Inserts a repetition of ARQ-15: "Placer Contact Person" 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)
    • removePlacerContactPerson

      public XCN removePlacerContactPerson(int rep) throws HL7Exception
      Removes a repetition of ARQ-15: "Placer Contact Person" 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)
    • removeArq15_PlacerContactPerson

      Removes a repetition of ARQ-15: "Placer Contact Person" 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)
    • getPlacerContactPhoneNumber

      Returns all repetitions of Placer Contact Phone Number (ARQ-16).
    • getArq16_PlacerContactPhoneNumber

      Returns all repetitions of Placer Contact Phone Number (ARQ-16).
    • getPlacerContactPhoneNumberReps

      Returns a count of the current number of repetitions of Placer Contact Phone Number (ARQ-16). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getPlacerContactPhoneNumber

      public XTN getPlacerContactPhoneNumber(int rep)
      Returns a specific repetition of ARQ-16: "Placer Contact Phone Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq16_PlacerContactPhoneNumber

      Returns a specific repetition of ARQ-16: "Placer Contact Phone Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq16_PlacerContactPhoneNumberReps

      Returns a count of the current number of repetitions of Placer Contact Phone Number (ARQ-16). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertPlacerContactPhoneNumber

      Inserts a repetition of ARQ-16: "Placer Contact Phone Number" 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)
    • insertArq16_PlacerContactPhoneNumber

      Inserts a repetition of ARQ-16: "Placer Contact Phone Number" 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)
    • removePlacerContactPhoneNumber

      Removes a repetition of ARQ-16: "Placer Contact Phone Number" 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)
    • removeArq16_PlacerContactPhoneNumber

      Removes a repetition of ARQ-16: "Placer Contact Phone Number" 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)
    • getPlacerContactAddress

      Returns all repetitions of Placer Contact Address (ARQ-17).
    • getArq17_PlacerContactAddress

      Returns all repetitions of Placer Contact Address (ARQ-17).
    • getPlacerContactAddressReps

      Returns a count of the current number of repetitions of Placer Contact Address (ARQ-17). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getPlacerContactAddress

      public XAD getPlacerContactAddress(int rep)
      Returns a specific repetition of ARQ-17: "Placer Contact Address" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq17_PlacerContactAddress

      Returns a specific repetition of ARQ-17: "Placer Contact Address" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq17_PlacerContactAddressReps

      Returns a count of the current number of repetitions of Placer Contact Address (ARQ-17). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertPlacerContactAddress

      public XAD insertPlacerContactAddress(int rep) throws HL7Exception
      Inserts a repetition of ARQ-17: "Placer Contact Address" 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)
    • insertArq17_PlacerContactAddress

      Inserts a repetition of ARQ-17: "Placer Contact Address" 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)
    • removePlacerContactAddress

      public XAD removePlacerContactAddress(int rep) throws HL7Exception
      Removes a repetition of ARQ-17: "Placer Contact Address" 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)
    • removeArq17_PlacerContactAddress

      Removes a repetition of ARQ-17: "Placer Contact Address" 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)
    • getPlacerContactLocation

      Returns ARQ-18: "Placer Contact Location" - creates it if necessary
    • getArq18_PlacerContactLocation

      Returns ARQ-18: "Placer Contact Location" - creates it if necessary
    • getEnteredByPerson

      public XCN[] getEnteredByPerson()
      Returns all repetitions of Entered By Person (ARQ-19).
    • getArq19_EnteredByPerson

      Returns all repetitions of Entered By Person (ARQ-19).
    • getEnteredByPersonReps

      public int getEnteredByPersonReps()
      Returns a count of the current number of repetitions of Entered By Person (ARQ-19). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getEnteredByPerson

      public XCN getEnteredByPerson(int rep)
      Returns a specific repetition of ARQ-19: "Entered By Person" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq19_EnteredByPerson

      public XCN getArq19_EnteredByPerson(int rep)
      Returns a specific repetition of ARQ-19: "Entered By Person" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq19_EnteredByPersonReps

      Returns a count of the current number of repetitions of Entered By Person (ARQ-19). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertEnteredByPerson

      public XCN insertEnteredByPerson(int rep) throws HL7Exception
      Inserts a repetition of ARQ-19: "Entered By Person" 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)
    • insertArq19_EnteredByPerson

      public XCN insertArq19_EnteredByPerson(int rep) throws HL7Exception
      Inserts a repetition of ARQ-19: "Entered By Person" 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)
    • removeEnteredByPerson

      public XCN removeEnteredByPerson(int rep) throws HL7Exception
      Removes a repetition of ARQ-19: "Entered By Person" 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)
    • removeArq19_EnteredByPerson

      public XCN removeArq19_EnteredByPerson(int rep) throws HL7Exception
      Removes a repetition of ARQ-19: "Entered By Person" 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)
    • getEnteredByPhoneNumber

      Returns all repetitions of Entered By Phone Number (ARQ-20).
    • getArq20_EnteredByPhoneNumber

      Returns all repetitions of Entered By Phone Number (ARQ-20).
    • getEnteredByPhoneNumberReps

      Returns a count of the current number of repetitions of Entered By Phone Number (ARQ-20). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getEnteredByPhoneNumber

      public XTN getEnteredByPhoneNumber(int rep)
      Returns a specific repetition of ARQ-20: "Entered By Phone Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq20_EnteredByPhoneNumber

      Returns a specific repetition of ARQ-20: "Entered By Phone Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq20_EnteredByPhoneNumberReps

      Returns a count of the current number of repetitions of Entered By Phone Number (ARQ-20). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertEnteredByPhoneNumber

      public XTN insertEnteredByPhoneNumber(int rep) throws HL7Exception
      Inserts a repetition of ARQ-20: "Entered By Phone Number" 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)
    • insertArq20_EnteredByPhoneNumber

      Inserts a repetition of ARQ-20: "Entered By Phone Number" 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)
    • removeEnteredByPhoneNumber

      public XTN removeEnteredByPhoneNumber(int rep) throws HL7Exception
      Removes a repetition of ARQ-20: "Entered By Phone Number" 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)
    • removeArq20_EnteredByPhoneNumber

      Removes a repetition of ARQ-20: "Entered By Phone Number" 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)
    • getEnteredByLocation

      Returns ARQ-21: "Entered by Location" - creates it if necessary
    • getArq21_EnteredByLocation

      Returns ARQ-21: "Entered by Location" - creates it if necessary
    • getParentPlacerAppointmentID

      Returns ARQ-22: "Parent Placer Appointment ID" - creates it if necessary
    • getArq22_ParentPlacerAppointmentID

      Returns ARQ-22: "Parent Placer Appointment ID" - creates it if necessary
    • getParentFillerAppointmentID

      Returns ARQ-23: "Parent Filler Appointment ID" - creates it if necessary
    • getArq23_ParentFillerAppointmentID

      Returns ARQ-23: "Parent Filler Appointment ID" - creates it if necessary
    • getPlacerOrderNumber

      Returns all repetitions of Placer Order Number (ARQ-24).
    • getArq24_PlacerOrderNumber

      Returns all repetitions of Placer Order Number (ARQ-24).
    • getPlacerOrderNumberReps

      Returns a count of the current number of repetitions of Placer Order Number (ARQ-24). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getPlacerOrderNumber

      public EI getPlacerOrderNumber(int rep)
      Returns a specific repetition of ARQ-24: "Placer Order Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq24_PlacerOrderNumber

      public EI getArq24_PlacerOrderNumber(int rep)
      Returns a specific repetition of ARQ-24: "Placer Order Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq24_PlacerOrderNumberReps

      Returns a count of the current number of repetitions of Placer Order Number (ARQ-24). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertPlacerOrderNumber

      public EI insertPlacerOrderNumber(int rep) throws HL7Exception
      Inserts a repetition of ARQ-24: "Placer Order Number" 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)
    • insertArq24_PlacerOrderNumber

      Inserts a repetition of ARQ-24: "Placer Order Number" 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)
    • removePlacerOrderNumber

      public EI removePlacerOrderNumber(int rep) throws HL7Exception
      Removes a repetition of ARQ-24: "Placer Order Number" 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)
    • removeArq24_PlacerOrderNumber

      Removes a repetition of ARQ-24: "Placer Order Number" 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)
    • getFillerOrderNumber

      Returns all repetitions of Filler Order Number (ARQ-25).
    • getArq25_FillerOrderNumber

      Returns all repetitions of Filler Order Number (ARQ-25).
    • getFillerOrderNumberReps

      Returns a count of the current number of repetitions of Filler Order Number (ARQ-25). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getFillerOrderNumber

      public EI getFillerOrderNumber(int rep)
      Returns a specific repetition of ARQ-25: "Filler Order Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq25_FillerOrderNumber

      public EI getArq25_FillerOrderNumber(int rep)
      Returns a specific repetition of ARQ-25: "Filler Order Number" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getArq25_FillerOrderNumberReps

      Returns a count of the current number of repetitions of Filler Order Number (ARQ-25). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertFillerOrderNumber

      public EI insertFillerOrderNumber(int rep) throws HL7Exception
      Inserts a repetition of ARQ-25: "Filler Order Number" 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)
    • insertArq25_FillerOrderNumber

      Inserts a repetition of ARQ-25: "Filler Order Number" 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)
    • removeFillerOrderNumber

      public EI removeFillerOrderNumber(int rep) throws HL7Exception
      Removes a repetition of ARQ-25: "Filler Order Number" 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)
    • removeArq25_FillerOrderNumber

      Removes a repetition of ARQ-25: "Filler Order Number" 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)
    • createNewTypeWithoutReflection

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