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