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.v23.group; 035 036import ca.uhn.hl7v2.model.v23.segment.*; 037 038import ca.uhn.hl7v2.HL7Exception; 039import ca.uhn.hl7v2.parser.ModelClassFactory; 040import ca.uhn.hl7v2.model.*; 041 042/** 043 * <p>Represents a ORM_O01_ORDER_DETAIL 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: OBR (Observation request segment) <b> choice</b></li> 049 * <li>2: RQD (Requisition detail) <b> choice</b></li> 050 * <li>3: RQ1 (Requisition detail-1 segment) <b> choice</b></li> 051 * <li>4: RXO (Pharmacy prescription order segment) <b> choice</b></li> 052 * <li>5: ODS (Dietary orders, supplements, and preferences) <b> choice</b></li> 053 * <li>6: ODT (Diet tray instructions segment) <b> choice</b></li> 054 * <li>7: NTE (Notes and comments segment) <b>optional repeating </b></li> 055 * <li>8: DG1 (Diagnosis) <b>optional repeating </b></li> 056 * <li>9: ORM_O01_OBSERVATION (a Group object) <b>optional repeating </b></li> 057 * </ul> 058 * <p> 059 * Note that this structure has "choice" elements. This means that one of the 060 * structures above marked as "choice" must be present, but no more than one. 061 * </p> 062 */ 063//@SuppressWarnings("unused") 064public class ORM_O01_ORDER_DETAIL extends AbstractGroup { 065 066 /** 067 * Creates a new ORM_O01_ORDER_DETAIL group 068 */ 069 public ORM_O01_ORDER_DETAIL(Group parent, ModelClassFactory factory) { 070 super(parent, factory); 071 init(factory); 072 } 073 074 private void init(ModelClassFactory factory) { 075 try { 076 this.add(OBR.class, true, false, true); 077 this.add(RQD.class, true, false, true); 078 this.add(RQ1.class, true, false, true); 079 this.add(RXO.class, true, false, true); 080 this.add(ODS.class, true, false, true); 081 this.add(ODT.class, true, false, true); 082 this.add(NTE.class, false, true, false); 083 this.add(DG1.class, false, true, false); 084 this.add(ORM_O01_OBSERVATION.class, false, true, false); 085 } catch(HL7Exception e) { 086 log.error("Unexpected error creating ORM_O01_ORDER_DETAIL - this is probably a bug in the source code generator.", e); 087 } 088 } 089 090 /** 091 * Returns "2.3" 092 */ 093 public String getVersion() { 094 return "2.3"; 095 } 096 097 098 099 /** 100 * Returns 101 * OBR (Observation request segment) - creates it if necessary 102 */ 103 public OBR getOBR() { 104 OBR retVal = getTyped("OBR", OBR.class); 105 return retVal; 106 } 107 108 109 110 111 /** 112 * Returns 113 * RQD (Requisition detail) - creates it if necessary 114 */ 115 public RQD getRQD() { 116 RQD retVal = getTyped("RQD", RQD.class); 117 return retVal; 118 } 119 120 121 122 123 /** 124 * Returns 125 * RQ1 (Requisition detail-1 segment) - creates it if necessary 126 */ 127 public RQ1 getRQ1() { 128 RQ1 retVal = getTyped("RQ1", RQ1.class); 129 return retVal; 130 } 131 132 133 134 135 /** 136 * Returns 137 * RXO (Pharmacy prescription order segment) - creates it if necessary 138 */ 139 public RXO getRXO() { 140 RXO retVal = getTyped("RXO", RXO.class); 141 return retVal; 142 } 143 144 145 146 147 /** 148 * Returns 149 * ODS (Dietary orders, supplements, and preferences) - creates it if necessary 150 */ 151 public ODS getODS() { 152 ODS retVal = getTyped("ODS", ODS.class); 153 return retVal; 154 } 155 156 157 158 159 /** 160 * Returns 161 * ODT (Diet tray instructions segment) - creates it if necessary 162 */ 163 public ODT getODT() { 164 ODT retVal = getTyped("ODT", ODT.class); 165 return retVal; 166 } 167 168 169 170 171 /** 172 * Returns 173 * the first repetition of 174 * NTE (Notes and comments segment) - creates it if necessary 175 */ 176 public NTE getNTE() { 177 NTE retVal = getTyped("NTE", NTE.class); 178 return retVal; 179 } 180 181 182 /** 183 * Returns a specific repetition of 184 * NTE (Notes and comments segment) - creates it if necessary 185 * 186 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 187 * @throws HL7Exception if the repetition requested is more than one 188 * greater than the number of existing repetitions. 189 */ 190 public NTE getNTE(int rep) { 191 NTE retVal = getTyped("NTE", rep, NTE.class); 192 return retVal; 193 } 194 195 /** 196 * Returns the number of existing repetitions of NTE 197 */ 198 public int getNTEReps() { 199 return getReps("NTE"); 200 } 201 202 /** 203 * <p> 204 * Returns a non-modifiable List containing all current existing repetitions of NTE. 205 * <p> 206 * <p> 207 * Note that unlike {@link #getNTE()}, this method will not create any reps 208 * if none are already present, so an empty list may be returned. 209 * </p> 210 */ 211 public java.util.List<NTE> getNTEAll() throws HL7Exception { 212 return getAllAsList("NTE", NTE.class); 213 } 214 215 /** 216 * Inserts a specific repetition of NTE (Notes and comments segment) 217 * @see AbstractGroup#insertRepetition(Structure, int) 218 */ 219 public void insertNTE(NTE structure, int rep) throws HL7Exception { 220 super.insertRepetition("NTE", structure, rep); 221 } 222 223 224 /** 225 * Inserts a specific repetition of NTE (Notes and comments segment) 226 * @see AbstractGroup#insertRepetition(Structure, int) 227 */ 228 public NTE insertNTE(int rep) throws HL7Exception { 229 return (NTE)super.insertRepetition("NTE", rep); 230 } 231 232 233 /** 234 * Removes a specific repetition of NTE (Notes and comments segment) 235 * @see AbstractGroup#removeRepetition(String, int) 236 */ 237 public NTE removeNTE(int rep) throws HL7Exception { 238 return (NTE)super.removeRepetition("NTE", rep); 239 } 240 241 242 243 /** 244 * Returns 245 * the first repetition of 246 * DG1 (Diagnosis) - creates it if necessary 247 */ 248 public DG1 getDG1() { 249 DG1 retVal = getTyped("DG1", DG1.class); 250 return retVal; 251 } 252 253 254 /** 255 * Returns a specific repetition of 256 * DG1 (Diagnosis) - creates it if necessary 257 * 258 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 259 * @throws HL7Exception if the repetition requested is more than one 260 * greater than the number of existing repetitions. 261 */ 262 public DG1 getDG1(int rep) { 263 DG1 retVal = getTyped("DG1", rep, DG1.class); 264 return retVal; 265 } 266 267 /** 268 * Returns the number of existing repetitions of DG1 269 */ 270 public int getDG1Reps() { 271 return getReps("DG1"); 272 } 273 274 /** 275 * <p> 276 * Returns a non-modifiable List containing all current existing repetitions of DG1. 277 * <p> 278 * <p> 279 * Note that unlike {@link #getDG1()}, this method will not create any reps 280 * if none are already present, so an empty list may be returned. 281 * </p> 282 */ 283 public java.util.List<DG1> getDG1All() throws HL7Exception { 284 return getAllAsList("DG1", DG1.class); 285 } 286 287 /** 288 * Inserts a specific repetition of DG1 (Diagnosis) 289 * @see AbstractGroup#insertRepetition(Structure, int) 290 */ 291 public void insertDG1(DG1 structure, int rep) throws HL7Exception { 292 super.insertRepetition("DG1", structure, rep); 293 } 294 295 296 /** 297 * Inserts a specific repetition of DG1 (Diagnosis) 298 * @see AbstractGroup#insertRepetition(Structure, int) 299 */ 300 public DG1 insertDG1(int rep) throws HL7Exception { 301 return (DG1)super.insertRepetition("DG1", rep); 302 } 303 304 305 /** 306 * Removes a specific repetition of DG1 (Diagnosis) 307 * @see AbstractGroup#removeRepetition(String, int) 308 */ 309 public DG1 removeDG1(int rep) throws HL7Exception { 310 return (DG1)super.removeRepetition("DG1", rep); 311 } 312 313 314 315 /** 316 * Returns 317 * the first repetition of 318 * OBSERVATION (a Group object) - creates it if necessary 319 */ 320 public ORM_O01_OBSERVATION getOBSERVATION() { 321 ORM_O01_OBSERVATION retVal = getTyped("OBSERVATION", ORM_O01_OBSERVATION.class); 322 return retVal; 323 } 324 325 326 /** 327 * Returns a specific repetition of 328 * OBSERVATION (a Group object) - creates it if necessary 329 * 330 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 331 * @throws HL7Exception if the repetition requested is more than one 332 * greater than the number of existing repetitions. 333 */ 334 public ORM_O01_OBSERVATION getOBSERVATION(int rep) { 335 ORM_O01_OBSERVATION retVal = getTyped("OBSERVATION", rep, ORM_O01_OBSERVATION.class); 336 return retVal; 337 } 338 339 /** 340 * Returns the number of existing repetitions of OBSERVATION 341 */ 342 public int getOBSERVATIONReps() { 343 return getReps("OBSERVATION"); 344 } 345 346 /** 347 * <p> 348 * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION. 349 * <p> 350 * <p> 351 * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps 352 * if none are already present, so an empty list may be returned. 353 * </p> 354 */ 355 public java.util.List<ORM_O01_OBSERVATION> getOBSERVATIONAll() throws HL7Exception { 356 return getAllAsList("OBSERVATION", ORM_O01_OBSERVATION.class); 357 } 358 359 /** 360 * Inserts a specific repetition of OBSERVATION (a Group object) 361 * @see AbstractGroup#insertRepetition(Structure, int) 362 */ 363 public void insertOBSERVATION(ORM_O01_OBSERVATION structure, int rep) throws HL7Exception { 364 super.insertRepetition("OBSERVATION", structure, rep); 365 } 366 367 368 /** 369 * Inserts a specific repetition of OBSERVATION (a Group object) 370 * @see AbstractGroup#insertRepetition(Structure, int) 371 */ 372 public ORM_O01_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 373 return (ORM_O01_OBSERVATION)super.insertRepetition("OBSERVATION", rep); 374 } 375 376 377 /** 378 * Removes a specific repetition of OBSERVATION (a Group object) 379 * @see AbstractGroup#removeRepetition(String, int) 380 */ 381 public ORM_O01_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 382 return (ORM_O01_OBSERVATION)super.removeRepetition("OBSERVATION", rep); 383 } 384 385 386 387} 388