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