ca.uhn.hl7v2.model.v24.segment
Class AIS

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.AIS

All Implemented Interfaces:

Segment, Structure, Serializable

public class AIS
extends AbstractSegment

Represents an HL7 AIS message segment (Appointment Information - Service). This segment has the following fields:

• AIS-1: Set ID - AIS (SI)
• AIS-2: Segment Action Code (ID) optional
• AIS-3: Universal Service Identifier (CE)
• AIS-4: Start Date/Time (TS) optional
• AIS-5: Start Date/Time Offset (NM) optional
• AIS-6: Start Date/Time Offset Units (CE) optional
• AIS-7: Duration (NM) optional
• AIS-8: Duration Units (CE) optional
• AIS-9: Allow Substitution Code (IS) optional
• AIS-10: Filler Status Code (CE) optional
• AIS-11: Placer Supplemental Service Information (CE) optional repeating
• AIS-12: Filler Supplemental Service Information (CE) optional repeating

See Also:

Serialized Form

Constructor Summary

AIS(Group parent, ModelClassFactory factory)
Creates a new AIS segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
SI	getAis1_SetIDAIS() Returns AIS-1: "Set ID - AIS" - creates it if necessary
CE	getAis10_FillerStatusCode() Returns AIS-10: "Filler Status Code" - creates it if necessary
CE	getAis11_PlacerSupplementalServiceInformation(int rep) Returns a specific repetition of AIS-11: "Placer Supplemental Service Information" - creates it if necessary
int	getAis11_PlacerSupplementalServiceInformationReps() Returns a count of the current number of repetitions of Placer Supplemental Service Information (AIS-11).
CE	getAis12_FillerSupplementalServiceInformation(int rep) Returns a specific repetition of AIS-12: "Filler Supplemental Service Information" - creates it if necessary
int	getAis12_FillerSupplementalServiceInformationReps() Returns a count of the current number of repetitions of Filler Supplemental Service Information (AIS-12).
ID	getAis2_SegmentActionCode() Returns AIS-2: "Segment Action Code" - creates it if necessary
CE	getAis3_UniversalServiceIdentifier() Returns AIS-3: "Universal Service Identifier" - creates it if necessary
TS	getAis4_StartDateTime() Returns AIS-4: "Start Date/Time" - creates it if necessary
NM	getAis5_StartDateTimeOffset() Returns AIS-5: "Start Date/Time Offset" - creates it if necessary
CE	getAis6_StartDateTimeOffsetUnits() Returns AIS-6: "Start Date/Time Offset Units" - creates it if necessary
NM	getAis7_Duration() Returns AIS-7: "Duration" - creates it if necessary
CE	getAis8_DurationUnits() Returns AIS-8: "Duration Units" - creates it if necessary
IS	getAis9_AllowSubstitutionCode() Returns AIS-9: "Allow Substitution Code" - creates it if necessary
IS	getAllowSubstitutionCode() Returns AIS-9: "Allow Substitution Code" - creates it if necessary
NM	getDuration() Returns AIS-7: "Duration" - creates it if necessary
CE	getDurationUnits() Returns AIS-8: "Duration Units" - creates it if necessary
CE	getFillerStatusCode() Returns AIS-10: "Filler Status Code" - creates it if necessary
CE[]	getFillerSupplementalServiceInformation() Returns all repetitions of Filler Supplemental Service Information (AIS-12).
CE	getFillerSupplementalServiceInformation(int rep) Returns a specific repetition of AIS-12: "Filler Supplemental Service Information" - creates it if necessary
int	getFillerSupplementalServiceInformationReps() Returns a count of the current number of repetitions of Filler Supplemental Service Information (AIS-12).
CE[]	getPlacerSupplementalServiceInformation() Returns all repetitions of Placer Supplemental Service Information (AIS-11).
CE	getPlacerSupplementalServiceInformation(int rep) Returns a specific repetition of AIS-11: "Placer Supplemental Service Information" - creates it if necessary
int	getPlacerSupplementalServiceInformationReps() Returns a count of the current number of repetitions of Placer Supplemental Service Information (AIS-11).
ID	getSegmentActionCode() Returns AIS-2: "Segment Action Code" - creates it if necessary
SI	getSetIDAIS() Returns AIS-1: "Set ID - AIS" - creates it if necessary
TS	getStartDateTime() Returns AIS-4: "Start Date/Time" - creates it if necessary
NM	getStartDateTimeOffset() Returns AIS-5: "Start Date/Time Offset" - creates it if necessary
CE	getStartDateTimeOffsetUnits() Returns AIS-6: "Start Date/Time Offset Units" - creates it if necessary
CE	getUniversalServiceIdentifier() Returns AIS-3: "Universal Service Identifier" - creates it if necessary
CE	insertAis11_PlacerSupplementalServiceInformation(int rep) Inserts a repetition of AIS-11: "Placer Supplemental Service Information" at a specific index
CE	insertAis12_FillerSupplementalServiceInformation(int rep) Inserts a repetition of AIS-12: "Filler Supplemental Service Information" at a specific index
CE	insertFillerSupplementalServiceInformation(int rep) Inserts a repetition of AIS-12: "Filler Supplemental Service Information" at a specific index
CE	insertPlacerSupplementalServiceInformation(int rep) Inserts a repetition of AIS-11: "Placer Supplemental Service Information" at a specific index
CE	removeAis11_PlacerSupplementalServiceInformation(int rep) Removes a repetition of AIS-11: "Placer Supplemental Service Information" at a specific index
CE	removeAis12_FillerSupplementalServiceInformation(int rep) Removes a repetition of AIS-12: "Filler Supplemental Service Information" at a specific index
CE	removeFillerSupplementalServiceInformation(int rep) Removes a repetition of AIS-12: "Filler Supplemental Service Information" at a specific index
CE	removePlacerSupplementalServiceInformation(int rep) Removes a repetition of AIS-11: "Placer Supplemental Service Information" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AIS

public AIS(Group parent,
           ModelClassFactory factory)

Creates a new AIS segment

Method Detail

getSetIDAIS

public SI getSetIDAIS()

Returns AIS-1: "Set ID - AIS" - creates it if necessary

getAis1_SetIDAIS

public SI getAis1_SetIDAIS()

Returns AIS-1: "Set ID - AIS" - creates it if necessary

getSegmentActionCode

public ID getSegmentActionCode()

Returns AIS-2: "Segment Action Code" - creates it if necessary

getAis2_SegmentActionCode

public ID getAis2_SegmentActionCode()

Returns AIS-2: "Segment Action Code" - creates it if necessary

getUniversalServiceIdentifier

public CE getUniversalServiceIdentifier()

Returns AIS-3: "Universal Service Identifier" - creates it if necessary

getAis3_UniversalServiceIdentifier

public CE getAis3_UniversalServiceIdentifier()

Returns AIS-3: "Universal Service Identifier" - creates it if necessary

getStartDateTime

public TS getStartDateTime()

Returns AIS-4: "Start Date/Time" - creates it if necessary

getAis4_StartDateTime

public TS getAis4_StartDateTime()

Returns AIS-4: "Start Date/Time" - creates it if necessary

getStartDateTimeOffset

public NM getStartDateTimeOffset()

Returns AIS-5: "Start Date/Time Offset" - creates it if necessary

getAis5_StartDateTimeOffset

public NM getAis5_StartDateTimeOffset()

Returns AIS-5: "Start Date/Time Offset" - creates it if necessary

getStartDateTimeOffsetUnits

public CE getStartDateTimeOffsetUnits()

Returns AIS-6: "Start Date/Time Offset Units" - creates it if necessary

getAis6_StartDateTimeOffsetUnits

public CE getAis6_StartDateTimeOffsetUnits()

Returns AIS-6: "Start Date/Time Offset Units" - creates it if necessary

getDuration

public NM getDuration()

Returns AIS-7: "Duration" - creates it if necessary

getAis7_Duration

public NM getAis7_Duration()

Returns AIS-7: "Duration" - creates it if necessary

getDurationUnits

public CE getDurationUnits()

Returns AIS-8: "Duration Units" - creates it if necessary

getAis8_DurationUnits

public CE getAis8_DurationUnits()

Returns AIS-8: "Duration Units" - creates it if necessary

getAllowSubstitutionCode

public IS getAllowSubstitutionCode()

Returns AIS-9: "Allow Substitution Code" - creates it if necessary

getAis9_AllowSubstitutionCode

public IS getAis9_AllowSubstitutionCode()

Returns AIS-9: "Allow Substitution Code" - creates it if necessary

getFillerStatusCode

public CE getFillerStatusCode()

Returns AIS-10: "Filler Status Code" - creates it if necessary

getAis10_FillerStatusCode

public CE getAis10_FillerStatusCode()

Returns AIS-10: "Filler Status Code" - creates it if necessary

getPlacerSupplementalServiceInformation

public CE[] getPlacerSupplementalServiceInformation()

Returns all repetitions of Placer Supplemental Service Information (AIS-11).

getPlacerSupplementalServiceInformationReps

public int getPlacerSupplementalServiceInformationReps()

Returns a count of the current number of repetitions of Placer Supplemental Service Information (AIS-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getPlacerSupplementalServiceInformation

public CE getPlacerSupplementalServiceInformation(int rep)

Returns a specific repetition of AIS-11: "Placer Supplemental Service Information" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getAis11_PlacerSupplementalServiceInformation

public CE getAis11_PlacerSupplementalServiceInformation(int rep)

Returns a specific repetition of AIS-11: "Placer Supplemental Service Information" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getAis11_PlacerSupplementalServiceInformationReps

public int getAis11_PlacerSupplementalServiceInformationReps()

Returns a count of the current number of repetitions of Placer Supplemental Service Information (AIS-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertPlacerSupplementalServiceInformation

public CE insertPlacerSupplementalServiceInformation(int rep)
                                              throws HL7Exception

Inserts a repetition of AIS-11: "Placer Supplemental Service Information" 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)

insertAis11_PlacerSupplementalServiceInformation

public CE insertAis11_PlacerSupplementalServiceInformation(int rep)
                                                    throws HL7Exception

Inserts a repetition of AIS-11: "Placer Supplemental Service Information" 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)

removePlacerSupplementalServiceInformation

public CE removePlacerSupplementalServiceInformation(int rep)
                                              throws HL7Exception

Removes a repetition of AIS-11: "Placer Supplemental Service Information" 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)

removeAis11_PlacerSupplementalServiceInformation

public CE removeAis11_PlacerSupplementalServiceInformation(int rep)
                                                    throws HL7Exception

Removes a repetition of AIS-11: "Placer Supplemental Service Information" 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)

getFillerSupplementalServiceInformation

public CE[] getFillerSupplementalServiceInformation()

Returns all repetitions of Filler Supplemental Service Information (AIS-12).

getFillerSupplementalServiceInformationReps

public int getFillerSupplementalServiceInformationReps()

Returns a count of the current number of repetitions of Filler Supplemental Service Information (AIS-12). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getFillerSupplementalServiceInformation

public CE getFillerSupplementalServiceInformation(int rep)

Returns a specific repetition of AIS-12: "Filler Supplemental Service Information" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getAis12_FillerSupplementalServiceInformation

public CE getAis12_FillerSupplementalServiceInformation(int rep)

Returns a specific repetition of AIS-12: "Filler Supplemental Service Information" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getAis12_FillerSupplementalServiceInformationReps

public int getAis12_FillerSupplementalServiceInformationReps()

Returns a count of the current number of repetitions of Filler Supplemental Service Information (AIS-12). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertFillerSupplementalServiceInformation

public CE insertFillerSupplementalServiceInformation(int rep)
                                              throws HL7Exception

Inserts a repetition of AIS-12: "Filler Supplemental Service Information" 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)

insertAis12_FillerSupplementalServiceInformation

public CE insertAis12_FillerSupplementalServiceInformation(int rep)
                                                    throws HL7Exception

Inserts a repetition of AIS-12: "Filler Supplemental Service Information" 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)

removeFillerSupplementalServiceInformation

public CE removeFillerSupplementalServiceInformation(int rep)
                                              throws HL7Exception

Removes a repetition of AIS-12: "Filler Supplemental Service Information" 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)

removeAis12_FillerSupplementalServiceInformation

public CE removeAis12_FillerSupplementalServiceInformation(int rep)
                                                    throws HL7Exception

Removes a repetition of AIS-12: "Filler Supplemental Service Information" 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