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 OMG_O19_PATIENT 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: PID (Patient Identification) <b> </b></li> 049 * <li>2: PD1 (Patient Additional Demographic) <b>optional </b></li> 050 * <li>3: NTE (Notes and Comments) <b>optional repeating </b></li> 051 * <li>4: NK1 (Next of Kin / Associated Parties) <b>optional repeating </b></li> 052 * <li>5: OMG_O19_PATIENT_VISIT (a Group object) <b>optional </b></li> 053 * <li>6: OMG_O19_INSURANCE (a Group object) <b>optional repeating </b></li> 054 * <li>7: GT1 (Guarantor) <b>optional </b></li> 055 * <li>8: AL1 (Patient Allergy Information) <b>optional repeating </b></li> 056 * </ul> 057 */ 058//@SuppressWarnings("unused") 059public class OMG_O19_PATIENT extends AbstractGroup { 060 061 /** 062 * Creates a new OMG_O19_PATIENT group 063 */ 064 public OMG_O19_PATIENT(Group parent, ModelClassFactory factory) { 065 super(parent, factory); 066 init(factory); 067 } 068 069 private void init(ModelClassFactory factory) { 070 try { 071 this.add(PID.class, true, false, false); 072 this.add(PD1.class, false, false, false); 073 this.add(NTE.class, false, true, false); 074 this.add(NK1.class, false, true, false); 075 this.add(OMG_O19_PATIENT_VISIT.class, false, false, false); 076 this.add(OMG_O19_INSURANCE.class, false, true, false); 077 this.add(GT1.class, false, false, false); 078 this.add(AL1.class, false, true, false); 079 } catch(HL7Exception e) { 080 log.error("Unexpected error creating OMG_O19_PATIENT - this is probably a bug in the source code generator.", e); 081 } 082 } 083 084 /** 085 * Returns "2.5" 086 */ 087 public String getVersion() { 088 return "2.5"; 089 } 090 091 092 093 /** 094 * Returns 095 * PID (Patient Identification) - creates it if necessary 096 */ 097 public PID getPID() { 098 PID retVal = getTyped("PID", PID.class); 099 return retVal; 100 } 101 102 103 104 105 /** 106 * Returns 107 * PD1 (Patient Additional Demographic) - creates it if necessary 108 */ 109 public PD1 getPD1() { 110 PD1 retVal = getTyped("PD1", PD1.class); 111 return retVal; 112 } 113 114 115 116 117 /** 118 * Returns 119 * the first repetition of 120 * NTE (Notes and Comments) - creates it if necessary 121 */ 122 public NTE getNTE() { 123 NTE retVal = getTyped("NTE", NTE.class); 124 return retVal; 125 } 126 127 128 /** 129 * Returns a specific repetition of 130 * NTE (Notes and Comments) - creates it if necessary 131 * 132 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 133 * @throws HL7Exception if the repetition requested is more than one 134 * greater than the number of existing repetitions. 135 */ 136 public NTE getNTE(int rep) { 137 NTE retVal = getTyped("NTE", rep, NTE.class); 138 return retVal; 139 } 140 141 /** 142 * Returns the number of existing repetitions of NTE 143 */ 144 public int getNTEReps() { 145 return getReps("NTE"); 146 } 147 148 /** 149 * <p> 150 * Returns a non-modifiable List containing all current existing repetitions of NTE. 151 * <p> 152 * <p> 153 * Note that unlike {@link #getNTE()}, this method will not create any reps 154 * if none are already present, so an empty list may be returned. 155 * </p> 156 */ 157 public java.util.List<NTE> getNTEAll() throws HL7Exception { 158 return getAllAsList("NTE", NTE.class); 159 } 160 161 /** 162 * Inserts a specific repetition of NTE (Notes and Comments) 163 * @see AbstractGroup#insertRepetition(Structure, int) 164 */ 165 public void insertNTE(NTE structure, int rep) throws HL7Exception { 166 super.insertRepetition("NTE", structure, rep); 167 } 168 169 170 /** 171 * Inserts a specific repetition of NTE (Notes and Comments) 172 * @see AbstractGroup#insertRepetition(Structure, int) 173 */ 174 public NTE insertNTE(int rep) throws HL7Exception { 175 return (NTE)super.insertRepetition("NTE", rep); 176 } 177 178 179 /** 180 * Removes a specific repetition of NTE (Notes and Comments) 181 * @see AbstractGroup#removeRepetition(String, int) 182 */ 183 public NTE removeNTE(int rep) throws HL7Exception { 184 return (NTE)super.removeRepetition("NTE", rep); 185 } 186 187 188 189 /** 190 * Returns 191 * the first repetition of 192 * NK1 (Next of Kin / Associated Parties) - creates it if necessary 193 */ 194 public NK1 getNK1() { 195 NK1 retVal = getTyped("NK1", NK1.class); 196 return retVal; 197 } 198 199 200 /** 201 * Returns a specific repetition of 202 * NK1 (Next of Kin / Associated Parties) - creates it if necessary 203 * 204 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 205 * @throws HL7Exception if the repetition requested is more than one 206 * greater than the number of existing repetitions. 207 */ 208 public NK1 getNK1(int rep) { 209 NK1 retVal = getTyped("NK1", rep, NK1.class); 210 return retVal; 211 } 212 213 /** 214 * Returns the number of existing repetitions of NK1 215 */ 216 public int getNK1Reps() { 217 return getReps("NK1"); 218 } 219 220 /** 221 * <p> 222 * Returns a non-modifiable List containing all current existing repetitions of NK1. 223 * <p> 224 * <p> 225 * Note that unlike {@link #getNK1()}, this method will not create any reps 226 * if none are already present, so an empty list may be returned. 227 * </p> 228 */ 229 public java.util.List<NK1> getNK1All() throws HL7Exception { 230 return getAllAsList("NK1", NK1.class); 231 } 232 233 /** 234 * Inserts a specific repetition of NK1 (Next of Kin / Associated Parties) 235 * @see AbstractGroup#insertRepetition(Structure, int) 236 */ 237 public void insertNK1(NK1 structure, int rep) throws HL7Exception { 238 super.insertRepetition("NK1", structure, rep); 239 } 240 241 242 /** 243 * Inserts a specific repetition of NK1 (Next of Kin / Associated Parties) 244 * @see AbstractGroup#insertRepetition(Structure, int) 245 */ 246 public NK1 insertNK1(int rep) throws HL7Exception { 247 return (NK1)super.insertRepetition("NK1", rep); 248 } 249 250 251 /** 252 * Removes a specific repetition of NK1 (Next of Kin / Associated Parties) 253 * @see AbstractGroup#removeRepetition(String, int) 254 */ 255 public NK1 removeNK1(int rep) throws HL7Exception { 256 return (NK1)super.removeRepetition("NK1", rep); 257 } 258 259 260 261 /** 262 * Returns 263 * PATIENT_VISIT (a Group object) - creates it if necessary 264 */ 265 public OMG_O19_PATIENT_VISIT getPATIENT_VISIT() { 266 OMG_O19_PATIENT_VISIT retVal = getTyped("PATIENT_VISIT", OMG_O19_PATIENT_VISIT.class); 267 return retVal; 268 } 269 270 271 272 273 /** 274 * Returns 275 * the first repetition of 276 * INSURANCE (a Group object) - creates it if necessary 277 */ 278 public OMG_O19_INSURANCE getINSURANCE() { 279 OMG_O19_INSURANCE retVal = getTyped("INSURANCE", OMG_O19_INSURANCE.class); 280 return retVal; 281 } 282 283 284 /** 285 * Returns a specific repetition of 286 * INSURANCE (a Group object) - creates it if necessary 287 * 288 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 289 * @throws HL7Exception if the repetition requested is more than one 290 * greater than the number of existing repetitions. 291 */ 292 public OMG_O19_INSURANCE getINSURANCE(int rep) { 293 OMG_O19_INSURANCE retVal = getTyped("INSURANCE", rep, OMG_O19_INSURANCE.class); 294 return retVal; 295 } 296 297 /** 298 * Returns the number of existing repetitions of INSURANCE 299 */ 300 public int getINSURANCEReps() { 301 return getReps("INSURANCE"); 302 } 303 304 /** 305 * <p> 306 * Returns a non-modifiable List containing all current existing repetitions of INSURANCE. 307 * <p> 308 * <p> 309 * Note that unlike {@link #getINSURANCE()}, this method will not create any reps 310 * if none are already present, so an empty list may be returned. 311 * </p> 312 */ 313 public java.util.List<OMG_O19_INSURANCE> getINSURANCEAll() throws HL7Exception { 314 return getAllAsList("INSURANCE", OMG_O19_INSURANCE.class); 315 } 316 317 /** 318 * Inserts a specific repetition of INSURANCE (a Group object) 319 * @see AbstractGroup#insertRepetition(Structure, int) 320 */ 321 public void insertINSURANCE(OMG_O19_INSURANCE structure, int rep) throws HL7Exception { 322 super.insertRepetition("INSURANCE", structure, rep); 323 } 324 325 326 /** 327 * Inserts a specific repetition of INSURANCE (a Group object) 328 * @see AbstractGroup#insertRepetition(Structure, int) 329 */ 330 public OMG_O19_INSURANCE insertINSURANCE(int rep) throws HL7Exception { 331 return (OMG_O19_INSURANCE)super.insertRepetition("INSURANCE", rep); 332 } 333 334 335 /** 336 * Removes a specific repetition of INSURANCE (a Group object) 337 * @see AbstractGroup#removeRepetition(String, int) 338 */ 339 public OMG_O19_INSURANCE removeINSURANCE(int rep) throws HL7Exception { 340 return (OMG_O19_INSURANCE)super.removeRepetition("INSURANCE", rep); 341 } 342 343 344 345 /** 346 * Returns 347 * GT1 (Guarantor) - creates it if necessary 348 */ 349 public GT1 getGT1() { 350 GT1 retVal = getTyped("GT1", GT1.class); 351 return retVal; 352 } 353 354 355 356 357 /** 358 * Returns 359 * the first repetition of 360 * AL1 (Patient Allergy Information) - creates it if necessary 361 */ 362 public AL1 getAL1() { 363 AL1 retVal = getTyped("AL1", AL1.class); 364 return retVal; 365 } 366 367 368 /** 369 * Returns a specific repetition of 370 * AL1 (Patient Allergy Information) - creates it if necessary 371 * 372 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 373 * @throws HL7Exception if the repetition requested is more than one 374 * greater than the number of existing repetitions. 375 */ 376 public AL1 getAL1(int rep) { 377 AL1 retVal = getTyped("AL1", rep, AL1.class); 378 return retVal; 379 } 380 381 /** 382 * Returns the number of existing repetitions of AL1 383 */ 384 public int getAL1Reps() { 385 return getReps("AL1"); 386 } 387 388 /** 389 * <p> 390 * Returns a non-modifiable List containing all current existing repetitions of AL1. 391 * <p> 392 * <p> 393 * Note that unlike {@link #getAL1()}, this method will not create any reps 394 * if none are already present, so an empty list may be returned. 395 * </p> 396 */ 397 public java.util.List<AL1> getAL1All() throws HL7Exception { 398 return getAllAsList("AL1", AL1.class); 399 } 400 401 /** 402 * Inserts a specific repetition of AL1 (Patient Allergy Information) 403 * @see AbstractGroup#insertRepetition(Structure, int) 404 */ 405 public void insertAL1(AL1 structure, int rep) throws HL7Exception { 406 super.insertRepetition("AL1", structure, rep); 407 } 408 409 410 /** 411 * Inserts a specific repetition of AL1 (Patient Allergy Information) 412 * @see AbstractGroup#insertRepetition(Structure, int) 413 */ 414 public AL1 insertAL1(int rep) throws HL7Exception { 415 return (AL1)super.insertRepetition("AL1", rep); 416 } 417 418 419 /** 420 * Removes a specific repetition of AL1 (Patient Allergy Information) 421 * @see AbstractGroup#removeRepetition(String, int) 422 */ 423 public AL1 removeAL1(int rep) throws HL7Exception { 424 return (AL1)super.removeRepetition("AL1", rep); 425 } 426 427 428 429} 430