View Javadoc
1   /*
2    * This class is an auto-generated source file for a HAPI
3    * HL7 v2.x standard structure class.
4    *
5    * For more information, visit: http://hl7api.sourceforge.net/
6    * 
7    * The contents of this file are subject to the Mozilla Public License Version 1.1 
8    * (the "License"); you may not use this file except in compliance with the License. 
9    * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
10   * Software distributed under the License is distributed on an "AS IS" basis, 
11   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
12   * specific language governing rights and limitations under the License. 
13   * 
14   * The Original Code is "[file_name]".  Description: 
15   * "[one_line_description]" 
16   * 
17   * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
18   * 2012.  All Rights Reserved. 
19   * 
20   * Contributor(s): ______________________________________. 
21   * 
22   * Alternatively, the contents of this file may be used under the terms of the 
23   * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
24   * applicable instead of those above.  If you wish to allow use of your version of this 
25   * file only under the terms of the GPL and not to allow others to use your version 
26   * of this file under the MPL, indicate your decision by deleting  the provisions above 
27   * and replace  them with the notice and other provisions required by the GPL License.  
28   * If you do not delete the provisions above, a recipient may use your version of 
29   * this file under either the MPL or the GPL. 
30   * 
31   */
32  
33  
34  package ca.uhn.hl7v2.model.v23.message;
35  
36  import ca.uhn.hl7v2.model.v23.group.*;
37  import ca.uhn.hl7v2.model.v23.segment.*;
38  
39  import ca.uhn.hl7v2.HL7Exception;
40  import ca.uhn.hl7v2.parser.ModelClassFactory;
41  import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
42  import ca.uhn.hl7v2.model.*;
43  
44  
45  /**
46   * <p>Represents a ADT_A37 message structure (see chapter ?). This structure contains the 
47   * following elements: </p>
48   * <ul>
49  		                 * <li>1: MSH (Message header segment) <b> </b> </li>
50  		                 * <li>2: EVN (Event type) <b> </b> </li>
51  		                 * <li>3: PID (Patient Identification) <b> </b> </li>
52  		                 * <li>4: PD1 (Patient Demographic) <b>optional </b> </li>
53  		                 * <li>5: PV1 (Patient visit) <b>optional </b> </li>
54  		                 * <li>6: DB1 (Disability Segment) <b>optional repeating</b> </li>
55  		                 * <li>7: PID (Patient Identification) <b> </b> </li>
56  		                 * <li>8: PV1 (Patient visit) <b>optional </b> </li>
57  		                 * <li>9: DB1 (Disability Segment) <b>optional repeating</b> </li>
58   * </ul>
59   */
60  //@SuppressWarnings("unused")
61  public class ADT_A37 extends AbstractMessage  {
62  
63      /**
64       * Creates a new ADT_A37 message with DefaultModelClassFactory. 
65       */ 
66      public ADT_A37() { 
67         this(new DefaultModelClassFactory());
68      }
69  
70      /** 
71       * Creates a new ADT_A37 message with custom ModelClassFactory.
72       */
73      public ADT_A37(ModelClassFactory factory) {
74         super(factory);
75         init(factory);
76      }
77  
78      private void init(ModelClassFactory factory) {
79         try {
80                            this.add(MSH.class, true, false);
81  	                          this.add(EVN.class, true, false);
82  	                          this.add(PID.class, true, false);
83  	                          this.add(PD1.class, false, false);
84  	                          this.add(PV1.class, false, false);
85  	                          this.add(DB1.class, false, true);
86  	                          this.add(PID.class, true, false);
87  	                          this.add(PV1.class, false, false);
88  	                          this.add(DB1.class, false, true);
89  	       } catch(HL7Exception e) {
90            log.error("Unexpected error creating ADT_A37 - this is probably a bug in the source code generator.", e);
91         }
92      }
93  
94  
95      /** 
96       * Returns "2.3"
97       */
98      public String getVersion() {
99         return "2.3";
100     }
101 
102 
103 
104 
105     /**
106      * <p>
107      * Returns
108      * MSH (Message header segment) - creates it if necessary
109      * </p>
110      * 
111      *
112      */
113     public MSH getMSH() { 
114        return getTyped("MSH", MSH.class);
115     }
116 
117 
118 
119 
120 
121     /**
122      * <p>
123      * Returns
124      * EVN (Event type) - creates it if necessary
125      * </p>
126      * 
127      *
128      */
129     public EVN getEVN() { 
130        return getTyped("EVN", EVN.class);
131     }
132 
133 
134 
135 
136 
137     /**
138      * <p>
139      * Returns
140      * PID (Patient Identification) - creates it if necessary
141      * </p>
142      * 
143      *
144      */
145     public PID getPID() { 
146        return getTyped("PID", PID.class);
147     }
148 
149 
150 
151 
152 
153     /**
154      * <p>
155      * Returns
156      * PD1 (Patient Demographic) - creates it if necessary
157      * </p>
158      * 
159      *
160      */
161     public PD1 getPD1() { 
162        return getTyped("PD1", PD1.class);
163     }
164 
165 
166 
167 
168 
169     /**
170      * <p>
171      * Returns
172      * PV1 (Patient visit) - creates it if necessary
173      * </p>
174      * 
175      *
176      */
177     public PV1 getPV1() { 
178        return getTyped("PV1", PV1.class);
179     }
180 
181 
182 
183 
184 
185     /**
186      * <p>
187      * Returns
188      * the first repetition of 
189      * DB1 (Disability Segment) - creates it if necessary
190      * </p>
191      * 
192      *
193      */
194     public DB1 getDB1() { 
195        return getTyped("DB1", DB1.class);
196     }
197 
198 
199     /**
200      * <p>
201      * Returns a specific repetition of
202      * DB1 (Disability Segment) - creates it if necessary
203      * </p>
204      * 
205      *
206      * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
207      * @throws HL7Exception if the repetition requested is more than one 
208      *     greater than the number of existing repetitions.
209      */
210     public DB1 getDB1(int rep) { 
211        return getTyped("DB1", rep, DB1.class);
212     }
213 
214     /** 
215      * <p>
216      * Returns the number of existing repetitions of DB1 
217      * </p>
218      * 
219      */ 
220     public int getDB1Reps() { 
221     	return getReps("DB1");
222     } 
223 
224     /** 
225      * <p>
226      * Returns a non-modifiable List containing all current existing repetitions of DB1.
227      * <p>
228      * <p>
229      * Note that unlike {@link #getDB1()}, this method will not create any reps
230      * if none are already present, so an empty list may be returned.
231      * </p>
232      * 
233      */ 
234     public java.util.List<DB1> getDB1All() throws HL7Exception {
235     	return getAllAsList("DB1", DB1.class);
236     } 
237 
238     /**
239      * <p>
240      * Inserts a specific repetition of DB1 (Disability Segment)
241      * </p>
242      * 
243      *
244      * @see AbstractGroup#insertRepetition(Structure, int) 
245      */
246     public void insertDB1(DB1 structure, int rep) throws HL7Exception { 
247        super.insertRepetition( "DB1", structure, rep);
248     }
249 
250 
251     /**
252      * <p>
253      * Inserts a specific repetition of DB1 (Disability Segment)
254      * </p>
255      * 
256      *
257      * @see AbstractGroup#insertRepetition(Structure, int) 
258      */
259     public DB1 insertDB1(int rep) throws HL7Exception { 
260        return (DB1)super.insertRepetition("DB1", rep);
261     }
262 
263 
264     /**
265      * <p>
266      * Removes a specific repetition of DB1 (Disability Segment)
267      * </p>
268      * 
269      *
270      * @see AbstractGroup#removeRepetition(String, int) 
271      */
272     public DB1 removeDB1(int rep) throws HL7Exception { 
273        return (DB1)super.removeRepetition("DB1", rep);
274     }
275 
276 
277 
278 
279     /**
280      * <p>
281      * Returns
282      * PID2 (Patient Identification) - creates it if necessary
283      * </p>
284      * 
285      *
286      */
287     public PID getPID2() { 
288        return getTyped("PID2", PID.class);
289     }
290 
291 
292 
293 
294 
295     /**
296      * <p>
297      * Returns
298      * PV12 (Patient visit) - creates it if necessary
299      * </p>
300      * 
301      *
302      */
303     public PV1 getPV12() { 
304        return getTyped("PV12", PV1.class);
305     }
306 
307 
308 
309 
310 
311     /**
312      * <p>
313      * Returns
314      * the first repetition of 
315      * DB12 (Disability Segment) - creates it if necessary
316      * </p>
317      * 
318      *
319      */
320     public DB1 getDB12() { 
321        return getTyped("DB12", DB1.class);
322     }
323 
324 
325     /**
326      * <p>
327      * Returns a specific repetition of
328      * DB12 (Disability Segment) - creates it if necessary
329      * </p>
330      * 
331      *
332      * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
333      * @throws HL7Exception if the repetition requested is more than one 
334      *     greater than the number of existing repetitions.
335      */
336     public DB1 getDB12(int rep) { 
337        return getTyped("DB12", rep, DB1.class);
338     }
339 
340     /** 
341      * <p>
342      * Returns the number of existing repetitions of DB12 
343      * </p>
344      * 
345      */ 
346     public int getDB12Reps() { 
347     	return getReps("DB12");
348     } 
349 
350     /** 
351      * <p>
352      * Returns a non-modifiable List containing all current existing repetitions of DB12.
353      * <p>
354      * <p>
355      * Note that unlike {@link #getDB12()}, this method will not create any reps
356      * if none are already present, so an empty list may be returned.
357      * </p>
358      * 
359      */ 
360     public java.util.List<DB1> getDB12All() throws HL7Exception {
361     	return getAllAsList("DB12", DB1.class);
362     } 
363 
364     /**
365      * <p>
366      * Inserts a specific repetition of DB12 (Disability Segment)
367      * </p>
368      * 
369      *
370      * @see AbstractGroup#insertRepetition(Structure, int) 
371      */
372     public void insertDB12(DB1 structure, int rep) throws HL7Exception { 
373        super.insertRepetition( "DB12", structure, rep);
374     }
375 
376 
377     /**
378      * <p>
379      * Inserts a specific repetition of DB12 (Disability Segment)
380      * </p>
381      * 
382      *
383      * @see AbstractGroup#insertRepetition(Structure, int) 
384      */
385     public DB1 insertDB12(int rep) throws HL7Exception { 
386        return (DB1)super.insertRepetition("DB12", rep);
387     }
388 
389 
390     /**
391      * <p>
392      * Removes a specific repetition of DB12 (Disability Segment)
393      * </p>
394      * 
395      *
396      * @see AbstractGroup#removeRepetition(String, int) 
397      */
398     public DB1 removeDB12(int rep) throws HL7Exception { 
399        return (DB1)super.removeRepetition("DB12", rep);
400     }
401 
402 
403 
404 }
405