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.v24.group; 35 36 import ca.uhn.hl7v2.model.v24.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 OMN_O07_ORDER 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: ORC (Common Order) <b> </b></li> 49 * <li>2: RQD (Requisition Detail) <b> </b></li> 50 * <li>3: RQ1 (Requisition Detail-1) <b>optional </b></li> 51 * <li>4: NTE (Notes and Comments) <b>optional repeating </b></li> 52 * <li>5: OMN_O07_OBSERVATION (a Group object) <b>optional repeating </b></li> 53 * <li>6: BLG (Billing) <b>optional </b></li> 54 * </ul> 55 */ 56 //@SuppressWarnings("unused") 57 public class OMN_O07_ORDER extends AbstractGroup { 58 59 /** 60 * Creates a new OMN_O07_ORDER group 61 */ 62 public OMN_O07_ORDER(Group parent, ModelClassFactory factory) { 63 super(parent, factory); 64 init(factory); 65 } 66 67 private void init(ModelClassFactory factory) { 68 try { 69 this.add(ORC.class, true, false, false); 70 this.add(RQD.class, true, false, false); 71 this.add(RQ1.class, false, false, false); 72 this.add(NTE.class, false, true, false); 73 this.add(OMN_O07_OBSERVATION.class, false, true, false); 74 this.add(BLG.class, false, false, false); 75 } catch(HL7Exception e) { 76 log.error("Unexpected error creating OMN_O07_ORDER - this is probably a bug in the source code generator.", e); 77 } 78 } 79 80 /** 81 * Returns "2.4" 82 */ 83 public String getVersion() { 84 return "2.4"; 85 } 86 87 88 89 /** 90 * Returns 91 * ORC (Common Order) - creates it if necessary 92 */ 93 public ORC getORC() { 94 ORC retVal = getTyped("ORC", ORC.class); 95 return retVal; 96 } 97 98 99 100 101 /** 102 * Returns 103 * RQD (Requisition Detail) - creates it if necessary 104 */ 105 public RQD getRQD() { 106 RQD retVal = getTyped("RQD", RQD.class); 107 return retVal; 108 } 109 110 111 112 113 /** 114 * Returns 115 * RQ1 (Requisition Detail-1) - creates it if necessary 116 */ 117 public RQ1 getRQ1() { 118 RQ1 retVal = getTyped("RQ1", RQ1.class); 119 return retVal; 120 } 121 122 123 124 125 /** 126 * Returns 127 * the first repetition of 128 * NTE (Notes and Comments) - creates it if necessary 129 */ 130 public NTE getNTE() { 131 NTE retVal = getTyped("NTE", NTE.class); 132 return retVal; 133 } 134 135 136 /** 137 * Returns a specific repetition of 138 * NTE (Notes and Comments) - creates it if necessary 139 * 140 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 141 * @throws HL7Exception if the repetition requested is more than one 142 * greater than the number of existing repetitions. 143 */ 144 public NTE getNTE(int rep) { 145 NTE retVal = getTyped("NTE", rep, NTE.class); 146 return retVal; 147 } 148 149 /** 150 * Returns the number of existing repetitions of NTE 151 */ 152 public int getNTEReps() { 153 return getReps("NTE"); 154 } 155 156 /** 157 * <p> 158 * Returns a non-modifiable List containing all current existing repetitions of NTE. 159 * <p> 160 * <p> 161 * Note that unlike {@link #getNTE()}, this method will not create any reps 162 * if none are already present, so an empty list may be returned. 163 * </p> 164 */ 165 public java.util.List<NTE> getNTEAll() throws HL7Exception { 166 return getAllAsList("NTE", NTE.class); 167 } 168 169 /** 170 * Inserts a specific repetition of NTE (Notes and Comments) 171 * @see AbstractGroup#insertRepetition(Structure, int) 172 */ 173 public void insertNTE(NTE structure, int rep) throws HL7Exception { 174 super.insertRepetition("NTE", structure, rep); 175 } 176 177 178 /** 179 * Inserts a specific repetition of NTE (Notes and Comments) 180 * @see AbstractGroup#insertRepetition(Structure, int) 181 */ 182 public NTE insertNTE(int rep) throws HL7Exception { 183 return (NTE)super.insertRepetition("NTE", rep); 184 } 185 186 187 /** 188 * Removes a specific repetition of NTE (Notes and Comments) 189 * @see AbstractGroup#removeRepetition(String, int) 190 */ 191 public NTE removeNTE(int rep) throws HL7Exception { 192 return (NTE)super.removeRepetition("NTE", rep); 193 } 194 195 196 197 /** 198 * Returns 199 * the first repetition of 200 * OBSERVATION (a Group object) - creates it if necessary 201 */ 202 public OMN_O07_OBSERVATION getOBSERVATION() { 203 OMN_O07_OBSERVATION retVal = getTyped("OBSERVATION", OMN_O07_OBSERVATION.class); 204 return retVal; 205 } 206 207 208 /** 209 * Returns a specific repetition of 210 * OBSERVATION (a Group object) - creates it if necessary 211 * 212 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 213 * @throws HL7Exception if the repetition requested is more than one 214 * greater than the number of existing repetitions. 215 */ 216 public OMN_O07_OBSERVATION getOBSERVATION(int rep) { 217 OMN_O07_OBSERVATION retVal = getTyped("OBSERVATION", rep, OMN_O07_OBSERVATION.class); 218 return retVal; 219 } 220 221 /** 222 * Returns the number of existing repetitions of OBSERVATION 223 */ 224 public int getOBSERVATIONReps() { 225 return getReps("OBSERVATION"); 226 } 227 228 /** 229 * <p> 230 * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION. 231 * <p> 232 * <p> 233 * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps 234 * if none are already present, so an empty list may be returned. 235 * </p> 236 */ 237 public java.util.List<OMN_O07_OBSERVATION> getOBSERVATIONAll() throws HL7Exception { 238 return getAllAsList("OBSERVATION", OMN_O07_OBSERVATION.class); 239 } 240 241 /** 242 * Inserts a specific repetition of OBSERVATION (a Group object) 243 * @see AbstractGroup#insertRepetition(Structure, int) 244 */ 245 public void insertOBSERVATION(OMN_O07_OBSERVATION structure, int rep) throws HL7Exception { 246 super.insertRepetition("OBSERVATION", structure, rep); 247 } 248 249 250 /** 251 * Inserts a specific repetition of OBSERVATION (a Group object) 252 * @see AbstractGroup#insertRepetition(Structure, int) 253 */ 254 public OMN_O07_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 255 return (OMN_O07_OBSERVATION)super.insertRepetition("OBSERVATION", rep); 256 } 257 258 259 /** 260 * Removes a specific repetition of OBSERVATION (a Group object) 261 * @see AbstractGroup#removeRepetition(String, int) 262 */ 263 public OMN_O07_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 264 return (OMN_O07_OBSERVATION)super.removeRepetition("OBSERVATION", rep); 265 } 266 267 268 269 /** 270 * Returns 271 * BLG (Billing) - creates it if necessary 272 */ 273 public BLG getBLG() { 274 BLG retVal = getTyped("BLG", BLG.class); 275 return retVal; 276 } 277 278 279 280 281 } 282