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.v27.group;
035
036import ca.uhn.hl7v2.model.v27.segment.*;
037
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a CCI_I22_MEDICATION_HISTORY group structure (a Group object).
044 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
045 * This Group contains the following elements:  
046 * </p>
047 * <ul>
048                         * <li>1: ORC (Common Order) <b>  </b></li>
049                         * <li>2: CCI_I22_MEDICATION_ORDER_DETAIL (a Group object) <b>optional  </b></li>
050                         * <li>3: CCI_I22_MEDICATION_ENCODING_DETAIL (a Group object) <b>optional  </b></li>
051                         * <li>4: CCI_I22_MEDICATION_ADMINISTRATION_DETAIL (a Group object) <b>optional repeating </b></li>
052                         * <li>5: CTI (Clinical Trial Identification) <b>optional repeating </b></li>
053 * </ul>
054 */
055//@SuppressWarnings("unused")
056public class CCI_I22_MEDICATION_HISTORY extends AbstractGroup {
057
058    /** 
059     * Creates a new CCI_I22_MEDICATION_HISTORY group
060     */
061    public CCI_I22_MEDICATION_HISTORY(Group parent, ModelClassFactory factory) {
062       super(parent, factory);
063       init(factory);
064    }
065
066    private void init(ModelClassFactory factory) {
067       try {
068                                  this.add(ORC.class, true, false, false);
069                                  this.add(CCI_I22_MEDICATION_ORDER_DETAIL.class, false, false, false);
070                                  this.add(CCI_I22_MEDICATION_ENCODING_DETAIL.class, false, false, false);
071                                  this.add(CCI_I22_MEDICATION_ADMINISTRATION_DETAIL.class, false, true, false);
072                                  this.add(CTI.class, false, true, false);
073       } catch(HL7Exception e) {
074          log.error("Unexpected error creating CCI_I22_MEDICATION_HISTORY - this is probably a bug in the source code generator.", e);
075       }
076    }
077
078    /** 
079     * Returns "2.7"
080     */
081    public String getVersion() {
082       return "2.7";
083    }
084
085
086
087    /**
088     * Returns
089     * ORC (Common Order) - creates it if necessary
090     */
091    public ORC getORC() { 
092       ORC retVal = getTyped("ORC", ORC.class);
093       return retVal;
094    }
095
096
097
098
099    /**
100     * Returns
101     * MEDICATION_ORDER_DETAIL (a Group object) - creates it if necessary
102     */
103    public CCI_I22_MEDICATION_ORDER_DETAIL getMEDICATION_ORDER_DETAIL() { 
104       CCI_I22_MEDICATION_ORDER_DETAIL retVal = getTyped("MEDICATION_ORDER_DETAIL", CCI_I22_MEDICATION_ORDER_DETAIL.class);
105       return retVal;
106    }
107
108
109
110
111    /**
112     * Returns
113     * MEDICATION_ENCODING_DETAIL (a Group object) - creates it if necessary
114     */
115    public CCI_I22_MEDICATION_ENCODING_DETAIL getMEDICATION_ENCODING_DETAIL() { 
116       CCI_I22_MEDICATION_ENCODING_DETAIL retVal = getTyped("MEDICATION_ENCODING_DETAIL", CCI_I22_MEDICATION_ENCODING_DETAIL.class);
117       return retVal;
118    }
119
120
121
122
123    /**
124     * Returns
125     * the first repetition of 
126     * MEDICATION_ADMINISTRATION_DETAIL (a Group object) - creates it if necessary
127     */
128    public CCI_I22_MEDICATION_ADMINISTRATION_DETAIL getMEDICATION_ADMINISTRATION_DETAIL() { 
129       CCI_I22_MEDICATION_ADMINISTRATION_DETAIL retVal = getTyped("MEDICATION_ADMINISTRATION_DETAIL", CCI_I22_MEDICATION_ADMINISTRATION_DETAIL.class);
130       return retVal;
131    }
132
133
134    /**
135     * Returns a specific repetition of
136     * MEDICATION_ADMINISTRATION_DETAIL (a Group object) - creates it if necessary
137     *
138     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
139     * @throws HL7Exception if the repetition requested is more than one 
140     *     greater than the number of existing repetitions.
141     */
142    public CCI_I22_MEDICATION_ADMINISTRATION_DETAIL getMEDICATION_ADMINISTRATION_DETAIL(int rep) { 
143       CCI_I22_MEDICATION_ADMINISTRATION_DETAIL retVal = getTyped("MEDICATION_ADMINISTRATION_DETAIL", rep, CCI_I22_MEDICATION_ADMINISTRATION_DETAIL.class);
144       return retVal;
145    }
146
147    /** 
148     * Returns the number of existing repetitions of MEDICATION_ADMINISTRATION_DETAIL 
149     */ 
150    public int getMEDICATION_ADMINISTRATION_DETAILReps() {  
151        return getReps("MEDICATION_ADMINISTRATION_DETAIL");
152    } 
153
154    /** 
155     * <p>
156     * Returns a non-modifiable List containing all current existing repetitions of MEDICATION_ADMINISTRATION_DETAIL.
157     * <p>
158     * <p>
159     * Note that unlike {@link #getMEDICATION_ADMINISTRATION_DETAIL()}, this method will not create any reps
160     * if none are already present, so an empty list may be returned.
161     * </p>
162     */ 
163    public java.util.List<CCI_I22_MEDICATION_ADMINISTRATION_DETAIL> getMEDICATION_ADMINISTRATION_DETAILAll() throws HL7Exception {
164        return getAllAsList("MEDICATION_ADMINISTRATION_DETAIL", CCI_I22_MEDICATION_ADMINISTRATION_DETAIL.class);
165    } 
166
167    /**
168     * Inserts a specific repetition of MEDICATION_ADMINISTRATION_DETAIL (a Group object)
169     * @see AbstractGroup#insertRepetition(Structure, int) 
170     */
171    public void insertMEDICATION_ADMINISTRATION_DETAIL(CCI_I22_MEDICATION_ADMINISTRATION_DETAIL structure, int rep) throws HL7Exception { 
172       super.insertRepetition("MEDICATION_ADMINISTRATION_DETAIL", structure, rep);
173    }
174
175
176    /**
177     * Inserts a specific repetition of MEDICATION_ADMINISTRATION_DETAIL (a Group object)
178     * @see AbstractGroup#insertRepetition(Structure, int) 
179     */
180    public CCI_I22_MEDICATION_ADMINISTRATION_DETAIL insertMEDICATION_ADMINISTRATION_DETAIL(int rep) throws HL7Exception { 
181       return (CCI_I22_MEDICATION_ADMINISTRATION_DETAIL)super.insertRepetition("MEDICATION_ADMINISTRATION_DETAIL", rep);
182    }
183
184
185    /**
186     * Removes a specific repetition of MEDICATION_ADMINISTRATION_DETAIL (a Group object)
187     * @see AbstractGroup#removeRepetition(String, int) 
188     */
189    public CCI_I22_MEDICATION_ADMINISTRATION_DETAIL removeMEDICATION_ADMINISTRATION_DETAIL(int rep) throws HL7Exception { 
190       return (CCI_I22_MEDICATION_ADMINISTRATION_DETAIL)super.removeRepetition("MEDICATION_ADMINISTRATION_DETAIL", rep);
191    }
192
193
194
195    /**
196     * Returns
197     * the first repetition of 
198     * CTI (Clinical Trial Identification) - creates it if necessary
199     */
200    public CTI getCTI() { 
201       CTI retVal = getTyped("CTI", CTI.class);
202       return retVal;
203    }
204
205
206    /**
207     * Returns a specific repetition of
208     * CTI (Clinical Trial Identification) - creates it if necessary
209     *
210     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
211     * @throws HL7Exception if the repetition requested is more than one 
212     *     greater than the number of existing repetitions.
213     */
214    public CTI getCTI(int rep) { 
215       CTI retVal = getTyped("CTI", rep, CTI.class);
216       return retVal;
217    }
218
219    /** 
220     * Returns the number of existing repetitions of CTI 
221     */ 
222    public int getCTIReps() {  
223        return getReps("CTI");
224    } 
225
226    /** 
227     * <p>
228     * Returns a non-modifiable List containing all current existing repetitions of CTI.
229     * <p>
230     * <p>
231     * Note that unlike {@link #getCTI()}, this method will not create any reps
232     * if none are already present, so an empty list may be returned.
233     * </p>
234     */ 
235    public java.util.List<CTI> getCTIAll() throws HL7Exception {
236        return getAllAsList("CTI", CTI.class);
237    } 
238
239    /**
240     * Inserts a specific repetition of CTI (Clinical Trial Identification)
241     * @see AbstractGroup#insertRepetition(Structure, int) 
242     */
243    public void insertCTI(CTI structure, int rep) throws HL7Exception { 
244       super.insertRepetition("CTI", structure, rep);
245    }
246
247
248    /**
249     * Inserts a specific repetition of CTI (Clinical Trial Identification)
250     * @see AbstractGroup#insertRepetition(Structure, int) 
251     */
252    public CTI insertCTI(int rep) throws HL7Exception { 
253       return (CTI)super.insertRepetition("CTI", rep);
254    }
255
256
257    /**
258     * Removes a specific repetition of CTI (Clinical Trial Identification)
259     * @see AbstractGroup#removeRepetition(String, int) 
260     */
261    public CTI removeCTI(int rep) throws HL7Exception { 
262       return (CTI)super.removeRepetition("CTI", rep);
263    }
264
265
266
267}
268