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 OPR_O38_RESPONSE 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: NK1 (Next of Kin / Associated Parties) <b> repeating </b></li> 049 * <li>2: PID (Patient Identification) <b>optional </b></li> 050 * <li>3: PRT (Participation Information) <b>optional repeating </b></li> 051 * <li>4: OPR_O38_SPECIMEN (a Group object) <b>optional repeating </b></li> 052 * </ul> 053 */ 054//@SuppressWarnings("unused") 055public class OPR_O38_RESPONSE extends AbstractGroup { 056 057 /** 058 * Creates a new OPR_O38_RESPONSE group 059 */ 060 public OPR_O38_RESPONSE(Group parent, ModelClassFactory factory) { 061 super(parent, factory); 062 init(factory); 063 } 064 065 private void init(ModelClassFactory factory) { 066 try { 067 this.add(NK1.class, true, true, false); 068 this.add(PID.class, false, false, false); 069 this.add(PRT.class, false, true, false); 070 this.add(OPR_O38_SPECIMEN.class, false, true, false); 071 } catch(HL7Exception e) { 072 log.error("Unexpected error creating OPR_O38_RESPONSE - this is probably a bug in the source code generator.", e); 073 } 074 } 075 076 /** 077 * Returns "2.7" 078 */ 079 public String getVersion() { 080 return "2.7"; 081 } 082 083 084 085 /** 086 * Returns 087 * the first repetition of 088 * NK1 (Next of Kin / Associated Parties) - creates it if necessary 089 */ 090 public NK1 getNK1() { 091 NK1 retVal = getTyped("NK1", NK1.class); 092 return retVal; 093 } 094 095 096 /** 097 * Returns a specific repetition of 098 * NK1 (Next of Kin / Associated Parties) - creates it if necessary 099 * 100 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 101 * @throws HL7Exception if the repetition requested is more than one 102 * greater than the number of existing repetitions. 103 */ 104 public NK1 getNK1(int rep) { 105 NK1 retVal = getTyped("NK1", rep, NK1.class); 106 return retVal; 107 } 108 109 /** 110 * Returns the number of existing repetitions of NK1 111 */ 112 public int getNK1Reps() { 113 return getReps("NK1"); 114 } 115 116 /** 117 * <p> 118 * Returns a non-modifiable List containing all current existing repetitions of NK1. 119 * <p> 120 * <p> 121 * Note that unlike {@link #getNK1()}, this method will not create any reps 122 * if none are already present, so an empty list may be returned. 123 * </p> 124 */ 125 public java.util.List<NK1> getNK1All() throws HL7Exception { 126 return getAllAsList("NK1", NK1.class); 127 } 128 129 /** 130 * Inserts a specific repetition of NK1 (Next of Kin / Associated Parties) 131 * @see AbstractGroup#insertRepetition(Structure, int) 132 */ 133 public void insertNK1(NK1 structure, int rep) throws HL7Exception { 134 super.insertRepetition("NK1", structure, rep); 135 } 136 137 138 /** 139 * Inserts a specific repetition of NK1 (Next of Kin / Associated Parties) 140 * @see AbstractGroup#insertRepetition(Structure, int) 141 */ 142 public NK1 insertNK1(int rep) throws HL7Exception { 143 return (NK1)super.insertRepetition("NK1", rep); 144 } 145 146 147 /** 148 * Removes a specific repetition of NK1 (Next of Kin / Associated Parties) 149 * @see AbstractGroup#removeRepetition(String, int) 150 */ 151 public NK1 removeNK1(int rep) throws HL7Exception { 152 return (NK1)super.removeRepetition("NK1", rep); 153 } 154 155 156 157 /** 158 * Returns 159 * PID (Patient Identification) - creates it if necessary 160 */ 161 public PID getPID() { 162 PID retVal = getTyped("PID", PID.class); 163 return retVal; 164 } 165 166 167 168 169 /** 170 * Returns 171 * the first repetition of 172 * PRT (Participation Information) - creates it if necessary 173 */ 174 public PRT getPRT() { 175 PRT retVal = getTyped("PRT", PRT.class); 176 return retVal; 177 } 178 179 180 /** 181 * Returns a specific repetition of 182 * PRT (Participation Information) - creates it if necessary 183 * 184 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 185 * @throws HL7Exception if the repetition requested is more than one 186 * greater than the number of existing repetitions. 187 */ 188 public PRT getPRT(int rep) { 189 PRT retVal = getTyped("PRT", rep, PRT.class); 190 return retVal; 191 } 192 193 /** 194 * Returns the number of existing repetitions of PRT 195 */ 196 public int getPRTReps() { 197 return getReps("PRT"); 198 } 199 200 /** 201 * <p> 202 * Returns a non-modifiable List containing all current existing repetitions of PRT. 203 * <p> 204 * <p> 205 * Note that unlike {@link #getPRT()}, this method will not create any reps 206 * if none are already present, so an empty list may be returned. 207 * </p> 208 */ 209 public java.util.List<PRT> getPRTAll() throws HL7Exception { 210 return getAllAsList("PRT", PRT.class); 211 } 212 213 /** 214 * Inserts a specific repetition of PRT (Participation Information) 215 * @see AbstractGroup#insertRepetition(Structure, int) 216 */ 217 public void insertPRT(PRT structure, int rep) throws HL7Exception { 218 super.insertRepetition("PRT", structure, rep); 219 } 220 221 222 /** 223 * Inserts a specific repetition of PRT (Participation Information) 224 * @see AbstractGroup#insertRepetition(Structure, int) 225 */ 226 public PRT insertPRT(int rep) throws HL7Exception { 227 return (PRT)super.insertRepetition("PRT", rep); 228 } 229 230 231 /** 232 * Removes a specific repetition of PRT (Participation Information) 233 * @see AbstractGroup#removeRepetition(String, int) 234 */ 235 public PRT removePRT(int rep) throws HL7Exception { 236 return (PRT)super.removeRepetition("PRT", rep); 237 } 238 239 240 241 /** 242 * Returns 243 * the first repetition of 244 * SPECIMEN (a Group object) - creates it if necessary 245 */ 246 public OPR_O38_SPECIMEN getSPECIMEN() { 247 OPR_O38_SPECIMEN retVal = getTyped("SPECIMEN", OPR_O38_SPECIMEN.class); 248 return retVal; 249 } 250 251 252 /** 253 * Returns a specific repetition of 254 * SPECIMEN (a Group object) - creates it if necessary 255 * 256 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 257 * @throws HL7Exception if the repetition requested is more than one 258 * greater than the number of existing repetitions. 259 */ 260 public OPR_O38_SPECIMEN getSPECIMEN(int rep) { 261 OPR_O38_SPECIMEN retVal = getTyped("SPECIMEN", rep, OPR_O38_SPECIMEN.class); 262 return retVal; 263 } 264 265 /** 266 * Returns the number of existing repetitions of SPECIMEN 267 */ 268 public int getSPECIMENReps() { 269 return getReps("SPECIMEN"); 270 } 271 272 /** 273 * <p> 274 * Returns a non-modifiable List containing all current existing repetitions of SPECIMEN. 275 * <p> 276 * <p> 277 * Note that unlike {@link #getSPECIMEN()}, this method will not create any reps 278 * if none are already present, so an empty list may be returned. 279 * </p> 280 */ 281 public java.util.List<OPR_O38_SPECIMEN> getSPECIMENAll() throws HL7Exception { 282 return getAllAsList("SPECIMEN", OPR_O38_SPECIMEN.class); 283 } 284 285 /** 286 * Inserts a specific repetition of SPECIMEN (a Group object) 287 * @see AbstractGroup#insertRepetition(Structure, int) 288 */ 289 public void insertSPECIMEN(OPR_O38_SPECIMEN structure, int rep) throws HL7Exception { 290 super.insertRepetition("SPECIMEN", structure, rep); 291 } 292 293 294 /** 295 * Inserts a specific repetition of SPECIMEN (a Group object) 296 * @see AbstractGroup#insertRepetition(Structure, int) 297 */ 298 public OPR_O38_SPECIMEN insertSPECIMEN(int rep) throws HL7Exception { 299 return (OPR_O38_SPECIMEN)super.insertRepetition("SPECIMEN", rep); 300 } 301 302 303 /** 304 * Removes a specific repetition of SPECIMEN (a Group object) 305 * @see AbstractGroup#removeRepetition(String, int) 306 */ 307 public OPR_O38_SPECIMEN removeSPECIMEN(int rep) throws HL7Exception { 308 return (OPR_O38_SPECIMEN)super.removeRepetition("SPECIMEN", rep); 309 } 310 311 312 313} 314