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

Class ORF_R04

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

Represents a ORF_R04 message structure (see chapter 7.3.3). This structure contains the following elements:

  • 1: MSH (Message Header)
  • 2: SFT (Software Segment) optional repeating
  • 3: MSA (Message Acknowledgment)
  • 4: QRD (Original-Style Query Definition)
  • 5: QRF (Original style query filter) optional
  • 6: ORF_R04_QUERY_RESPONSE (a Group object) repeating
  • 7: ERR (Error) optional repeating
  • 8: QAK (Query Acknowledgment) optional
  • 9: DSC (Continuation Pointer) optional
See Also:

  • Constructor Details

    • ORF_R04

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

    • ORF_R04

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

    • getMSA

      public MSA getMSA()

      Returns MSA (Message Acknowledgment) - creates it if necessary

    • getQRD

      public QRD getQRD()

      Returns QRD (Original-Style Query Definition) - creates it if necessary

    • getQRF

      public QRF getQRF()

      Returns QRF (Original style query filter) - creates it if necessary

    • getQUERY_RESPONSE

      public ORF_R04_QUERY_RESPONSE getQUERY_RESPONSE()

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

    • getQUERY_RESPONSE

      public ORF_R04_QUERY_RESPONSE getQUERY_RESPONSE(int rep)

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

    • getQUERY_RESPONSEReps

      public int getQUERY_RESPONSEReps()

      Returns the number of existing repetitions of QUERY_RESPONSE

    • getQUERY_RESPONSEAll

      public List<ORF_R04_QUERY_RESPONSE> getQUERY_RESPONSEAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertQUERY_RESPONSE

      public void insertQUERY_RESPONSE(ORF_R04_QUERY_RESPONSE structure, int rep) throws HL7Exception

      Inserts a specific repetition of QUERY_RESPONSE (a Group object)

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

    • insertQUERY_RESPONSE

      public ORF_R04_QUERY_RESPONSE insertQUERY_RESPONSE(int rep) throws HL7Exception

      Inserts a specific repetition of QUERY_RESPONSE (a Group object)

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

    • removeQUERY_RESPONSE

      public ORF_R04_QUERY_RESPONSE removeQUERY_RESPONSE(int rep) throws HL7Exception

      Removes a specific repetition of QUERY_RESPONSE (a Group object)

      Throws:
      HL7Exception
      See Also:

    • getERR

      public ERR getERR()

      Returns the first repetition of ERR (Error) - creates it if necessary

    • getERR

      public ERR getERR(int rep)

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

    • getERRReps

      public int getERRReps()

      Returns the number of existing repetitions of ERR

    • getERRAll

      public List<ERR> getERRAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertERR

      public void insertERR(ERR structure, int rep) throws HL7Exception

      Inserts a specific repetition of ERR (Error)

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

    • insertERR

      public ERR insertERR(int rep) throws HL7Exception

      Inserts a specific repetition of ERR (Error)

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

    • removeERR

      public ERR removeERR(int rep) throws HL7Exception

      Removes a specific repetition of ERR (Error)

      Throws:
      HL7Exception
      See Also:

    • getQAK

      public QAK getQAK()

      Returns QAK (Query Acknowledgment) - creates it if necessary

    • getDSC

      public DSC getDSC()

      Returns DSC (Continuation Pointer) - creates it if necessary