Generic SGARQ Business Object

The SGARQ Business Object is a representation of the HL7 V2.4 SGARQ segment.

Business object structure

The generic SGARQ business object is a hierarchical business object. Each of its attributes is either an HL7 datatype business object or a native type.

SGARQ includes the following attributes:  

Business object attributes
Name Type Key Cardinality Comment
Placer_Appointment_ID DTEI TRUE 1 placer application's permanent identifier
Filler_Appointment_ID DTEI FALSE 1 filler application's permanent identifier
Occurrence_Number Float FALSE 1 uniquely identifes individual occurrence
Placer_Group_Number DTEI FALSE 1 groups sets of appointments together
Schedule_ID DTCE FALSE 1 schedule when this appointment should be booked
Request_Event_Reason DTCE FALSE 1 gives reason why request event is being triggered
Appointment_Reason DTCE FALSE 1 code for reason why appointment will take place. Refer to User-defined Table 0276 - Appointment reason codes
Appointment_Type DTCE FALSE 1 type of appointment. Refer to User-defined Table 0277 - Appointment type codes
Appointment_Duration Float FALSE 1 amount of time requested for appointment
Appointment_Duration_Units DTCE FALSE 1 "specifies units of time used in ARQ-9. Refer to Chapter 7
Requested_Start_Date_Time_Range DTDR FALSE n date/time that appointment should begin
Priority_ARQ String FALSE 1 urgency of request
Repeating_Interval DTRI FALSE 1 interval between repeating appointments
Repeating_Interval_Duration String FALSE 1 specifies how long appointment repetitions should continue
Placer_Contact_Person DTXCN FALSE n person responsible for appointment scheduling
Placer_Contact_Phone_Number DTXTN FALSE n phone number to contact placer
Placer_Contact_Address DTXAD FALSE n address used to contact placer
Placer_Contact_Location DTPL FALSE 1 location of the placer
Entered_By_Person DTXCN FALSE n person responsible for entering appointment
Entered_By_Phone_Number DTXTN FALSE n phone number to contact the ARQ-19
Entered_By_Location DTPL FALSE 1 code for location of entered by person
Parent_Placer_Appointment_ID DTEI FALSE 1 relates a child to its parent (placer)
Parent_Filler_Appointment_ID DTEI FALSE 1 relates a child to its parent (filler)
Placer_Order_Number DTEI FALSE n placer application's order number
Filler_Order_Number DTEI FALSE n filler application's order number
ObjectEventId String FALSE 1

Supported verbs

The generic SGARQ business object supports the following verbs:

Examining the object

To examine a listing of the attributes of the generic business object, use IBM WebSphere Interchange Server System Manager or IBM WebSphere Interchange Server Business Object Designer.

Related reference

For more information on related business objects, see the following documents:

  • Generic DTEI Business Object
  • Generic DTCE Business Object
  • Generic DTDR Business Object
  • Generic DTRI Business Object
  • Generic DTXCN Business Object
  • Generic DTXTN Business Object
  • Generic DTXAD Business Object
  • Generic DTPL Business Object
  • Copyright IBM Corp. 2002, 2003