Package ca.uhn.hl7v2.model.v251.message

Class ADT_A24

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractGroup
ca.uhn.hl7v2.model.AbstractMessage
ca.uhn.hl7v2.model.v251.message.ADT_A24
All Implemented Interfaces:
Group, Message, Structure, Visitable, Serializable
public class ADT_A24 extends AbstractMessage

Represents a ADT_A24 message structure (see chapter 3.3.24). This structure contains the following elements:

  • 1: MSH (Message Header)
  • 2: SFT (Software Segment) optional repeating
  • 3: EVN (Event Type)
  • 4: PID (Patient Identification)
  • 5: PD1 (Patient Additional Demographic) optional
  • 6: PV1 (Patient Visit) optional
  • 7: DB1 (Disability) optional repeating
  • 8: PID (Patient Identification)
  • 9: PD1 (Patient Additional Demographic) optional
  • 10: PV1 (Patient Visit) optional
  • 11: DB1 (Disability) optional repeating
See Also:

  • Constructor Details

    • ADT_A24

      public ADT_A24()
      Creates a new ADT_A24 message with DefaultModelClassFactory.

    • ADT_A24

      public ADT_A24(ModelClassFactory factory)
      Creates a new ADT_A24 message with custom ModelClassFactory.

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.5.1"
      Specified by:
      getVersion in interface Message
      Overrides:
      getVersion in class AbstractMessage

    • getMSH

      public MSH getMSH()

      Returns MSH (Message Header) - creates it if necessary

    • getSFT

      public SFT getSFT()

      Returns the first repetition of SFT (Software Segment) - creates it if necessary

    • getSFT

      public SFT getSFT(int rep)

      Returns a specific repetition of SFT (Software Segment) - creates it if necessary

      Parameters:
      rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)
      Throws:
      HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

    • getSFTReps

      public int getSFTReps()

      Returns the number of existing repetitions of SFT

    • getSFTAll

      public List<SFT> getSFTAll() throws HL7Exception

      Returns a non-modifiable List containing all current existing repetitions of SFT.

      Note that unlike getSFT(), this method will not create any reps if none are already present, so an empty list may be returned.

      Throws:
      HL7Exception

    • insertSFT

      public void insertSFT(SFT structure, int rep) throws HL7Exception

      Inserts a specific repetition of SFT (Software Segment)

      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertSFT

      public SFT insertSFT(int rep) throws HL7Exception

      Inserts a specific repetition of SFT (Software Segment)

      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeSFT

      public SFT removeSFT(int rep) throws HL7Exception

      Removes a specific repetition of SFT (Software Segment)

      Throws:
      HL7Exception
      See Also:

    • getEVN

      public EVN getEVN()

      Returns EVN (Event Type) - creates it if necessary

    • getPID

      public PID getPID()

      Returns PID (Patient Identification) - creates it if necessary

    • getPD1

      public PD1 getPD1()

      Returns PD1 (Patient Additional Demographic) - creates it if necessary

    • getPV1

      public PV1 getPV1()

      Returns PV1 (Patient Visit) - creates it if necessary

    • getDB1

      public DB1 getDB1()

      Returns the first repetition of DB1 (Disability) - creates it if necessary

    • getDB1

      public DB1 getDB1(int rep)

      Returns a specific repetition of DB1 (Disability) - creates it if necessary

      Parameters:
      rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)
      Throws:
      HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

    • getDB1Reps

      public int getDB1Reps()

      Returns the number of existing repetitions of DB1

    • getDB1All

      public List<DB1> getDB1All() throws HL7Exception

      Returns a non-modifiable List containing all current existing repetitions of DB1.

      Note that unlike getDB1(), this method will not create any reps if none are already present, so an empty list may be returned.

      Throws:
      HL7Exception

    • insertDB1

      public void insertDB1(DB1 structure, int rep) throws HL7Exception

      Inserts a specific repetition of DB1 (Disability)

      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertDB1

      public DB1 insertDB1(int rep) throws HL7Exception

      Inserts a specific repetition of DB1 (Disability)

      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeDB1

      public DB1 removeDB1(int rep) throws HL7Exception

      Removes a specific repetition of DB1 (Disability)

      Throws:
      HL7Exception
      See Also:

    • getPID2

      public PID getPID2()

      Returns PID2 (Patient Identification) - creates it if necessary

    • getPD12

      public PD1 getPD12()

      Returns PD12 (Patient Additional Demographic) - creates it if necessary

    • getPV12

      public PV1 getPV12()

      Returns PV12 (Patient Visit) - creates it if necessary

    • getDB12

      public DB1 getDB12()

      Returns the first repetition of DB12 (Disability) - creates it if necessary

    • getDB12

      public DB1 getDB12(int rep)

      Returns a specific repetition of DB12 (Disability) - creates it if necessary

      Parameters:
      rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)
      Throws:
      HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

    • getDB12Reps

      public int getDB12Reps()

      Returns the number of existing repetitions of DB12

    • getDB12All

      public List<DB1> getDB12All() throws HL7Exception

      Returns a non-modifiable List containing all current existing repetitions of DB12.

      Note that unlike getDB12(), this method will not create any reps if none are already present, so an empty list may be returned.

      Throws:
      HL7Exception

    • insertDB12

      public void insertDB12(DB1 structure, int rep) throws HL7Exception

      Inserts a specific repetition of DB12 (Disability)

      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertDB12

      public DB1 insertDB12(int rep) throws HL7Exception

      Inserts a specific repetition of DB12 (Disability)

      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeDB12

      public DB1 removeDB12(int rep) throws HL7Exception

      Removes a specific repetition of DB12 (Disability)

      Throws:
      HL7Exception
      See Also: