Package ca.uhn.hl7v2.model.v23.segment

Class ARQ

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v23.segment.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 (ST) optional
  • ARQ-13: Repeating Interval (RI) optional
  • ARQ-14: Repeating Interval Duration (ST) optional
  • ARQ-15: Placer Contact Person (XCN) optional
  • ARQ-16: Placer Contact Phone Number (XTN) optional
  • ARQ-17: Placer Contact Address (XAD) optional
  • ARQ-18: Placer Contact Location (PL) optional
  • ARQ-19: Entered By Person (XCN)
  • 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
See Also:

  • Constructor Details

  • Method Details

    • getPlacerAppointmentID

      public EI getPlacerAppointmentID()
      Returns ARQ-1: "Placer Appointment ID" - creates it if necessary

    • getArq1_PlacerAppointmentID

      public EI getArq1_PlacerAppointmentID()
      Returns ARQ-1: "Placer Appointment ID" - creates it if necessary

    • getFillerAppointmentID

      public EI getFillerAppointmentID()
      Returns ARQ-2: "Filler Appointment ID" - creates it if necessary

    • getArq2_FillerAppointmentID

      public EI getArq2_FillerAppointmentID()
      Returns ARQ-2: "Filler Appointment ID" - creates it if necessary

    • getOccurrenceNumber

      public NM getOccurrenceNumber()
      Returns ARQ-3: "Occurrence Number" - creates it if necessary

    • getArq3_OccurrenceNumber

      public NM getArq3_OccurrenceNumber()
      Returns ARQ-3: "Occurrence Number" - creates it if necessary

    • getPlacerGroupNumber

      public EI getPlacerGroupNumber()
      Returns ARQ-4: "Placer Group Number" - creates it if necessary

    • getArq4_PlacerGroupNumber

      public EI 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

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

    • getRequestEventReason

      public CE getRequestEventReason()
      Returns ARQ-6: "Request Event Reason" - creates it if necessary

    • getArq6_RequestEventReason

      public CE getArq6_RequestEventReason()
      Returns ARQ-6: "Request Event Reason" - creates it if necessary

    • getAppointmentReason

      public CE getAppointmentReason()
      Returns ARQ-7: "Appointment Reason" - creates it if necessary

    • getArq7_AppointmentReason

      public CE getArq7_AppointmentReason()
      Returns ARQ-7: "Appointment Reason" - creates it if necessary

    • getAppointmentType

      public CE getAppointmentType()
      Returns ARQ-8: "Appointment Type" - creates it if necessary

    • getArq8_AppointmentType

      public CE getArq8_AppointmentType()
      Returns ARQ-8: "Appointment Type" - creates it if necessary

    • getAppointmentDuration

      public NM getAppointmentDuration()
      Returns ARQ-9: "Appointment Duration" - creates it if necessary

    • getArq9_AppointmentDuration

      public NM getArq9_AppointmentDuration()
      Returns ARQ-9: "Appointment Duration" - creates it if necessary

    • getAppointmentDurationUnits

      public CE getAppointmentDurationUnits()
      Returns ARQ-10: "Appointment Duration Units" - creates it if necessary

    • getArq10_AppointmentDurationUnits

      public CE getArq10_AppointmentDurationUnits()
      Returns ARQ-10: "Appointment Duration Units" - creates it if necessary

    • getRequestedStartDateTimeRange

      public DR[] getRequestedStartDateTimeRange()
      Returns all repetitions of Requested Start Date/Time Range (ARQ-11).

    • getArq11_RequestedStartDateTimeRange

      public DR[] getArq11_RequestedStartDateTimeRange()
      Returns all repetitions of Requested Start Date/Time Range (ARQ-11).

    • getRequestedStartDateTimeRangeReps

      public int 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

      public DR getRequestedStartDateTimeRange(int rep)
      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

      public DR getArq11_RequestedStartDateTimeRange(int rep)
      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

      public int 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

      public DR insertRequestedStartDateTimeRange(int rep) throws HL7Exception
      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

      public DR insertArq11_RequestedStartDateTimeRange(int rep) throws HL7Exception
      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

      public DR removeRequestedStartDateTimeRange(int rep) throws HL7Exception
      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

      public DR removeArq11_RequestedStartDateTimeRange(int rep) throws HL7Exception
      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)

    • getPriority

      public ST getPriority()
      Returns ARQ-12: "Priority" - creates it if necessary

    • getArq12_Priority

      public ST getArq12_Priority()
      Returns ARQ-12: "Priority" - creates it if necessary

    • getRepeatingInterval

      public RI getRepeatingInterval()
      Returns ARQ-13: "Repeating Interval" - creates it if necessary

    • getArq13_RepeatingInterval

      public RI getArq13_RepeatingInterval()
      Returns ARQ-13: "Repeating Interval" - creates it if necessary

    • getRepeatingIntervalDuration

      public ST getRepeatingIntervalDuration()
      Returns ARQ-14: "Repeating Interval Duration" - creates it if necessary

    • getArq14_RepeatingIntervalDuration

      public ST getArq14_RepeatingIntervalDuration()
      Returns ARQ-14: "Repeating Interval Duration" - creates it if necessary

    • getPlacerContactPerson

      public XCN getPlacerContactPerson()
      Returns ARQ-15: "Placer Contact Person" - creates it if necessary

    • getArq15_PlacerContactPerson

      public XCN getArq15_PlacerContactPerson()
      Returns ARQ-15: "Placer Contact Person" - creates it if necessary

    • getPlacerContactPhoneNumber

      public XTN getPlacerContactPhoneNumber()
      Returns ARQ-16: "Placer Contact Phone Number" - creates it if necessary

    • getArq16_PlacerContactPhoneNumber

      public XTN getArq16_PlacerContactPhoneNumber()
      Returns ARQ-16: "Placer Contact Phone Number" - creates it if necessary

    • getPlacerContactAddress

      public XAD getPlacerContactAddress()
      Returns ARQ-17: "Placer Contact Address" - creates it if necessary

    • getArq17_PlacerContactAddress

      public XAD getArq17_PlacerContactAddress()
      Returns ARQ-17: "Placer Contact Address" - creates it if necessary

    • getPlacerContactLocation

      public PL getPlacerContactLocation()
      Returns ARQ-18: "Placer Contact Location" - creates it if necessary

    • getArq18_PlacerContactLocation

      public PL getArq18_PlacerContactLocation()
      Returns ARQ-18: "Placer Contact Location" - creates it if necessary

    • getEnteredByPerson

      public XCN getEnteredByPerson()
      Returns ARQ-19: "Entered By Person" - creates it if necessary

    • getArq19_EnteredByPerson

      public XCN getArq19_EnteredByPerson()
      Returns ARQ-19: "Entered By Person" - creates it if necessary

    • getEnteredByPhoneNumber

      public XTN[] getEnteredByPhoneNumber()
      Returns all repetitions of Entered By Phone Number (ARQ-20).

    • getArq20_EnteredByPhoneNumber

      public XTN[] getArq20_EnteredByPhoneNumber()
      Returns all repetitions of Entered By Phone Number (ARQ-20).

    • getEnteredByPhoneNumberReps

      public int 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

      public XTN getArq20_EnteredByPhoneNumber(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_EnteredByPhoneNumberReps

      public int 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

      public XTN insertArq20_EnteredByPhoneNumber(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)

    • 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

      public XTN removeArq20_EnteredByPhoneNumber(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)

    • getEnteredByLocation

      public PL getEnteredByLocation()
      Returns ARQ-21: "Entered By Location" - creates it if necessary

    • getArq21_EnteredByLocation

      public PL getArq21_EnteredByLocation()
      Returns ARQ-21: "Entered By Location" - creates it if necessary

    • getParentPlacerAppointmentID

      public EI getParentPlacerAppointmentID()
      Returns ARQ-22: "Parent Placer Appointment ID" - creates it if necessary

    • getArq22_ParentPlacerAppointmentID

      public EI getArq22_ParentPlacerAppointmentID()
      Returns ARQ-22: "Parent Placer Appointment ID" - creates it if necessary

    • getParentFillerAppointmentID

      public EI getParentFillerAppointmentID()
      Returns ARQ-23: "Parent Filler Appointment ID" - creates it if necessary

    • getArq23_ParentFillerAppointmentID

      public EI getArq23_ParentFillerAppointmentID()
      Returns ARQ-23: "Parent Filler Appointment ID" - creates it if necessary

    • createNewTypeWithoutReflection

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