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 AL1 message segment (Patient Allergy Information). 
50   * This segment has the following fields:</p>
51   * <ul>
52       * <li>AL1-1: Set ID - AL1 (SI) <b> </b>
53       * <li>AL1-2: Allergen Type Code (CE) <b>optional </b>
54       * <li>AL1-3: Allergen Code/Mnemonic/Description (CE) <b> </b>
55       * <li>AL1-4: Allergy Severity Code (CE) <b>optional </b>
56       * <li>AL1-5: Allergy Reaction Code (ST) <b>optional repeating</b>
57       * <li>AL1-6: Identification Date (DT) <b>optional </b>
58   * </ul>
59   */
60  @SuppressWarnings("unused")
61  public class AL1 extends AbstractSegment {
62  
63      /** 
64       * Creates a new AL1 segment
65       */
66      public AL1(Group parent, ModelClassFactory factory) {
67         super(parent, factory);
68         init(factory);
69      }
70  
71      private void init(ModelClassFactory factory) {
72         try {
73                                    this.add(SI.class, true, 1, 4, new Object[]{ getMessage() }, "Set ID - AL1");
74                                    this.add(CE.class, false, 1, 250, new Object[]{ getMessage() }, "Allergen Type Code");
75                                    this.add(CE.class, true, 1, 250, new Object[]{ getMessage() }, "Allergen Code/Mnemonic/Description");
76                                    this.add(CE.class, false, 1, 250, new Object[]{ getMessage() }, "Allergy Severity Code");
77                                    this.add(ST.class, false, 0, 15, new Object[]{ getMessage() }, "Allergy Reaction Code");
78                                    this.add(DT.class, false, 1, 8, new Object[]{ getMessage() }, "Identification Date");
79         } catch(HL7Exception e) {
80            log.error("Unexpected error creating AL1 - this is probably a bug in the source code generator.", e);
81         }
82      }
83  
84  
85  
86      /**
87       * Returns
88       * AL1-1: "Set ID - AL1" - creates it if necessary
89       */
90      public SI getSetIDAL1() { 
91  		SI retVal = this.getTypedField(1, 0);
92  		return retVal;
93      }
94      
95      /**
96       * Returns
97       * AL1-1: "Set ID - AL1" - creates it if necessary
98       */
99      public SI getAl11_SetIDAL1() { 
100 		SI retVal = this.getTypedField(1, 0);
101 		return retVal;
102     }
103 
104 
105 
106     /**
107      * Returns
108      * AL1-2: "Allergen Type Code" - creates it if necessary
109      */
110     public CE getAllergenTypeCode() { 
111 		CE retVal = this.getTypedField(2, 0);
112 		return retVal;
113     }
114     
115     /**
116      * Returns
117      * AL1-2: "Allergen Type Code" - creates it if necessary
118      */
119     public CE getAl12_AllergenTypeCode() { 
120 		CE retVal = this.getTypedField(2, 0);
121 		return retVal;
122     }
123 
124 
125 
126     /**
127      * Returns
128      * AL1-3: "Allergen Code/Mnemonic/Description" - creates it if necessary
129      */
130     public CE getAllergenCodeMnemonicDescription() { 
131 		CE retVal = this.getTypedField(3, 0);
132 		return retVal;
133     }
134     
135     /**
136      * Returns
137      * AL1-3: "Allergen Code/Mnemonic/Description" - creates it if necessary
138      */
139     public CE getAl13_AllergenCodeMnemonicDescription() { 
140 		CE retVal = this.getTypedField(3, 0);
141 		return retVal;
142     }
143 
144 
145 
146     /**
147      * Returns
148      * AL1-4: "Allergy Severity Code" - creates it if necessary
149      */
150     public CE getAllergySeverityCode() { 
151 		CE retVal = this.getTypedField(4, 0);
152 		return retVal;
153     }
154     
155     /**
156      * Returns
157      * AL1-4: "Allergy Severity Code" - creates it if necessary
158      */
159     public CE getAl14_AllergySeverityCode() { 
160 		CE retVal = this.getTypedField(4, 0);
161 		return retVal;
162     }
163 
164 
165     /**
166      * Returns all repetitions of Allergy Reaction Code (AL1-5).
167      */
168     public ST[] getAllergyReactionCode() {
169     	ST[] retVal = this.getTypedField(5, new ST[0]);
170     	return retVal;
171     }
172 
173 
174     /**
175      * Returns all repetitions of Allergy Reaction Code (AL1-5).
176      */
177     public ST[] getAl15_AllergyReactionCode() {
178     	ST[] retVal = this.getTypedField(5, new ST[0]);
179     	return retVal;
180     }
181 
182 
183     /**
184      * Returns a count of the current number of repetitions of Allergy Reaction Code (AL1-5).
185      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
186      * it will return zero.
187      */
188     public int getAllergyReactionCodeReps() {
189     	return this.getReps(5);
190     }
191 
192 
193     /**
194      * Returns a specific repetition of
195      * AL1-5: "Allergy Reaction Code" - creates it if necessary
196      *
197      * @param rep The repetition index (0-indexed)
198      */
199     public ST getAllergyReactionCode(int rep) { 
200 		ST retVal = this.getTypedField(5, rep);
201 		return retVal;
202     }
203 
204     /**
205      * Returns a specific repetition of
206      * AL1-5: "Allergy Reaction Code" - creates it if necessary
207      *
208      * @param rep The repetition index (0-indexed)
209      */
210     public ST getAl15_AllergyReactionCode(int rep) { 
211 		ST retVal = this.getTypedField(5, rep);
212 		return retVal;
213     }
214 
215     /**
216      * Returns a count of the current number of repetitions of Allergy Reaction Code (AL1-5).
217      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
218      * it will return zero.
219      */
220     public int getAl15_AllergyReactionCodeReps() {
221     	return this.getReps(5);
222     }
223 
224 
225     /**
226      * Inserts a repetition of
227      * AL1-5: "Allergy Reaction Code" at a specific index
228      *
229      * @param rep The repetition index (0-indexed)
230      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
231      */
232     public ST insertAllergyReactionCode(int rep) throws HL7Exception { 
233         return (ST) super.insertRepetition(5, rep);
234     }
235 
236 
237     /**
238      * Inserts a repetition of
239      * AL1-5: "Allergy Reaction Code" at a specific index
240      *
241      * @param rep The repetition index (0-indexed)
242      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
243      */
244     public ST insertAl15_AllergyReactionCode(int rep) throws HL7Exception { 
245         return (ST) super.insertRepetition(5, rep);
246     }
247 
248 
249     /**
250      * Removes a repetition of
251      * AL1-5: "Allergy Reaction Code" at a specific index
252      *
253      * @param rep The repetition index (0-indexed)
254      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
255      */
256     public ST removeAllergyReactionCode(int rep) throws HL7Exception { 
257         return (ST) super.removeRepetition(5, rep);
258     }
259 
260 
261     /**
262      * Removes a repetition of
263      * AL1-5: "Allergy Reaction Code" at a specific index
264      *
265      * @param rep The repetition index (0-indexed)
266      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
267      */
268     public ST removeAl15_AllergyReactionCode(int rep) throws HL7Exception { 
269         return (ST) super.removeRepetition(5, rep);
270     }
271 
272 
273 
274 
275     /**
276      * Returns
277      * AL1-6: "Identification Date" - creates it if necessary
278      */
279     public DT getIdentificationDate() { 
280 		DT retVal = this.getTypedField(6, 0);
281 		return retVal;
282     }
283     
284     /**
285      * Returns
286      * AL1-6: "Identification Date" - creates it if necessary
287      */
288     public DT getAl16_IdentificationDate() { 
289 		DT retVal = this.getTypedField(6, 0);
290 		return retVal;
291     }
292 
293 
294 
295 
296 
297     /** {@inheritDoc} */   
298     protected Type createNewTypeWithoutReflection(int field) {
299        switch (field) {
300           case 0: return new SI(getMessage());
301           case 1: return new CE(getMessage());
302           case 2: return new CE(getMessage());
303           case 3: return new CE(getMessage());
304           case 4: return new ST(getMessage());
305           case 5: return new DT(getMessage());
306           default: return null;
307        }
308    }
309 
310 
311 }
312