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

Class CSU_C09_PATIENT

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

Represents a CSU_C09_PATIENT 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: PID (Patient identification)
  • 2: PD1 (patient additional demographic) optional
  • 3: NTE (Notes and Comments) optional repeating
  • 4: CSU_C09_VISIT (a Group object) optional
  • 5: CSR (Clinical Study Registration)
  • 6: CSU_C09_STUDY_PHASE (a Group object) repeating
See Also:

  • Constructor Details

  • Method Details

    • getVersion

      public String getVersion()
      Returns "2.4"

    • getPID

      public PID getPID()
      Returns PID (Patient identification) - creates it if necessary

    • getPD1

      public PD1 getPD1()
      Returns PD1 (patient additional demographic) - 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:

    • getVISIT

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

    • getCSR

      public CSR getCSR()
      Returns CSR (Clinical Study Registration) - creates it if necessary

    • getSTUDY_PHASE

      public CSU_C09_STUDY_PHASE getSTUDY_PHASE()
      Returns the first repetition of STUDY_PHASE (a Group object) - creates it if necessary

    • getSTUDY_PHASE

      public CSU_C09_STUDY_PHASE getSTUDY_PHASE(int rep)
      Returns a specific repetition of STUDY_PHASE (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.

    • getSTUDY_PHASEReps

      public int getSTUDY_PHASEReps()
      Returns the number of existing repetitions of STUDY_PHASE

    • getSTUDY_PHASEAll

      public List<CSU_C09_STUDY_PHASE> getSTUDY_PHASEAll() throws HL7Exception

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

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

      Throws:
      HL7Exception

    • insertSTUDY_PHASE

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

    • insertSTUDY_PHASE

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

    • removeSTUDY_PHASE

      public CSU_C09_STUDY_PHASE removeSTUDY_PHASE(int rep) throws HL7Exception
      Removes a specific repetition of STUDY_PHASE (a Group object)
      Throws:
      HL7Exception
      See Also: