ca.uhn.hl7v2.model.v231.segment
Class AL1

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v231.segment.AL1

All Implemented Interfaces:

Segment, Structure, Serializable

public class AL1
extends AbstractSegment

Represents an HL7 AL1 message segment (AL1 - patient allergy information segment). This segment has the following fields:

• AL1-1: Set ID - AL1 (SI)
• AL1-2: Allergy Type (IS) optional
• AL1-3: Allergy Code/Mnemonic/Description (CE)
• AL1-4: Allergy Severity (IS) optional
• AL1-5: Allergy Reaction (ST) optional repeating
• AL1-6: Identification Date (DT) optional

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
SI	getAl11_SetIDAL1() Returns AL1-1: "Set ID - AL1" - creates it if necessary
IS	getAl12_AllergyType() Returns AL1-2: "Allergy Type" - creates it if necessary
CE	getAl13_AllergyCodeMnemonicDescription() Returns AL1-3: "Allergy Code/Mnemonic/Description" - creates it if necessary
IS	getAl14_AllergySeverity() Returns AL1-4: "Allergy Severity" - creates it if necessary
ST	getAl15_AllergyReaction(int rep) Returns a specific repetition of AL1-5: "Allergy Reaction" - creates it if necessary
int	getAl15_AllergyReactionReps() Returns a count of the current number of repetitions of Allergy Reaction (AL1-5).
DT	getAl16_IdentificationDate() Returns AL1-6: "Identification Date" - creates it if necessary
CE	getAllergyCodeMnemonicDescription() Returns AL1-3: "Allergy Code/Mnemonic/Description" - creates it if necessary
ST[]	getAllergyReaction() Returns all repetitions of Allergy Reaction (AL1-5).
ST	getAllergyReaction(int rep) Returns a specific repetition of AL1-5: "Allergy Reaction" - creates it if necessary
int	getAllergyReactionReps() Returns a count of the current number of repetitions of Allergy Reaction (AL1-5).
IS	getAllergySeverity() Returns AL1-4: "Allergy Severity" - creates it if necessary
IS	getAllergyType() Returns AL1-2: "Allergy Type" - creates it if necessary
DT	getIdentificationDate() Returns AL1-6: "Identification Date" - creates it if necessary
SI	getSetIDAL1() Returns AL1-1: "Set ID - AL1" - creates it if necessary
ST	insertAl15_AllergyReaction(int rep) Inserts a repetition of AL1-5: "Allergy Reaction" at a specific index
ST	insertAllergyReaction(int rep) Inserts a repetition of AL1-5: "Allergy Reaction" at a specific index
ST	removeAl15_AllergyReaction(int rep) Removes a repetition of AL1-5: "Allergy Reaction" at a specific index
ST	removeAllergyReaction(int rep) Removes a repetition of AL1-5: "Allergy Reaction" 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

AL1

public AL1(Group parent,
           ModelClassFactory factory)

Creates a new AL1 segment

Method Detail

getSetIDAL1

public SI getSetIDAL1()

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

getAl11_SetIDAL1

public SI getAl11_SetIDAL1()

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

getAllergyType

public IS getAllergyType()

Returns AL1-2: "Allergy Type" - creates it if necessary

getAl12_AllergyType

public IS getAl12_AllergyType()

Returns AL1-2: "Allergy Type" - creates it if necessary

getAllergyCodeMnemonicDescription

public CE getAllergyCodeMnemonicDescription()

Returns AL1-3: "Allergy Code/Mnemonic/Description" - creates it if necessary

getAl13_AllergyCodeMnemonicDescription

public CE getAl13_AllergyCodeMnemonicDescription()

Returns AL1-3: "Allergy Code/Mnemonic/Description" - creates it if necessary

getAllergySeverity

public IS getAllergySeverity()

Returns AL1-4: "Allergy Severity" - creates it if necessary

getAl14_AllergySeverity

public IS getAl14_AllergySeverity()

Returns AL1-4: "Allergy Severity" - creates it if necessary

getAllergyReaction

public ST[] getAllergyReaction()

Returns all repetitions of Allergy Reaction (AL1-5).

getAllergyReactionReps

public int getAllergyReactionReps()

Returns a count of the current number of repetitions of Allergy Reaction (AL1-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getAllergyReaction

public ST getAllergyReaction(int rep)

Returns a specific repetition of AL1-5: "Allergy Reaction" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getAl15_AllergyReaction

public ST getAl15_AllergyReaction(int rep)

Returns a specific repetition of AL1-5: "Allergy Reaction" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getAl15_AllergyReactionReps

public int getAl15_AllergyReactionReps()

Returns a count of the current number of repetitions of Allergy Reaction (AL1-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertAllergyReaction

public ST insertAllergyReaction(int rep)
                         throws HL7Exception

Inserts a repetition of AL1-5: "Allergy Reaction" 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)

insertAl15_AllergyReaction

public ST insertAl15_AllergyReaction(int rep)
                              throws HL7Exception

Inserts a repetition of AL1-5: "Allergy Reaction" 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)

removeAllergyReaction

public ST removeAllergyReaction(int rep)
                         throws HL7Exception

Removes a repetition of AL1-5: "Allergy Reaction" 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)

removeAl15_AllergyReaction

public ST removeAl15_AllergyReaction(int rep)
                              throws HL7Exception

Removes a repetition of AL1-5: "Allergy Reaction" 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)

getIdentificationDate

public DT getIdentificationDate()

Returns AL1-6: "Identification Date" - creates it if necessary

getAl16_IdentificationDate

public DT getAl16_IdentificationDate()

Returns AL1-6: "Identification Date" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment