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.v27.group; 035 036import ca.uhn.hl7v2.model.v27.segment.*; 037 038import ca.uhn.hl7v2.HL7Exception; 039import ca.uhn.hl7v2.parser.ModelClassFactory; 040import ca.uhn.hl7v2.model.*; 041 042/** 043 * <p>Represents a ORU_R01_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: PRT (Participation Information) <b>optional repeating </b></li> 051 * <li>4: NTE (Notes and Comments) <b>optional repeating </b></li> 052 * <li>5: NK1 (Next of Kin / Associated Parties) <b>optional repeating </b></li> 053 * <li>6: ORU_R01_PATIENT_OBSERVATION (a Group object) <b>optional repeating </b></li> 054 * <li>7: ORU_R01_VISIT (a Group object) <b>optional </b></li> 055 * </ul> 056 */ 057//@SuppressWarnings("unused") 058public class ORU_R01_PATIENT extends AbstractGroup { 059 060 /** 061 * Creates a new ORU_R01_PATIENT group 062 */ 063 public ORU_R01_PATIENT(Group parent, ModelClassFactory factory) { 064 super(parent, factory); 065 init(factory); 066 } 067 068 private void init(ModelClassFactory factory) { 069 try { 070 this.add(PID.class, true, false, false); 071 this.add(PD1.class, false, false, false); 072 this.add(PRT.class, false, true, false); 073 this.add(NTE.class, false, true, false); 074 this.add(NK1.class, false, true, false); 075 this.add(ORU_R01_PATIENT_OBSERVATION.class, false, true, false); 076 this.add(ORU_R01_VISIT.class, false, false, false); 077 } catch(HL7Exception e) { 078 log.error("Unexpected error creating ORU_R01_PATIENT - this is probably a bug in the source code generator.", e); 079 } 080 } 081 082 /** 083 * Returns "2.7" 084 */ 085 public String getVersion() { 086 return "2.7"; 087 } 088 089 090 091 /** 092 * Returns 093 * PID (Patient Identification) - creates it if necessary 094 */ 095 public PID getPID() { 096 PID retVal = getTyped("PID", PID.class); 097 return retVal; 098 } 099 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 * PRT (Participation Information) - creates it if necessary 119 */ 120 public PRT getPRT() { 121 PRT retVal = getTyped("PRT", PRT.class); 122 return retVal; 123 } 124 125 126 /** 127 * Returns a specific repetition of 128 * PRT (Participation Information) - 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 PRT getPRT(int rep) { 135 PRT retVal = getTyped("PRT", rep, PRT.class); 136 return retVal; 137 } 138 139 /** 140 * Returns the number of existing repetitions of PRT 141 */ 142 public int getPRTReps() { 143 return getReps("PRT"); 144 } 145 146 /** 147 * <p> 148 * Returns a non-modifiable List containing all current existing repetitions of PRT. 149 * <p> 150 * <p> 151 * Note that unlike {@link #getPRT()}, 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<PRT> getPRTAll() throws HL7Exception { 156 return getAllAsList("PRT", PRT.class); 157 } 158 159 /** 160 * Inserts a specific repetition of PRT (Participation Information) 161 * @see AbstractGroup#insertRepetition(Structure, int) 162 */ 163 public void insertPRT(PRT structure, int rep) throws HL7Exception { 164 super.insertRepetition("PRT", structure, rep); 165 } 166 167 168 /** 169 * Inserts a specific repetition of PRT (Participation Information) 170 * @see AbstractGroup#insertRepetition(Structure, int) 171 */ 172 public PRT insertPRT(int rep) throws HL7Exception { 173 return (PRT)super.insertRepetition("PRT", rep); 174 } 175 176 177 /** 178 * Removes a specific repetition of PRT (Participation Information) 179 * @see AbstractGroup#removeRepetition(String, int) 180 */ 181 public PRT removePRT(int rep) throws HL7Exception { 182 return (PRT)super.removeRepetition("PRT", 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 * NK1 (Next of Kin / Associated Parties) - creates it if necessary 263 */ 264 public NK1 getNK1() { 265 NK1 retVal = getTyped("NK1", NK1.class); 266 return retVal; 267 } 268 269 270 /** 271 * Returns a specific repetition of 272 * NK1 (Next of Kin / Associated Parties) - 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 NK1 getNK1(int rep) { 279 NK1 retVal = getTyped("NK1", rep, NK1.class); 280 return retVal; 281 } 282 283 /** 284 * Returns the number of existing repetitions of NK1 285 */ 286 public int getNK1Reps() { 287 return getReps("NK1"); 288 } 289 290 /** 291 * <p> 292 * Returns a non-modifiable List containing all current existing repetitions of NK1. 293 * <p> 294 * <p> 295 * Note that unlike {@link #getNK1()}, 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<NK1> getNK1All() throws HL7Exception { 300 return getAllAsList("NK1", NK1.class); 301 } 302 303 /** 304 * Inserts a specific repetition of NK1 (Next of Kin / Associated Parties) 305 * @see AbstractGroup#insertRepetition(Structure, int) 306 */ 307 public void insertNK1(NK1 structure, int rep) throws HL7Exception { 308 super.insertRepetition("NK1", structure, rep); 309 } 310 311 312 /** 313 * Inserts a specific repetition of NK1 (Next of Kin / Associated Parties) 314 * @see AbstractGroup#insertRepetition(Structure, int) 315 */ 316 public NK1 insertNK1(int rep) throws HL7Exception { 317 return (NK1)super.insertRepetition("NK1", rep); 318 } 319 320 321 /** 322 * Removes a specific repetition of NK1 (Next of Kin / Associated Parties) 323 * @see AbstractGroup#removeRepetition(String, int) 324 */ 325 public NK1 removeNK1(int rep) throws HL7Exception { 326 return (NK1)super.removeRepetition("NK1", rep); 327 } 328 329 330 331 /** 332 * Returns 333 * the first repetition of 334 * PATIENT_OBSERVATION (a Group object) - creates it if necessary 335 */ 336 public ORU_R01_PATIENT_OBSERVATION getPATIENT_OBSERVATION() { 337 ORU_R01_PATIENT_OBSERVATION retVal = getTyped("PATIENT_OBSERVATION", ORU_R01_PATIENT_OBSERVATION.class); 338 return retVal; 339 } 340 341 342 /** 343 * Returns a specific repetition of 344 * PATIENT_OBSERVATION (a Group object) - 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 ORU_R01_PATIENT_OBSERVATION getPATIENT_OBSERVATION(int rep) { 351 ORU_R01_PATIENT_OBSERVATION retVal = getTyped("PATIENT_OBSERVATION", rep, ORU_R01_PATIENT_OBSERVATION.class); 352 return retVal; 353 } 354 355 /** 356 * Returns the number of existing repetitions of PATIENT_OBSERVATION 357 */ 358 public int getPATIENT_OBSERVATIONReps() { 359 return getReps("PATIENT_OBSERVATION"); 360 } 361 362 /** 363 * <p> 364 * Returns a non-modifiable List containing all current existing repetitions of PATIENT_OBSERVATION. 365 * <p> 366 * <p> 367 * Note that unlike {@link #getPATIENT_OBSERVATION()}, 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<ORU_R01_PATIENT_OBSERVATION> getPATIENT_OBSERVATIONAll() throws HL7Exception { 372 return getAllAsList("PATIENT_OBSERVATION", ORU_R01_PATIENT_OBSERVATION.class); 373 } 374 375 /** 376 * Inserts a specific repetition of PATIENT_OBSERVATION (a Group object) 377 * @see AbstractGroup#insertRepetition(Structure, int) 378 */ 379 public void insertPATIENT_OBSERVATION(ORU_R01_PATIENT_OBSERVATION structure, int rep) throws HL7Exception { 380 super.insertRepetition("PATIENT_OBSERVATION", structure, rep); 381 } 382 383 384 /** 385 * Inserts a specific repetition of PATIENT_OBSERVATION (a Group object) 386 * @see AbstractGroup#insertRepetition(Structure, int) 387 */ 388 public ORU_R01_PATIENT_OBSERVATION insertPATIENT_OBSERVATION(int rep) throws HL7Exception { 389 return (ORU_R01_PATIENT_OBSERVATION)super.insertRepetition("PATIENT_OBSERVATION", rep); 390 } 391 392 393 /** 394 * Removes a specific repetition of PATIENT_OBSERVATION (a Group object) 395 * @see AbstractGroup#removeRepetition(String, int) 396 */ 397 public ORU_R01_PATIENT_OBSERVATION removePATIENT_OBSERVATION(int rep) throws HL7Exception { 398 return (ORU_R01_PATIENT_OBSERVATION)super.removeRepetition("PATIENT_OBSERVATION", rep); 399 } 400 401 402 403 /** 404 * Returns 405 * VISIT (a Group object) - creates it if necessary 406 */ 407 public ORU_R01_VISIT getVISIT() { 408 ORU_R01_VISIT retVal = getTyped("VISIT", ORU_R01_VISIT.class); 409 return retVal; 410 } 411 412 413 414 415} 416