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.v28.group; 35 36 import ca.uhn.hl7v2.model.v28.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 DPR_O48_DONOR 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: PID (Patient Identification) <b> </b></li> 49 * <li>2: PD1 (Patient Additional Demographic) <b>optional </b></li> 50 * <li>3: OBX (Observation/Result) <b>optional repeating </b></li> 51 * <li>4: NTE (Notes and Comments) <b>optional repeating </b></li> 52 * <li>5: AL1 (Patient Allergy Information) <b>optional repeating </b></li> 53 * <li>6: ARV (Access Restriction) <b>optional repeating </b></li> 54 * <li>7: DPR_O48_DONOR_REGISTRATION (a Group object) <b>optional </b></li> 55 * </ul> 56 */ 57 //@SuppressWarnings("unused") 58 public class DPR_O48_DONOR extends AbstractGroup { 59 60 /** 61 * Creates a new DPR_O48_DONOR group 62 */ 63 public DPR_O48_DONOR(Group parent, ModelClassFactory factory) { 64 super(parent, factory); 65 init(factory); 66 } 67 68 private void init(ModelClassFactory factory) { 69 try { 70 this.add(PID.class, true, false, false); 71 this.add(PD1.class, false, false, false); 72 this.add(OBX.class, false, true, false); 73 this.add(NTE.class, false, true, false); 74 this.add(AL1.class, false, true, false); 75 this.add(ARV.class, false, true, false); 76 this.add(DPR_O48_DONOR_REGISTRATION.class, false, false, false); 77 } catch(HL7Exception e) { 78 log.error("Unexpected error creating DPR_O48_DONOR - this is probably a bug in the source code generator.", e); 79 } 80 } 81 82 /** 83 * Returns "2.8" 84 */ 85 public String getVersion() { 86 return "2.8"; 87 } 88 89 90 91 /** 92 * Returns 93 * PID (Patient Identification) - creates it if necessary 94 */ 95 public PID getPID() { 96 PID retVal = getTyped("PID", PID.class); 97 return retVal; 98 } 99 100 101 102 103 /** 104 * Returns 105 * PD1 (Patient Additional Demographic) - creates it if necessary 106 */ 107 public PD1 getPD1() { 108 PD1 retVal = getTyped("PD1", PD1.class); 109 return retVal; 110 } 111 112 113 114 115 /** 116 * Returns 117 * the first repetition of 118 * OBX (Observation/Result) - creates it if necessary 119 */ 120 public OBX getOBX() { 121 OBX retVal = getTyped("OBX", OBX.class); 122 return retVal; 123 } 124 125 126 /** 127 * Returns a specific repetition of 128 * OBX (Observation/Result) - creates it if necessary 129 * 130 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 131 * @throws HL7Exception if the repetition requested is more than one 132 * greater than the number of existing repetitions. 133 */ 134 public OBX getOBX(int rep) { 135 OBX retVal = getTyped("OBX", rep, OBX.class); 136 return retVal; 137 } 138 139 /** 140 * Returns the number of existing repetitions of OBX 141 */ 142 public int getOBXReps() { 143 return getReps("OBX"); 144 } 145 146 /** 147 * <p> 148 * Returns a non-modifiable List containing all current existing repetitions of OBX. 149 * <p> 150 * <p> 151 * Note that unlike {@link #getOBX()}, this method will not create any reps 152 * if none are already present, so an empty list may be returned. 153 * </p> 154 */ 155 public java.util.List<OBX> getOBXAll() throws HL7Exception { 156 return getAllAsList("OBX", OBX.class); 157 } 158 159 /** 160 * Inserts a specific repetition of OBX (Observation/Result) 161 * @see AbstractGroup#insertRepetition(Structure, int) 162 */ 163 public void insertOBX(OBX structure, int rep) throws HL7Exception { 164 super.insertRepetition("OBX", structure, rep); 165 } 166 167 168 /** 169 * Inserts a specific repetition of OBX (Observation/Result) 170 * @see AbstractGroup#insertRepetition(Structure, int) 171 */ 172 public OBX insertOBX(int rep) throws HL7Exception { 173 return (OBX)super.insertRepetition("OBX", rep); 174 } 175 176 177 /** 178 * Removes a specific repetition of OBX (Observation/Result) 179 * @see AbstractGroup#removeRepetition(String, int) 180 */ 181 public OBX removeOBX(int rep) throws HL7Exception { 182 return (OBX)super.removeRepetition("OBX", rep); 183 } 184 185 186 187 /** 188 * Returns 189 * the first repetition of 190 * NTE (Notes and Comments) - creates it if necessary 191 */ 192 public NTE getNTE() { 193 NTE retVal = getTyped("NTE", NTE.class); 194 return retVal; 195 } 196 197 198 /** 199 * Returns a specific repetition of 200 * NTE (Notes and Comments) - creates it if necessary 201 * 202 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 203 * @throws HL7Exception if the repetition requested is more than one 204 * greater than the number of existing repetitions. 205 */ 206 public NTE getNTE(int rep) { 207 NTE retVal = getTyped("NTE", rep, NTE.class); 208 return retVal; 209 } 210 211 /** 212 * Returns the number of existing repetitions of NTE 213 */ 214 public int getNTEReps() { 215 return getReps("NTE"); 216 } 217 218 /** 219 * <p> 220 * Returns a non-modifiable List containing all current existing repetitions of NTE. 221 * <p> 222 * <p> 223 * Note that unlike {@link #getNTE()}, this method will not create any reps 224 * if none are already present, so an empty list may be returned. 225 * </p> 226 */ 227 public java.util.List<NTE> getNTEAll() throws HL7Exception { 228 return getAllAsList("NTE", NTE.class); 229 } 230 231 /** 232 * Inserts a specific repetition of NTE (Notes and Comments) 233 * @see AbstractGroup#insertRepetition(Structure, int) 234 */ 235 public void insertNTE(NTE structure, int rep) throws HL7Exception { 236 super.insertRepetition("NTE", structure, rep); 237 } 238 239 240 /** 241 * Inserts a specific repetition of NTE (Notes and Comments) 242 * @see AbstractGroup#insertRepetition(Structure, int) 243 */ 244 public NTE insertNTE(int rep) throws HL7Exception { 245 return (NTE)super.insertRepetition("NTE", rep); 246 } 247 248 249 /** 250 * Removes a specific repetition of NTE (Notes and Comments) 251 * @see AbstractGroup#removeRepetition(String, int) 252 */ 253 public NTE removeNTE(int rep) throws HL7Exception { 254 return (NTE)super.removeRepetition("NTE", rep); 255 } 256 257 258 259 /** 260 * Returns 261 * the first repetition of 262 * AL1 (Patient Allergy Information) - creates it if necessary 263 */ 264 public AL1 getAL1() { 265 AL1 retVal = getTyped("AL1", AL1.class); 266 return retVal; 267 } 268 269 270 /** 271 * Returns a specific repetition of 272 * AL1 (Patient Allergy Information) - creates it if necessary 273 * 274 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 275 * @throws HL7Exception if the repetition requested is more than one 276 * greater than the number of existing repetitions. 277 */ 278 public AL1 getAL1(int rep) { 279 AL1 retVal = getTyped("AL1", rep, AL1.class); 280 return retVal; 281 } 282 283 /** 284 * Returns the number of existing repetitions of AL1 285 */ 286 public int getAL1Reps() { 287 return getReps("AL1"); 288 } 289 290 /** 291 * <p> 292 * Returns a non-modifiable List containing all current existing repetitions of AL1. 293 * <p> 294 * <p> 295 * Note that unlike {@link #getAL1()}, this method will not create any reps 296 * if none are already present, so an empty list may be returned. 297 * </p> 298 */ 299 public java.util.List<AL1> getAL1All() throws HL7Exception { 300 return getAllAsList("AL1", AL1.class); 301 } 302 303 /** 304 * Inserts a specific repetition of AL1 (Patient Allergy Information) 305 * @see AbstractGroup#insertRepetition(Structure, int) 306 */ 307 public void insertAL1(AL1 structure, int rep) throws HL7Exception { 308 super.insertRepetition("AL1", structure, rep); 309 } 310 311 312 /** 313 * Inserts a specific repetition of AL1 (Patient Allergy Information) 314 * @see AbstractGroup#insertRepetition(Structure, int) 315 */ 316 public AL1 insertAL1(int rep) throws HL7Exception { 317 return (AL1)super.insertRepetition("AL1", rep); 318 } 319 320 321 /** 322 * Removes a specific repetition of AL1 (Patient Allergy Information) 323 * @see AbstractGroup#removeRepetition(String, int) 324 */ 325 public AL1 removeAL1(int rep) throws HL7Exception { 326 return (AL1)super.removeRepetition("AL1", rep); 327 } 328 329 330 331 /** 332 * Returns 333 * the first repetition of 334 * ARV (Access Restriction) - creates it if necessary 335 */ 336 public ARV getARV() { 337 ARV retVal = getTyped("ARV", ARV.class); 338 return retVal; 339 } 340 341 342 /** 343 * Returns a specific repetition of 344 * ARV (Access Restriction) - creates it if necessary 345 * 346 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 347 * @throws HL7Exception if the repetition requested is more than one 348 * greater than the number of existing repetitions. 349 */ 350 public ARV getARV(int rep) { 351 ARV retVal = getTyped("ARV", rep, ARV.class); 352 return retVal; 353 } 354 355 /** 356 * Returns the number of existing repetitions of ARV 357 */ 358 public int getARVReps() { 359 return getReps("ARV"); 360 } 361 362 /** 363 * <p> 364 * Returns a non-modifiable List containing all current existing repetitions of ARV. 365 * <p> 366 * <p> 367 * Note that unlike {@link #getARV()}, this method will not create any reps 368 * if none are already present, so an empty list may be returned. 369 * </p> 370 */ 371 public java.util.List<ARV> getARVAll() throws HL7Exception { 372 return getAllAsList("ARV", ARV.class); 373 } 374 375 /** 376 * Inserts a specific repetition of ARV (Access Restriction) 377 * @see AbstractGroup#insertRepetition(Structure, int) 378 */ 379 public void insertARV(ARV structure, int rep) throws HL7Exception { 380 super.insertRepetition("ARV", structure, rep); 381 } 382 383 384 /** 385 * Inserts a specific repetition of ARV (Access Restriction) 386 * @see AbstractGroup#insertRepetition(Structure, int) 387 */ 388 public ARV insertARV(int rep) throws HL7Exception { 389 return (ARV)super.insertRepetition("ARV", rep); 390 } 391 392 393 /** 394 * Removes a specific repetition of ARV (Access Restriction) 395 * @see AbstractGroup#removeRepetition(String, int) 396 */ 397 public ARV removeARV(int rep) throws HL7Exception { 398 return (ARV)super.removeRepetition("ARV", rep); 399 } 400 401 402 403 /** 404 * Returns 405 * DONOR_REGISTRATION (a Group object) - creates it if necessary 406 */ 407 public DPR_O48_DONOR_REGISTRATION getDONOR_REGISTRATION() { 408 DPR_O48_DONOR_REGISTRATION retVal = getTyped("DONOR_REGISTRATION", DPR_O48_DONOR_REGISTRATION.class); 409 return retVal; 410 } 411 412 413 414 415 } 416