Package ca.uhn.hl7v2.model.v24.segment

Class CM2

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

Represents an HL7 CM2 message segment (Clinical Study Schedule Master). This segment has the following fields:

  • CM2-1: Set ID- CM2 (SI) optional
  • CM2-2: Scheduled Time Point (CE)
  • CM2-3: Description of Time Point (ST) optional
  • CM2-4: Events Scheduled This Time Point (CE) repeating
See Also:

  • Constructor Details

  • Method Details

    • getSetIDCM2

      public SI getSetIDCM2()
      Returns CM2-1: "Set ID- CM2" - creates it if necessary

    • getCm21_SetIDCM2

      public SI getCm21_SetIDCM2()
      Returns CM2-1: "Set ID- CM2" - creates it if necessary

    • getScheduledTimePoint

      public CE getScheduledTimePoint()
      Returns CM2-2: "Scheduled Time Point" - creates it if necessary

    • getCm22_ScheduledTimePoint

      public CE getCm22_ScheduledTimePoint()
      Returns CM2-2: "Scheduled Time Point" - creates it if necessary

    • getDescriptionOfTimePoint

      public ST getDescriptionOfTimePoint()
      Returns CM2-3: "Description of Time Point" - creates it if necessary

    • getCm23_DescriptionOfTimePoint

      public ST getCm23_DescriptionOfTimePoint()
      Returns CM2-3: "Description of Time Point" - creates it if necessary

    • getEventsScheduledThisTimePoint

      public CE[] getEventsScheduledThisTimePoint()
      Returns all repetitions of Events Scheduled This Time Point (CM2-4).

    • getCm24_EventsScheduledThisTimePoint

      public CE[] getCm24_EventsScheduledThisTimePoint()
      Returns all repetitions of Events Scheduled This Time Point (CM2-4).

    • getEventsScheduledThisTimePointReps

      public int getEventsScheduledThisTimePointReps()
      Returns a count of the current number of repetitions of Events Scheduled This Time Point (CM2-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getEventsScheduledThisTimePoint

      public CE getEventsScheduledThisTimePoint(int rep)
      Returns a specific repetition of CM2-4: "Events Scheduled This Time Point" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCm24_EventsScheduledThisTimePoint

      public CE getCm24_EventsScheduledThisTimePoint(int rep)
      Returns a specific repetition of CM2-4: "Events Scheduled This Time Point" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCm24_EventsScheduledThisTimePointReps

      public int getCm24_EventsScheduledThisTimePointReps()
      Returns a count of the current number of repetitions of Events Scheduled This Time Point (CM2-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertEventsScheduledThisTimePoint

      public CE insertEventsScheduledThisTimePoint(int rep) throws HL7Exception
      Inserts a repetition of CM2-4: "Events Scheduled This Time Point" 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)

    • insertCm24_EventsScheduledThisTimePoint

      public CE insertCm24_EventsScheduledThisTimePoint(int rep) throws HL7Exception
      Inserts a repetition of CM2-4: "Events Scheduled This Time Point" 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)

    • removeEventsScheduledThisTimePoint

      public CE removeEventsScheduledThisTimePoint(int rep) throws HL7Exception
      Removes a repetition of CM2-4: "Events Scheduled This Time Point" 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)

    • removeCm24_EventsScheduledThisTimePoint

      public CE removeCm24_EventsScheduledThisTimePoint(int rep) throws HL7Exception
      Removes a repetition of CM2-4: "Events Scheduled This Time Point" 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