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.v26.message;
035
036import ca.uhn.hl7v2.model.v26.group.*;
037import ca.uhn.hl7v2.model.v26.segment.*;
038
039import java.util.List;
040
041import ca.uhn.hl7v2.HL7Exception;
042import ca.uhn.hl7v2.parser.ModelClassFactory;
043import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
044import ca.uhn.hl7v2.model.AbstractMessage;
045
046/**
047 * <p>Represents a PEX_P07 message structure (see chapter 7.11.1). This structure contains the 
048 * following elements: </p>
049 * <ul>
050                 * <li>1: MSH (Message Header) <b> </b></li>
051                 * <li>2: SFT (Software Segment) <b>optional repeating</b></li>
052                 * <li>3: UAC (User Authentication Credential Segment) <b>optional </b></li>
053                 * <li>4: EVN (Event Type) <b> </b></li>
054                 * <li>5: PID (Patient Identification) <b> </b></li>
055                 * <li>6: PD1 (Patient Additional Demographic) <b>optional </b></li>
056                 * <li>7: NTE (Notes and Comments) <b>optional repeating</b></li>
057                 * <li>8: PEX_P07_VISIT (a Group object) <b>optional </b></li>
058                 * <li>9: PEX_P07_EXPERIENCE (a Group object) <b> repeating</b></li>
059 * </ul>
060 */
061@SuppressWarnings("unused")
062public class PEX_P07 extends AbstractMessage  {
063
064    /**
065     * Creates a new PEX_P07 message with DefaultModelClassFactory. 
066     */ 
067    public PEX_P07() { 
068       this(new DefaultModelClassFactory());
069    }
070
071    /** 
072     * Creates a new PEX_P07 message with custom ModelClassFactory.
073     */
074    public PEX_P07(ModelClassFactory factory) {
075       super(factory);
076       init(factory);
077    }
078
079    private void init(ModelClassFactory factory) {
080       try {
081                          this.add(MSH.class, true, false);
082                          this.add(SFT.class, false, true);
083                          this.add(UAC.class, false, false);
084                          this.add(EVN.class, true, false);
085                          this.add(PID.class, true, false);
086                          this.add(PD1.class, false, false);
087                          this.add(NTE.class, false, true);
088                          this.add(PEX_P07_VISIT.class, false, false);
089                          this.add(PEX_P07_EXPERIENCE.class, true, true);
090       } catch(HL7Exception e) {
091          log.error("Unexpected error creating PEX_P07 - this is probably a bug in the source code generator.", e);
092       }
093    }
094
095    /** 
096     * Returns "2.6"
097     */
098    public String getVersion() {
099       return "2.6";
100    }
101
102
103
104    /**
105     * Returns
106     * MSH (Message Header) - creates it if necessary
107     */
108    public MSH getMSH() { 
109       return getTyped("MSH", MSH.class);
110    }
111
112
113
114
115    /**
116     * Returns
117     * the first repetition of 
118     * SFT (Software Segment) - creates it if necessary
119     */
120    public SFT getSFT() { 
121       return getTyped("SFT", SFT.class);
122    }
123
124
125    /**
126     * Returns a specific repetition of
127     * SFT (Software Segment) - creates it if necessary
128     *
129     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
130     * @throws HL7Exception if the repetition requested is more than one 
131     *     greater than the number of existing repetitions.
132     */
133    public SFT getSFT(int rep) { 
134       return getTyped("SFT", rep, SFT.class);
135    }
136
137    /** 
138     * Returns the number of existing repetitions of SFT 
139     */ 
140    public int getSFTReps() { 
141        return getReps("SFT");
142    } 
143
144    /** 
145     * <p>
146     * Returns a non-modifiable List containing all current existing repetitions of SFT.
147     * <p>
148     * <p>
149     * Note that unlike {@link #getSFT()}, 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 List<SFT> getSFTAll() throws HL7Exception {
154        return getAllAsList("SFT", SFT.class);
155    } 
156
157    /**
158     * Inserts a specific repetition of SFT (Software Segment)
159     * @see AbstractGroup#insertRepetition(Structure, int) 
160     */
161    public void insertSFT(SFT structure, int rep) throws HL7Exception { 
162       super.insertRepetition( "SFT", structure, rep);
163    }
164
165
166    /**
167     * Inserts a specific repetition of SFT (Software Segment)
168     * @see AbstractGroup#insertRepetition(Structure, int) 
169     */
170    public SFT insertSFT(int rep) throws HL7Exception { 
171       return (SFT)super.insertRepetition("SFT", rep);
172    }
173
174
175    /**
176     * Removes a specific repetition of SFT (Software Segment)
177     * @see AbstractGroup#removeRepetition(String, int) 
178     */
179    public SFT removeSFT(int rep) throws HL7Exception { 
180       return (SFT)super.removeRepetition("SFT", rep);
181    }
182
183
184
185    /**
186     * Returns
187     * UAC (User Authentication Credential Segment) - creates it if necessary
188     */
189    public UAC getUAC() { 
190       return getTyped("UAC", UAC.class);
191    }
192
193
194
195
196    /**
197     * Returns
198     * EVN (Event Type) - creates it if necessary
199     */
200    public EVN getEVN() { 
201       return getTyped("EVN", EVN.class);
202    }
203
204
205
206
207    /**
208     * Returns
209     * PID (Patient Identification) - creates it if necessary
210     */
211    public PID getPID() { 
212       return getTyped("PID", PID.class);
213    }
214
215
216
217
218    /**
219     * Returns
220     * PD1 (Patient Additional Demographic) - creates it if necessary
221     */
222    public PD1 getPD1() { 
223       return getTyped("PD1", PD1.class);
224    }
225
226
227
228
229    /**
230     * Returns
231     * the first repetition of 
232     * NTE (Notes and Comments) - creates it if necessary
233     */
234    public NTE getNTE() { 
235       return getTyped("NTE", NTE.class);
236    }
237
238
239    /**
240     * Returns a specific repetition of
241     * NTE (Notes and Comments) - creates it if necessary
242     *
243     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
244     * @throws HL7Exception if the repetition requested is more than one 
245     *     greater than the number of existing repetitions.
246     */
247    public NTE getNTE(int rep) { 
248       return getTyped("NTE", rep, NTE.class);
249    }
250
251    /** 
252     * Returns the number of existing repetitions of NTE 
253     */ 
254    public int getNTEReps() { 
255        return getReps("NTE");
256    } 
257
258    /** 
259     * <p>
260     * Returns a non-modifiable List containing all current existing repetitions of NTE.
261     * <p>
262     * <p>
263     * Note that unlike {@link #getNTE()}, this method will not create any reps
264     * if none are already present, so an empty list may be returned.
265     * </p>
266     */ 
267    public List<NTE> getNTEAll() throws HL7Exception {
268        return getAllAsList("NTE", NTE.class);
269    } 
270
271    /**
272     * Inserts a specific repetition of NTE (Notes and Comments)
273     * @see AbstractGroup#insertRepetition(Structure, int) 
274     */
275    public void insertNTE(NTE structure, int rep) throws HL7Exception { 
276       super.insertRepetition( "NTE", structure, rep);
277    }
278
279
280    /**
281     * Inserts a specific repetition of NTE (Notes and Comments)
282     * @see AbstractGroup#insertRepetition(Structure, int) 
283     */
284    public NTE insertNTE(int rep) throws HL7Exception { 
285       return (NTE)super.insertRepetition("NTE", rep);
286    }
287
288
289    /**
290     * Removes a specific repetition of NTE (Notes and Comments)
291     * @see AbstractGroup#removeRepetition(String, int) 
292     */
293    public NTE removeNTE(int rep) throws HL7Exception { 
294       return (NTE)super.removeRepetition("NTE", rep);
295    }
296
297
298
299    /**
300     * Returns
301     * VISIT (a Group object) - creates it if necessary
302     */
303    public PEX_P07_VISIT getVISIT() { 
304       return getTyped("VISIT", PEX_P07_VISIT.class);
305    }
306
307
308
309
310    /**
311     * Returns
312     * the first repetition of 
313     * EXPERIENCE (a Group object) - creates it if necessary
314     */
315    public PEX_P07_EXPERIENCE getEXPERIENCE() { 
316       return getTyped("EXPERIENCE", PEX_P07_EXPERIENCE.class);
317    }
318
319
320    /**
321     * Returns a specific repetition of
322     * EXPERIENCE (a Group object) - creates it if necessary
323     *
324     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
325     * @throws HL7Exception if the repetition requested is more than one 
326     *     greater than the number of existing repetitions.
327     */
328    public PEX_P07_EXPERIENCE getEXPERIENCE(int rep) { 
329       return getTyped("EXPERIENCE", rep, PEX_P07_EXPERIENCE.class);
330    }
331
332    /** 
333     * Returns the number of existing repetitions of EXPERIENCE 
334     */ 
335    public int getEXPERIENCEReps() { 
336        return getReps("EXPERIENCE");
337    } 
338
339    /** 
340     * <p>
341     * Returns a non-modifiable List containing all current existing repetitions of EXPERIENCE.
342     * <p>
343     * <p>
344     * Note that unlike {@link #getEXPERIENCE()}, this method will not create any reps
345     * if none are already present, so an empty list may be returned.
346     * </p>
347     */ 
348    public List<PEX_P07_EXPERIENCE> getEXPERIENCEAll() throws HL7Exception {
349        return getAllAsList("EXPERIENCE", PEX_P07_EXPERIENCE.class);
350    } 
351
352    /**
353     * Inserts a specific repetition of EXPERIENCE (a Group object)
354     * @see AbstractGroup#insertRepetition(Structure, int) 
355     */
356    public void insertEXPERIENCE(PEX_P07_EXPERIENCE structure, int rep) throws HL7Exception { 
357       super.insertRepetition( "EXPERIENCE", structure, rep);
358    }
359
360
361    /**
362     * Inserts a specific repetition of EXPERIENCE (a Group object)
363     * @see AbstractGroup#insertRepetition(Structure, int) 
364     */
365    public PEX_P07_EXPERIENCE insertEXPERIENCE(int rep) throws HL7Exception { 
366       return (PEX_P07_EXPERIENCE)super.insertRepetition("EXPERIENCE", rep);
367    }
368
369
370    /**
371     * Removes a specific repetition of EXPERIENCE (a Group object)
372     * @see AbstractGroup#removeRepetition(String, int) 
373     */
374    public PEX_P07_EXPERIENCE removeEXPERIENCE(int rep) throws HL7Exception { 
375       return (PEX_P07_EXPERIENCE)super.removeRepetition("EXPERIENCE", rep);
376    }
377
378
379
380}
381