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