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