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.v28.group;
35  
36  import ca.uhn.hl7v2.model.v28.segment.*;
37  
38  import ca.uhn.hl7v2.HL7Exception;
39  import ca.uhn.hl7v2.parser.ModelClassFactory;
40  import ca.uhn.hl7v2.model.*;
41  
42  /**
43   * <p>Represents a CCI_I22_MEDICATION_ADMINISTRATION_DETAIL group structure (a Group object).
44   * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
45   * This Group contains the following elements:  
46   * </p>
47   * <ul>
48                           * <li>1: RXA (Pharmacy/Treatment Administration) <b> repeating </b></li>
49                           * <li>2: RXR (Pharmacy/Treatment Route) <b>  </b></li>
50                           * <li>3: CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION (a Group object) <b>optional repeating </b></li>
51   * </ul>
52   */
53  //@SuppressWarnings("unused")
54  public class CCI_I22_MEDICATION_ADMINISTRATION_DETAIL extends AbstractGroup {
55  
56      /** 
57       * Creates a new CCI_I22_MEDICATION_ADMINISTRATION_DETAIL group
58       */
59      public CCI_I22_MEDICATION_ADMINISTRATION_DETAIL(Group parent, ModelClassFactory factory) {
60         super(parent, factory);
61         init(factory);
62      }
63  
64      private void init(ModelClassFactory factory) {
65         try {
66                                    this.add(RXA.class, true, true, false);
67                                    this.add(RXR.class, true, false, false);
68                                    this.add(CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION.class, false, true, false);
69         } catch(HL7Exception e) {
70            log.error("Unexpected error creating CCI_I22_MEDICATION_ADMINISTRATION_DETAIL - this is probably a bug in the source code generator.", e);
71         }
72      }
73  
74      /** 
75       * Returns "2.8"
76       */
77      public String getVersion() {
78         return "2.8";
79      }
80  
81  
82  
83      /**
84       * Returns
85       * the first repetition of 
86       * RXA (Pharmacy/Treatment Administration) - creates it if necessary
87       */
88      public RXA getRXA() { 
89         RXA retVal = getTyped("RXA", RXA.class);
90         return retVal;
91      }
92  
93  
94      /**
95       * Returns a specific repetition of
96       * RXA (Pharmacy/Treatment Administration) - creates it if necessary
97       *
98       * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
99       * @throws HL7Exception if the repetition requested is more than one 
100      *     greater than the number of existing repetitions.
101      */
102     public RXA getRXA(int rep) { 
103        RXA retVal = getTyped("RXA", rep, RXA.class);
104        return retVal;
105     }
106 
107     /** 
108      * Returns the number of existing repetitions of RXA 
109      */ 
110     public int getRXAReps() {  
111         return getReps("RXA");
112     } 
113 
114     /** 
115      * <p>
116      * Returns a non-modifiable List containing all current existing repetitions of RXA.
117      * <p>
118      * <p>
119      * Note that unlike {@link #getRXA()}, this method will not create any reps
120      * if none are already present, so an empty list may be returned.
121      * </p>
122      */ 
123     public java.util.List<RXA> getRXAAll() throws HL7Exception {
124     	return getAllAsList("RXA", RXA.class);
125     } 
126 
127     /**
128      * Inserts a specific repetition of RXA (Pharmacy/Treatment Administration)
129      * @see AbstractGroup#insertRepetition(Structure, int) 
130      */
131     public void insertRXA(RXA structure, int rep) throws HL7Exception { 
132        super.insertRepetition("RXA", structure, rep);
133     }
134 
135 
136     /**
137      * Inserts a specific repetition of RXA (Pharmacy/Treatment Administration)
138      * @see AbstractGroup#insertRepetition(Structure, int) 
139      */
140     public RXA insertRXA(int rep) throws HL7Exception { 
141        return (RXA)super.insertRepetition("RXA", rep);
142     }
143 
144 
145     /**
146      * Removes a specific repetition of RXA (Pharmacy/Treatment Administration)
147      * @see AbstractGroup#removeRepetition(String, int) 
148      */
149     public RXA removeRXA(int rep) throws HL7Exception { 
150        return (RXA)super.removeRepetition("RXA", rep);
151     }
152 
153 
154 
155     /**
156      * Returns
157      * RXR (Pharmacy/Treatment Route) - creates it if necessary
158      */
159     public RXR getRXR() { 
160        RXR retVal = getTyped("RXR", RXR.class);
161        return retVal;
162     }
163 
164 
165 
166 
167     /**
168      * Returns
169      * the first repetition of 
170      * MEDICATION_ADMINISTRATION_OBSERVATION (a Group object) - creates it if necessary
171      */
172     public CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION getMEDICATION_ADMINISTRATION_OBSERVATION() { 
173        CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION retVal = getTyped("MEDICATION_ADMINISTRATION_OBSERVATION", CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION.class);
174        return retVal;
175     }
176 
177 
178     /**
179      * Returns a specific repetition of
180      * MEDICATION_ADMINISTRATION_OBSERVATION (a Group object) - creates it if necessary
181      *
182      * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
183      * @throws HL7Exception if the repetition requested is more than one 
184      *     greater than the number of existing repetitions.
185      */
186     public CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION getMEDICATION_ADMINISTRATION_OBSERVATION(int rep) { 
187        CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION retVal = getTyped("MEDICATION_ADMINISTRATION_OBSERVATION", rep, CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION.class);
188        return retVal;
189     }
190 
191     /** 
192      * Returns the number of existing repetitions of MEDICATION_ADMINISTRATION_OBSERVATION 
193      */ 
194     public int getMEDICATION_ADMINISTRATION_OBSERVATIONReps() {  
195         return getReps("MEDICATION_ADMINISTRATION_OBSERVATION");
196     } 
197 
198     /** 
199      * <p>
200      * Returns a non-modifiable List containing all current existing repetitions of MEDICATION_ADMINISTRATION_OBSERVATION.
201      * <p>
202      * <p>
203      * Note that unlike {@link #getMEDICATION_ADMINISTRATION_OBSERVATION()}, this method will not create any reps
204      * if none are already present, so an empty list may be returned.
205      * </p>
206      */ 
207     public java.util.List<CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION> getMEDICATION_ADMINISTRATION_OBSERVATIONAll() throws HL7Exception {
208     	return getAllAsList("MEDICATION_ADMINISTRATION_OBSERVATION", CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION.class);
209     } 
210 
211     /**
212      * Inserts a specific repetition of MEDICATION_ADMINISTRATION_OBSERVATION (a Group object)
213      * @see AbstractGroup#insertRepetition(Structure, int) 
214      */
215     public void insertMEDICATION_ADMINISTRATION_OBSERVATION(CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION structure, int rep) throws HL7Exception { 
216        super.insertRepetition("MEDICATION_ADMINISTRATION_OBSERVATION", structure, rep);
217     }
218 
219 
220     /**
221      * Inserts a specific repetition of MEDICATION_ADMINISTRATION_OBSERVATION (a Group object)
222      * @see AbstractGroup#insertRepetition(Structure, int) 
223      */
224     public CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION insertMEDICATION_ADMINISTRATION_OBSERVATION(int rep) throws HL7Exception { 
225        return (CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION)super.insertRepetition("MEDICATION_ADMINISTRATION_OBSERVATION", rep);
226     }
227 
228 
229     /**
230      * Removes a specific repetition of MEDICATION_ADMINISTRATION_OBSERVATION (a Group object)
231      * @see AbstractGroup#removeRepetition(String, int) 
232      */
233     public CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION removeMEDICATION_ADMINISTRATION_OBSERVATION(int rep) throws HL7Exception { 
234        return (CCI_I22_MEDICATION_ADMINISTRATION_OBSERVATION)super.removeRepetition("MEDICATION_ADMINISTRATION_OBSERVATION", rep);
235     }
236 
237 
238 
239 }
240