Package ca.uhn.hl7v2.model.v24.message

Class ADT_A54

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

Represents a ADT_A54 message structure (see chapter 3). This structure contains the following elements:

  • 1: MSH (Message Header)
  • 2: EVN (Event Type)
  • 3: PID (Patient identification)
  • 4: PD1 (patient additional demographic) optional
  • 5: ROL (Role) optional repeating
  • 6: PV1 (Patient visit)
  • 7: PV2 (Patient visit - additional information) optional
  • 8: ROL (Role) optional repeating
See Also:

  • Constructor Details

    • ADT_A54

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

    • ADT_A54

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

  • Method Details

    • getVersion

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

    • getMSH

      public MSH getMSH()

      Returns MSH (Message Header) - creates it if necessary

    • 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

    • getROL

      public ROL getROL()

      Returns the first repetition of ROL (Role) - creates it if necessary

    • getROL

      public ROL getROL(int rep)

      Returns a specific repetition of ROL (Role) - 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.

    • getROLReps

      public int getROLReps()

      Returns the number of existing repetitions of ROL

    • getROLAll

      public List<ROL> getROLAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertROL

      public void insertROL(ROL structure, int rep) throws HL7Exception

      Inserts a specific repetition of ROL (Role)

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

    • insertROL

      public ROL insertROL(int rep) throws HL7Exception

      Inserts a specific repetition of ROL (Role)

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

    • removeROL

      public ROL removeROL(int rep) throws HL7Exception

      Removes a specific repetition of ROL (Role)

      Throws:
      HL7Exception
      See Also:

    • getPV1

      public PV1 getPV1()

      Returns PV1 (Patient visit) - creates it if necessary

    • getPV2

      public PV2 getPV2()

      Returns PV2 (Patient visit - additional information) - creates it if necessary

    • getROL2

      public ROL getROL2()

      Returns the first repetition of ROL2 (Role) - creates it if necessary

    • getROL2

      public ROL getROL2(int rep)

      Returns a specific repetition of ROL2 (Role) - 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.

    • getROL2Reps

      public int getROL2Reps()

      Returns the number of existing repetitions of ROL2

    • getROL2All

      public List<ROL> getROL2All() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertROL2

      public void insertROL2(ROL structure, int rep) throws HL7Exception

      Inserts a specific repetition of ROL2 (Role)

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

    • insertROL2

      public ROL insertROL2(int rep) throws HL7Exception

      Inserts a specific repetition of ROL2 (Role)

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

    • removeROL2

      public ROL removeROL2(int rep) throws HL7Exception

      Removes a specific repetition of ROL2 (Role)

      Throws:
      HL7Exception
      See Also: