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.v26.message; 035 036import ca.uhn.hl7v2.model.v26.group.*; 037import ca.uhn.hl7v2.model.v26.segment.*; 038 039import ca.uhn.hl7v2.HL7Exception; 040import ca.uhn.hl7v2.parser.ModelClassFactory; 041import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 042import ca.uhn.hl7v2.model.*; 043 044 045/** 046 * <p>Represents a CRM_C01 message structure (see chapter 7.7.1). This structure contains the 047 * following elements: </p> 048 * <ul> 049 * <li>1: MSH (Message Header) <b> </b> </li> 050 * <li>2: SFT (Software Segment) <b>optional repeating</b> </li> 051 * <li>3: UAC (User Authentication Credential Segment) <b>optional </b> </li> 052 * <li>4: CRM_C01_PATIENT (a Group object) <b> repeating</b> </li> 053 * </ul> 054 */ 055//@SuppressWarnings("unused") 056public class CRM_C01 extends AbstractMessage { 057 058 /** 059 * Creates a new CRM_C01 message with DefaultModelClassFactory. 060 */ 061 public CRM_C01() { 062 this(new DefaultModelClassFactory()); 063 } 064 065 /** 066 * Creates a new CRM_C01 message with custom ModelClassFactory. 067 */ 068 public CRM_C01(ModelClassFactory factory) { 069 super(factory); 070 init(factory); 071 } 072 073 private void init(ModelClassFactory factory) { 074 try { 075 this.add(MSH.class, true, false); 076 this.add(SFT.class, false, true); 077 this.add(UAC.class, false, false); 078 this.add(CRM_C01_PATIENT.class, true, true); 079 } catch(HL7Exception e) { 080 log.error("Unexpected error creating CRM_C01 - this is probably a bug in the source code generator.", e); 081 } 082 } 083 084 085 /** 086 * Returns "2.6" 087 */ 088 public String getVersion() { 089 return "2.6"; 090 } 091 092 093 094 095 /** 096 * <p> 097 * Returns 098 * MSH (Message Header) - creates it if necessary 099 * </p> 100 * 101 * 102 */ 103 public MSH getMSH() { 104 return getTyped("MSH", MSH.class); 105 } 106 107 108 109 110 111 /** 112 * <p> 113 * Returns 114 * the first repetition of 115 * SFT (Software Segment) - creates it if necessary 116 * </p> 117 * 118 * 119 */ 120 public SFT getSFT() { 121 return getTyped("SFT", SFT.class); 122 } 123 124 125 /** 126 * <p> 127 * Returns a specific repetition of 128 * SFT (Software Segment) - creates it if necessary 129 * </p> 130 * 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 SFT getSFT(int rep) { 137 return getTyped("SFT", rep, SFT.class); 138 } 139 140 /** 141 * <p> 142 * Returns the number of existing repetitions of SFT 143 * </p> 144 * 145 */ 146 public int getSFTReps() { 147 return getReps("SFT"); 148 } 149 150 /** 151 * <p> 152 * Returns a non-modifiable List containing all current existing repetitions of SFT. 153 * <p> 154 * <p> 155 * Note that unlike {@link #getSFT()}, this method will not create any reps 156 * if none are already present, so an empty list may be returned. 157 * </p> 158 * 159 */ 160 public java.util.List<SFT> getSFTAll() throws HL7Exception { 161 return getAllAsList("SFT", SFT.class); 162 } 163 164 /** 165 * <p> 166 * Inserts a specific repetition of SFT (Software Segment) 167 * </p> 168 * 169 * 170 * @see AbstractGroup#insertRepetition(Structure, int) 171 */ 172 public void insertSFT(SFT structure, int rep) throws HL7Exception { 173 super.insertRepetition( "SFT", structure, rep); 174 } 175 176 177 /** 178 * <p> 179 * Inserts a specific repetition of SFT (Software Segment) 180 * </p> 181 * 182 * 183 * @see AbstractGroup#insertRepetition(Structure, int) 184 */ 185 public SFT insertSFT(int rep) throws HL7Exception { 186 return (SFT)super.insertRepetition("SFT", rep); 187 } 188 189 190 /** 191 * <p> 192 * Removes a specific repetition of SFT (Software Segment) 193 * </p> 194 * 195 * 196 * @see AbstractGroup#removeRepetition(String, int) 197 */ 198 public SFT removeSFT(int rep) throws HL7Exception { 199 return (SFT)super.removeRepetition("SFT", rep); 200 } 201 202 203 204 205 /** 206 * <p> 207 * Returns 208 * UAC (User Authentication Credential Segment) - creates it if necessary 209 * </p> 210 * 211 * 212 */ 213 public UAC getUAC() { 214 return getTyped("UAC", UAC.class); 215 } 216 217 218 219 220 221 /** 222 * <p> 223 * Returns 224 * the first repetition of 225 * PATIENT (a Group object) - creates it if necessary 226 * </p> 227 * 228 * 229 */ 230 public CRM_C01_PATIENT getPATIENT() { 231 return getTyped("PATIENT", CRM_C01_PATIENT.class); 232 } 233 234 235 /** 236 * <p> 237 * Returns a specific repetition of 238 * PATIENT (a Group object) - creates it if necessary 239 * </p> 240 * 241 * 242 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 243 * @throws HL7Exception if the repetition requested is more than one 244 * greater than the number of existing repetitions. 245 */ 246 public CRM_C01_PATIENT getPATIENT(int rep) { 247 return getTyped("PATIENT", rep, CRM_C01_PATIENT.class); 248 } 249 250 /** 251 * <p> 252 * Returns the number of existing repetitions of PATIENT 253 * </p> 254 * 255 */ 256 public int getPATIENTReps() { 257 return getReps("PATIENT"); 258 } 259 260 /** 261 * <p> 262 * Returns a non-modifiable List containing all current existing repetitions of PATIENT. 263 * <p> 264 * <p> 265 * Note that unlike {@link #getPATIENT()}, this method will not create any reps 266 * if none are already present, so an empty list may be returned. 267 * </p> 268 * 269 */ 270 public java.util.List<CRM_C01_PATIENT> getPATIENTAll() throws HL7Exception { 271 return getAllAsList("PATIENT", CRM_C01_PATIENT.class); 272 } 273 274 /** 275 * <p> 276 * Inserts a specific repetition of PATIENT (a Group object) 277 * </p> 278 * 279 * 280 * @see AbstractGroup#insertRepetition(Structure, int) 281 */ 282 public void insertPATIENT(CRM_C01_PATIENT structure, int rep) throws HL7Exception { 283 super.insertRepetition( "PATIENT", structure, rep); 284 } 285 286 287 /** 288 * <p> 289 * Inserts a specific repetition of PATIENT (a Group object) 290 * </p> 291 * 292 * 293 * @see AbstractGroup#insertRepetition(Structure, int) 294 */ 295 public CRM_C01_PATIENT insertPATIENT(int rep) throws HL7Exception { 296 return (CRM_C01_PATIENT)super.insertRepetition("PATIENT", rep); 297 } 298 299 300 /** 301 * <p> 302 * Removes a specific repetition of PATIENT (a Group object) 303 * </p> 304 * 305 * 306 * @see AbstractGroup#removeRepetition(String, int) 307 */ 308 public CRM_C01_PATIENT removePATIENT(int rep) throws HL7Exception { 309 return (CRM_C01_PATIENT)super.removeRepetition("PATIENT", rep); 310 } 311 312 313 314} 315