/*
    * This class is an auto-generated source file for a HAPI
    * HL7 v2.x standard structure class.
    *
    * For more information, visit: http://hl7api.sourceforge.net/
    * 
    * The contents of this file are subject to the Mozilla Public License Version 1.1 
    * (the "License"); you may not use this file except in compliance with the License. 
    * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
   * Software distributed under the License is distributed on an "AS IS" basis, 
   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
   * specific language governing rights and limitations under the License. 
   * 
   * The Original Code is "[file_name]".  Description: 
   * "[one_line_description]" 
   * 
   * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
   * 2012.  All Rights Reserved. 
   * 
   * Contributor(s): ______________________________________. 
   * 
   * Alternatively, the contents of this file may be used under the terms of the 
   * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
   * applicable instead of those above.  If you wish to allow use of your version of this 
   * file only under the terms of the GPL and not to allow others to use your version 
   * of this file under the MPL, indicate your decision by deleting  the provisions above 
   * and replace  them with the notice and other provisions required by the GPL License.  
   * If you do not delete the provisions above, a recipient may use your version of 
   * this file under either the MPL or the GPL. 
   * 
   */
  
  
  package ca.uhn.hl7v2.model.v23.segment;
  
  // import ca.uhn.hl7v2.model.v23.group.*;
  import ca.uhn.hl7v2.model.v23.datatype.*;
  import ca.uhn.hl7v2.HL7Exception;
  import ca.uhn.hl7v2.parser.ModelClassFactory;
  import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
  import ca.uhn.hl7v2.model.AbstractMessage;
  import ca.uhn.hl7v2.model.Group;
  import ca.uhn.hl7v2.model.Type;
  import ca.uhn.hl7v2.model.AbstractSegment;
  import ca.uhn.hl7v2.model.Varies;
  
  
  /**
   *<p>Represents an HL7 CSR message segment (Clinical Study Registration). 
   * This segment has the following fields:</p>
   * <ul>
       * <li>CSR-1: Sponsor Study ID (EI) <b> </b>
       * <li>CSR-2: Alternate Study ID (EI) <b>optional </b>
       * <li>CSR-3: Institution Registering the Patient (CE) <b>optional </b>
       * <li>CSR-4: Sponsor Patient ID (CX) <b> </b>
       * <li>CSR-5: Alternate Patient ID (CX) <b>optional </b>
       * <li>CSR-6: Date/Time of Patient Study Registration (TS) <b>optional </b>
       * <li>CSR-7: Person Performing Study Registration (XCN) <b>optional </b>
       * <li>CSR-8: Study Authorizing Provider (XCN) <b> </b>
       * <li>CSR-9: Date/time Patient Study Consent Signed (TS) <b>optional </b>
       * <li>CSR-10: Patient Study Eligibility Status (CE) <b>optional </b>
       * <li>CSR-11: Study Randomization Date/time (TS) <b>optional repeating</b>
       * <li>CSR-12: Study Randomized Arm (CE) <b>optional repeating</b>
       * <li>CSR-13: Stratum for Study Randomization (CE) <b>optional repeating</b>
       * <li>CSR-14: Patient Evaluability Status (CE) <b>optional </b>
       * <li>CSR-15: Date/time Ended Study (TS) <b>optional </b>
       * <li>CSR-16: Reason Ended Study (CE) <b>optional </b>
   * </ul>
   */
  @SuppressWarnings("unused")
  public class CSR extends AbstractSegment {
  
      /** 
       * Creates a new CSR segment
       */
      public CSR(Group parent, ModelClassFactory factory) {
         super(parent, factory);
         init(factory);
      }
  
      private void init(ModelClassFactory factory) {
         try {
                                    this.add(EI.class, true, 1, 60, new Object[]{ getMessage() }, "Sponsor Study ID");
                                    this.add(EI.class, false, 1, 60, new Object[]{ getMessage() }, "Alternate Study ID");
                                    this.add(CE.class, false, 1, 60, new Object[]{ getMessage() }, "Institution Registering the Patient");
                                    this.add(CX.class, true, 1, 30, new Object[]{ getMessage() }, "Sponsor Patient ID");
                                    this.add(CX.class, false, 1, 30, new Object[]{ getMessage() }, "Alternate Patient ID");
                                    this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Date/Time of Patient Study Registration");
                                    this.add(XCN.class, false, 1, 60, new Object[]{ getMessage() }, "Person Performing Study Registration");
                                    this.add(XCN.class, true, 1, 60, new Object[]{ getMessage() }, "Study Authorizing Provider");
                                    this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Date/time Patient Study Consent Signed");
                                    this.add(CE.class, false, 1, 60, new Object[]{ getMessage() }, "Patient Study Eligibility Status");
                                    this.add(TS.class, false, 3, 26, new Object[]{ getMessage() }, "Study Randomization Date/time");
                                    this.add(CE.class, false, 3, 200, new Object[]{ getMessage() }, "Study Randomized Arm");
                                    this.add(CE.class, false, 3, 200, new Object[]{ getMessage() }, "Stratum for Study Randomization");
                                    this.add(CE.class, false, 1, 60, new Object[]{ getMessage() }, "Patient Evaluability Status");
                                    this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Date/time Ended Study");
                                    this.add(CE.class, false, 1, 60, new Object[]{ getMessage() }, "Reason Ended Study");
         } catch(HL7Exception e) {
           log.error("Unexpected error creating CSR - this is probably a bug in the source code generator.", e);
        }
     }
 
 
 
     /**
      * Returns
      * CSR-1: "Sponsor Study ID" - creates it if necessary
      */
     public EI getSponsorStudyID() { 
 		EI retVal = this.getTypedField(1, 0);
 		return retVal;
     }
     
     /**
      * Returns
      * CSR-1: "Sponsor Study ID" - creates it if necessary
      */
     public EI getCsr1_SponsorStudyID() { 
 		EI retVal = this.getTypedField(1, 0);
 		return retVal;
     }
 
 
 
     /**
      * Returns
      * CSR-2: "Alternate Study ID" - creates it if necessary
      */
     public EI getAlternateStudyID() { 
 		EI retVal = this.getTypedField(2, 0);
 		return retVal;
     }
     
     /**
      * Returns
      * CSR-2: "Alternate Study ID" - creates it if necessary
      */
     public EI getCsr2_AlternateStudyID() { 
 		EI retVal = this.getTypedField(2, 0);
 		return retVal;
     }
 
 
 
     /**
      * Returns
      * CSR-3: "Institution Registering the Patient" - creates it if necessary
      */
     public CE getInstitutionRegisteringThePatient() { 
 		CE retVal = this.getTypedField(3, 0);
 		return retVal;
     }
     
     /**
      * Returns
      * CSR-3: "Institution Registering the Patient" - creates it if necessary
      */
     public CE getCsr3_InstitutionRegisteringThePatient() { 
 		CE retVal = this.getTypedField(3, 0);
 		return retVal;
     }
 
 
 
     /**
      * Returns
      * CSR-4: "Sponsor Patient ID" - creates it if necessary
      */
     public CX getSponsorPatientID() { 
 		CX retVal = this.getTypedField(4, 0);
 		return retVal;
     }
     
     /**
      * Returns
      * CSR-4: "Sponsor Patient ID" - creates it if necessary
      */
     public CX getCsr4_SponsorPatientID() { 
 		CX retVal = this.getTypedField(4, 0);
 		return retVal;
     }
 
 
 
     /**
      * Returns
      * CSR-5: "Alternate Patient ID" - creates it if necessary
      */
     public CX getAlternatePatientID() { 
 		CX retVal = this.getTypedField(5, 0);
 		return retVal;
     }
     
     /**
      * Returns
      * CSR-5: "Alternate Patient ID" - creates it if necessary
      */
     public CX getCsr5_AlternatePatientID() { 
 		CX retVal = this.getTypedField(5, 0);
 		return retVal;
     }
 
 
 
     /**
      * Returns
      * CSR-6: "Date/Time of Patient Study Registration" - creates it if necessary
      */
     public TS getDateTimeOfPatientStudyRegistration() { 
 		TS retVal = this.getTypedField(6, 0);
 		return retVal;
     }
     
     /**
      * Returns
      * CSR-6: "Date/Time of Patient Study Registration" - creates it if necessary
      */
     public TS getCsr6_DateTimeOfPatientStudyRegistration() { 
 		TS retVal = this.getTypedField(6, 0);
 		return retVal;
     }
 
 
 
     /**
      * Returns
      * CSR-7: "Person Performing Study Registration" - creates it if necessary
      */
     public XCN getPersonPerformingStudyRegistration() { 
 		XCN retVal = this.getTypedField(7, 0);
 		return retVal;
     }
     
     /**
      * Returns
      * CSR-7: "Person Performing Study Registration" - creates it if necessary
      */
     public XCN getCsr7_PersonPerformingStudyRegistration() { 
 		XCN retVal = this.getTypedField(7, 0);
 		return retVal;
     }
 
 
 
     /**
      * Returns
      * CSR-8: "Study Authorizing Provider" - creates it if necessary
      */
     public XCN getStudyAuthorizingProvider() { 
 		XCN retVal = this.getTypedField(8, 0);
 		return retVal;
     }
     
     /**
      * Returns
      * CSR-8: "Study Authorizing Provider" - creates it if necessary
      */
     public XCN getCsr8_StudyAuthorizingProvider() { 
 		XCN retVal = this.getTypedField(8, 0);
 		return retVal;
     }
 
 
 
     /**
      * Returns
      * CSR-9: "Date/time Patient Study Consent Signed" - creates it if necessary
      */
     public TS getDateTimePatientStudyConsentSigned() { 
 		TS retVal = this.getTypedField(9, 0);
 		return retVal;
     }
     
     /**
      * Returns
      * CSR-9: "Date/time Patient Study Consent Signed" - creates it if necessary
      */
     public TS getCsr9_DateTimePatientStudyConsentSigned() { 
 		TS retVal = this.getTypedField(9, 0);
 		return retVal;
     }
 
 
 
     /**
      * Returns
      * CSR-10: "Patient Study Eligibility Status" - creates it if necessary
      */
     public CE getPatientStudyEligibilityStatus() { 
 		CE retVal = this.getTypedField(10, 0);
 		return retVal;
     }
     
     /**
      * Returns
      * CSR-10: "Patient Study Eligibility Status" - creates it if necessary
      */
     public CE getCsr10_PatientStudyEligibilityStatus() { 
 		CE retVal = this.getTypedField(10, 0);
 		return retVal;
     }
 
 
     /**
      * Returns all repetitions of Study Randomization Date/time (CSR-11).
      */
     public TS[] getStudyRandomizationDateTime() {
     	TS[] retVal = this.getTypedField(11, new TS[0]);
     	return retVal;
     }
 
 
     /**
      * Returns all repetitions of Study Randomization Date/time (CSR-11).
      */
     public TS[] getCsr11_StudyRandomizationDateTime() {
     	TS[] retVal = this.getTypedField(11, new TS[0]);
     	return retVal;
     }
 
 
     /**
      * Returns a count of the current number of repetitions of Study Randomization Date/time (CSR-11).
      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
      * it will return zero.
      */
     public int getStudyRandomizationDateTimeReps() {
     	return this.getReps(11);
     }
 
 
     /**
      * Returns a specific repetition of
      * CSR-11: "Study Randomization Date/time" - creates it if necessary
      *
      * @param rep The repetition index (0-indexed)
      */
     public TS getStudyRandomizationDateTime(int rep) { 
 		TS retVal = this.getTypedField(11, rep);
 		return retVal;
     }
 
     /**
      * Returns a specific repetition of
      * CSR-11: "Study Randomization Date/time" - creates it if necessary
      *
      * @param rep The repetition index (0-indexed)
      */
     public TS getCsr11_StudyRandomizationDateTime(int rep) { 
 		TS retVal = this.getTypedField(11, rep);
 		return retVal;
     }
 
     /**
      * Returns a count of the current number of repetitions of Study Randomization Date/time (CSR-11).
      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
      * it will return zero.
      */
     public int getCsr11_StudyRandomizationDateTimeReps() {
     	return this.getReps(11);
     }
 
 
     /**
      * Inserts a repetition of
      * CSR-11: "Study Randomization Date/time" at a specific index
      *
      * @param rep The repetition index (0-indexed)
      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
      */
     public TS insertStudyRandomizationDateTime(int rep) throws HL7Exception { 
         return (TS) super.insertRepetition(11, rep);
     }
 
 
     /**
      * Inserts a repetition of
      * CSR-11: "Study Randomization Date/time" at a specific index
      *
      * @param rep The repetition index (0-indexed)
      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
      */
     public TS insertCsr11_StudyRandomizationDateTime(int rep) throws HL7Exception { 
         return (TS) super.insertRepetition(11, rep);
     }
 
 
     /**
      * Removes a repetition of
      * CSR-11: "Study Randomization Date/time" at a specific index
      *
      * @param rep The repetition index (0-indexed)
      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
      */
     public TS removeStudyRandomizationDateTime(int rep) throws HL7Exception { 
         return (TS) super.removeRepetition(11, rep);
     }
 
 
     /**
      * Removes a repetition of
      * CSR-11: "Study Randomization Date/time" at a specific index
      *
      * @param rep The repetition index (0-indexed)
      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
      */
     public TS removeCsr11_StudyRandomizationDateTime(int rep) throws HL7Exception { 
         return (TS) super.removeRepetition(11, rep);
     }
 
 
 
     /**
      * Returns all repetitions of Study Randomized Arm (CSR-12).
      */
     public CE[] getStudyRandomizedArm() {
     	CE[] retVal = this.getTypedField(12, new CE[0]);
     	return retVal;
     }
 
 
     /**
      * Returns all repetitions of Study Randomized Arm (CSR-12).
      */
     public CE[] getCsr12_StudyRandomizedArm() {
     	CE[] retVal = this.getTypedField(12, new CE[0]);
     	return retVal;
     }
 
 
     /**
      * Returns a count of the current number of repetitions of Study Randomized Arm (CSR-12).
      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
      * it will return zero.
      */
     public int getStudyRandomizedArmReps() {
     	return this.getReps(12);
     }
 
 
     /**
      * Returns a specific repetition of
      * CSR-12: "Study Randomized Arm" - creates it if necessary
      *
      * @param rep The repetition index (0-indexed)
      */
     public CE getStudyRandomizedArm(int rep) { 
 		CE retVal = this.getTypedField(12, rep);
 		return retVal;
     }
 
     /**
      * Returns a specific repetition of
      * CSR-12: "Study Randomized Arm" - creates it if necessary
      *
      * @param rep The repetition index (0-indexed)
      */
     public CE getCsr12_StudyRandomizedArm(int rep) { 
 		CE retVal = this.getTypedField(12, rep);
 		return retVal;
     }
 
     /**
      * Returns a count of the current number of repetitions of Study Randomized Arm (CSR-12).
      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
      * it will return zero.
      */
     public int getCsr12_StudyRandomizedArmReps() {
     	return this.getReps(12);
     }
 
 
     /**
      * Inserts a repetition of
      * CSR-12: "Study Randomized Arm" at a specific index
      *
      * @param rep The repetition index (0-indexed)
      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
      */
     public CE insertStudyRandomizedArm(int rep) throws HL7Exception { 
         return (CE) super.insertRepetition(12, rep);
     }
 
 
     /**
      * Inserts a repetition of
      * CSR-12: "Study Randomized Arm" at a specific index
      *
      * @param rep The repetition index (0-indexed)
      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
      */
     public CE insertCsr12_StudyRandomizedArm(int rep) throws HL7Exception { 
         return (CE) super.insertRepetition(12, rep);
     }
 
 
     /**
      * Removes a repetition of
      * CSR-12: "Study Randomized Arm" at a specific index
      *
      * @param rep The repetition index (0-indexed)
      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
      */
     public CE removeStudyRandomizedArm(int rep) throws HL7Exception { 
         return (CE) super.removeRepetition(12, rep);
     }
 
 
     /**
      * Removes a repetition of
      * CSR-12: "Study Randomized Arm" at a specific index
      *
      * @param rep The repetition index (0-indexed)
      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
      */
     public CE removeCsr12_StudyRandomizedArm(int rep) throws HL7Exception { 
         return (CE) super.removeRepetition(12, rep);
     }
 
 
 
     /**
      * Returns all repetitions of Stratum for Study Randomization (CSR-13).
      */
     public CE[] getStratumForStudyRandomization() {
     	CE[] retVal = this.getTypedField(13, new CE[0]);
     	return retVal;
     }
 
 
     /**
      * Returns all repetitions of Stratum for Study Randomization (CSR-13).
      */
     public CE[] getCsr13_StratumForStudyRandomization() {
     	CE[] retVal = this.getTypedField(13, new CE[0]);
     	return retVal;
     }
 
 
     /**
      * Returns a count of the current number of repetitions of Stratum for Study Randomization (CSR-13).
      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
      * it will return zero.
      */
     public int getStratumForStudyRandomizationReps() {
     	return this.getReps(13);
     }
 
 
     /**
      * Returns a specific repetition of
      * CSR-13: "Stratum for Study Randomization" - creates it if necessary
      *
      * @param rep The repetition index (0-indexed)
      */
     public CE getStratumForStudyRandomization(int rep) { 
 		CE retVal = this.getTypedField(13, rep);
 		return retVal;
     }
 
     /**
      * Returns a specific repetition of
      * CSR-13: "Stratum for Study Randomization" - creates it if necessary
      *
      * @param rep The repetition index (0-indexed)
      */
     public CE getCsr13_StratumForStudyRandomization(int rep) { 
 		CE retVal = this.getTypedField(13, rep);
 		return retVal;
     }
 
     /**
      * Returns a count of the current number of repetitions of Stratum for Study Randomization (CSR-13).
      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
      * it will return zero.
      */
     public int getCsr13_StratumForStudyRandomizationReps() {
     	return this.getReps(13);
     }
 
 
     /**
      * Inserts a repetition of
      * CSR-13: "Stratum for Study Randomization" at a specific index
      *
      * @param rep The repetition index (0-indexed)
      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
      */
     public CE insertStratumForStudyRandomization(int rep) throws HL7Exception { 
         return (CE) super.insertRepetition(13, rep);
     }
 
 
     /**
      * Inserts a repetition of
      * CSR-13: "Stratum for Study Randomization" at a specific index
      *
      * @param rep The repetition index (0-indexed)
      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
      */
     public CE insertCsr13_StratumForStudyRandomization(int rep) throws HL7Exception { 
         return (CE) super.insertRepetition(13, rep);
     }
 
 
     /**
      * Removes a repetition of
      * CSR-13: "Stratum for Study Randomization" at a specific index
      *
      * @param rep The repetition index (0-indexed)
      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
      */
     public CE removeStratumForStudyRandomization(int rep) throws HL7Exception { 
         return (CE) super.removeRepetition(13, rep);
     }
 
 
     /**
      * Removes a repetition of
      * CSR-13: "Stratum for Study Randomization" at a specific index
      *
      * @param rep The repetition index (0-indexed)
      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
      */
     public CE removeCsr13_StratumForStudyRandomization(int rep) throws HL7Exception { 
         return (CE) super.removeRepetition(13, rep);
     }
 
 
 
 
     /**
      * Returns
      * CSR-14: "Patient Evaluability Status" - creates it if necessary
      */
     public CE getPatientEvaluabilityStatus() { 
 		CE retVal = this.getTypedField(14, 0);
 		return retVal;
     }
     
     /**
      * Returns
      * CSR-14: "Patient Evaluability Status" - creates it if necessary
      */
     public CE getCsr14_PatientEvaluabilityStatus() { 
 		CE retVal = this.getTypedField(14, 0);
 		return retVal;
     }
 
 
 
     /**
      * Returns
      * CSR-15: "Date/time Ended Study" - creates it if necessary
      */
     public TS getDateTimeEndedStudy() { 
 		TS retVal = this.getTypedField(15, 0);
 		return retVal;
     }
     
     /**
      * Returns
      * CSR-15: "Date/time Ended Study" - creates it if necessary
      */
     public TS getCsr15_DateTimeEndedStudy() { 
 		TS retVal = this.getTypedField(15, 0);
 		return retVal;
     }
 
 
 
     /**
      * Returns
      * CSR-16: "Reason Ended Study" - creates it if necessary
      */
     public CE getReasonEndedStudy() { 
 		CE retVal = this.getTypedField(16, 0);
 		return retVal;
     }
     
     /**
      * Returns
      * CSR-16: "Reason Ended Study" - creates it if necessary
      */
     public CE getCsr16_ReasonEndedStudy() { 
 		CE retVal = this.getTypedField(16, 0);
 		return retVal;
     }
 
 
 
 
 
     /** {@inheritDoc} */   
     protected Type createNewTypeWithoutReflection(int field) {
        switch (field) {
           case 0: return new EI(getMessage());
           case 1: return new EI(getMessage());
           case 2: return new CE(getMessage());
           case 3: return new CX(getMessage());
           case 4: return new CX(getMessage());
           case 5: return new TS(getMessage());
           case 6: return new XCN(getMessage());
           case 7: return new XCN(getMessage());
           case 8: return new TS(getMessage());
           case 9: return new CE(getMessage());
           case 10: return new TS(getMessage());
           case 11: return new CE(getMessage());
           case 12: return new CE(getMessage());
           case 13: return new CE(getMessage());
           case 14: return new TS(getMessage());
           case 15: return new CE(getMessage());
           default: return null;
        }
    }
 
 
 }