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 ORR_O02_ORDER 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: ORC (Common order segment) <b> </b></li> 049 * <li>2: OBR (Observation request segment) <b> choice</b></li> 050 * <li>3: RQD (Requisition detail) <b> choice</b></li> 051 * <li>4: RQ1 (Requisition detail-1 segment) <b> choice</b></li> 052 * <li>5: RXO (Pharmacy prescription order segment) <b> choice</b></li> 053 * <li>6: ODS (Dietary orders, supplements, and preferences) <b> choice</b></li> 054 * <li>7: ODT (Diet tray instructions segment) <b> choice</b></li> 055 * <li>8: NTE (Notes and comments segment) <b>optional repeating </b></li> 056 * <li>9: CTI (Clinical Trial Identification) <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 ORR_O02_ORDER extends AbstractGroup { 065 066 /** 067 * Creates a new ORR_O02_ORDER group 068 */ 069 public ORR_O02_ORDER(Group parent, ModelClassFactory factory) { 070 super(parent, factory); 071 init(factory); 072 } 073 074 private void init(ModelClassFactory factory) { 075 try { 076 this.add(ORC.class, true, false, false); 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(CTI.class, false, true, false); 085 } catch(HL7Exception e) { 086 log.error("Unexpected error creating ORR_O02_ORDER - 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 * ORC (Common order segment) - creates it if necessary 102 */ 103 public ORC getORC() { 104 ORC retVal = getTyped("ORC", ORC.class); 105 return retVal; 106 } 107 108 109 110 111 /** 112 * Returns 113 * OBR (Observation request segment) - creates it if necessary 114 */ 115 public OBR getOBR() { 116 OBR retVal = getTyped("OBR", OBR.class); 117 return retVal; 118 } 119 120 121 122 123 /** 124 * Returns 125 * RQD (Requisition detail) - creates it if necessary 126 */ 127 public RQD getRQD() { 128 RQD retVal = getTyped("RQD", RQD.class); 129 return retVal; 130 } 131 132 133 134 135 /** 136 * Returns 137 * RQ1 (Requisition detail-1 segment) - creates it if necessary 138 */ 139 public RQ1 getRQ1() { 140 RQ1 retVal = getTyped("RQ1", RQ1.class); 141 return retVal; 142 } 143 144 145 146 147 /** 148 * Returns 149 * RXO (Pharmacy prescription order segment) - creates it if necessary 150 */ 151 public RXO getRXO() { 152 RXO retVal = getTyped("RXO", RXO.class); 153 return retVal; 154 } 155 156 157 158 159 /** 160 * Returns 161 * ODS (Dietary orders, supplements, and preferences) - creates it if necessary 162 */ 163 public ODS getODS() { 164 ODS retVal = getTyped("ODS", ODS.class); 165 return retVal; 166 } 167 168 169 170 171 /** 172 * Returns 173 * ODT (Diet tray instructions segment) - creates it if necessary 174 */ 175 public ODT getODT() { 176 ODT retVal = getTyped("ODT", ODT.class); 177 return retVal; 178 } 179 180 181 182 183 /** 184 * Returns 185 * the first repetition of 186 * NTE (Notes and comments segment) - creates it if necessary 187 */ 188 public NTE getNTE() { 189 NTE retVal = getTyped("NTE", NTE.class); 190 return retVal; 191 } 192 193 194 /** 195 * Returns a specific repetition of 196 * NTE (Notes and comments segment) - creates it if necessary 197 * 198 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 199 * @throws HL7Exception if the repetition requested is more than one 200 * greater than the number of existing repetitions. 201 */ 202 public NTE getNTE(int rep) { 203 NTE retVal = getTyped("NTE", rep, NTE.class); 204 return retVal; 205 } 206 207 /** 208 * Returns the number of existing repetitions of NTE 209 */ 210 public int getNTEReps() { 211 return getReps("NTE"); 212 } 213 214 /** 215 * <p> 216 * Returns a non-modifiable List containing all current existing repetitions of NTE. 217 * <p> 218 * <p> 219 * Note that unlike {@link #getNTE()}, this method will not create any reps 220 * if none are already present, so an empty list may be returned. 221 * </p> 222 */ 223 public java.util.List<NTE> getNTEAll() throws HL7Exception { 224 return getAllAsList("NTE", NTE.class); 225 } 226 227 /** 228 * Inserts a specific repetition of NTE (Notes and comments segment) 229 * @see AbstractGroup#insertRepetition(Structure, int) 230 */ 231 public void insertNTE(NTE structure, int rep) throws HL7Exception { 232 super.insertRepetition("NTE", structure, rep); 233 } 234 235 236 /** 237 * Inserts a specific repetition of NTE (Notes and comments segment) 238 * @see AbstractGroup#insertRepetition(Structure, int) 239 */ 240 public NTE insertNTE(int rep) throws HL7Exception { 241 return (NTE)super.insertRepetition("NTE", rep); 242 } 243 244 245 /** 246 * Removes a specific repetition of NTE (Notes and comments segment) 247 * @see AbstractGroup#removeRepetition(String, int) 248 */ 249 public NTE removeNTE(int rep) throws HL7Exception { 250 return (NTE)super.removeRepetition("NTE", rep); 251 } 252 253 254 255 /** 256 * Returns 257 * the first repetition of 258 * CTI (Clinical Trial Identification) - creates it if necessary 259 */ 260 public CTI getCTI() { 261 CTI retVal = getTyped("CTI", CTI.class); 262 return retVal; 263 } 264 265 266 /** 267 * Returns a specific repetition of 268 * CTI (Clinical Trial Identification) - creates it if necessary 269 * 270 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 271 * @throws HL7Exception if the repetition requested is more than one 272 * greater than the number of existing repetitions. 273 */ 274 public CTI getCTI(int rep) { 275 CTI retVal = getTyped("CTI", rep, CTI.class); 276 return retVal; 277 } 278 279 /** 280 * Returns the number of existing repetitions of CTI 281 */ 282 public int getCTIReps() { 283 return getReps("CTI"); 284 } 285 286 /** 287 * <p> 288 * Returns a non-modifiable List containing all current existing repetitions of CTI. 289 * <p> 290 * <p> 291 * Note that unlike {@link #getCTI()}, this method will not create any reps 292 * if none are already present, so an empty list may be returned. 293 * </p> 294 */ 295 public java.util.List<CTI> getCTIAll() throws HL7Exception { 296 return getAllAsList("CTI", CTI.class); 297 } 298 299 /** 300 * Inserts a specific repetition of CTI (Clinical Trial Identification) 301 * @see AbstractGroup#insertRepetition(Structure, int) 302 */ 303 public void insertCTI(CTI structure, int rep) throws HL7Exception { 304 super.insertRepetition("CTI", structure, rep); 305 } 306 307 308 /** 309 * Inserts a specific repetition of CTI (Clinical Trial Identification) 310 * @see AbstractGroup#insertRepetition(Structure, int) 311 */ 312 public CTI insertCTI(int rep) throws HL7Exception { 313 return (CTI)super.insertRepetition("CTI", rep); 314 } 315 316 317 /** 318 * Removes a specific repetition of CTI (Clinical Trial Identification) 319 * @see AbstractGroup#removeRepetition(String, int) 320 */ 321 public CTI removeCTI(int rep) throws HL7Exception { 322 return (CTI)super.removeRepetition("CTI", rep); 323 } 324 325 326 327} 328