1 /* 2 * This class is an auto-generated source file for a HAPI 3 * HL7 v2.x standard structure class. 4 * 5 * For more information, visit: http://hl7api.sourceforge.net/ 6 * 7 * The contents of this file are subject to the Mozilla Public License Version 1.1 8 * (the "License"); you may not use this file except in compliance with the License. 9 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 10 * Software distributed under the License is distributed on an "AS IS" basis, 11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 12 * specific language governing rights and limitations under the License. 13 * 14 * The Original Code is "[file_name]". Description: 15 * "[one_line_description]" 16 * 17 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 18 * 2012. All Rights Reserved. 19 * 20 * Contributor(s): ______________________________________. 21 * 22 * Alternatively, the contents of this file may be used under the terms of the 23 * GNU General Public License (the "GPL"), in which case the provisions of the GPL are 24 * applicable instead of those above. If you wish to allow use of your version of this 25 * file only under the terms of the GPL and not to allow others to use your version 26 * of this file under the MPL, indicate your decision by deleting the provisions above 27 * and replace them with the notice and other provisions required by the GPL License. 28 * If you do not delete the provisions above, a recipient may use your version of 29 * this file under either the MPL or the GPL. 30 * 31 */ 32 33 34 package ca.uhn.hl7v2.model.v24.group; 35 36 import ca.uhn.hl7v2.model.v24.segment.*; 37 38 import ca.uhn.hl7v2.HL7Exception; 39 import ca.uhn.hl7v2.parser.ModelClassFactory; 40 import ca.uhn.hl7v2.model.*; 41 42 /** 43 * <p>Represents a RSP_Z86_COMMON_ORDER group structure (a Group object). 44 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. 45 * This Group contains the following elements: 46 * </p> 47 * <ul> 48 * <li>1: ORC (Common Order) <b> </b></li> 49 * <li>2: RSP_Z86_ORDER_DETAIL (a Group object) <b>optional </b></li> 50 * <li>3: RSP_Z86_ENCODED_ORDER (a Group object) <b>optional </b></li> 51 * <li>4: RSP_Z86_DISPENSE (a Group object) <b>optional </b></li> 52 * <li>5: RSP_Z86_GIVE (a Group object) <b>optional </b></li> 53 * <li>6: RSP_Z86_ADMINISTRATION (a Group object) <b>optional </b></li> 54 * <li>7: RSP_Z86_OBSERVATION (a Group object) <b> repeating </b></li> 55 * </ul> 56 */ 57 //@SuppressWarnings("unused") 58 public class RSP_Z86_COMMON_ORDER extends AbstractGroup { 59 60 /** 61 * Creates a new RSP_Z86_COMMON_ORDER group 62 */ 63 public RSP_Z86_COMMON_ORDER(Group parent, ModelClassFactory factory) { 64 super(parent, factory); 65 init(factory); 66 } 67 68 private void init(ModelClassFactory factory) { 69 try { 70 this.add(ORC.class, true, false, false); 71 this.add(RSP_Z86_ORDER_DETAIL.class, false, false, false); 72 this.add(RSP_Z86_ENCODED_ORDER.class, false, false, false); 73 this.add(RSP_Z86_DISPENSE.class, false, false, false); 74 this.add(RSP_Z86_GIVE.class, false, false, false); 75 this.add(RSP_Z86_ADMINISTRATION.class, false, false, false); 76 this.add(RSP_Z86_OBSERVATION.class, true, true, false); 77 } catch(HL7Exception e) { 78 log.error("Unexpected error creating RSP_Z86_COMMON_ORDER - this is probably a bug in the source code generator.", e); 79 } 80 } 81 82 /** 83 * Returns "2.4" 84 */ 85 public String getVersion() { 86 return "2.4"; 87 } 88 89 90 91 /** 92 * Returns 93 * ORC (Common Order) - creates it if necessary 94 */ 95 public ORC getORC() { 96 ORC retVal = getTyped("ORC", ORC.class); 97 return retVal; 98 } 99 100 101 102 103 /** 104 * Returns 105 * ORDER_DETAIL (a Group object) - creates it if necessary 106 */ 107 public RSP_Z86_ORDER_DETAIL getORDER_DETAIL() { 108 RSP_Z86_ORDER_DETAIL retVal = getTyped("ORDER_DETAIL", RSP_Z86_ORDER_DETAIL.class); 109 return retVal; 110 } 111 112 113 114 115 /** 116 * Returns 117 * ENCODED_ORDER (a Group object) - creates it if necessary 118 */ 119 public RSP_Z86_ENCODED_ORDER getENCODED_ORDER() { 120 RSP_Z86_ENCODED_ORDER retVal = getTyped("ENCODED_ORDER", RSP_Z86_ENCODED_ORDER.class); 121 return retVal; 122 } 123 124 125 126 127 /** 128 * Returns 129 * DISPENSE (a Group object) - creates it if necessary 130 */ 131 public RSP_Z86_DISPENSE getDISPENSE() { 132 RSP_Z86_DISPENSE retVal = getTyped("DISPENSE", RSP_Z86_DISPENSE.class); 133 return retVal; 134 } 135 136 137 138 139 /** 140 * Returns 141 * GIVE (a Group object) - creates it if necessary 142 */ 143 public RSP_Z86_GIVE getGIVE() { 144 RSP_Z86_GIVE retVal = getTyped("GIVE", RSP_Z86_GIVE.class); 145 return retVal; 146 } 147 148 149 150 151 /** 152 * Returns 153 * ADMINISTRATION (a Group object) - creates it if necessary 154 */ 155 public RSP_Z86_ADMINISTRATION getADMINISTRATION() { 156 RSP_Z86_ADMINISTRATION retVal = getTyped("ADMINISTRATION", RSP_Z86_ADMINISTRATION.class); 157 return retVal; 158 } 159 160 161 162 163 /** 164 * Returns 165 * the first repetition of 166 * OBSERVATION (a Group object) - creates it if necessary 167 */ 168 public RSP_Z86_OBSERVATION getOBSERVATION() { 169 RSP_Z86_OBSERVATION retVal = getTyped("OBSERVATION", RSP_Z86_OBSERVATION.class); 170 return retVal; 171 } 172 173 174 /** 175 * Returns a specific repetition of 176 * OBSERVATION (a Group object) - creates it if necessary 177 * 178 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 179 * @throws HL7Exception if the repetition requested is more than one 180 * greater than the number of existing repetitions. 181 */ 182 public RSP_Z86_OBSERVATION getOBSERVATION(int rep) { 183 RSP_Z86_OBSERVATION retVal = getTyped("OBSERVATION", rep, RSP_Z86_OBSERVATION.class); 184 return retVal; 185 } 186 187 /** 188 * Returns the number of existing repetitions of OBSERVATION 189 */ 190 public int getOBSERVATIONReps() { 191 return getReps("OBSERVATION"); 192 } 193 194 /** 195 * <p> 196 * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION. 197 * <p> 198 * <p> 199 * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps 200 * if none are already present, so an empty list may be returned. 201 * </p> 202 */ 203 public java.util.List<RSP_Z86_OBSERVATION> getOBSERVATIONAll() throws HL7Exception { 204 return getAllAsList("OBSERVATION", RSP_Z86_OBSERVATION.class); 205 } 206 207 /** 208 * Inserts a specific repetition of OBSERVATION (a Group object) 209 * @see AbstractGroup#insertRepetition(Structure, int) 210 */ 211 public void insertOBSERVATION(RSP_Z86_OBSERVATION structure, int rep) throws HL7Exception { 212 super.insertRepetition("OBSERVATION", structure, rep); 213 } 214 215 216 /** 217 * Inserts a specific repetition of OBSERVATION (a Group object) 218 * @see AbstractGroup#insertRepetition(Structure, int) 219 */ 220 public RSP_Z86_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 221 return (RSP_Z86_OBSERVATION)super.insertRepetition("OBSERVATION", rep); 222 } 223 224 225 /** 226 * Removes a specific repetition of OBSERVATION (a Group object) 227 * @see AbstractGroup#removeRepetition(String, int) 228 */ 229 public RSP_Z86_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 230 return (RSP_Z86_OBSERVATION)super.removeRepetition("OBSERVATION", rep); 231 } 232 233 234 235 } 236