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

Class SCH

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v23.segment.SCH
All Implemented Interfaces:
Segment, Structure, Visitable, Serializable
public class SCH extends AbstractSegment

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

  • SCH-1: Placer Appointment ID (EI)
  • 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
  • SCH-13: Placer Contact Phone Number (XTN) optional
  • SCH-14: Placer Contact Address (XAD) optional
  • SCH-15: Placer Contact Location (PL) optional
  • SCH-16: Filler Contact Person (XCN)
  • SCH-17: Filler Contact Phone Number (XTN) optional
  • SCH-18: Filler Contact Address (XAD) optional
  • SCH-19: Filler Contact Location (PL) optional
  • SCH-20: Entered By Person (XCN)
  • 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
See Also:

  • Constructor Details

  • Method Details

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

    • getSch11_AppointmentTimingQuantity

      public TQ[] getSch11_AppointmentTimingQuantity()
      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()
      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.

    • 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 SCH-12: "Placer Contact Person" - creates it if necessary

    • getSch12_PlacerContactPerson

      public XCN getSch12_PlacerContactPerson()
      Returns SCH-12: "Placer Contact Person" - creates it if necessary

    • 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 SCH-14: "Placer Contact Address" - creates it if necessary

    • getSch14_PlacerContactAddress

      public XAD getSch14_PlacerContactAddress()
      Returns SCH-14: "Placer Contact Address" - creates it if necessary

    • 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 SCH-16: "Filler Contact Person" - creates it if necessary

    • getSch16_FillerContactPerson

      public XCN getSch16_FillerContactPerson()
      Returns SCH-16: "Filler Contact Person" - creates it if necessary

    • 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 SCH-18: "Filler Contact Address" - creates it if necessary

    • getSch18_FillerContactAddress

      public XAD getSch18_FillerContactAddress()
      Returns SCH-18: "Filler Contact Address" - creates it if necessary

    • 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 SCH-20: "Entered By Person" - creates it if necessary

    • getSch20_EnteredByPerson

      public XCN getSch20_EnteredByPerson()
      Returns SCH-20: "Entered By Person" - creates it if necessary

    • getEnteredByPhoneNumber

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

    • getSch21_EnteredByPhoneNumber

      public XTN[] getSch21_EnteredByPhoneNumber()
      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()
      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.

    • 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

    • createNewTypeWithoutReflection

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