ca.uhn.hl7v2.model.v24.segment
Class CM0

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.CM0

All Implemented Interfaces:

Segment, Structure, Serializable

public class CM0
extends AbstractSegment

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

• CM0-1: Set ID - CM0 (SI) optional
• CM0-2: Sponsor Study ID (EI)
• CM0-3: Alternate Study ID (EI) optional repeating
• CM0-4: Title of Study (ST)
• CM0-5: Chairman of Study (XCN) optional repeating
• 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 repeating
• CM0-10: Contact's Telephone Number (XTN) optional
• CM0-11: Contact's Address (XAD) optional repeating

See Also:

Serialized Form

Constructor Summary

CM0(Group parent, ModelClassFactory factory)
Creates a new CM0 segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
EI[]	getAlternateStudyID() Returns all repetitions of Alternate Study ID (CM0-3).
EI	getAlternateStudyID(int rep) Returns a specific repetition of CM0-3: "Alternate Study ID" - creates it if necessary
int	getAlternateStudyIDReps() Returns a count of the current number of repetitions of Alternate Study ID (CM0-3).
XCN[]	getChairmanOfStudy() Returns all repetitions of Chairman of Study (CM0-5).
XCN	getChairmanOfStudy(int rep) Returns a specific repetition of CM0-5: "Chairman of Study" - creates it if necessary
int	getChairmanOfStudyReps() Returns a count of the current number of repetitions of Chairman of Study (CM0-5).
SI	getCm01_SetIDCM0() Returns CM0-1: "Set ID - CM0" - creates it if necessary
XTN	getCm010_ContactSTelephoneNumber() Returns CM0-10: "Contact's Telephone Number" - creates it if necessary
XAD	getCm011_ContactSAddress(int rep) Returns a specific repetition of CM0-11: "Contact's Address" - creates it if necessary
int	getCm011_ContactSAddressReps() Returns a count of the current number of repetitions of Contact's Address (CM0-11).
EI	getCm02_SponsorStudyID() Returns CM0-2: "Sponsor Study ID" - creates it if necessary
EI	getCm03_AlternateStudyID(int rep) Returns a specific repetition of CM0-3: "Alternate Study ID" - creates it if necessary
int	getCm03_AlternateStudyIDReps() Returns a count of the current number of repetitions of Alternate Study ID (CM0-3).
ST	getCm04_TitleOfStudy() Returns CM0-4: "Title of Study" - creates it if necessary
XCN	getCm05_ChairmanOfStudy(int rep) Returns a specific repetition of CM0-5: "Chairman of Study" - creates it if necessary
int	getCm05_ChairmanOfStudyReps() Returns a count of the current number of repetitions of Chairman of Study (CM0-5).
DT	getCm06_LastIRBApprovalDate() Returns CM0-6: "Last IRB Approval Date" - creates it if necessary
NM	getCm07_TotalAccrualToDate() Returns CM0-7: "Total Accrual to Date" - creates it if necessary
DT	getCm08_LastAccrualDate() Returns CM0-8: "Last Accrual Date" - creates it if necessary
XCN	getCm09_ContactForStudy(int rep) Returns a specific repetition of CM0-9: "Contact for Study" - creates it if necessary
int	getCm09_ContactForStudyReps() Returns a count of the current number of repetitions of Contact for Study (CM0-9).
XCN[]	getContactForStudy() Returns all repetitions of Contact for Study (CM0-9).
XCN	getContactForStudy(int rep) Returns a specific repetition of CM0-9: "Contact for Study" - creates it if necessary
int	getContactForStudyReps() Returns a count of the current number of repetitions of Contact for Study (CM0-9).
XAD[]	getContactSAddress() Returns all repetitions of Contact's Address (CM0-11).
XAD	getContactSAddress(int rep) Returns a specific repetition of CM0-11: "Contact's Address" - creates it if necessary
int	getContactSAddressReps() Returns a count of the current number of repetitions of Contact's Address (CM0-11).
XTN	getContactSTelephoneNumber() Returns CM0-10: "Contact's Telephone Number" - creates it if necessary
DT	getLastAccrualDate() Returns CM0-8: "Last Accrual Date" - creates it if necessary
DT	getLastIRBApprovalDate() Returns CM0-6: "Last IRB Approval Date" - creates it if necessary
SI	getSetIDCM0() Returns CM0-1: "Set ID - CM0" - creates it if necessary
EI	getSponsorStudyID() Returns CM0-2: "Sponsor Study ID" - creates it if necessary
ST	getTitleOfStudy() Returns CM0-4: "Title of Study" - creates it if necessary
NM	getTotalAccrualToDate() Returns CM0-7: "Total Accrual to Date" - creates it if necessary
EI	insertAlternateStudyID(int rep) Inserts a repetition of CM0-3: "Alternate Study ID" at a specific index
XCN	insertChairmanOfStudy(int rep) Inserts a repetition of CM0-5: "Chairman of Study" at a specific index
XAD	insertCm011_ContactSAddress(int rep) Inserts a repetition of CM0-11: "Contact's Address" at a specific index
EI	insertCm03_AlternateStudyID(int rep) Inserts a repetition of CM0-3: "Alternate Study ID" at a specific index
XCN	insertCm05_ChairmanOfStudy(int rep) Inserts a repetition of CM0-5: "Chairman of Study" at a specific index
XCN	insertCm09_ContactForStudy(int rep) Inserts a repetition of CM0-9: "Contact for Study" at a specific index
XCN	insertContactForStudy(int rep) Inserts a repetition of CM0-9: "Contact for Study" at a specific index
XAD	insertContactSAddress(int rep) Inserts a repetition of CM0-11: "Contact's Address" at a specific index
EI	removeAlternateStudyID(int rep) Removes a repetition of CM0-3: "Alternate Study ID" at a specific index
XCN	removeChairmanOfStudy(int rep) Removes a repetition of CM0-5: "Chairman of Study" at a specific index
XAD	removeCm011_ContactSAddress(int rep) Removes a repetition of CM0-11: "Contact's Address" at a specific index
EI	removeCm03_AlternateStudyID(int rep) Removes a repetition of CM0-3: "Alternate Study ID" at a specific index
XCN	removeCm05_ChairmanOfStudy(int rep) Removes a repetition of CM0-5: "Chairman of Study" at a specific index
XCN	removeCm09_ContactForStudy(int rep) Removes a repetition of CM0-9: "Contact for Study" at a specific index
XCN	removeContactForStudy(int rep) Removes a repetition of CM0-9: "Contact for Study" at a specific index
XAD	removeContactSAddress(int rep) Removes a repetition of CM0-11: "Contact's Address" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CM0

public CM0(Group parent,
           ModelClassFactory factory)

Creates a new CM0 segment

Method Detail

getSetIDCM0

public SI getSetIDCM0()

Returns CM0-1: "Set ID - CM0" - creates it if necessary

getCm01_SetIDCM0

public SI getCm01_SetIDCM0()

Returns CM0-1: "Set ID - CM0" - 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 EI[] getAlternateStudyID()

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 EI 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 EI 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 EI 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 EI 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 EI 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 EI 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 all repetitions of Chairman of Study (CM0-5).

getChairmanOfStudyReps

public int getChairmanOfStudyReps()

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

getChairmanOfStudy

public XCN getChairmanOfStudy(int rep)

Returns a specific repetition of CM0-5: "Chairman of Study" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCm05_ChairmanOfStudy

public XCN getCm05_ChairmanOfStudy(int rep)

Returns a specific repetition of CM0-5: "Chairman of Study" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCm05_ChairmanOfStudyReps

public int getCm05_ChairmanOfStudyReps()

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

insertChairmanOfStudy

public XCN insertChairmanOfStudy(int rep)
                          throws HL7Exception

Inserts a repetition of CM0-5: "Chairman of Study" 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)

insertCm05_ChairmanOfStudy

public XCN insertCm05_ChairmanOfStudy(int rep)
                               throws HL7Exception

Inserts a repetition of CM0-5: "Chairman of Study" 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)

removeChairmanOfStudy

public XCN removeChairmanOfStudy(int rep)
                          throws HL7Exception

Removes a repetition of CM0-5: "Chairman of Study" 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)

removeCm05_ChairmanOfStudy

public XCN removeCm05_ChairmanOfStudy(int rep)
                               throws HL7Exception

Removes a repetition of CM0-5: "Chairman of Study" 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)

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 all repetitions of Contact for Study (CM0-9).

getContactForStudyReps

public int getContactForStudyReps()

Returns a count of the current number of repetitions of Contact for Study (CM0-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getContactForStudy

public XCN getContactForStudy(int rep)

Returns a specific repetition of CM0-9: "Contact for Study" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCm09_ContactForStudy

public XCN getCm09_ContactForStudy(int rep)

Returns a specific repetition of CM0-9: "Contact for Study" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCm09_ContactForStudyReps

public int getCm09_ContactForStudyReps()

Returns a count of the current number of repetitions of Contact for Study (CM0-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertContactForStudy

public XCN insertContactForStudy(int rep)
                          throws HL7Exception

Inserts a repetition of CM0-9: "Contact for Study" 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)

insertCm09_ContactForStudy

public XCN insertCm09_ContactForStudy(int rep)
                               throws HL7Exception

Inserts a repetition of CM0-9: "Contact for Study" 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)

removeContactForStudy

public XCN removeContactForStudy(int rep)
                          throws HL7Exception

Removes a repetition of CM0-9: "Contact for Study" 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)

removeCm09_ContactForStudy

public XCN removeCm09_ContactForStudy(int rep)
                               throws HL7Exception

Removes a repetition of CM0-9: "Contact for Study" 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)

getContactSTelephoneNumber

public XTN getContactSTelephoneNumber()

Returns CM0-10: "Contact's Telephone Number" - creates it if necessary

getCm010_ContactSTelephoneNumber

public XTN getCm010_ContactSTelephoneNumber()

Returns CM0-10: "Contact's Telephone Number" - creates it if necessary

getContactSAddress

public XAD[] getContactSAddress()

Returns all repetitions of Contact's Address (CM0-11).

getContactSAddressReps

public int getContactSAddressReps()

Returns a count of the current number of repetitions of Contact's Address (CM0-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getContactSAddress

public XAD getContactSAddress(int rep)

Returns a specific repetition of CM0-11: "Contact's Address" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCm011_ContactSAddress

public XAD getCm011_ContactSAddress(int rep)

Returns a specific repetition of CM0-11: "Contact's Address" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCm011_ContactSAddressReps

public int getCm011_ContactSAddressReps()

Returns a count of the current number of repetitions of Contact's Address (CM0-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertContactSAddress

public XAD insertContactSAddress(int rep)
                          throws HL7Exception

Inserts a repetition of CM0-11: "Contact's Address" 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)

insertCm011_ContactSAddress

public XAD insertCm011_ContactSAddress(int rep)
                                throws HL7Exception

Inserts a repetition of CM0-11: "Contact's Address" 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)

removeContactSAddress

public XAD removeContactSAddress(int rep)
                          throws HL7Exception

Removes a repetition of CM0-11: "Contact's Address" 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)

removeCm011_ContactSAddress

public XAD removeCm011_ContactSAddress(int rep)
                                throws HL7Exception

Removes a repetition of CM0-11: "Contact's Address" 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)

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment