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

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

All Implemented Interfaces:: Segment, Structure, Serializable

public class SCH
extends AbstractSegment
extends AbstractSegment

Represents an HL7 SCH message segment (Scheduling Activity Information). This segment has the following fields:

SCH-1: Placer Appointment ID (EI) optional
SCH-2: Filler Appointment ID (EI) optional
SCH-3: Occurrence Number (NM) optional
SCH-4: Placer Group Number (EI) optional
SCH-5: Schedule ID (CE) optional
SCH-6: Event Reason (CE)
SCH-7: Appointment Reason (CE) optional
SCH-8: Appointment Type (CE) optional
SCH-9: Appointment Duration (NM) optional
SCH-10: Appointment Duration Units (CE) optional
SCH-11: Appointment Timing Quantity (TQ) repeating
SCH-12: Placer Contact Person (XCN) optional repeating
SCH-13: Placer Contact Phone Number (XTN) optional
SCH-14: Placer Contact Address (XAD) optional repeating
SCH-15: Placer Contact Location (PL) optional
SCH-16: Filler Contact Person (XCN) repeating
SCH-17: Filler Contact Phone Number (XTN) optional
SCH-18: Filler Contact Address (XAD) optional repeating
SCH-19: Filler Contact Location (PL) optional
SCH-20: Entered By Person (XCN) repeating
SCH-21: Entered By Phone Number (XTN) optional repeating
SCH-22: Entered by Location (PL) optional
SCH-23: Parent Placer Appointment ID (EI) optional
SCH-24: Parent Filler Appointment ID (EI) optional
SCH-25: Filler Status Code (CE) optional
SCH-26: Placer Order Number (EI) optional repeating
SCH-27: Filler Order Number (EI) optional repeating

See Also:: Serialized Form

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

Method Summary
`protected Type`	`createNewTypeWithoutReflection(int field)`
`NM`	`getAppointmentDuration()` Returns SCH-9: "Appointment Duration" - creates it if necessary
`CE`	`getAppointmentDurationUnits()` Returns SCH-10: "Appointment Duration Units" - creates it if necessary
`CE`	`getAppointmentReason()` Returns SCH-7: "Appointment Reason" - creates it if necessary
`TQ[]`	`getAppointmentTimingQuantity()` Returns all repetitions of Appointment Timing Quantity (SCH-11).
`TQ`	`getAppointmentTimingQuantity(int rep)` Returns a specific repetition of SCH-11: "Appointment Timing Quantity" - creates it if necessary
`int`	`getAppointmentTimingQuantityReps()` Returns a count of the current number of repetitions of Appointment Timing Quantity (SCH-11).
`CE`	`getAppointmentType()` Returns SCH-8: "Appointment Type" - creates it if necessary
`PL`	`getEnteredByLocation()` Returns SCH-22: "Entered by Location" - creates it if necessary
`XCN[]`	`getEnteredByPerson()` Returns all repetitions of Entered By Person (SCH-20).
`XCN`	`getEnteredByPerson(int rep)` Returns a specific repetition of SCH-20: "Entered By Person" - creates it if necessary
`int`	`getEnteredByPersonReps()` Returns a count of the current number of repetitions of Entered By Person (SCH-20).
`XTN[]`	`getEnteredByPhoneNumber()` Returns all repetitions of Entered By Phone Number (SCH-21).
`XTN`	`getEnteredByPhoneNumber(int rep)` Returns a specific repetition of SCH-21: "Entered By Phone Number" - creates it if necessary
`int`	`getEnteredByPhoneNumberReps()` Returns a count of the current number of repetitions of Entered By Phone Number (SCH-21).
`CE`	`getEventReason()` Returns SCH-6: "Event Reason" - creates it if necessary
`EI`	`getFillerAppointmentID()` Returns SCH-2: "Filler Appointment ID" - creates it if necessary
`XAD[]`	`getFillerContactAddress()` Returns all repetitions of Filler Contact Address (SCH-18).
`XAD`	`getFillerContactAddress(int rep)` Returns a specific repetition of SCH-18: "Filler Contact Address" - creates it if necessary
`int`	`getFillerContactAddressReps()` Returns a count of the current number of repetitions of Filler Contact Address (SCH-18).
`PL`	`getFillerContactLocation()` Returns SCH-19: "Filler Contact Location" - creates it if necessary
`XCN[]`	`getFillerContactPerson()` Returns all repetitions of Filler Contact Person (SCH-16).
`XCN`	`getFillerContactPerson(int rep)` Returns a specific repetition of SCH-16: "Filler Contact Person" - creates it if necessary
`int`	`getFillerContactPersonReps()` Returns a count of the current number of repetitions of Filler Contact Person (SCH-16).
`XTN`	`getFillerContactPhoneNumber()` Returns SCH-17: "Filler Contact Phone Number" - creates it if necessary
`EI[]`	`getFillerOrderNumber()` Returns all repetitions of Filler Order Number (SCH-27).
`EI`	`getFillerOrderNumber(int rep)` Returns a specific repetition of SCH-27: "Filler Order Number" - creates it if necessary
`int`	`getFillerOrderNumberReps()` Returns a count of the current number of repetitions of Filler Order Number (SCH-27).
`CE`	`getFillerStatusCode()` Returns SCH-25: "Filler Status Code" - creates it if necessary
`NM`	`getOccurrenceNumber()` Returns SCH-3: "Occurrence Number" - creates it if necessary
`EI`	`getParentFillerAppointmentID()` Returns SCH-24: "Parent Filler Appointment ID" - creates it if necessary
`EI`	`getParentPlacerAppointmentID()` Returns SCH-23: "Parent Placer Appointment ID" - creates it if necessary
`EI`	`getPlacerAppointmentID()` Returns SCH-1: "Placer Appointment ID" - creates it if necessary
`XAD[]`	`getPlacerContactAddress()` Returns all repetitions of Placer Contact Address (SCH-14).
`XAD`	`getPlacerContactAddress(int rep)` Returns a specific repetition of SCH-14: "Placer Contact Address" - creates it if necessary
`int`	`getPlacerContactAddressReps()` Returns a count of the current number of repetitions of Placer Contact Address (SCH-14).
`PL`	`getPlacerContactLocation()` Returns SCH-15: "Placer Contact Location" - creates it if necessary
`XCN[]`	`getPlacerContactPerson()` Returns all repetitions of Placer Contact Person (SCH-12).
`XCN`	`getPlacerContactPerson(int rep)` Returns a specific repetition of SCH-12: "Placer Contact Person" - creates it if necessary
`int`	`getPlacerContactPersonReps()` Returns a count of the current number of repetitions of Placer Contact Person (SCH-12).
`XTN`	`getPlacerContactPhoneNumber()` Returns SCH-13: "Placer Contact Phone Number" - creates it if necessary
`EI`	`getPlacerGroupNumber()` Returns SCH-4: "Placer Group Number" - creates it if necessary
`EI[]`	`getPlacerOrderNumber()` Returns all repetitions of Placer Order Number (SCH-26).
`EI`	`getPlacerOrderNumber(int rep)` Returns a specific repetition of SCH-26: "Placer Order Number" - creates it if necessary
`int`	`getPlacerOrderNumberReps()` Returns a count of the current number of repetitions of Placer Order Number (SCH-26).
`EI`	`getSch1_PlacerAppointmentID()` Returns SCH-1: "Placer Appointment ID" - creates it if necessary
`CE`	`getSch10_AppointmentDurationUnits()` Returns SCH-10: "Appointment Duration Units" - creates it if necessary
`TQ`	`getSch11_AppointmentTimingQuantity(int rep)` Returns a specific repetition of SCH-11: "Appointment Timing Quantity" - creates it if necessary
`int`	`getSch11_AppointmentTimingQuantityReps()` Returns a count of the current number of repetitions of Appointment Timing Quantity (SCH-11).
`XCN`	`getSch12_PlacerContactPerson(int rep)` Returns a specific repetition of SCH-12: "Placer Contact Person" - creates it if necessary
`int`	`getSch12_PlacerContactPersonReps()` Returns a count of the current number of repetitions of Placer Contact Person (SCH-12).
`XTN`	`getSch13_PlacerContactPhoneNumber()` Returns SCH-13: "Placer Contact Phone Number" - creates it if necessary
`XAD`	`getSch14_PlacerContactAddress(int rep)` Returns a specific repetition of SCH-14: "Placer Contact Address" - creates it if necessary
`int`	`getSch14_PlacerContactAddressReps()` Returns a count of the current number of repetitions of Placer Contact Address (SCH-14).
`PL`	`getSch15_PlacerContactLocation()` Returns SCH-15: "Placer Contact Location" - creates it if necessary
`XCN`	`getSch16_FillerContactPerson(int rep)` Returns a specific repetition of SCH-16: "Filler Contact Person" - creates it if necessary
`int`	`getSch16_FillerContactPersonReps()` Returns a count of the current number of repetitions of Filler Contact Person (SCH-16).
`XTN`	`getSch17_FillerContactPhoneNumber()` Returns SCH-17: "Filler Contact Phone Number" - creates it if necessary
`XAD`	`getSch18_FillerContactAddress(int rep)` Returns a specific repetition of SCH-18: "Filler Contact Address" - creates it if necessary
`int`	`getSch18_FillerContactAddressReps()` Returns a count of the current number of repetitions of Filler Contact Address (SCH-18).
`PL`	`getSch19_FillerContactLocation()` Returns SCH-19: "Filler Contact Location" - creates it if necessary
`EI`	`getSch2_FillerAppointmentID()` Returns SCH-2: "Filler Appointment ID" - creates it if necessary
`XCN`	`getSch20_EnteredByPerson(int rep)` Returns a specific repetition of SCH-20: "Entered By Person" - creates it if necessary
`int`	`getSch20_EnteredByPersonReps()` Returns a count of the current number of repetitions of Entered By Person (SCH-20).
`XTN`	`getSch21_EnteredByPhoneNumber(int rep)` Returns a specific repetition of SCH-21: "Entered By Phone Number" - creates it if necessary
`int`	`getSch21_EnteredByPhoneNumberReps()` Returns a count of the current number of repetitions of Entered By Phone Number (SCH-21).
`PL`	`getSch22_EnteredByLocation()` Returns SCH-22: "Entered by Location" - creates it if necessary
`EI`	`getSch23_ParentPlacerAppointmentID()` Returns SCH-23: "Parent Placer Appointment ID" - creates it if necessary
`EI`	`getSch24_ParentFillerAppointmentID()` Returns SCH-24: "Parent Filler Appointment ID" - creates it if necessary
`CE`	`getSch25_FillerStatusCode()` Returns SCH-25: "Filler Status Code" - creates it if necessary
`EI`	`getSch26_PlacerOrderNumber(int rep)` Returns a specific repetition of SCH-26: "Placer Order Number" - creates it if necessary
`int`	`getSch26_PlacerOrderNumberReps()` Returns a count of the current number of repetitions of Placer Order Number (SCH-26).
`EI`	`getSch27_FillerOrderNumber(int rep)` Returns a specific repetition of SCH-27: "Filler Order Number" - creates it if necessary
`int`	`getSch27_FillerOrderNumberReps()` Returns a count of the current number of repetitions of Filler Order Number (SCH-27).
`NM`	`getSch3_OccurrenceNumber()` Returns SCH-3: "Occurrence Number" - creates it if necessary
`EI`	`getSch4_PlacerGroupNumber()` Returns SCH-4: "Placer Group Number" - creates it if necessary
`CE`	`getSch5_ScheduleID()` Returns SCH-5: "Schedule ID" - creates it if necessary
`CE`	`getSch6_EventReason()` Returns SCH-6: "Event Reason" - creates it if necessary
`CE`	`getSch7_AppointmentReason()` Returns SCH-7: "Appointment Reason" - creates it if necessary
`CE`	`getSch8_AppointmentType()` Returns SCH-8: "Appointment Type" - creates it if necessary
`NM`	`getSch9_AppointmentDuration()` Returns SCH-9: "Appointment Duration" - creates it if necessary
`CE`	`getScheduleID()` Returns SCH-5: "Schedule ID" - creates it if necessary
`TQ`	`insertAppointmentTimingQuantity(int rep)` Inserts a repetition of SCH-11: "Appointment Timing Quantity" at a specific index
`XCN`	`insertEnteredByPerson(int rep)` Inserts a repetition of SCH-20: "Entered By Person" at a specific index
`XTN`	`insertEnteredByPhoneNumber(int rep)` Inserts a repetition of SCH-21: "Entered By Phone Number" at a specific index
`XAD`	`insertFillerContactAddress(int rep)` Inserts a repetition of SCH-18: "Filler Contact Address" at a specific index
`XCN`	`insertFillerContactPerson(int rep)` Inserts a repetition of SCH-16: "Filler Contact Person" at a specific index
`EI`	`insertFillerOrderNumber(int rep)` Inserts a repetition of SCH-27: "Filler Order Number" at a specific index
`XAD`	`insertPlacerContactAddress(int rep)` Inserts a repetition of SCH-14: "Placer Contact Address" at a specific index
`XCN`	`insertPlacerContactPerson(int rep)` Inserts a repetition of SCH-12: "Placer Contact Person" at a specific index
`EI`	`insertPlacerOrderNumber(int rep)` Inserts a repetition of SCH-26: "Placer Order Number" at a specific index
`TQ`	`insertSch11_AppointmentTimingQuantity(int rep)` Inserts a repetition of SCH-11: "Appointment Timing Quantity" at a specific index
`XCN`	`insertSch12_PlacerContactPerson(int rep)` Inserts a repetition of SCH-12: "Placer Contact Person" at a specific index
`XAD`	`insertSch14_PlacerContactAddress(int rep)` Inserts a repetition of SCH-14: "Placer Contact Address" at a specific index
`XCN`	`insertSch16_FillerContactPerson(int rep)` Inserts a repetition of SCH-16: "Filler Contact Person" at a specific index
`XAD`	`insertSch18_FillerContactAddress(int rep)` Inserts a repetition of SCH-18: "Filler Contact Address" at a specific index
`XCN`	`insertSch20_EnteredByPerson(int rep)` Inserts a repetition of SCH-20: "Entered By Person" at a specific index
`XTN`	`insertSch21_EnteredByPhoneNumber(int rep)` Inserts a repetition of SCH-21: "Entered By Phone Number" at a specific index
`EI`	`insertSch26_PlacerOrderNumber(int rep)` Inserts a repetition of SCH-26: "Placer Order Number" at a specific index
`EI`	`insertSch27_FillerOrderNumber(int rep)` Inserts a repetition of SCH-27: "Filler Order Number" at a specific index
`TQ`	`removeAppointmentTimingQuantity(int rep)` Removes a repetition of SCH-11: "Appointment Timing Quantity" at a specific index
`XCN`	`removeEnteredByPerson(int rep)` Removes a repetition of SCH-20: "Entered By Person" at a specific index
`XTN`	`removeEnteredByPhoneNumber(int rep)` Removes a repetition of SCH-21: "Entered By Phone Number" at a specific index
`XAD`	`removeFillerContactAddress(int rep)` Removes a repetition of SCH-18: "Filler Contact Address" at a specific index
`XCN`	`removeFillerContactPerson(int rep)` Removes a repetition of SCH-16: "Filler Contact Person" at a specific index
`EI`	`removeFillerOrderNumber(int rep)` Removes a repetition of SCH-27: "Filler Order Number" at a specific index
`XAD`	`removePlacerContactAddress(int rep)` Removes a repetition of SCH-14: "Placer Contact Address" at a specific index
`XCN`	`removePlacerContactPerson(int rep)` Removes a repetition of SCH-12: "Placer Contact Person" at a specific index
`EI`	`removePlacerOrderNumber(int rep)` Removes a repetition of SCH-26: "Placer Order Number" at a specific index
`TQ`	`removeSch11_AppointmentTimingQuantity(int rep)` Removes a repetition of SCH-11: "Appointment Timing Quantity" at a specific index
`XCN`	`removeSch12_PlacerContactPerson(int rep)` Removes a repetition of SCH-12: "Placer Contact Person" at a specific index
`XAD`	`removeSch14_PlacerContactAddress(int rep)` Removes a repetition of SCH-14: "Placer Contact Address" at a specific index
`XCN`	`removeSch16_FillerContactPerson(int rep)` Removes a repetition of SCH-16: "Filler Contact Person" at a specific index
`XAD`	`removeSch18_FillerContactAddress(int rep)` Removes a repetition of SCH-18: "Filler Contact Address" at a specific index
`XCN`	`removeSch20_EnteredByPerson(int rep)` Removes a repetition of SCH-20: "Entered By Person" at a specific index
`XTN`	`removeSch21_EnteredByPhoneNumber(int rep)` Removes a repetition of SCH-21: "Entered By Phone Number" at a specific index
`EI`	`removeSch26_PlacerOrderNumber(int rep)` Removes a repetition of SCH-26: "Placer Order Number" at a specific index
`EI`	`removeSch27_FillerOrderNumber(int rep)` Removes a repetition of SCH-27: "Filler Order Number" 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

SCH

public SCH(Group parent,
           ModelClassFactory factory)

Creates a new SCH segment

Method Detail

getPlacerAppointmentID

public EI getPlacerAppointmentID()

Returns SCH-1: "Placer Appointment ID" - creates it if necessary

getSch1_PlacerAppointmentID

public EI getSch1_PlacerAppointmentID()

Returns SCH-1: "Placer Appointment ID" - creates it if necessary

getFillerAppointmentID

public EI getFillerAppointmentID()

Returns SCH-2: "Filler Appointment ID" - creates it if necessary

getSch2_FillerAppointmentID

public EI getSch2_FillerAppointmentID()

Returns SCH-2: "Filler Appointment ID" - creates it if necessary

getOccurrenceNumber

public NM getOccurrenceNumber()

Returns SCH-3: "Occurrence Number" - creates it if necessary

getSch3_OccurrenceNumber

public NM getSch3_OccurrenceNumber()

Returns SCH-3: "Occurrence Number" - creates it if necessary

getPlacerGroupNumber

public EI getPlacerGroupNumber()

Returns SCH-4: "Placer Group Number" - creates it if necessary

getSch4_PlacerGroupNumber

public EI getSch4_PlacerGroupNumber()

Returns SCH-4: "Placer Group Number" - creates it if necessary

getScheduleID

public CE getScheduleID()

Returns SCH-5: "Schedule ID" - creates it if necessary

getSch5_ScheduleID

public CE getSch5_ScheduleID()

Returns SCH-5: "Schedule ID" - creates it if necessary

getEventReason

public CE getEventReason()

Returns SCH-6: "Event Reason" - creates it if necessary

getSch6_EventReason

public CE getSch6_EventReason()

Returns SCH-6: "Event Reason" - creates it if necessary

getAppointmentReason

public CE getAppointmentReason()

Returns SCH-7: "Appointment Reason" - creates it if necessary

getSch7_AppointmentReason

public CE getSch7_AppointmentReason()

Returns SCH-7: "Appointment Reason" - creates it if necessary

getAppointmentType

public CE getAppointmentType()

Returns SCH-8: "Appointment Type" - creates it if necessary

getSch8_AppointmentType

public CE getSch8_AppointmentType()

Returns SCH-8: "Appointment Type" - creates it if necessary

getAppointmentDuration

public NM getAppointmentDuration()

Returns SCH-9: "Appointment Duration" - creates it if necessary

getSch9_AppointmentDuration

public NM getSch9_AppointmentDuration()

Returns SCH-9: "Appointment Duration" - creates it if necessary

getAppointmentDurationUnits

public CE getAppointmentDurationUnits()

Returns SCH-10: "Appointment Duration Units" - creates it if necessary

getSch10_AppointmentDurationUnits

public CE getSch10_AppointmentDurationUnits()

Returns SCH-10: "Appointment Duration Units" - creates it if necessary

getAppointmentTimingQuantity

public TQ[] getAppointmentTimingQuantity()

Returns all repetitions of Appointment Timing Quantity (SCH-11).

getAppointmentTimingQuantityReps

public int getAppointmentTimingQuantityReps()

Returns a count of the current number of repetitions of Appointment Timing Quantity (SCH-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getAppointmentTimingQuantity

public TQ getAppointmentTimingQuantity(int rep)

Returns a specific repetition of SCH-11: "Appointment Timing Quantity" - creates it if necessary

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

getSch11_AppointmentTimingQuantity

public TQ getSch11_AppointmentTimingQuantity(int rep)

Returns a specific repetition of SCH-11: "Appointment Timing Quantity" - creates it if necessary

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

getSch11_AppointmentTimingQuantityReps

public int getSch11_AppointmentTimingQuantityReps()

insertAppointmentTimingQuantity

public TQ insertAppointmentTimingQuantity(int rep)
                                   throws HL7Exception

Inserts a repetition of SCH-11: "Appointment Timing Quantity" 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)

insertSch11_AppointmentTimingQuantity

public TQ insertSch11_AppointmentTimingQuantity(int rep)
                                         throws HL7Exception

Inserts a repetition of SCH-11: "Appointment Timing Quantity" 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)

removeAppointmentTimingQuantity

public TQ removeAppointmentTimingQuantity(int rep)
                                   throws HL7Exception

Removes a repetition of SCH-11: "Appointment Timing Quantity" 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)

removeSch11_AppointmentTimingQuantity

public TQ removeSch11_AppointmentTimingQuantity(int rep)
                                         throws HL7Exception

Removes a repetition of SCH-11: "Appointment Timing Quantity" 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)

getPlacerContactPerson

public XCN[] getPlacerContactPerson()

Returns all repetitions of Placer Contact Person (SCH-12).

getPlacerContactPersonReps

public int getPlacerContactPersonReps()

Returns a count of the current number of repetitions of Placer Contact Person (SCH-12). 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 SCH-12: "Placer Contact Person" - creates it if necessary

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

getSch12_PlacerContactPerson

public XCN getSch12_PlacerContactPerson(int rep)

Returns a specific repetition of SCH-12: "Placer Contact Person" - creates it if necessary

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

getSch12_PlacerContactPersonReps

public int getSch12_PlacerContactPersonReps()

insertPlacerContactPerson

public XCN insertPlacerContactPerson(int rep)
                              throws HL7Exception

Inserts a repetition of SCH-12: "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)

insertSch12_PlacerContactPerson

public XCN insertSch12_PlacerContactPerson(int rep)
                                    throws HL7Exception

Inserts a repetition of SCH-12: "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 SCH-12: "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)

removeSch12_PlacerContactPerson

public XCN removeSch12_PlacerContactPerson(int rep)
                                    throws HL7Exception

Removes a repetition of SCH-12: "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 SCH-13: "Placer Contact Phone Number" - creates it if necessary

getSch13_PlacerContactPhoneNumber

public XTN getSch13_PlacerContactPhoneNumber()

Returns SCH-13: "Placer Contact Phone Number" - creates it if necessary

getPlacerContactAddress

public XAD[] getPlacerContactAddress()

Returns all repetitions of Placer Contact Address (SCH-14).

getPlacerContactAddressReps

public int getPlacerContactAddressReps()

Returns a count of the current number of repetitions of Placer Contact Address (SCH-14). 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 SCH-14: "Placer Contact Address" - creates it if necessary

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

getSch14_PlacerContactAddress

public XAD getSch14_PlacerContactAddress(int rep)

Returns a specific repetition of SCH-14: "Placer Contact Address" - creates it if necessary

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

getSch14_PlacerContactAddressReps

public int getSch14_PlacerContactAddressReps()

insertPlacerContactAddress

public XAD insertPlacerContactAddress(int rep)
                               throws HL7Exception

Inserts a repetition of SCH-14: "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)

insertSch14_PlacerContactAddress

public XAD insertSch14_PlacerContactAddress(int rep)
                                     throws HL7Exception

Inserts a repetition of SCH-14: "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 SCH-14: "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)

removeSch14_PlacerContactAddress

public XAD removeSch14_PlacerContactAddress(int rep)
                                     throws HL7Exception

Removes a repetition of SCH-14: "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 SCH-15: "Placer Contact Location" - creates it if necessary

getSch15_PlacerContactLocation

public PL getSch15_PlacerContactLocation()

Returns SCH-15: "Placer Contact Location" - creates it if necessary

getFillerContactPerson

public XCN[] getFillerContactPerson()

Returns all repetitions of Filler Contact Person (SCH-16).

getFillerContactPersonReps

public int getFillerContactPersonReps()

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

getFillerContactPerson

public XCN getFillerContactPerson(int rep)

Returns a specific repetition of SCH-16: "Filler Contact Person" - creates it if necessary

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

getSch16_FillerContactPerson

public XCN getSch16_FillerContactPerson(int rep)

Returns a specific repetition of SCH-16: "Filler Contact Person" - creates it if necessary

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

getSch16_FillerContactPersonReps

public int getSch16_FillerContactPersonReps()

insertFillerContactPerson

public XCN insertFillerContactPerson(int rep)
                              throws HL7Exception

Inserts a repetition of SCH-16: "Filler 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)

insertSch16_FillerContactPerson

public XCN insertSch16_FillerContactPerson(int rep)
                                    throws HL7Exception

Inserts a repetition of SCH-16: "Filler 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)

removeFillerContactPerson

public XCN removeFillerContactPerson(int rep)
                              throws HL7Exception

Removes a repetition of SCH-16: "Filler 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)

removeSch16_FillerContactPerson

public XCN removeSch16_FillerContactPerson(int rep)
                                    throws HL7Exception

Removes a repetition of SCH-16: "Filler 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)

getFillerContactPhoneNumber

public XTN getFillerContactPhoneNumber()

Returns SCH-17: "Filler Contact Phone Number" - creates it if necessary

getSch17_FillerContactPhoneNumber

public XTN getSch17_FillerContactPhoneNumber()

Returns SCH-17: "Filler Contact Phone Number" - creates it if necessary

getFillerContactAddress

public XAD[] getFillerContactAddress()

Returns all repetitions of Filler Contact Address (SCH-18).

getFillerContactAddressReps

public int getFillerContactAddressReps()

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

getFillerContactAddress

public XAD getFillerContactAddress(int rep)

Returns a specific repetition of SCH-18: "Filler Contact Address" - creates it if necessary

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

getSch18_FillerContactAddress

public XAD getSch18_FillerContactAddress(int rep)

Returns a specific repetition of SCH-18: "Filler Contact Address" - creates it if necessary

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

getSch18_FillerContactAddressReps

public int getSch18_FillerContactAddressReps()

insertFillerContactAddress

public XAD insertFillerContactAddress(int rep)
                               throws HL7Exception

Inserts a repetition of SCH-18: "Filler 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)

insertSch18_FillerContactAddress

public XAD insertSch18_FillerContactAddress(int rep)
                                     throws HL7Exception

Inserts a repetition of SCH-18: "Filler 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)

removeFillerContactAddress

public XAD removeFillerContactAddress(int rep)
                               throws HL7Exception

Removes a repetition of SCH-18: "Filler 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)

removeSch18_FillerContactAddress

public XAD removeSch18_FillerContactAddress(int rep)
                                     throws HL7Exception

Removes a repetition of SCH-18: "Filler 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)

getFillerContactLocation

public PL getFillerContactLocation()

Returns SCH-19: "Filler Contact Location" - creates it if necessary

getSch19_FillerContactLocation

public PL getSch19_FillerContactLocation()

Returns SCH-19: "Filler Contact Location" - creates it if necessary

getEnteredByPerson

public XCN[] getEnteredByPerson()

Returns all repetitions of Entered By Person (SCH-20).

getEnteredByPersonReps

public int getEnteredByPersonReps()

Returns a count of the current number of repetitions of Entered By Person (SCH-20). 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 SCH-20: "Entered By Person" - creates it if necessary

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

getSch20_EnteredByPerson

public XCN getSch20_EnteredByPerson(int rep)

Returns a specific repetition of SCH-20: "Entered By Person" - creates it if necessary

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

getSch20_EnteredByPersonReps

public int getSch20_EnteredByPersonReps()

insertEnteredByPerson

public XCN insertEnteredByPerson(int rep)
                          throws HL7Exception

Inserts a repetition of SCH-20: "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)

insertSch20_EnteredByPerson

public XCN insertSch20_EnteredByPerson(int rep)
                                throws HL7Exception

Inserts a repetition of SCH-20: "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 SCH-20: "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)

removeSch20_EnteredByPerson

public XCN removeSch20_EnteredByPerson(int rep)
                                throws HL7Exception

Removes a repetition of SCH-20: "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 (SCH-21).

getEnteredByPhoneNumberReps

public int getEnteredByPhoneNumberReps()

Returns a count of the current number of repetitions of Entered By Phone Number (SCH-21). 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 SCH-21: "Entered By Phone Number" - creates it if necessary

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

getSch21_EnteredByPhoneNumber

public XTN getSch21_EnteredByPhoneNumber(int rep)

Returns a specific repetition of SCH-21: "Entered By Phone Number" - creates it if necessary

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

getSch21_EnteredByPhoneNumberReps

public int getSch21_EnteredByPhoneNumberReps()

insertEnteredByPhoneNumber

public XTN insertEnteredByPhoneNumber(int rep)
                               throws HL7Exception

Inserts a repetition of SCH-21: "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)

insertSch21_EnteredByPhoneNumber

public XTN insertSch21_EnteredByPhoneNumber(int rep)
                                     throws HL7Exception

Inserts a repetition of SCH-21: "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 SCH-21: "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)

removeSch21_EnteredByPhoneNumber

public XTN removeSch21_EnteredByPhoneNumber(int rep)
                                     throws HL7Exception

Removes a repetition of SCH-21: "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 SCH-22: "Entered by Location" - creates it if necessary

getSch22_EnteredByLocation

public PL getSch22_EnteredByLocation()

Returns SCH-22: "Entered by Location" - creates it if necessary

getParentPlacerAppointmentID

public EI getParentPlacerAppointmentID()

Returns SCH-23: "Parent Placer Appointment ID" - creates it if necessary

getSch23_ParentPlacerAppointmentID

public EI getSch23_ParentPlacerAppointmentID()

Returns SCH-23: "Parent Placer Appointment ID" - creates it if necessary

getParentFillerAppointmentID

public EI getParentFillerAppointmentID()

Returns SCH-24: "Parent Filler Appointment ID" - creates it if necessary

getSch24_ParentFillerAppointmentID

public EI getSch24_ParentFillerAppointmentID()

Returns SCH-24: "Parent Filler Appointment ID" - creates it if necessary

getFillerStatusCode

public CE getFillerStatusCode()

Returns SCH-25: "Filler Status Code" - creates it if necessary

getSch25_FillerStatusCode

public CE getSch25_FillerStatusCode()

Returns SCH-25: "Filler Status Code" - creates it if necessary

getPlacerOrderNumber

public EI[] getPlacerOrderNumber()

Returns all repetitions of Placer Order Number (SCH-26).

getPlacerOrderNumberReps

public int getPlacerOrderNumberReps()

Returns a count of the current number of repetitions of Placer Order Number (SCH-26). 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 SCH-26: "Placer Order Number" - creates it if necessary

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

getSch26_PlacerOrderNumber

public EI getSch26_PlacerOrderNumber(int rep)

Returns a specific repetition of SCH-26: "Placer Order Number" - creates it if necessary

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

getSch26_PlacerOrderNumberReps

public int getSch26_PlacerOrderNumberReps()

insertPlacerOrderNumber

public EI insertPlacerOrderNumber(int rep)
                           throws HL7Exception

Inserts a repetition of SCH-26: "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)

insertSch26_PlacerOrderNumber

public EI insertSch26_PlacerOrderNumber(int rep)
                                 throws HL7Exception

Inserts a repetition of SCH-26: "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 SCH-26: "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)

removeSch26_PlacerOrderNumber

public EI removeSch26_PlacerOrderNumber(int rep)
                                 throws HL7Exception

Removes a repetition of SCH-26: "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 (SCH-27).

getFillerOrderNumberReps

public int getFillerOrderNumberReps()

Returns a count of the current number of repetitions of Filler Order Number (SCH-27). 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 SCH-27: "Filler Order Number" - creates it if necessary

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

getSch27_FillerOrderNumber

public EI getSch27_FillerOrderNumber(int rep)

Returns a specific repetition of SCH-27: "Filler Order Number" - creates it if necessary

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

getSch27_FillerOrderNumberReps

public int getSch27_FillerOrderNumberReps()

insertFillerOrderNumber

public EI insertFillerOrderNumber(int rep)
                           throws HL7Exception

Inserts a repetition of SCH-27: "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)

insertSch27_FillerOrderNumber

public EI insertSch27_FillerOrderNumber(int rep)
                                 throws HL7Exception

Inserts a repetition of SCH-27: "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 SCH-27: "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)

removeSch27_FillerOrderNumber

public EI removeSch27_FillerOrderNumber(int rep)
                                 throws HL7Exception

Removes a repetition of SCH-27: "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 SCH

SCH

getPlacerAppointmentID

getSch1_PlacerAppointmentID

getFillerAppointmentID

getSch2_FillerAppointmentID

getOccurrenceNumber

getSch3_OccurrenceNumber

getPlacerGroupNumber

getSch4_PlacerGroupNumber

getScheduleID

getSch5_ScheduleID

getEventReason

getSch6_EventReason

getAppointmentReason

getSch7_AppointmentReason

getAppointmentType

getSch8_AppointmentType

getAppointmentDuration

getSch9_AppointmentDuration

getAppointmentDurationUnits

getSch10_AppointmentDurationUnits

getAppointmentTimingQuantity

getAppointmentTimingQuantityReps

getAppointmentTimingQuantity

getSch11_AppointmentTimingQuantity

getSch11_AppointmentTimingQuantityReps

insertAppointmentTimingQuantity

insertSch11_AppointmentTimingQuantity

removeAppointmentTimingQuantity

removeSch11_AppointmentTimingQuantity

getPlacerContactPerson

getPlacerContactPersonReps

getPlacerContactPerson

getSch12_PlacerContactPerson

getSch12_PlacerContactPersonReps

insertPlacerContactPerson

insertSch12_PlacerContactPerson

removePlacerContactPerson

removeSch12_PlacerContactPerson

getPlacerContactPhoneNumber

getSch13_PlacerContactPhoneNumber

getPlacerContactAddress

getPlacerContactAddressReps

getPlacerContactAddress

getSch14_PlacerContactAddress

getSch14_PlacerContactAddressReps

insertPlacerContactAddress

insertSch14_PlacerContactAddress

removePlacerContactAddress

removeSch14_PlacerContactAddress

getPlacerContactLocation

getSch15_PlacerContactLocation

getFillerContactPerson

getFillerContactPersonReps

getFillerContactPerson

getSch16_FillerContactPerson

getSch16_FillerContactPersonReps

insertFillerContactPerson

insertSch16_FillerContactPerson

removeFillerContactPerson

removeSch16_FillerContactPerson

getFillerContactPhoneNumber

getSch17_FillerContactPhoneNumber

getFillerContactAddress

getFillerContactAddressReps

getFillerContactAddress

getSch18_FillerContactAddress

getSch18_FillerContactAddressReps

insertFillerContactAddress

insertSch18_FillerContactAddress

removeFillerContactAddress

removeSch18_FillerContactAddress

getFillerContactLocation

getSch19_FillerContactLocation

getEnteredByPerson

getEnteredByPersonReps

getEnteredByPerson

getSch20_EnteredByPerson

getSch20_EnteredByPersonReps

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