Package ca.uhn.hl7v2.model.v23.group

Class PEX_P08_PEX_CAUSE

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

Represents a PEX_P08_PEX_CAUSE 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: PCR (Possible Causal Relationship)
  • 2: PEX_P08_RX_ORDER (a Group object) optional
  • 3: PEX_P08_RX_ADMINISTRATION (a Group object) optional repeating
  • 4: PRB (Problem Detail) optional repeating
  • 5: OBX (Observation segment) optional repeating
  • 6: NTE (Notes and comments segment) optional repeating
  • 7: PEX_P08_ASSOCIATED_PERSON (a Group object) optional
  • 8: PEX_P08_STUDY (a Group object) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.3"

    • getPCR

      public PCR getPCR()
      Returns PCR (Possible Causal Relationship) - creates it if necessary

    • getRX_ORDER

      public PEX_P08_RX_ORDER getRX_ORDER()
      Returns RX_ORDER (a Group object) - creates it if necessary

    • getRX_ADMINISTRATION

      public PEX_P08_RX_ADMINISTRATION getRX_ADMINISTRATION()
      Returns the first repetition of RX_ADMINISTRATION (a Group object) - creates it if necessary

    • getRX_ADMINISTRATION

      public PEX_P08_RX_ADMINISTRATION getRX_ADMINISTRATION(int rep)
      Returns a specific repetition of RX_ADMINISTRATION (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.

    • getRX_ADMINISTRATIONReps

      public int getRX_ADMINISTRATIONReps()
      Returns the number of existing repetitions of RX_ADMINISTRATION

    • getRX_ADMINISTRATIONAll

      public List<PEX_P08_RX_ADMINISTRATION> getRX_ADMINISTRATIONAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertRX_ADMINISTRATION

      public void insertRX_ADMINISTRATION(PEX_P08_RX_ADMINISTRATION structure, int rep) throws HL7Exception
      Inserts a specific repetition of RX_ADMINISTRATION (a Group object)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertRX_ADMINISTRATION

      public PEX_P08_RX_ADMINISTRATION insertRX_ADMINISTRATION(int rep) throws HL7Exception
      Inserts a specific repetition of RX_ADMINISTRATION (a Group object)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeRX_ADMINISTRATION

      public PEX_P08_RX_ADMINISTRATION removeRX_ADMINISTRATION(int rep) throws HL7Exception
      Removes a specific repetition of RX_ADMINISTRATION (a Group object)
      Throws:
      HL7Exception
      See Also:

    • getPRB

      public PRB getPRB()
      Returns the first repetition of PRB (Problem Detail) - creates it if necessary

    • getPRB

      public PRB getPRB(int rep)
      Returns a specific repetition of PRB (Problem Detail) - 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.

    • getPRBReps

      public int getPRBReps()
      Returns the number of existing repetitions of PRB

    • getPRBAll

      public List<PRB> getPRBAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertPRB

      public void insertPRB(PRB structure, int rep) throws HL7Exception
      Inserts a specific repetition of PRB (Problem Detail)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertPRB

      public PRB insertPRB(int rep) throws HL7Exception
      Inserts a specific repetition of PRB (Problem Detail)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removePRB

      public PRB removePRB(int rep) throws HL7Exception
      Removes a specific repetition of PRB (Problem Detail)
      Throws:
      HL7Exception
      See Also:

    • getOBX

      public OBX getOBX()
      Returns the first repetition of OBX (Observation segment) - creates it if necessary

    • getOBX

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

    • 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 segment)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertOBX

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

    • removeOBX

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

    • getNTE

      public NTE getNTE()
      Returns the first repetition of NTE (Notes and comments segment) - creates it if necessary

    • getNTE

      public NTE getNTE(int rep)
      Returns a specific repetition of NTE (Notes and comments 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.

    • 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 segment)
      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 segment)
      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 segment)
      Throws:
      HL7Exception
      See Also:

    • getASSOCIATED_PERSON

      public PEX_P08_ASSOCIATED_PERSON getASSOCIATED_PERSON()
      Returns ASSOCIATED_PERSON (a Group object) - creates it if necessary

    • getSTUDY

      public PEX_P08_STUDY getSTUDY()
      Returns the first repetition of STUDY (a Group object) - creates it if necessary

    • getSTUDY

      public PEX_P08_STUDY getSTUDY(int rep)
      Returns a specific repetition of STUDY (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.

    • getSTUDYReps

      public int getSTUDYReps()
      Returns the number of existing repetitions of STUDY

    • getSTUDYAll

      public List<PEX_P08_STUDY> getSTUDYAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertSTUDY

      public void insertSTUDY(PEX_P08_STUDY structure, int rep) throws HL7Exception
      Inserts a specific repetition of STUDY (a Group object)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertSTUDY

      public PEX_P08_STUDY insertSTUDY(int rep) throws HL7Exception
      Inserts a specific repetition of STUDY (a Group object)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeSTUDY

      public PEX_P08_STUDY removeSTUDY(int rep) throws HL7Exception
      Removes a specific repetition of STUDY (a Group object)
      Throws:
      HL7Exception
      See Also: