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

Class OUL_R24

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

Represents a OUL_R24 message structure (see chapter 7.3.9). This structure contains the following elements:

  • 1: MSH (Message Header)
  • 2: SFT (Software Segment) optional repeating
  • 3: NTE (Notes and Comments) optional
  • 4: OUL_R24_PATIENT (a Group object) optional
  • 5: OUL_R24_VISIT (a Group object) optional
  • 6: OUL_R24_ORDER (a Group object) repeating
  • 7: DSC (Continuation Pointer) optional
See Also:

  • Constructor Details

    • OUL_R24

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

    • OUL_R24

      public OUL_R24(ModelClassFactory factory)
      Creates a new OUL_R24 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:

    • getNTE

      public NTE getNTE()

      Returns NTE (Notes and Comments) - creates it if necessary

    • getPATIENT

      public OUL_R24_PATIENT getPATIENT()

      Returns PATIENT (a Group object) - creates it if necessary

    • getVISIT

      public OUL_R24_VISIT getVISIT()

      Returns VISIT (a Group object) - creates it if necessary

    • getORDER

      public OUL_R24_ORDER getORDER()

      Returns the first repetition of ORDER (a Group object) - creates it if necessary

    • getORDER

      public OUL_R24_ORDER getORDER(int rep)

      Returns a specific repetition of ORDER (a Group object) - 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.

    • getORDERReps

      public int getORDERReps()

      Returns the number of existing repetitions of ORDER

    • getORDERAll

      public List<OUL_R24_ORDER> getORDERAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertORDER

      public void insertORDER(OUL_R24_ORDER structure, int rep) throws HL7Exception

      Inserts a specific repetition of ORDER (a Group object)

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

    • insertORDER

      public OUL_R24_ORDER insertORDER(int rep) throws HL7Exception

      Inserts a specific repetition of ORDER (a Group object)

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

    • removeORDER

      public OUL_R24_ORDER removeORDER(int rep) throws HL7Exception

      Removes a specific repetition of ORDER (a Group object)

      Throws:
      HL7Exception
      See Also:

    • getDSC

      public DSC getDSC()

      Returns DSC (Continuation Pointer) - creates it if necessary