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 ORF_R04_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>optional </b></li> 49 * <li>2: OBR (Observation Request) <b> </b></li> 50 * <li>3: NTE (Notes and Comments) <b>optional repeating </b></li> 51 * <li>4: CTD (Contact Data) <b>optional </b></li> 52 * <li>5: ORF_R04_OBSERVATION (a Group object) <b> repeating </b></li> 53 * <li>6: CTI (Clinical Trial Identification) <b>optional repeating </b></li> 54 * </ul> 55 */ 56 //@SuppressWarnings("unused") 57 public class ORF_R04_ORDER extends AbstractGroup { 58 59 /** 60 * Creates a new ORF_R04_ORDER group 61 */ 62 public ORF_R04_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, false, false, false); 70 this.add(OBR.class, true, false, false); 71 this.add(NTE.class, false, true, false); 72 this.add(CTD.class, false, false, false); 73 this.add(ORF_R04_OBSERVATION.class, true, true, false); 74 this.add(CTI.class, false, true, false); 75 } catch(HL7Exception e) { 76 log.error("Unexpected error creating ORF_R04_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 * 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 * the first repetition of 116 * NTE (Notes and Comments) - creates it if necessary 117 */ 118 public NTE getNTE() { 119 NTE retVal = getTyped("NTE", NTE.class); 120 return retVal; 121 } 122 123 124 /** 125 * Returns a specific repetition of 126 * NTE (Notes and Comments) - creates it if necessary 127 * 128 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 129 * @throws HL7Exception if the repetition requested is more than one 130 * greater than the number of existing repetitions. 131 */ 132 public NTE getNTE(int rep) { 133 NTE retVal = getTyped("NTE", rep, NTE.class); 134 return retVal; 135 } 136 137 /** 138 * Returns the number of existing repetitions of NTE 139 */ 140 public int getNTEReps() { 141 return getReps("NTE"); 142 } 143 144 /** 145 * <p> 146 * Returns a non-modifiable List containing all current existing repetitions of NTE. 147 * <p> 148 * <p> 149 * Note that unlike {@link #getNTE()}, this method will not create any reps 150 * if none are already present, so an empty list may be returned. 151 * </p> 152 */ 153 public java.util.List<NTE> getNTEAll() throws HL7Exception { 154 return getAllAsList("NTE", NTE.class); 155 } 156 157 /** 158 * Inserts a specific repetition of NTE (Notes and Comments) 159 * @see AbstractGroup#insertRepetition(Structure, int) 160 */ 161 public void insertNTE(NTE structure, int rep) throws HL7Exception { 162 super.insertRepetition("NTE", structure, rep); 163 } 164 165 166 /** 167 * Inserts a specific repetition of NTE (Notes and Comments) 168 * @see AbstractGroup#insertRepetition(Structure, int) 169 */ 170 public NTE insertNTE(int rep) throws HL7Exception { 171 return (NTE)super.insertRepetition("NTE", rep); 172 } 173 174 175 /** 176 * Removes a specific repetition of NTE (Notes and Comments) 177 * @see AbstractGroup#removeRepetition(String, int) 178 */ 179 public NTE removeNTE(int rep) throws HL7Exception { 180 return (NTE)super.removeRepetition("NTE", rep); 181 } 182 183 184 185 /** 186 * Returns 187 * CTD (Contact Data) - creates it if necessary 188 */ 189 public CTD getCTD() { 190 CTD retVal = getTyped("CTD", CTD.class); 191 return retVal; 192 } 193 194 195 196 197 /** 198 * Returns 199 * the first repetition of 200 * OBSERVATION (a Group object) - creates it if necessary 201 */ 202 public ORF_R04_OBSERVATION getOBSERVATION() { 203 ORF_R04_OBSERVATION retVal = getTyped("OBSERVATION", ORF_R04_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 ORF_R04_OBSERVATION getOBSERVATION(int rep) { 217 ORF_R04_OBSERVATION retVal = getTyped("OBSERVATION", rep, ORF_R04_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<ORF_R04_OBSERVATION> getOBSERVATIONAll() throws HL7Exception { 238 return getAllAsList("OBSERVATION", ORF_R04_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(ORF_R04_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 ORF_R04_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 255 return (ORF_R04_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 ORF_R04_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 264 return (ORF_R04_OBSERVATION)super.removeRepetition("OBSERVATION", rep); 265 } 266 267 268 269 /** 270 * Returns 271 * the first repetition of 272 * CTI (Clinical Trial Identification) - creates it if necessary 273 */ 274 public CTI getCTI() { 275 CTI retVal = getTyped("CTI", CTI.class); 276 return retVal; 277 } 278 279 280 /** 281 * Returns a specific repetition of 282 * CTI (Clinical Trial Identification) - creates it if necessary 283 * 284 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 285 * @throws HL7Exception if the repetition requested is more than one 286 * greater than the number of existing repetitions. 287 */ 288 public CTI getCTI(int rep) { 289 CTI retVal = getTyped("CTI", rep, CTI.class); 290 return retVal; 291 } 292 293 /** 294 * Returns the number of existing repetitions of CTI 295 */ 296 public int getCTIReps() { 297 return getReps("CTI"); 298 } 299 300 /** 301 * <p> 302 * Returns a non-modifiable List containing all current existing repetitions of CTI. 303 * <p> 304 * <p> 305 * Note that unlike {@link #getCTI()}, this method will not create any reps 306 * if none are already present, so an empty list may be returned. 307 * </p> 308 */ 309 public java.util.List<CTI> getCTIAll() throws HL7Exception { 310 return getAllAsList("CTI", CTI.class); 311 } 312 313 /** 314 * Inserts a specific repetition of CTI (Clinical Trial Identification) 315 * @see AbstractGroup#insertRepetition(Structure, int) 316 */ 317 public void insertCTI(CTI structure, int rep) throws HL7Exception { 318 super.insertRepetition("CTI", structure, rep); 319 } 320 321 322 /** 323 * Inserts a specific repetition of CTI (Clinical Trial Identification) 324 * @see AbstractGroup#insertRepetition(Structure, int) 325 */ 326 public CTI insertCTI(int rep) throws HL7Exception { 327 return (CTI)super.insertRepetition("CTI", rep); 328 } 329 330 331 /** 332 * Removes a specific repetition of CTI (Clinical Trial Identification) 333 * @see AbstractGroup#removeRepetition(String, int) 334 */ 335 public CTI removeCTI(int rep) throws HL7Exception { 336 return (CTI)super.removeRepetition("CTI", rep); 337 } 338 339 340 341 } 342