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

Class AL1

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

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

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

  • Constructor Details

  • Method Details

    • getSetIDAL1

      public CE getSetIDAL1()
      Returns AL1-1: "Set ID - AL1" - creates it if necessary

    • getAl11_SetIDAL1

      public CE getAl11_SetIDAL1()
      Returns AL1-1: "Set ID - AL1" - creates it if necessary

    • getAllergenTypeCode

      public CE getAllergenTypeCode()
      Returns AL1-2: "Allergen Type Code" - creates it if necessary

    • getAl12_AllergenTypeCode

      public CE getAl12_AllergenTypeCode()
      Returns AL1-2: "Allergen Type Code" - creates it if necessary

    • getAllergenCodeMnemonicDescription

      public CE getAllergenCodeMnemonicDescription()
      Returns AL1-3: "Allergen Code/Mnemonic/Description" - creates it if necessary

    • getAl13_AllergenCodeMnemonicDescription

      public CE getAl13_AllergenCodeMnemonicDescription()
      Returns AL1-3: "Allergen Code/Mnemonic/Description" - creates it if necessary

    • getAllergySeverityCode

      public CE getAllergySeverityCode()
      Returns AL1-4: "Allergy Severity Code" - creates it if necessary

    • getAl14_AllergySeverityCode

      public CE getAl14_AllergySeverityCode()
      Returns AL1-4: "Allergy Severity Code" - creates it if necessary

    • getAllergyReactionCode

      public ST[] getAllergyReactionCode()
      Returns all repetitions of Allergy Reaction Code (AL1-5).

    • getAl15_AllergyReactionCode

      public ST[] getAl15_AllergyReactionCode()
      Returns all repetitions of Allergy Reaction Code (AL1-5).

    • getAllergyReactionCodeReps

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

    • getAllergyReactionCode

      public ST getAllergyReactionCode(int rep)
      Returns a specific repetition of AL1-5: "Allergy Reaction Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getAl15_AllergyReactionCode

      public ST getAl15_AllergyReactionCode(int rep)
      Returns a specific repetition of AL1-5: "Allergy Reaction Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getAl15_AllergyReactionCodeReps

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

    • insertAllergyReactionCode

      public ST insertAllergyReactionCode(int rep) throws HL7Exception
      Inserts a repetition of AL1-5: "Allergy Reaction Code" 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_AllergyReactionCode

      public ST insertAl15_AllergyReactionCode(int rep) throws HL7Exception
      Inserts a repetition of AL1-5: "Allergy Reaction Code" 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)

    • removeAllergyReactionCode

      public ST removeAllergyReactionCode(int rep) throws HL7Exception
      Removes a repetition of AL1-5: "Allergy Reaction Code" 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_AllergyReactionCode

      public ST removeAl15_AllergyReactionCode(int rep) throws HL7Exception
      Removes a repetition of AL1-5: "Allergy Reaction Code" 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