Source code

001/*
002 * This class is an auto-generated source file for a HAPI
003 * HL7 v2.x standard structure class.
004 *
005 * For more information, visit: http://hl7api.sourceforge.net/
006 * 
007 * The contents of this file are subject to the Mozilla Public License Version 1.1 
008 * (the "License"); you may not use this file except in compliance with the License. 
009 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
010 * Software distributed under the License is distributed on an "AS IS" basis, 
011 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
012 * specific language governing rights and limitations under the License. 
013 * 
014 * The Original Code is "[file_name]".  Description: 
015 * "[one_line_description]" 
016 * 
017 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
018 * 2012.  All Rights Reserved. 
019 * 
020 * Contributor(s): ______________________________________. 
021 * 
022 * Alternatively, the contents of this file may be used under the terms of the 
023 * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
024 * applicable instead of those above.  If you wish to allow use of your version of this 
025 * file only under the terms of the GPL and not to allow others to use your version 
026 * of this file under the MPL, indicate your decision by deleting  the provisions above 
027 * and replace  them with the notice and other provisions required by the GPL License.  
028 * If you do not delete the provisions above, a recipient may use your version of 
029 * this file under either the MPL or the GPL. 
030 * 
031 */
032
033
034package ca.uhn.hl7v2.model.v23.group;
035
036import ca.uhn.hl7v2.model.v23.segment.*;
037
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a CSU_C11_PATIENT group structure (a Group object).
044 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
045 * This Group contains the following elements:  
046 * </p>
047 * <ul>
048                         * <li>1: PID (Patient Identification) <b>  </b></li>
049                         * <li>2: PD1 (Patient Demographic) <b>optional  </b></li>
050                         * <li>3: NTE (Notes and comments segment) <b>optional repeating </b></li>
051                         * <li>4: CSU_C11_VISIT (a Group object) <b>optional  </b></li>
052                         * <li>5: CSR (Clinical Study Registration) <b>  </b></li>
053                         * <li>6: CSU_C11_STUDY_PHASE (a Group object) <b> repeating </b></li>
054 * </ul>
055 */
056//@SuppressWarnings("unused")
057public class CSU_C11_PATIENT extends AbstractGroup {
058
059    /** 
060     * Creates a new CSU_C11_PATIENT group
061     */
062    public CSU_C11_PATIENT(Group parent, ModelClassFactory factory) {
063       super(parent, factory);
064       init(factory);
065    }
066
067    private void init(ModelClassFactory factory) {
068       try {
069                                  this.add(PID.class, true, false, false);
070                                  this.add(PD1.class, false, false, false);
071                                  this.add(NTE.class, false, true, false);
072                                  this.add(CSU_C11_VISIT.class, false, false, false);
073                                  this.add(CSR.class, true, false, false);
074                                  this.add(CSU_C11_STUDY_PHASE.class, true, true, false);
075       } catch(HL7Exception e) {
076          log.error("Unexpected error creating CSU_C11_PATIENT - this is probably a bug in the source code generator.", e);
077       }
078    }
079
080    /** 
081     * Returns "2.3"
082     */
083    public String getVersion() {
084       return "2.3";
085    }
086
087
088
089    /**
090     * Returns
091     * PID (Patient Identification) - creates it if necessary
092     */
093    public PID getPID() { 
094       PID retVal = getTyped("PID", PID.class);
095       return retVal;
096    }
097
098
099
100
101    /**
102     * Returns
103     * PD1 (Patient Demographic) - creates it if necessary
104     */
105    public PD1 getPD1() { 
106       PD1 retVal = getTyped("PD1", PD1.class);
107       return retVal;
108    }
109
110
111
112
113    /**
114     * Returns
115     * the first repetition of 
116     * NTE (Notes and comments segment) - creates it if necessary
117     */
118    public NTE getNTE() { 
119       NTE retVal = getTyped("NTE", NTE.class);
120       return retVal;
121    }
122
123
124    /**
125     * Returns a specific repetition of
126     * NTE (Notes and comments segment) - creates it if necessary
127     *
128     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
129     * @throws HL7Exception if the repetition requested is more than one 
130     *     greater than the number of existing repetitions.
131     */
132    public NTE getNTE(int rep) { 
133       NTE retVal = getTyped("NTE", rep, NTE.class);
134       return retVal;
135    }
136
137    /** 
138     * Returns the number of existing repetitions of NTE 
139     */ 
140    public int getNTEReps() {  
141        return getReps("NTE");
142    } 
143
144    /** 
145     * <p>
146     * Returns a non-modifiable List containing all current existing repetitions of NTE.
147     * <p>
148     * <p>
149     * Note that unlike {@link #getNTE()}, this method will not create any reps
150     * if none are already present, so an empty list may be returned.
151     * </p>
152     */ 
153    public java.util.List<NTE> getNTEAll() throws HL7Exception {
154        return getAllAsList("NTE", NTE.class);
155    } 
156
157    /**
158     * Inserts a specific repetition of NTE (Notes and comments segment)
159     * @see AbstractGroup#insertRepetition(Structure, int) 
160     */
161    public void insertNTE(NTE structure, int rep) throws HL7Exception { 
162       super.insertRepetition("NTE", structure, rep);
163    }
164
165
166    /**
167     * Inserts a specific repetition of NTE (Notes and comments segment)
168     * @see AbstractGroup#insertRepetition(Structure, int) 
169     */
170    public NTE insertNTE(int rep) throws HL7Exception { 
171       return (NTE)super.insertRepetition("NTE", rep);
172    }
173
174
175    /**
176     * Removes a specific repetition of NTE (Notes and comments segment)
177     * @see AbstractGroup#removeRepetition(String, int) 
178     */
179    public NTE removeNTE(int rep) throws HL7Exception { 
180       return (NTE)super.removeRepetition("NTE", rep);
181    }
182
183
184
185    /**
186     * Returns
187     * VISIT (a Group object) - creates it if necessary
188     */
189    public CSU_C11_VISIT getVISIT() { 
190       CSU_C11_VISIT retVal = getTyped("VISIT", CSU_C11_VISIT.class);
191       return retVal;
192    }
193
194
195
196
197    /**
198     * Returns
199     * CSR (Clinical Study Registration) - creates it if necessary
200     */
201    public CSR getCSR() { 
202       CSR retVal = getTyped("CSR", CSR.class);
203       return retVal;
204    }
205
206
207
208
209    /**
210     * Returns
211     * the first repetition of 
212     * STUDY_PHASE (a Group object) - creates it if necessary
213     */
214    public CSU_C11_STUDY_PHASE getSTUDY_PHASE() { 
215       CSU_C11_STUDY_PHASE retVal = getTyped("STUDY_PHASE", CSU_C11_STUDY_PHASE.class);
216       return retVal;
217    }
218
219
220    /**
221     * Returns a specific repetition of
222     * STUDY_PHASE (a Group object) - creates it if necessary
223     *
224     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
225     * @throws HL7Exception if the repetition requested is more than one 
226     *     greater than the number of existing repetitions.
227     */
228    public CSU_C11_STUDY_PHASE getSTUDY_PHASE(int rep) { 
229       CSU_C11_STUDY_PHASE retVal = getTyped("STUDY_PHASE", rep, CSU_C11_STUDY_PHASE.class);
230       return retVal;
231    }
232
233    /** 
234     * Returns the number of existing repetitions of STUDY_PHASE 
235     */ 
236    public int getSTUDY_PHASEReps() {  
237        return getReps("STUDY_PHASE");
238    } 
239
240    /** 
241     * <p>
242     * Returns a non-modifiable List containing all current existing repetitions of STUDY_PHASE.
243     * <p>
244     * <p>
245     * Note that unlike {@link #getSTUDY_PHASE()}, this method will not create any reps
246     * if none are already present, so an empty list may be returned.
247     * </p>
248     */ 
249    public java.util.List<CSU_C11_STUDY_PHASE> getSTUDY_PHASEAll() throws HL7Exception {
250        return getAllAsList("STUDY_PHASE", CSU_C11_STUDY_PHASE.class);
251    } 
252
253    /**
254     * Inserts a specific repetition of STUDY_PHASE (a Group object)
255     * @see AbstractGroup#insertRepetition(Structure, int) 
256     */
257    public void insertSTUDY_PHASE(CSU_C11_STUDY_PHASE structure, int rep) throws HL7Exception { 
258       super.insertRepetition("STUDY_PHASE", structure, rep);
259    }
260
261
262    /**
263     * Inserts a specific repetition of STUDY_PHASE (a Group object)
264     * @see AbstractGroup#insertRepetition(Structure, int) 
265     */
266    public CSU_C11_STUDY_PHASE insertSTUDY_PHASE(int rep) throws HL7Exception { 
267       return (CSU_C11_STUDY_PHASE)super.insertRepetition("STUDY_PHASE", rep);
268    }
269
270
271    /**
272     * Removes a specific repetition of STUDY_PHASE (a Group object)
273     * @see AbstractGroup#removeRepetition(String, int) 
274     */
275    public CSU_C11_STUDY_PHASE removeSTUDY_PHASE(int rep) throws HL7Exception { 
276       return (CSU_C11_STUDY_PHASE)super.removeRepetition("STUDY_PHASE", rep);
277    }
278
279
280
281}
282