Package ca.uhn.hl7v2.model.v22.group

Class ORM_O01_ORDER_DETAIL

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractGroup
ca.uhn.hl7v2.model.v22.group.ORM_O01_ORDER_DETAIL
All Implemented Interfaces:
Group, Structure, Visitable, Serializable
public class ORM_O01_ORDER_DETAIL extends AbstractGroup

Represents a ORM_O01_ORDER_DETAIL group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

  • 1: OBR (OBSERVATION REQUEST) choice
  • 2: RQD (REQUISITION DETAIL) choice
  • 3: RQ1 (REQUISITION DETAIL-!) choice
  • 4: RXO (PHARMACY PRESCRIPTION ORDER) choice
  • 5: ODS (DIETARY ORDERS, SUPPLEMENTS, and PREFERENCES) choice
  • 6: ODT (DIET TRAY INSTRUCTION) choice
  • 7: NTE (NOTES AND COMMENTS) optional repeating
  • 8: OBX (OBSERVATION RESULT) optional repeating
  • 9: NTE (NOTES AND COMMENTS) repeating

Note that this structure has "choice" elements. This means that one of the structures above marked as "choice" must be present, but no more than one.

See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.2"

    • getOBR

      public OBR getOBR()
      Returns OBR (OBSERVATION REQUEST) - creates it if necessary

    • getRQD

      public RQD getRQD()
      Returns RQD (REQUISITION DETAIL) - creates it if necessary

    • getRQ1

      public RQ1 getRQ1()
      Returns RQ1 (REQUISITION DETAIL-!) - creates it if necessary

    • getRXO

      public RXO getRXO()
      Returns RXO (PHARMACY PRESCRIPTION ORDER) - creates it if necessary

    • getODS

      public ODS getODS()
      Returns ODS (DIETARY ORDERS, SUPPLEMENTS, and PREFERENCES) - creates it if necessary

    • getODT

      public ODT getODT()
      Returns ODT (DIET TRAY INSTRUCTION) - creates it if necessary

    • getNTE

      public NTE getNTE()
      Returns the first repetition of NTE (NOTES AND COMMENTS) - creates it if necessary

    • getNTE

      public NTE getNTE(int rep)
      Returns a specific repetition of NTE (NOTES AND COMMENTS) - 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.

    • getNTEReps

      public int getNTEReps()
      Returns the number of existing repetitions of NTE

    • getNTEAll

      public List<NTE> getNTEAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertNTE

      public void insertNTE(NTE structure, int rep) throws HL7Exception
      Inserts a specific repetition of NTE (NOTES AND COMMENTS)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertNTE

      public NTE insertNTE(int rep) throws HL7Exception
      Inserts a specific repetition of NTE (NOTES AND COMMENTS)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeNTE

      public NTE removeNTE(int rep) throws HL7Exception
      Removes a specific repetition of NTE (NOTES AND COMMENTS)
      Throws:
      HL7Exception
      See Also:

    • getOBX

      public OBX getOBX()
      Returns the first repetition of OBX (OBSERVATION RESULT) - creates it if necessary

    • getOBX

      public OBX getOBX(int rep)
      Returns a specific repetition of OBX (OBSERVATION RESULT) - 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.

    • getOBXReps

      public int getOBXReps()
      Returns the number of existing repetitions of OBX

    • getOBXAll

      public List<OBX> getOBXAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertOBX

      public void insertOBX(OBX structure, int rep) throws HL7Exception
      Inserts a specific repetition of OBX (OBSERVATION RESULT)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertOBX

      public OBX insertOBX(int rep) throws HL7Exception
      Inserts a specific repetition of OBX (OBSERVATION RESULT)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeOBX

      public OBX removeOBX(int rep) throws HL7Exception
      Removes a specific repetition of OBX (OBSERVATION RESULT)
      Throws:
      HL7Exception
      See Also:

    • getNTE2

      public NTE getNTE2()
      Returns the first repetition of NTE2 (NOTES AND COMMENTS) - creates it if necessary

    • getNTE2

      public NTE getNTE2(int rep)
      Returns a specific repetition of NTE (NOTES AND COMMENTS) - 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.

    • getNTE2Reps

      public int getNTE2Reps()
      Returns the number of existing repetitions of NTE2

    • getNTE2All

      public List<NTE> getNTE2All() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertNTE2

      public void insertNTE2(NTE structure, int rep) throws HL7Exception
      Inserts a specific repetition of NTE2 (NOTES AND COMMENTS)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertNTE2

      public NTE insertNTE2(int rep) throws HL7Exception
      Inserts a specific repetition of NTE2 (NOTES AND COMMENTS)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeNTE2

      public NTE removeNTE2(int rep) throws HL7Exception
      Removes a specific repetition of NTE2 (NOTES AND COMMENTS)
      Throws:
      HL7Exception
      See Also: