Package ca.uhn.hl7v2.model.v23.segment

Class CM0

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v23.segment.CM0
All Implemented Interfaces:
Segment, Structure, Visitable, Serializable
public class CM0 extends AbstractSegment

Represents an HL7 CM0 message segment (Clinical Study Master). This segment has the following fields:

  • CM0-1: CM0 - Set ID (SI) optional
  • CM0-2: Sponsor Study ID (EI)
  • CM0-3: Alternate Study ID (CE) optional repeating
  • CM0-4: Title of Study (ST)
  • CM0-5: Chairman of Study (XCN) optional
  • CM0-6: Last IRB Approval Date (DT) optional
  • CM0-7: Total Accrual to Date (NM) optional
  • CM0-8: Last Accrual Date (DT) optional
  • CM0-9: Contact for Study (XCN) optional
  • CM0-10: Contact's Tel. Number (XTN) optional
  • CM0-11: Contact's Address (XAD) optional
See Also:

  • Constructor Details

  • Method Details

    • getCM0SetID

      public SI getCM0SetID()
      Returns CM0-1: "CM0 - Set ID" - creates it if necessary

    • getCm01_CM0SetID

      public SI getCm01_CM0SetID()
      Returns CM0-1: "CM0 - Set ID" - creates it if necessary

    • getSponsorStudyID

      public EI getSponsorStudyID()
      Returns CM0-2: "Sponsor Study ID" - creates it if necessary

    • getCm02_SponsorStudyID

      public EI getCm02_SponsorStudyID()
      Returns CM0-2: "Sponsor Study ID" - creates it if necessary

    • getAlternateStudyID

      public CE[] getAlternateStudyID()
      Returns all repetitions of Alternate Study ID (CM0-3).

    • getCm03_AlternateStudyID

      public CE[] getCm03_AlternateStudyID()
      Returns all repetitions of Alternate Study ID (CM0-3).

    • getAlternateStudyIDReps

      public int getAlternateStudyIDReps()
      Returns a count of the current number of repetitions of Alternate Study ID (CM0-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getAlternateStudyID

      public CE getAlternateStudyID(int rep)
      Returns a specific repetition of CM0-3: "Alternate Study ID" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCm03_AlternateStudyID

      public CE getCm03_AlternateStudyID(int rep)
      Returns a specific repetition of CM0-3: "Alternate Study ID" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getCm03_AlternateStudyIDReps

      public int getCm03_AlternateStudyIDReps()
      Returns a count of the current number of repetitions of Alternate Study ID (CM0-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertAlternateStudyID

      public CE insertAlternateStudyID(int rep) throws HL7Exception
      Inserts a repetition of CM0-3: "Alternate Study ID" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertCm03_AlternateStudyID

      public CE insertCm03_AlternateStudyID(int rep) throws HL7Exception
      Inserts a repetition of CM0-3: "Alternate Study ID" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeAlternateStudyID

      public CE removeAlternateStudyID(int rep) throws HL7Exception
      Removes a repetition of CM0-3: "Alternate Study ID" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeCm03_AlternateStudyID

      public CE removeCm03_AlternateStudyID(int rep) throws HL7Exception
      Removes a repetition of CM0-3: "Alternate Study ID" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • getTitleOfStudy

      public ST getTitleOfStudy()
      Returns CM0-4: "Title of Study" - creates it if necessary

    • getCm04_TitleOfStudy

      public ST getCm04_TitleOfStudy()
      Returns CM0-4: "Title of Study" - creates it if necessary

    • getChairmanOfStudy

      public XCN getChairmanOfStudy()
      Returns CM0-5: "Chairman of Study" - creates it if necessary

    • getCm05_ChairmanOfStudy

      public XCN getCm05_ChairmanOfStudy()
      Returns CM0-5: "Chairman of Study" - creates it if necessary

    • getLastIRBApprovalDate

      public DT getLastIRBApprovalDate()
      Returns CM0-6: "Last IRB Approval Date" - creates it if necessary

    • getCm06_LastIRBApprovalDate

      public DT getCm06_LastIRBApprovalDate()
      Returns CM0-6: "Last IRB Approval Date" - creates it if necessary

    • getTotalAccrualToDate

      public NM getTotalAccrualToDate()
      Returns CM0-7: "Total Accrual to Date" - creates it if necessary

    • getCm07_TotalAccrualToDate

      public NM getCm07_TotalAccrualToDate()
      Returns CM0-7: "Total Accrual to Date" - creates it if necessary

    • getLastAccrualDate

      public DT getLastAccrualDate()
      Returns CM0-8: "Last Accrual Date" - creates it if necessary

    • getCm08_LastAccrualDate

      public DT getCm08_LastAccrualDate()
      Returns CM0-8: "Last Accrual Date" - creates it if necessary

    • getContactForStudy

      public XCN getContactForStudy()
      Returns CM0-9: "Contact for Study" - creates it if necessary

    • getCm09_ContactForStudy

      public XCN getCm09_ContactForStudy()
      Returns CM0-9: "Contact for Study" - creates it if necessary

    • getContactSTelNumber

      public XTN getContactSTelNumber()
      Returns CM0-10: "Contact's Tel. Number" - creates it if necessary

    • getCm010_ContactSTelNumber

      public XTN getCm010_ContactSTelNumber()
      Returns CM0-10: "Contact's Tel. Number" - creates it if necessary

    • getContactSAddress

      public XAD getContactSAddress()
      Returns CM0-11: "Contact's Address" - creates it if necessary

    • getCm011_ContactSAddress

      public XAD getCm011_ContactSAddress()
      Returns CM0-11: "Contact's Address" - creates it if necessary

    • createNewTypeWithoutReflection

      protected Type createNewTypeWithoutReflection(int field)
      Overrides:
      createNewTypeWithoutReflection in class AbstractSegment