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

Class AIP

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

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

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

  • Constructor Details

  • Method Details

    • getSetIDAIP

      public SI getSetIDAIP()
      Returns AIP-1: "Set ID - AIP" - creates it if necessary

    • getAip1_SetIDAIP

      public SI getAip1_SetIDAIP()
      Returns AIP-1: "Set ID - AIP" - creates it if necessary

    • getSegmentActionCode

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

    • getAip2_SegmentActionCode

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

    • getPersonnelResourceID

      public XCN[] getPersonnelResourceID()
      Returns all repetitions of Personnel Resource ID (AIP-3).

    • getAip3_PersonnelResourceID

      public XCN[] getAip3_PersonnelResourceID()
      Returns all repetitions of Personnel Resource ID (AIP-3).

    • getPersonnelResourceIDReps

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

    • getPersonnelResourceID

      public XCN getPersonnelResourceID(int rep)
      Returns a specific repetition of AIP-3: "Personnel Resource ID" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getAip3_PersonnelResourceID

      public XCN getAip3_PersonnelResourceID(int rep)
      Returns a specific repetition of AIP-3: "Personnel Resource ID" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getAip3_PersonnelResourceIDReps

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

    • insertPersonnelResourceID

      public XCN insertPersonnelResourceID(int rep) throws HL7Exception
      Inserts a repetition of AIP-3: "Personnel 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)

    • insertAip3_PersonnelResourceID

      public XCN insertAip3_PersonnelResourceID(int rep) throws HL7Exception
      Inserts a repetition of AIP-3: "Personnel 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)

    • removePersonnelResourceID

      public XCN removePersonnelResourceID(int rep) throws HL7Exception
      Removes a repetition of AIP-3: "Personnel 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)

    • removeAip3_PersonnelResourceID

      public XCN removeAip3_PersonnelResourceID(int rep) throws HL7Exception
      Removes a repetition of AIP-3: "Personnel 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)

    • getResourceRole

      public CE getResourceRole()
      Returns AIP-4: "Resource Role" - creates it if necessary

    • getAip4_ResourceRole

      public CE getAip4_ResourceRole()
      Returns AIP-4: "Resource Role" - creates it if necessary

    • getResourceGroup

      public CE getResourceGroup()
      Returns AIP-5: "Resource Group" - creates it if necessary

    • getAip5_ResourceGroup

      public CE getAip5_ResourceGroup()
      Returns AIP-5: "Resource Group" - creates it if necessary

    • getStartDateTime

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

    • getAip6_StartDateTime

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

    • getStartDateTimeOffset

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

    • getAip7_StartDateTimeOffset

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

    • getStartDateTimeOffsetUnits

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

    • getAip8_StartDateTimeOffsetUnits

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

    • getDuration

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

    • getAip9_Duration

      public NM getAip9_Duration()
      Returns AIP-9: "Duration" - creates it if necessary

    • getDurationUnits

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

    • getAip10_DurationUnits

      public CE getAip10_DurationUnits()
      Returns AIP-10: "Duration Units" - creates it if necessary

    • getAllowSubstitutionCode

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

    • getAip11_AllowSubstitutionCode

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

    • getFillerStatusCode

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

    • getAip12_FillerStatusCode

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

    • createNewTypeWithoutReflection

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