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

Class OUL_R23

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_R23
All Implemented Interfaces:
Group, Message, Structure, Visitable, Serializable
public class OUL_R23 extends AbstractMessage

Represents a OUL_R23 message structure (see chapter 7.3.8). This structure contains the following elements:

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

  • Constructor Details

    • OUL_R23

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

    • OUL_R23

      public OUL_R23(ModelClassFactory factory)
      Creates a new OUL_R23 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_R23_PATIENT getPATIENT()

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

    • getVISIT

      public OUL_R23_VISIT getVISIT()

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

    • getSPECIMEN

      public OUL_R23_SPECIMEN getSPECIMEN()

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

    • getSPECIMEN

      public OUL_R23_SPECIMEN getSPECIMEN(int rep)

      Returns a specific repetition of SPECIMEN (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.

    • getSPECIMENReps

      public int getSPECIMENReps()

      Returns the number of existing repetitions of SPECIMEN

    • getSPECIMENAll

      public List<OUL_R23_SPECIMEN> getSPECIMENAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertSPECIMEN

      public void insertSPECIMEN(OUL_R23_SPECIMEN structure, int rep) throws HL7Exception

      Inserts a specific repetition of SPECIMEN (a Group object)

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

    • insertSPECIMEN

      public OUL_R23_SPECIMEN insertSPECIMEN(int rep) throws HL7Exception

      Inserts a specific repetition of SPECIMEN (a Group object)

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

    • removeSPECIMEN

      public OUL_R23_SPECIMEN removeSPECIMEN(int rep) throws HL7Exception

      Removes a specific repetition of SPECIMEN (a Group object)

      Throws:
      HL7Exception
      See Also:

    • getDSC

      public DSC getDSC()

      Returns DSC (Continuation Pointer) - creates it if necessary