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 RSP_Z82_COMMON_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: RSP_Z82_ORDER_DETAIL (a Group object) <b>optional </b></li> 50 * <li>3: RSP_Z82_ENCODED_ORDER (a Group object) <b>optional </b></li> 51 * <li>4: RXD (Pharmacy/Treatment Dispense) <b> </b></li> 52 * <li>5: RXR (Pharmacy/Treatment Route) <b> repeating </b></li> 53 * <li>6: RXC (Pharmacy/Treatment Component Order) <b>optional repeating </b></li> 54 * <li>7: RSP_Z82_OBSERVATION (a Group object) <b> repeating </b></li> 55 * </ul> 56 */ 57 //@SuppressWarnings("unused") 58 public class RSP_Z82_COMMON_ORDER extends AbstractGroup { 59 60 /** 61 * Creates a new RSP_Z82_COMMON_ORDER group 62 */ 63 public RSP_Z82_COMMON_ORDER(Group parent, ModelClassFactory factory) { 64 super(parent, factory); 65 init(factory); 66 } 67 68 private void init(ModelClassFactory factory) { 69 try { 70 this.add(ORC.class, true, false, false); 71 this.add(RSP_Z82_ORDER_DETAIL.class, false, false, false); 72 this.add(RSP_Z82_ENCODED_ORDER.class, false, false, false); 73 this.add(RXD.class, true, false, false); 74 this.add(RXR.class, true, true, false); 75 this.add(RXC.class, false, true, false); 76 this.add(RSP_Z82_OBSERVATION.class, true, true, false); 77 } catch(HL7Exception e) { 78 log.error("Unexpected error creating RSP_Z82_COMMON_ORDER - this is probably a bug in the source code generator.", e); 79 } 80 } 81 82 /** 83 * Returns "2.4" 84 */ 85 public String getVersion() { 86 return "2.4"; 87 } 88 89 90 91 /** 92 * Returns 93 * ORC (Common Order) - creates it if necessary 94 */ 95 public ORC getORC() { 96 ORC retVal = getTyped("ORC", ORC.class); 97 return retVal; 98 } 99 100 101 102 103 /** 104 * Returns 105 * ORDER_DETAIL (a Group object) - creates it if necessary 106 */ 107 public RSP_Z82_ORDER_DETAIL getORDER_DETAIL() { 108 RSP_Z82_ORDER_DETAIL retVal = getTyped("ORDER_DETAIL", RSP_Z82_ORDER_DETAIL.class); 109 return retVal; 110 } 111 112 113 114 115 /** 116 * Returns 117 * ENCODED_ORDER (a Group object) - creates it if necessary 118 */ 119 public RSP_Z82_ENCODED_ORDER getENCODED_ORDER() { 120 RSP_Z82_ENCODED_ORDER retVal = getTyped("ENCODED_ORDER", RSP_Z82_ENCODED_ORDER.class); 121 return retVal; 122 } 123 124 125 126 127 /** 128 * Returns 129 * RXD (Pharmacy/Treatment Dispense) - creates it if necessary 130 */ 131 public RXD getRXD() { 132 RXD retVal = getTyped("RXD", RXD.class); 133 return retVal; 134 } 135 136 137 138 139 /** 140 * Returns 141 * the first repetition of 142 * RXR (Pharmacy/Treatment Route) - creates it if necessary 143 */ 144 public RXR getRXR() { 145 RXR retVal = getTyped("RXR", RXR.class); 146 return retVal; 147 } 148 149 150 /** 151 * Returns a specific repetition of 152 * RXR (Pharmacy/Treatment Route) - creates it if necessary 153 * 154 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 155 * @throws HL7Exception if the repetition requested is more than one 156 * greater than the number of existing repetitions. 157 */ 158 public RXR getRXR(int rep) { 159 RXR retVal = getTyped("RXR", rep, RXR.class); 160 return retVal; 161 } 162 163 /** 164 * Returns the number of existing repetitions of RXR 165 */ 166 public int getRXRReps() { 167 return getReps("RXR"); 168 } 169 170 /** 171 * <p> 172 * Returns a non-modifiable List containing all current existing repetitions of RXR. 173 * <p> 174 * <p> 175 * Note that unlike {@link #getRXR()}, this method will not create any reps 176 * if none are already present, so an empty list may be returned. 177 * </p> 178 */ 179 public java.util.List<RXR> getRXRAll() throws HL7Exception { 180 return getAllAsList("RXR", RXR.class); 181 } 182 183 /** 184 * Inserts a specific repetition of RXR (Pharmacy/Treatment Route) 185 * @see AbstractGroup#insertRepetition(Structure, int) 186 */ 187 public void insertRXR(RXR structure, int rep) throws HL7Exception { 188 super.insertRepetition("RXR", structure, rep); 189 } 190 191 192 /** 193 * Inserts a specific repetition of RXR (Pharmacy/Treatment Route) 194 * @see AbstractGroup#insertRepetition(Structure, int) 195 */ 196 public RXR insertRXR(int rep) throws HL7Exception { 197 return (RXR)super.insertRepetition("RXR", rep); 198 } 199 200 201 /** 202 * Removes a specific repetition of RXR (Pharmacy/Treatment Route) 203 * @see AbstractGroup#removeRepetition(String, int) 204 */ 205 public RXR removeRXR(int rep) throws HL7Exception { 206 return (RXR)super.removeRepetition("RXR", rep); 207 } 208 209 210 211 /** 212 * Returns 213 * the first repetition of 214 * RXC (Pharmacy/Treatment Component Order) - creates it if necessary 215 */ 216 public RXC getRXC() { 217 RXC retVal = getTyped("RXC", RXC.class); 218 return retVal; 219 } 220 221 222 /** 223 * Returns a specific repetition of 224 * RXC (Pharmacy/Treatment Component Order) - creates it if necessary 225 * 226 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 227 * @throws HL7Exception if the repetition requested is more than one 228 * greater than the number of existing repetitions. 229 */ 230 public RXC getRXC(int rep) { 231 RXC retVal = getTyped("RXC", rep, RXC.class); 232 return retVal; 233 } 234 235 /** 236 * Returns the number of existing repetitions of RXC 237 */ 238 public int getRXCReps() { 239 return getReps("RXC"); 240 } 241 242 /** 243 * <p> 244 * Returns a non-modifiable List containing all current existing repetitions of RXC. 245 * <p> 246 * <p> 247 * Note that unlike {@link #getRXC()}, this method will not create any reps 248 * if none are already present, so an empty list may be returned. 249 * </p> 250 */ 251 public java.util.List<RXC> getRXCAll() throws HL7Exception { 252 return getAllAsList("RXC", RXC.class); 253 } 254 255 /** 256 * Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order) 257 * @see AbstractGroup#insertRepetition(Structure, int) 258 */ 259 public void insertRXC(RXC structure, int rep) throws HL7Exception { 260 super.insertRepetition("RXC", structure, rep); 261 } 262 263 264 /** 265 * Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order) 266 * @see AbstractGroup#insertRepetition(Structure, int) 267 */ 268 public RXC insertRXC(int rep) throws HL7Exception { 269 return (RXC)super.insertRepetition("RXC", rep); 270 } 271 272 273 /** 274 * Removes a specific repetition of RXC (Pharmacy/Treatment Component Order) 275 * @see AbstractGroup#removeRepetition(String, int) 276 */ 277 public RXC removeRXC(int rep) throws HL7Exception { 278 return (RXC)super.removeRepetition("RXC", rep); 279 } 280 281 282 283 /** 284 * Returns 285 * the first repetition of 286 * OBSERVATION (a Group object) - creates it if necessary 287 */ 288 public RSP_Z82_OBSERVATION getOBSERVATION() { 289 RSP_Z82_OBSERVATION retVal = getTyped("OBSERVATION", RSP_Z82_OBSERVATION.class); 290 return retVal; 291 } 292 293 294 /** 295 * Returns a specific repetition of 296 * OBSERVATION (a Group object) - creates it if necessary 297 * 298 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 299 * @throws HL7Exception if the repetition requested is more than one 300 * greater than the number of existing repetitions. 301 */ 302 public RSP_Z82_OBSERVATION getOBSERVATION(int rep) { 303 RSP_Z82_OBSERVATION retVal = getTyped("OBSERVATION", rep, RSP_Z82_OBSERVATION.class); 304 return retVal; 305 } 306 307 /** 308 * Returns the number of existing repetitions of OBSERVATION 309 */ 310 public int getOBSERVATIONReps() { 311 return getReps("OBSERVATION"); 312 } 313 314 /** 315 * <p> 316 * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION. 317 * <p> 318 * <p> 319 * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps 320 * if none are already present, so an empty list may be returned. 321 * </p> 322 */ 323 public java.util.List<RSP_Z82_OBSERVATION> getOBSERVATIONAll() throws HL7Exception { 324 return getAllAsList("OBSERVATION", RSP_Z82_OBSERVATION.class); 325 } 326 327 /** 328 * Inserts a specific repetition of OBSERVATION (a Group object) 329 * @see AbstractGroup#insertRepetition(Structure, int) 330 */ 331 public void insertOBSERVATION(RSP_Z82_OBSERVATION structure, int rep) throws HL7Exception { 332 super.insertRepetition("OBSERVATION", structure, rep); 333 } 334 335 336 /** 337 * Inserts a specific repetition of OBSERVATION (a Group object) 338 * @see AbstractGroup#insertRepetition(Structure, int) 339 */ 340 public RSP_Z82_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 341 return (RSP_Z82_OBSERVATION)super.insertRepetition("OBSERVATION", rep); 342 } 343 344 345 /** 346 * Removes a specific repetition of OBSERVATION (a Group object) 347 * @see AbstractGroup#removeRepetition(String, int) 348 */ 349 public RSP_Z82_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 350 return (RSP_Z82_OBSERVATION)super.removeRepetition("OBSERVATION", rep); 351 } 352 353 354 355 } 356