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.v24.group;
035
036import ca.uhn.hl7v2.model.v24.segment.*;
037
038import java.util.List;
039
040import ca.uhn.hl7v2.HL7Exception;
041import ca.uhn.hl7v2.parser.ModelClassFactory;
042import ca.uhn.hl7v2.model.*;
043
044/**
045 * <p>Represents a CSU_C09_PATIENT group structure (a Group object).
046 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
047 * This Group contains the following elements:  
048 * </p>
049 * <ul>
050                 * <li>1: PID (Patient identification) <b> </b></li>
051                 * <li>2: PD1 (patient additional demographic) <b>optional </b></li>
052                 * <li>3: NTE (Notes and Comments) <b>optional repeating</b></li>
053                 * <li>4: CSU_C09_VISIT (a Group object) <b>optional </b></li>
054                 * <li>5: CSR (Clinical Study Registration) <b> </b></li>
055                 * <li>6: CSU_C09_STUDY_PHASE (a Group object) <b> repeating</b></li>
056 * </ul>
057 */
058@SuppressWarnings("unused")
059public class CSU_C09_PATIENT extends AbstractGroup {
060
061    /** 
062     * Creates a new CSU_C09_PATIENT group
063     */
064    public CSU_C09_PATIENT(Group parent, ModelClassFactory factory) {
065       super(parent, factory);
066       init(factory);
067    }
068
069    private void init(ModelClassFactory factory) {
070       try {
071                          this.add(PID.class, true, false);
072                          this.add(PD1.class, false, false);
073                          this.add(NTE.class, false, true);
074                          this.add(CSU_C09_VISIT.class, false, false);
075                          this.add(CSR.class, true, false);
076                          this.add(CSU_C09_STUDY_PHASE.class, true, true);
077       } catch(HL7Exception e) {
078          log.error("Unexpected error creating CSU_C09_PATIENT - this is probably a bug in the source code generator.", e);
079       }
080    }
081
082    /** 
083     * Returns "2.4"
084     */
085    public String getVersion() {
086       return "2.4";
087    }
088
089
090
091    /**
092     * Returns
093     * PID (Patient identification) - creates it if necessary
094     */
095    public PID getPID() { 
096       PID retVal = getTyped("PID", PID.class);
097       return retVal;
098    }
099
100
101
102
103    /**
104     * Returns
105     * PD1 (patient additional demographic) - creates it if necessary
106     */
107    public PD1 getPD1() { 
108       PD1 retVal = getTyped("PD1", PD1.class);
109       return retVal;
110    }
111
112
113
114
115    /**
116     * Returns
117     * the first repetition of 
118     * NTE (Notes and Comments) - creates it if necessary
119     */
120    public NTE getNTE() { 
121       NTE retVal = getTyped("NTE", NTE.class);
122       return retVal;
123    }
124
125
126    /**
127     * Returns a specific repetition of
128     * NTE (Notes and Comments) - creates it if necessary
129     *
130     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
131     * @throws HL7Exception if the repetition requested is more than one 
132     *     greater than the number of existing repetitions.
133     */
134    public NTE getNTE(int rep) { 
135       NTE retVal = getTyped("NTE", rep, NTE.class);
136       return retVal;
137    }
138
139    /** 
140     * Returns the number of existing repetitions of NTE 
141     */ 
142    public int getNTEReps() {  
143        return getReps("NTE");
144    } 
145
146    /** 
147     * <p>
148     * Returns a non-modifiable List containing all current existing repetitions of NTE.
149     * <p>
150     * <p>
151     * Note that unlike {@link #getNTE()}, this method will not create any reps
152     * if none are already present, so an empty list may be returned.
153     * </p>
154     */ 
155    public List<NTE> getNTEAll() throws HL7Exception {
156        return getAllAsList("NTE", NTE.class);
157    } 
158
159    /**
160     * Inserts a specific repetition of NTE (Notes and Comments)
161     * @see AbstractGroup#insertRepetition(Structure, int) 
162     */
163    public void insertNTE(NTE structure, int rep) throws HL7Exception { 
164       super.insertRepetition("NTE", structure, rep);
165    }
166
167
168    /**
169     * Inserts a specific repetition of NTE (Notes and Comments)
170     * @see AbstractGroup#insertRepetition(Structure, int) 
171     */
172    public NTE insertNTE(int rep) throws HL7Exception { 
173       return (NTE)super.insertRepetition("NTE", rep);
174    }
175
176
177    /**
178     * Removes a specific repetition of NTE (Notes and Comments)
179     * @see AbstractGroup#removeRepetition(String, int) 
180     */
181    public NTE removeNTE(int rep) throws HL7Exception { 
182       return (NTE)super.removeRepetition("NTE", rep);
183    }
184
185
186
187    /**
188     * Returns
189     * VISIT (a Group object) - creates it if necessary
190     */
191    public CSU_C09_VISIT getVISIT() { 
192       CSU_C09_VISIT retVal = getTyped("VISIT", CSU_C09_VISIT.class);
193       return retVal;
194    }
195
196
197
198
199    /**
200     * Returns
201     * CSR (Clinical Study Registration) - creates it if necessary
202     */
203    public CSR getCSR() { 
204       CSR retVal = getTyped("CSR", CSR.class);
205       return retVal;
206    }
207
208
209
210
211    /**
212     * Returns
213     * the first repetition of 
214     * STUDY_PHASE (a Group object) - creates it if necessary
215     */
216    public CSU_C09_STUDY_PHASE getSTUDY_PHASE() { 
217       CSU_C09_STUDY_PHASE retVal = getTyped("STUDY_PHASE", CSU_C09_STUDY_PHASE.class);
218       return retVal;
219    }
220
221
222    /**
223     * Returns a specific repetition of
224     * STUDY_PHASE (a Group object) - creates it if necessary
225     *
226     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
227     * @throws HL7Exception if the repetition requested is more than one 
228     *     greater than the number of existing repetitions.
229     */
230    public CSU_C09_STUDY_PHASE getSTUDY_PHASE(int rep) { 
231       CSU_C09_STUDY_PHASE retVal = getTyped("STUDY_PHASE", rep, CSU_C09_STUDY_PHASE.class);
232       return retVal;
233    }
234
235    /** 
236     * Returns the number of existing repetitions of STUDY_PHASE 
237     */ 
238    public int getSTUDY_PHASEReps() {  
239        return getReps("STUDY_PHASE");
240    } 
241
242    /** 
243     * <p>
244     * Returns a non-modifiable List containing all current existing repetitions of STUDY_PHASE.
245     * <p>
246     * <p>
247     * Note that unlike {@link #getSTUDY_PHASE()}, this method will not create any reps
248     * if none are already present, so an empty list may be returned.
249     * </p>
250     */ 
251    public List<CSU_C09_STUDY_PHASE> getSTUDY_PHASEAll() throws HL7Exception {
252        return getAllAsList("STUDY_PHASE", CSU_C09_STUDY_PHASE.class);
253    } 
254
255    /**
256     * Inserts a specific repetition of STUDY_PHASE (a Group object)
257     * @see AbstractGroup#insertRepetition(Structure, int) 
258     */
259    public void insertSTUDY_PHASE(CSU_C09_STUDY_PHASE structure, int rep) throws HL7Exception { 
260       super.insertRepetition("STUDY_PHASE", structure, rep);
261    }
262
263
264    /**
265     * Inserts a specific repetition of STUDY_PHASE (a Group object)
266     * @see AbstractGroup#insertRepetition(Structure, int) 
267     */
268    public CSU_C09_STUDY_PHASE insertSTUDY_PHASE(int rep) throws HL7Exception { 
269       return (CSU_C09_STUDY_PHASE)super.insertRepetition("STUDY_PHASE", rep);
270    }
271
272
273    /**
274     * Removes a specific repetition of STUDY_PHASE (a Group object)
275     * @see AbstractGroup#removeRepetition(String, int) 
276     */
277    public CSU_C09_STUDY_PHASE removeSTUDY_PHASE(int rep) throws HL7Exception { 
278       return (CSU_C09_STUDY_PHASE)super.removeRepetition("STUDY_PHASE", rep);
279    }
280
281
282
283}
284