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

Class AIG

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

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

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

  • Constructor Details

  • Method Details

    • getSetIDAIG

      public SI getSetIDAIG()
      Returns AIG-1: "Set ID - AIG" - creates it if necessary

    • getAig1_SetIDAIG

      public SI getAig1_SetIDAIG()
      Returns AIG-1: "Set ID - AIG" - creates it if necessary

    • getSegmentActionCode

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

    • getAig2_SegmentActionCode

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

    • getResourceID

      public CE getResourceID()
      Returns AIG-3: "Resource ID" - creates it if necessary

    • getAig3_ResourceID

      public CE getAig3_ResourceID()
      Returns AIG-3: "Resource ID" - creates it if necessary

    • getResourceType

      public CE getResourceType()
      Returns AIG-4: "Resource Type" - creates it if necessary

    • getAig4_ResourceType

      public CE getAig4_ResourceType()
      Returns AIG-4: "Resource Type" - creates it if necessary

    • getResourceGroup

      public CE[] getResourceGroup()
      Returns all repetitions of Resource Group (AIG-5).

    • getAig5_ResourceGroup

      public CE[] getAig5_ResourceGroup()
      Returns all repetitions of Resource Group (AIG-5).

    • getResourceGroupReps

      public int getResourceGroupReps()
      Returns a count of the current number of repetitions of Resource Group (AIG-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getResourceGroup

      public CE getResourceGroup(int rep)
      Returns a specific repetition of AIG-5: "Resource Group" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getAig5_ResourceGroup

      public CE getAig5_ResourceGroup(int rep)
      Returns a specific repetition of AIG-5: "Resource Group" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getAig5_ResourceGroupReps

      public int getAig5_ResourceGroupReps()
      Returns a count of the current number of repetitions of Resource Group (AIG-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertResourceGroup

      public CE insertResourceGroup(int rep) throws HL7Exception
      Inserts a repetition of AIG-5: "Resource Group" 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)

    • insertAig5_ResourceGroup

      public CE insertAig5_ResourceGroup(int rep) throws HL7Exception
      Inserts a repetition of AIG-5: "Resource Group" 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)

    • removeResourceGroup

      public CE removeResourceGroup(int rep) throws HL7Exception
      Removes a repetition of AIG-5: "Resource Group" 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)

    • removeAig5_ResourceGroup

      public CE removeAig5_ResourceGroup(int rep) throws HL7Exception
      Removes a repetition of AIG-5: "Resource Group" 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)

    • getResourceQuantity

      public NM getResourceQuantity()
      Returns AIG-6: "Resource Quantity" - creates it if necessary

    • getAig6_ResourceQuantity

      public NM getAig6_ResourceQuantity()
      Returns AIG-6: "Resource Quantity" - creates it if necessary

    • getResourceQuantityUnits

      public CE getResourceQuantityUnits()
      Returns AIG-7: "Resource Quantity Units" - creates it if necessary

    • getAig7_ResourceQuantityUnits

      public CE getAig7_ResourceQuantityUnits()
      Returns AIG-7: "Resource Quantity Units" - creates it if necessary

    • getStartDateTime

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

    • getAig8_StartDateTime

      public TS getAig8_StartDateTime()
      Returns AIG-8: "Start Date/Time" - creates it if necessary

    • getStartDateTimeOffset

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

    • getAig9_StartDateTimeOffset

      public NM getAig9_StartDateTimeOffset()
      Returns AIG-9: "Start Date/Time Offset" - creates it if necessary

    • getStartDateTimeOffsetUnits

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

    • getAig10_StartDateTimeOffsetUnits

      public CE getAig10_StartDateTimeOffsetUnits()
      Returns AIG-10: "Start Date/Time Offset Units" - creates it if necessary

    • getDuration

      public NM getDuration()
      Returns AIG-11: "Duration" - creates it if necessary

    • getAig11_Duration

      public NM getAig11_Duration()
      Returns AIG-11: "Duration" - creates it if necessary

    • getDurationUnits

      public CE getDurationUnits()
      Returns AIG-12: "Duration Units" - creates it if necessary

    • getAig12_DurationUnits

      public CE getAig12_DurationUnits()
      Returns AIG-12: "Duration Units" - creates it if necessary

    • getAllowSubstitutionCode

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

    • getAig13_AllowSubstitutionCode

      public IS getAig13_AllowSubstitutionCode()
      Returns AIG-13: "Allow Substitution Code" - creates it if necessary

    • getFillerStatusCode

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

    • getAig14_FillerStatusCode

      public CE getAig14_FillerStatusCode()
      Returns AIG-14: "Filler Status Code" - creates it if necessary

    • createNewTypeWithoutReflection

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