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.v25.segment;
35  
36  // import ca.uhn.hl7v2.model.v25.group.*;
37  import ca.uhn.hl7v2.model.v25.datatype.*;
38  import ca.uhn.hl7v2.HL7Exception;
39  import ca.uhn.hl7v2.parser.ModelClassFactory;
40  import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
41  import ca.uhn.hl7v2.model.AbstractMessage;
42  import ca.uhn.hl7v2.model.Group;
43  import ca.uhn.hl7v2.model.Type;
44  import ca.uhn.hl7v2.model.AbstractSegment;
45  import ca.uhn.hl7v2.model.Varies;
46  
47  
48  /**
49   *<p>Represents an HL7 MRG message segment (Merge Patient Information). 
50   * This segment has the following fields:</p>
51   * <ul>
52       * <li>MRG-1: Prior Patient Identifier List (CX) <b> repeating</b>
53       * <li>MRG-2: Prior Alternate Patient ID (CX) <b>optional repeating</b>
54       * <li>MRG-3: Prior Patient Account Number (CX) <b>optional </b>
55       * <li>MRG-4: Prior Patient ID (CX) <b>optional </b>
56       * <li>MRG-5: Prior Visit Number (CX) <b>optional </b>
57       * <li>MRG-6: Prior Alternate Visit ID (CX) <b>optional </b>
58       * <li>MRG-7: Prior Patient Name (XPN) <b>optional repeating</b>
59   * </ul>
60   */
61  @SuppressWarnings("unused")
62  public class MRG extends AbstractSegment {
63  
64      /** 
65       * Creates a new MRG segment
66       */
67      public MRG(Group parent, ModelClassFactory factory) {
68         super(parent, factory);
69         init(factory);
70      }
71  
72      private void init(ModelClassFactory factory) {
73         try {
74                                    this.add(CX.class, true, 0, 250, new Object[]{ getMessage() }, "Prior Patient Identifier List");
75                                    this.add(CX.class, false, 0, 250, new Object[]{ getMessage() }, "Prior Alternate Patient ID");
76                                    this.add(CX.class, false, 1, 250, new Object[]{ getMessage() }, "Prior Patient Account Number");
77                                    this.add(CX.class, false, 1, 250, new Object[]{ getMessage() }, "Prior Patient ID");
78                                    this.add(CX.class, false, 1, 250, new Object[]{ getMessage() }, "Prior Visit Number");
79                                    this.add(CX.class, false, 1, 250, new Object[]{ getMessage() }, "Prior Alternate Visit ID");
80                                    this.add(XPN.class, false, 0, 250, new Object[]{ getMessage() }, "Prior Patient Name");
81         } catch(HL7Exception e) {
82            log.error("Unexpected error creating MRG - this is probably a bug in the source code generator.", e);
83         }
84      }
85  
86  
87      /**
88       * Returns all repetitions of Prior Patient Identifier List (MRG-1).
89       */
90      public CX[] getPriorPatientIdentifierList() {
91      	CX[] retVal = this.getTypedField(1, new CX[0]);
92      	return retVal;
93      }
94  
95  
96      /**
97       * Returns all repetitions of Prior Patient Identifier List (MRG-1).
98       */
99      public CX[] getMrg1_PriorPatientIdentifierList() {
100     	CX[] retVal = this.getTypedField(1, new CX[0]);
101     	return retVal;
102     }
103 
104 
105     /**
106      * Returns a count of the current number of repetitions of Prior Patient Identifier List (MRG-1).
107      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
108      * it will return zero.
109      */
110     public int getPriorPatientIdentifierListReps() {
111     	return this.getReps(1);
112     }
113 
114 
115     /**
116      * Returns a specific repetition of
117      * MRG-1: "Prior Patient Identifier List" - creates it if necessary
118      *
119      * @param rep The repetition index (0-indexed)
120      */
121     public CX getPriorPatientIdentifierList(int rep) { 
122 		CX retVal = this.getTypedField(1, rep);
123 		return retVal;
124     }
125 
126     /**
127      * Returns a specific repetition of
128      * MRG-1: "Prior Patient Identifier List" - creates it if necessary
129      *
130      * @param rep The repetition index (0-indexed)
131      */
132     public CX getMrg1_PriorPatientIdentifierList(int rep) { 
133 		CX retVal = this.getTypedField(1, rep);
134 		return retVal;
135     }
136 
137     /**
138      * Returns a count of the current number of repetitions of Prior Patient Identifier List (MRG-1).
139      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
140      * it will return zero.
141      */
142     public int getMrg1_PriorPatientIdentifierListReps() {
143     	return this.getReps(1);
144     }
145 
146 
147     /**
148      * Inserts a repetition of
149      * MRG-1: "Prior Patient Identifier List" at a specific index
150      *
151      * @param rep The repetition index (0-indexed)
152      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
153      */
154     public CX insertPriorPatientIdentifierList(int rep) throws HL7Exception { 
155         return (CX) super.insertRepetition(1, rep);
156     }
157 
158 
159     /**
160      * Inserts a repetition of
161      * MRG-1: "Prior Patient Identifier List" at a specific index
162      *
163      * @param rep The repetition index (0-indexed)
164      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
165      */
166     public CX insertMrg1_PriorPatientIdentifierList(int rep) throws HL7Exception { 
167         return (CX) super.insertRepetition(1, rep);
168     }
169 
170 
171     /**
172      * Removes a repetition of
173      * MRG-1: "Prior Patient Identifier List" at a specific index
174      *
175      * @param rep The repetition index (0-indexed)
176      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
177      */
178     public CX removePriorPatientIdentifierList(int rep) throws HL7Exception { 
179         return (CX) super.removeRepetition(1, rep);
180     }
181 
182 
183     /**
184      * Removes a repetition of
185      * MRG-1: "Prior Patient Identifier List" at a specific index
186      *
187      * @param rep The repetition index (0-indexed)
188      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
189      */
190     public CX removeMrg1_PriorPatientIdentifierList(int rep) throws HL7Exception { 
191         return (CX) super.removeRepetition(1, rep);
192     }
193 
194 
195 
196     /**
197      * Returns all repetitions of Prior Alternate Patient ID (MRG-2).
198      */
199     public CX[] getPriorAlternatePatientID() {
200     	CX[] retVal = this.getTypedField(2, new CX[0]);
201     	return retVal;
202     }
203 
204 
205     /**
206      * Returns all repetitions of Prior Alternate Patient ID (MRG-2).
207      */
208     public CX[] getMrg2_PriorAlternatePatientID() {
209     	CX[] retVal = this.getTypedField(2, new CX[0]);
210     	return retVal;
211     }
212 
213 
214     /**
215      * Returns a count of the current number of repetitions of Prior Alternate Patient ID (MRG-2).
216      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
217      * it will return zero.
218      */
219     public int getPriorAlternatePatientIDReps() {
220     	return this.getReps(2);
221     }
222 
223 
224     /**
225      * Returns a specific repetition of
226      * MRG-2: "Prior Alternate Patient ID" - creates it if necessary
227      *
228      * @param rep The repetition index (0-indexed)
229      */
230     public CX getPriorAlternatePatientID(int rep) { 
231 		CX retVal = this.getTypedField(2, rep);
232 		return retVal;
233     }
234 
235     /**
236      * Returns a specific repetition of
237      * MRG-2: "Prior Alternate Patient ID" - creates it if necessary
238      *
239      * @param rep The repetition index (0-indexed)
240      */
241     public CX getMrg2_PriorAlternatePatientID(int rep) { 
242 		CX retVal = this.getTypedField(2, rep);
243 		return retVal;
244     }
245 
246     /**
247      * Returns a count of the current number of repetitions of Prior Alternate Patient ID (MRG-2).
248      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
249      * it will return zero.
250      */
251     public int getMrg2_PriorAlternatePatientIDReps() {
252     	return this.getReps(2);
253     }
254 
255 
256     /**
257      * Inserts a repetition of
258      * MRG-2: "Prior Alternate Patient ID" at a specific index
259      *
260      * @param rep The repetition index (0-indexed)
261      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
262      */
263     public CX insertPriorAlternatePatientID(int rep) throws HL7Exception { 
264         return (CX) super.insertRepetition(2, rep);
265     }
266 
267 
268     /**
269      * Inserts a repetition of
270      * MRG-2: "Prior Alternate Patient ID" at a specific index
271      *
272      * @param rep The repetition index (0-indexed)
273      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
274      */
275     public CX insertMrg2_PriorAlternatePatientID(int rep) throws HL7Exception { 
276         return (CX) super.insertRepetition(2, rep);
277     }
278 
279 
280     /**
281      * Removes a repetition of
282      * MRG-2: "Prior Alternate Patient ID" at a specific index
283      *
284      * @param rep The repetition index (0-indexed)
285      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
286      */
287     public CX removePriorAlternatePatientID(int rep) throws HL7Exception { 
288         return (CX) super.removeRepetition(2, rep);
289     }
290 
291 
292     /**
293      * Removes a repetition of
294      * MRG-2: "Prior Alternate Patient ID" at a specific index
295      *
296      * @param rep The repetition index (0-indexed)
297      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
298      */
299     public CX removeMrg2_PriorAlternatePatientID(int rep) throws HL7Exception { 
300         return (CX) super.removeRepetition(2, rep);
301     }
302 
303 
304 
305 
306     /**
307      * Returns
308      * MRG-3: "Prior Patient Account Number" - creates it if necessary
309      */
310     public CX getPriorPatientAccountNumber() { 
311 		CX retVal = this.getTypedField(3, 0);
312 		return retVal;
313     }
314     
315     /**
316      * Returns
317      * MRG-3: "Prior Patient Account Number" - creates it if necessary
318      */
319     public CX getMrg3_PriorPatientAccountNumber() { 
320 		CX retVal = this.getTypedField(3, 0);
321 		return retVal;
322     }
323 
324 
325 
326     /**
327      * Returns
328      * MRG-4: "Prior Patient ID" - creates it if necessary
329      */
330     public CX getPriorPatientID() { 
331 		CX retVal = this.getTypedField(4, 0);
332 		return retVal;
333     }
334     
335     /**
336      * Returns
337      * MRG-4: "Prior Patient ID" - creates it if necessary
338      */
339     public CX getMrg4_PriorPatientID() { 
340 		CX retVal = this.getTypedField(4, 0);
341 		return retVal;
342     }
343 
344 
345 
346     /**
347      * Returns
348      * MRG-5: "Prior Visit Number" - creates it if necessary
349      */
350     public CX getPriorVisitNumber() { 
351 		CX retVal = this.getTypedField(5, 0);
352 		return retVal;
353     }
354     
355     /**
356      * Returns
357      * MRG-5: "Prior Visit Number" - creates it if necessary
358      */
359     public CX getMrg5_PriorVisitNumber() { 
360 		CX retVal = this.getTypedField(5, 0);
361 		return retVal;
362     }
363 
364 
365 
366     /**
367      * Returns
368      * MRG-6: "Prior Alternate Visit ID" - creates it if necessary
369      */
370     public CX getPriorAlternateVisitID() { 
371 		CX retVal = this.getTypedField(6, 0);
372 		return retVal;
373     }
374     
375     /**
376      * Returns
377      * MRG-6: "Prior Alternate Visit ID" - creates it if necessary
378      */
379     public CX getMrg6_PriorAlternateVisitID() { 
380 		CX retVal = this.getTypedField(6, 0);
381 		return retVal;
382     }
383 
384 
385     /**
386      * Returns all repetitions of Prior Patient Name (MRG-7).
387      */
388     public XPN[] getPriorPatientName() {
389     	XPN[] retVal = this.getTypedField(7, new XPN[0]);
390     	return retVal;
391     }
392 
393 
394     /**
395      * Returns all repetitions of Prior Patient Name (MRG-7).
396      */
397     public XPN[] getMrg7_PriorPatientName() {
398     	XPN[] retVal = this.getTypedField(7, new XPN[0]);
399     	return retVal;
400     }
401 
402 
403     /**
404      * Returns a count of the current number of repetitions of Prior Patient Name (MRG-7).
405      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
406      * it will return zero.
407      */
408     public int getPriorPatientNameReps() {
409     	return this.getReps(7);
410     }
411 
412 
413     /**
414      * Returns a specific repetition of
415      * MRG-7: "Prior Patient Name" - creates it if necessary
416      *
417      * @param rep The repetition index (0-indexed)
418      */
419     public XPN getPriorPatientName(int rep) { 
420 		XPN retVal = this.getTypedField(7, rep);
421 		return retVal;
422     }
423 
424     /**
425      * Returns a specific repetition of
426      * MRG-7: "Prior Patient Name" - creates it if necessary
427      *
428      * @param rep The repetition index (0-indexed)
429      */
430     public XPN getMrg7_PriorPatientName(int rep) { 
431 		XPN retVal = this.getTypedField(7, rep);
432 		return retVal;
433     }
434 
435     /**
436      * Returns a count of the current number of repetitions of Prior Patient Name (MRG-7).
437      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
438      * it will return zero.
439      */
440     public int getMrg7_PriorPatientNameReps() {
441     	return this.getReps(7);
442     }
443 
444 
445     /**
446      * Inserts a repetition of
447      * MRG-7: "Prior Patient Name" at a specific index
448      *
449      * @param rep The repetition index (0-indexed)
450      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
451      */
452     public XPN insertPriorPatientName(int rep) throws HL7Exception { 
453         return (XPN) super.insertRepetition(7, rep);
454     }
455 
456 
457     /**
458      * Inserts a repetition of
459      * MRG-7: "Prior Patient Name" at a specific index
460      *
461      * @param rep The repetition index (0-indexed)
462      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
463      */
464     public XPN insertMrg7_PriorPatientName(int rep) throws HL7Exception { 
465         return (XPN) super.insertRepetition(7, rep);
466     }
467 
468 
469     /**
470      * Removes a repetition of
471      * MRG-7: "Prior Patient Name" at a specific index
472      *
473      * @param rep The repetition index (0-indexed)
474      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
475      */
476     public XPN removePriorPatientName(int rep) throws HL7Exception { 
477         return (XPN) super.removeRepetition(7, rep);
478     }
479 
480 
481     /**
482      * Removes a repetition of
483      * MRG-7: "Prior Patient Name" at a specific index
484      *
485      * @param rep The repetition index (0-indexed)
486      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
487      */
488     public XPN removeMrg7_PriorPatientName(int rep) throws HL7Exception { 
489         return (XPN) super.removeRepetition(7, rep);
490     }
491 
492 
493 
494 
495 
496 
497     /** {@inheritDoc} */   
498     protected Type createNewTypeWithoutReflection(int field) {
499        switch (field) {
500           case 0: return new CX(getMessage());
501           case 1: return new CX(getMessage());
502           case 2: return new CX(getMessage());
503           case 3: return new CX(getMessage());
504           case 4: return new CX(getMessage());
505           case 5: return new CX(getMessage());
506           case 6: return new XPN(getMessage());
507           default: return null;
508        }
509    }
510 
511 
512 }
513