Package ca.uhn.hl7v2.model.v24.group

Class PPG_PCG_PATHWAY

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

Represents a PPG_PCG_PATHWAY 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: PTH (Pathway)
  • 2: NTE (Notes and Comments) optional repeating
  • 3: VAR (Variance) optional repeating
  • 4: PPG_PCG_PATHWAY_ROLE (a Group object) optional repeating
  • 5: PPG_PCG_GOAL (a Group object) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.4"

    • getPTH

      public PTH getPTH()
      Returns PTH (Pathway) - 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:

    • getVAR

      public VAR getVAR()
      Returns the first repetition of VAR (Variance) - creates it if necessary

    • getVAR

      public VAR getVAR(int rep)
      Returns a specific repetition of VAR (Variance) - 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.

    • getVARReps

      public int getVARReps()
      Returns the number of existing repetitions of VAR

    • getVARAll

      public List<VAR> getVARAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertVAR

      public void insertVAR(VAR structure, int rep) throws HL7Exception
      Inserts a specific repetition of VAR (Variance)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • insertVAR

      public VAR insertVAR(int rep) throws HL7Exception
      Inserts a specific repetition of VAR (Variance)
      Throws:
      HL7Exception
      See Also:
      • AbstractGroup#insertRepetition(Structure, int)

    • removeVAR

      public VAR removeVAR(int rep) throws HL7Exception
      Removes a specific repetition of VAR (Variance)
      Throws:
      HL7Exception
      See Also:

    • getPATHWAY_ROLE

      public PPG_PCG_PATHWAY_ROLE getPATHWAY_ROLE()
      Returns the first repetition of PATHWAY_ROLE (a Group object) - creates it if necessary

    • getPATHWAY_ROLE

      public PPG_PCG_PATHWAY_ROLE getPATHWAY_ROLE(int rep)
      Returns a specific repetition of PATHWAY_ROLE (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.

    • getPATHWAY_ROLEReps

      public int getPATHWAY_ROLEReps()
      Returns the number of existing repetitions of PATHWAY_ROLE

    • getPATHWAY_ROLEAll

      public List<PPG_PCG_PATHWAY_ROLE> getPATHWAY_ROLEAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertPATHWAY_ROLE

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

    • insertPATHWAY_ROLE

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

    • removePATHWAY_ROLE

      public PPG_PCG_PATHWAY_ROLE removePATHWAY_ROLE(int rep) throws HL7Exception
      Removes a specific repetition of PATHWAY_ROLE (a Group object)
      Throws:
      HL7Exception
      See Also:

    • getGOAL

      public PPG_PCG_GOAL getGOAL()
      Returns the first repetition of GOAL (a Group object) - creates it if necessary

    • getGOAL

      public PPG_PCG_GOAL getGOAL(int rep)
      Returns a specific repetition of GOAL (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.

    • getGOALReps

      public int getGOALReps()
      Returns the number of existing repetitions of GOAL

    • getGOALAll

      public List<PPG_PCG_GOAL> getGOALAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertGOAL

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

    • insertGOAL

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

    • removeGOAL

      public PPG_PCG_GOAL removeGOAL(int rep) throws HL7Exception
      Removes a specific repetition of GOAL (a Group object)
      Throws:
      HL7Exception
      See Also: