ARQ (HAPI - 04 - Generated Structures v2.4 1.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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

All Implemented Interfaces:: Segment, Structure, Serializable

public class ARQ
extends AbstractSegment
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:: Serialized Form

Constructor Summary
`ARQ(Group parent, ModelClassFactory factory)` Creates a new ARQ segment

Method Summary
`protected Type`	`createNewTypeWithoutReflection(int field)`
`NM`	`getAppointmentDuration()` Returns ARQ-9: "Appointment Duration" - creates it if necessary
`CE`	`getAppointmentDurationUnits()` Returns ARQ-10: "Appointment Duration Units" - creates it if necessary
`CE`	`getAppointmentReason()` Returns ARQ-7: "Appointment Reason" - creates it if necessary
`CE`	`getAppointmentType()` Returns ARQ-8: "Appointment Type" - creates it if necessary
`EI`	`getArq1_PlacerAppointmentID()` Returns ARQ-1: "Placer Appointment ID" - creates it if necessary
`CE`	`getArq10_AppointmentDurationUnits()` Returns ARQ-10: "Appointment Duration Units" - creates it if necessary
`DR`	`getArq11_RequestedStartDateTimeRange(int rep)` Returns a specific repetition of ARQ-11: "Requested Start Date/Time Range" - creates it if necessary
`int`	`getArq11_RequestedStartDateTimeRangeReps()` Returns a count of the current number of repetitions of Requested Start Date/Time Range (ARQ-11).
`ST`	`getArq12_PriorityARQ()` Returns ARQ-12: "Priority-ARQ" - creates it if necessary
`RI`	`getArq13_RepeatingInterval()` Returns ARQ-13: "Repeating Interval" - creates it if necessary
`ST`	`getArq14_RepeatingIntervalDuration()` Returns ARQ-14: "Repeating Interval Duration" - creates it if necessary
`XCN`	`getArq15_PlacerContactPerson(int rep)` Returns a specific repetition of ARQ-15: "Placer Contact Person" - creates it if necessary
`int`	`getArq15_PlacerContactPersonReps()` Returns a count of the current number of repetitions of Placer Contact Person (ARQ-15).
`XTN`	`getArq16_PlacerContactPhoneNumber(int rep)` Returns a specific repetition of ARQ-16: "Placer Contact Phone Number" - creates it if necessary
`int`	`getArq16_PlacerContactPhoneNumberReps()` Returns a count of the current number of repetitions of Placer Contact Phone Number (ARQ-16).
`XAD`	`getArq17_PlacerContactAddress(int rep)` Returns a specific repetition of ARQ-17: "Placer Contact Address" - creates it if necessary
`int`	`getArq17_PlacerContactAddressReps()` Returns a count of the current number of repetitions of Placer Contact Address (ARQ-17).
`PL`	`getArq18_PlacerContactLocation()` Returns ARQ-18: "Placer Contact Location" - creates it if necessary
`XCN`	`getArq19_EnteredByPerson(int rep)` Returns a specific repetition of ARQ-19: "Entered By Person" - creates it if necessary
`int`	`getArq19_EnteredByPersonReps()` Returns a count of the current number of repetitions of Entered By Person (ARQ-19).
`EI`	`getArq2_FillerAppointmentID()` Returns ARQ-2: "Filler Appointment ID" - creates it if necessary
`XTN`	`getArq20_EnteredByPhoneNumber(int rep)` Returns a specific repetition of ARQ-20: "Entered By Phone Number" - creates it if necessary
`int`	`getArq20_EnteredByPhoneNumberReps()` Returns a count of the current number of repetitions of Entered By Phone Number (ARQ-20).
`PL`	`getArq21_EnteredByLocation()` Returns ARQ-21: "Entered by Location" - creates it if necessary
`EI`	`getArq22_ParentPlacerAppointmentID()` Returns ARQ-22: "Parent Placer Appointment ID" - creates it if necessary
`EI`	`getArq23_ParentFillerAppointmentID()` Returns ARQ-23: "Parent Filler Appointment ID" - creates it if necessary
`EI`	`getArq24_PlacerOrderNumber(int rep)` Returns a specific repetition of ARQ-24: "Placer Order Number" - creates it if necessary
`int`	`getArq24_PlacerOrderNumberReps()` Returns a count of the current number of repetitions of Placer Order Number (ARQ-24).
`EI`	`getArq25_FillerOrderNumber(int rep)` Returns a specific repetition of ARQ-25: "Filler Order Number" - creates it if necessary
`int`	`getArq25_FillerOrderNumberReps()` Returns a count of the current number of repetitions of Filler Order Number (ARQ-25).
`NM`	`getArq3_OccurrenceNumber()` Returns ARQ-3: "Occurrence Number" - creates it if necessary
`EI`	`getArq4_PlacerGroupNumber()` Returns ARQ-4: "Placer Group Number" - creates it if necessary
`CE`	`getArq5_ScheduleID()` Returns ARQ-5: "Schedule ID" - creates it if necessary
`CE`	`getArq6_RequestEventReason()` Returns ARQ-6: "Request Event Reason" - creates it if necessary
`CE`	`getArq7_AppointmentReason()` Returns ARQ-7: "Appointment Reason" - creates it if necessary
`CE`	`getArq8_AppointmentType()` Returns ARQ-8: "Appointment Type" - creates it if necessary
`NM`	`getArq9_AppointmentDuration()` Returns ARQ-9: "Appointment Duration" - creates it if necessary
`PL`	`getEnteredByLocation()` Returns ARQ-21: "Entered by Location" - creates it if necessary
`XCN[]`	`getEnteredByPerson()` Returns all repetitions of Entered By Person (ARQ-19).
`XCN`	`getEnteredByPerson(int rep)` Returns a specific repetition of ARQ-19: "Entered By Person" - creates it if necessary
`int`	`getEnteredByPersonReps()` Returns a count of the current number of repetitions of Entered By Person (ARQ-19).
`XTN[]`	`getEnteredByPhoneNumber()` Returns all repetitions of Entered By Phone Number (ARQ-20).
`XTN`	`getEnteredByPhoneNumber(int rep)` Returns a specific repetition of ARQ-20: "Entered By Phone Number" - creates it if necessary
`int`	`getEnteredByPhoneNumberReps()` Returns a count of the current number of repetitions of Entered By Phone Number (ARQ-20).
`EI`	`getFillerAppointmentID()` Returns ARQ-2: "Filler Appointment ID" - creates it if necessary
`EI[]`	`getFillerOrderNumber()` Returns all repetitions of Filler Order Number (ARQ-25).
`EI`	`getFillerOrderNumber(int rep)` Returns a specific repetition of ARQ-25: "Filler Order Number" - creates it if necessary
`int`	`getFillerOrderNumberReps()` Returns a count of the current number of repetitions of Filler Order Number (ARQ-25).
`NM`	`getOccurrenceNumber()` Returns ARQ-3: "Occurrence Number" - creates it if necessary
`EI`	`getParentFillerAppointmentID()` Returns ARQ-23: "Parent Filler Appointment ID" - creates it if necessary
`EI`	`getParentPlacerAppointmentID()` Returns ARQ-22: "Parent Placer Appointment ID" - creates it if necessary
`EI`	`getPlacerAppointmentID()` Returns ARQ-1: "Placer Appointment ID" - creates it if necessary
`XAD[]`	`getPlacerContactAddress()` Returns all repetitions of Placer Contact Address (ARQ-17).
`XAD`	`getPlacerContactAddress(int rep)` Returns a specific repetition of ARQ-17: "Placer Contact Address" - creates it if necessary
`int`	`getPlacerContactAddressReps()` Returns a count of the current number of repetitions of Placer Contact Address (ARQ-17).
`PL`	`getPlacerContactLocation()` Returns ARQ-18: "Placer Contact Location" - creates it if necessary
`XCN[]`	`getPlacerContactPerson()` Returns all repetitions of Placer Contact Person (ARQ-15).
`XCN`	`getPlacerContactPerson(int rep)` Returns a specific repetition of ARQ-15: "Placer Contact Person" - creates it if necessary
`int`	`getPlacerContactPersonReps()` Returns a count of the current number of repetitions of Placer Contact Person (ARQ-15).
`XTN[]`	`getPlacerContactPhoneNumber()` Returns all repetitions of Placer Contact Phone Number (ARQ-16).
`XTN`	`getPlacerContactPhoneNumber(int rep)` Returns a specific repetition of ARQ-16: "Placer Contact Phone Number" - creates it if necessary
`int`	`getPlacerContactPhoneNumberReps()` Returns a count of the current number of repetitions of Placer Contact Phone Number (ARQ-16).
`EI`	`getPlacerGroupNumber()` Returns ARQ-4: "Placer Group Number" - creates it if necessary
`EI[]`	`getPlacerOrderNumber()` Returns all repetitions of Placer Order Number (ARQ-24).
`EI`	`getPlacerOrderNumber(int rep)` Returns a specific repetition of ARQ-24: "Placer Order Number" - creates it if necessary
`int`	`getPlacerOrderNumberReps()` Returns a count of the current number of repetitions of Placer Order Number (ARQ-24).
`ST`	`getPriorityARQ()` Returns ARQ-12: "Priority-ARQ" - creates it if necessary
`RI`	`getRepeatingInterval()` Returns ARQ-13: "Repeating Interval" - creates it if necessary
`ST`	`getRepeatingIntervalDuration()` Returns ARQ-14: "Repeating Interval Duration" - creates it if necessary
`DR[]`	`getRequestedStartDateTimeRange()` Returns all repetitions of Requested Start Date/Time Range (ARQ-11).
`DR`	`getRequestedStartDateTimeRange(int rep)` Returns a specific repetition of ARQ-11: "Requested Start Date/Time Range" - creates it if necessary
`int`	`getRequestedStartDateTimeRangeReps()` Returns a count of the current number of repetitions of Requested Start Date/Time Range (ARQ-11).
`CE`	`getRequestEventReason()` Returns ARQ-6: "Request Event Reason" - creates it if necessary
`CE`	`getScheduleID()` Returns ARQ-5: "Schedule ID" - creates it if necessary
`DR`	`insertArq11_RequestedStartDateTimeRange(int rep)` Inserts a repetition of ARQ-11: "Requested Start Date/Time Range" at a specific index
`XCN`	`insertArq15_PlacerContactPerson(int rep)` Inserts a repetition of ARQ-15: "Placer Contact Person" at a specific index
`XTN`	`insertArq16_PlacerContactPhoneNumber(int rep)` Inserts a repetition of ARQ-16: "Placer Contact Phone Number" at a specific index
`XAD`	`insertArq17_PlacerContactAddress(int rep)` Inserts a repetition of ARQ-17: "Placer Contact Address" at a specific index
`XCN`	`insertArq19_EnteredByPerson(int rep)` Inserts a repetition of ARQ-19: "Entered By Person" at a specific index
`XTN`	`insertArq20_EnteredByPhoneNumber(int rep)` Inserts a repetition of ARQ-20: "Entered By Phone Number" at a specific index
`EI`	`insertArq24_PlacerOrderNumber(int rep)` Inserts a repetition of ARQ-24: "Placer Order Number" at a specific index
`EI`	`insertArq25_FillerOrderNumber(int rep)` Inserts a repetition of ARQ-25: "Filler Order Number" at a specific index
`XCN`	`insertEnteredByPerson(int rep)` Inserts a repetition of ARQ-19: "Entered By Person" at a specific index
`XTN`	`insertEnteredByPhoneNumber(int rep)` Inserts a repetition of ARQ-20: "Entered By Phone Number" at a specific index
`EI`	`insertFillerOrderNumber(int rep)` Inserts a repetition of ARQ-25: "Filler Order Number" at a specific index
`XAD`	`insertPlacerContactAddress(int rep)` Inserts a repetition of ARQ-17: "Placer Contact Address" at a specific index
`XCN`	`insertPlacerContactPerson(int rep)` Inserts a repetition of ARQ-15: "Placer Contact Person" at a specific index
`XTN`	`insertPlacerContactPhoneNumber(int rep)` Inserts a repetition of ARQ-16: "Placer Contact Phone Number" at a specific index
`EI`	`insertPlacerOrderNumber(int rep)` Inserts a repetition of ARQ-24: "Placer Order Number" at a specific index
`DR`	`insertRequestedStartDateTimeRange(int rep)` Inserts a repetition of ARQ-11: "Requested Start Date/Time Range" at a specific index
`DR`	`removeArq11_RequestedStartDateTimeRange(int rep)` Removes a repetition of ARQ-11: "Requested Start Date/Time Range" at a specific index
`XCN`	`removeArq15_PlacerContactPerson(int rep)` Removes a repetition of ARQ-15: "Placer Contact Person" at a specific index
`XTN`	`removeArq16_PlacerContactPhoneNumber(int rep)` Removes a repetition of ARQ-16: "Placer Contact Phone Number" at a specific index
`XAD`	`removeArq17_PlacerContactAddress(int rep)` Removes a repetition of ARQ-17: "Placer Contact Address" at a specific index
`XCN`	`removeArq19_EnteredByPerson(int rep)` Removes a repetition of ARQ-19: "Entered By Person" at a specific index
`XTN`	`removeArq20_EnteredByPhoneNumber(int rep)` Removes a repetition of ARQ-20: "Entered By Phone Number" at a specific index
`EI`	`removeArq24_PlacerOrderNumber(int rep)` Removes a repetition of ARQ-24: "Placer Order Number" at a specific index
`EI`	`removeArq25_FillerOrderNumber(int rep)` Removes a repetition of ARQ-25: "Filler Order Number" at a specific index
`XCN`	`removeEnteredByPerson(int rep)` Removes a repetition of ARQ-19: "Entered By Person" at a specific index
`XTN`	`removeEnteredByPhoneNumber(int rep)` Removes a repetition of ARQ-20: "Entered By Phone Number" at a specific index
`EI`	`removeFillerOrderNumber(int rep)` Removes a repetition of ARQ-25: "Filler Order Number" at a specific index
`XAD`	`removePlacerContactAddress(int rep)` Removes a repetition of ARQ-17: "Placer Contact Address" at a specific index
`XCN`	`removePlacerContactPerson(int rep)` Removes a repetition of ARQ-15: "Placer Contact Person" at a specific index
`XTN`	`removePlacerContactPhoneNumber(int rep)` Removes a repetition of ARQ-16: "Placer Contact Phone Number" at a specific index
`EI`	`removePlacerOrderNumber(int rep)` Removes a repetition of ARQ-24: "Placer Order Number" at a specific index
`DR`	`removeRequestedStartDateTimeRange(int rep)` Removes a repetition of ARQ-11: "Requested Start Date/Time Range" 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

ARQ

public ARQ(Group parent,
           ModelClassFactory factory)

Creates a new ARQ segment

Method Detail

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).

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()

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)

getPriorityARQ

public ST getPriorityARQ()

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

getArq12_PriorityARQ

public ST getArq12_PriorityARQ()

Returns ARQ-12: "Priority-ARQ" - 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 all repetitions of Placer Contact Person (ARQ-15).

getPlacerContactPersonReps

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

public XCN getArq15_PlacerContactPerson(int rep)

Returns a specific repetition of ARQ-15: "Placer Contact Person" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getArq15_PlacerContactPersonReps

public int getArq15_PlacerContactPersonReps()

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

public XCN insertArq15_PlacerContactPerson(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)

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

public XCN removeArq15_PlacerContactPerson(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)

getPlacerContactPhoneNumber

public XTN[] getPlacerContactPhoneNumber()

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

getPlacerContactPhoneNumberReps

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

public XTN getArq16_PlacerContactPhoneNumber(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_PlacerContactPhoneNumberReps

public int getArq16_PlacerContactPhoneNumberReps()

insertPlacerContactPhoneNumber

public XTN insertPlacerContactPhoneNumber(int rep)
                                   throws HL7Exception

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

public XTN insertArq16_PlacerContactPhoneNumber(int rep)
                                         throws HL7Exception

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

public XTN removePlacerContactPhoneNumber(int rep)
                                   throws HL7Exception

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

public XTN removeArq16_PlacerContactPhoneNumber(int rep)
                                         throws HL7Exception

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

public XAD[] getPlacerContactAddress()

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

getPlacerContactAddressReps

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

public XAD getArq17_PlacerContactAddress(int rep)

Returns a specific repetition of ARQ-17: "Placer Contact Address" - creates it if necessary

Parameters:: rep - The repetition index (0-indexed)

getArq17_PlacerContactAddressReps

public int getArq17_PlacerContactAddressReps()

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

public XAD insertArq17_PlacerContactAddress(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)

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

public XAD removeArq17_PlacerContactAddress(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)

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

public int getArq19_EnteredByPersonReps()

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

public XTN[] getEnteredByPhoneNumber()

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()

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

getPlacerOrderNumber

public EI[] getPlacerOrderNumber()

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

getPlacerOrderNumberReps

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

public int getArq24_PlacerOrderNumberReps()

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

public EI insertArq24_PlacerOrderNumber(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)

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

public EI removeArq24_PlacerOrderNumber(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)

getFillerOrderNumber

public EI[] getFillerOrderNumber()

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

getFillerOrderNumberReps

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

public int getArq25_FillerOrderNumberReps()

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

public EI insertArq25_FillerOrderNumber(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)

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

public EI removeArq25_FillerOrderNumber(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)

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:: createNewTypeWithoutReflection in class AbstractSegment

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

ARQ

getPlacerAppointmentID

getArq1_PlacerAppointmentID

getFillerAppointmentID

getArq2_FillerAppointmentID

getOccurrenceNumber

getArq3_OccurrenceNumber

getPlacerGroupNumber

getArq4_PlacerGroupNumber

getScheduleID

getArq5_ScheduleID

getRequestEventReason

getArq6_RequestEventReason

getAppointmentReason

getArq7_AppointmentReason

getAppointmentType

getArq8_AppointmentType

getAppointmentDuration

getArq9_AppointmentDuration

getAppointmentDurationUnits

getArq10_AppointmentDurationUnits

getRequestedStartDateTimeRange

getRequestedStartDateTimeRangeReps

getRequestedStartDateTimeRange

getArq11_RequestedStartDateTimeRange

getArq11_RequestedStartDateTimeRangeReps

insertRequestedStartDateTimeRange

insertArq11_RequestedStartDateTimeRange

removeRequestedStartDateTimeRange

removeArq11_RequestedStartDateTimeRange

getPriorityARQ

getArq12_PriorityARQ

getRepeatingInterval

getArq13_RepeatingInterval

getRepeatingIntervalDuration

getArq14_RepeatingIntervalDuration

getPlacerContactPerson

getPlacerContactPersonReps

getPlacerContactPerson

getArq15_PlacerContactPerson

getArq15_PlacerContactPersonReps

insertPlacerContactPerson

insertArq15_PlacerContactPerson

removePlacerContactPerson

removeArq15_PlacerContactPerson

getPlacerContactPhoneNumber

getPlacerContactPhoneNumberReps

getPlacerContactPhoneNumber

getArq16_PlacerContactPhoneNumber

getArq16_PlacerContactPhoneNumberReps

insertPlacerContactPhoneNumber

insertArq16_PlacerContactPhoneNumber

removePlacerContactPhoneNumber

removeArq16_PlacerContactPhoneNumber

getPlacerContactAddress

getPlacerContactAddressReps

getPlacerContactAddress

getArq17_PlacerContactAddress

getArq17_PlacerContactAddressReps

insertPlacerContactAddress

insertArq17_PlacerContactAddress

removePlacerContactAddress

removeArq17_PlacerContactAddress

getPlacerContactLocation

getArq18_PlacerContactLocation

getEnteredByPerson

getEnteredByPersonReps

getEnteredByPerson

getArq19_EnteredByPerson

getArq19_EnteredByPersonReps

insertEnteredByPerson

insertArq19_EnteredByPerson

removeEnteredByPerson

removeArq19_EnteredByPerson

getEnteredByPhoneNumber

getEnteredByPhoneNumberReps

getEnteredByPhoneNumber

getArq20_EnteredByPhoneNumber

getArq20_EnteredByPhoneNumberReps

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