Package ca.uhn.hl7v2.model.v251.segment

Class AIL

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

Represents an HL7 AIL message segment (Appointment Information - Location Resource). This segment has the following fields:

  • AIL-1: Set ID - AIL (SI)
  • AIL-2: Segment Action Code (ID) optional
  • AIL-3: Location Resource ID (PL) optional repeating
  • AIL-4: Location Type-AIL (CE) optional
  • AIL-5: Location Group (CE) optional
  • AIL-6: Start Date/Time (TS) optional
  • AIL-7: Start Date/Time Offset (NM) optional
  • AIL-8: Start Date/Time Offset Units (CE) optional
  • AIL-9: Duration (NM) optional
  • AIL-10: Duration Units (CE) optional
  • AIL-11: Allow Substitution Code (IS) optional
  • AIL-12: Filler Status Code (CE) optional
See Also:

  • Constructor Details

  • Method Details

    • getSetIDAIL

      public SI getSetIDAIL()
      Returns AIL-1: "Set ID - AIL" - creates it if necessary

    • getAil1_SetIDAIL

      public SI getAil1_SetIDAIL()
      Returns AIL-1: "Set ID - AIL" - creates it if necessary

    • getSegmentActionCode

      public ID getSegmentActionCode()
      Returns AIL-2: "Segment Action Code" - creates it if necessary

    • getAil2_SegmentActionCode

      public ID getAil2_SegmentActionCode()
      Returns AIL-2: "Segment Action Code" - creates it if necessary

    • getLocationResourceID

      public PL[] getLocationResourceID()
      Returns all repetitions of Location Resource ID (AIL-3).

    • getAil3_LocationResourceID

      public PL[] getAil3_LocationResourceID()
      Returns all repetitions of Location Resource ID (AIL-3).

    • getLocationResourceIDReps

      public int getLocationResourceIDReps()
      Returns a count of the current number of repetitions of Location Resource ID (AIL-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getLocationResourceID

      public PL getLocationResourceID(int rep)
      Returns a specific repetition of AIL-3: "Location Resource ID" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getAil3_LocationResourceID

      public PL getAil3_LocationResourceID(int rep)
      Returns a specific repetition of AIL-3: "Location Resource ID" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getAil3_LocationResourceIDReps

      public int getAil3_LocationResourceIDReps()
      Returns a count of the current number of repetitions of Location Resource ID (AIL-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertLocationResourceID

      public PL insertLocationResourceID(int rep) throws HL7Exception
      Inserts a repetition of AIL-3: "Location Resource ID" 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)

    • insertAil3_LocationResourceID

      public PL insertAil3_LocationResourceID(int rep) throws HL7Exception
      Inserts a repetition of AIL-3: "Location Resource ID" 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)

    • removeLocationResourceID

      public PL removeLocationResourceID(int rep) throws HL7Exception
      Removes a repetition of AIL-3: "Location Resource ID" 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)

    • removeAil3_LocationResourceID

      public PL removeAil3_LocationResourceID(int rep) throws HL7Exception
      Removes a repetition of AIL-3: "Location Resource ID" 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)

    • getLocationTypeAIL

      public CE getLocationTypeAIL()
      Returns AIL-4: "Location Type-AIL" - creates it if necessary

    • getAil4_LocationTypeAIL

      public CE getAil4_LocationTypeAIL()
      Returns AIL-4: "Location Type-AIL" - creates it if necessary

    • getLocationGroup

      public CE getLocationGroup()
      Returns AIL-5: "Location Group" - creates it if necessary

    • getAil5_LocationGroup

      public CE getAil5_LocationGroup()
      Returns AIL-5: "Location Group" - creates it if necessary

    • getStartDateTime

      public TS getStartDateTime()
      Returns AIL-6: "Start Date/Time" - creates it if necessary

    • getAil6_StartDateTime

      public TS getAil6_StartDateTime()
      Returns AIL-6: "Start Date/Time" - creates it if necessary

    • getStartDateTimeOffset

      public NM getStartDateTimeOffset()
      Returns AIL-7: "Start Date/Time Offset" - creates it if necessary

    • getAil7_StartDateTimeOffset

      public NM getAil7_StartDateTimeOffset()
      Returns AIL-7: "Start Date/Time Offset" - creates it if necessary

    • getStartDateTimeOffsetUnits

      public CE getStartDateTimeOffsetUnits()
      Returns AIL-8: "Start Date/Time Offset Units" - creates it if necessary

    • getAil8_StartDateTimeOffsetUnits

      public CE getAil8_StartDateTimeOffsetUnits()
      Returns AIL-8: "Start Date/Time Offset Units" - creates it if necessary

    • getDuration

      public NM getDuration()
      Returns AIL-9: "Duration" - creates it if necessary

    • getAil9_Duration

      public NM getAil9_Duration()
      Returns AIL-9: "Duration" - creates it if necessary

    • getDurationUnits

      public CE getDurationUnits()
      Returns AIL-10: "Duration Units" - creates it if necessary

    • getAil10_DurationUnits

      public CE getAil10_DurationUnits()
      Returns AIL-10: "Duration Units" - creates it if necessary

    • getAllowSubstitutionCode

      public IS getAllowSubstitutionCode()
      Returns AIL-11: "Allow Substitution Code" - creates it if necessary

    • getAil11_AllowSubstitutionCode

      public IS getAil11_AllowSubstitutionCode()
      Returns AIL-11: "Allow Substitution Code" - creates it if necessary

    • getFillerStatusCode

      public CE getFillerStatusCode()
      Returns AIL-12: "Filler Status Code" - creates it if necessary

    • getAil12_FillerStatusCode

      public CE getAil12_FillerStatusCode()
      Returns AIL-12: "Filler Status Code" - creates it if necessary

    • createNewTypeWithoutReflection

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