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