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.v23.group; 035 036import ca.uhn.hl7v2.model.v23.segment.*; 037 038import ca.uhn.hl7v2.HL7Exception; 039import ca.uhn.hl7v2.parser.ModelClassFactory; 040import ca.uhn.hl7v2.model.*; 041 042/** 043 * <p>Represents a DOC_T12_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: EVN (Event type) <b>optional </b></li> 049 * <li>2: PID (Patient Identification) <b> </b></li> 050 * <li>3: PV1 (Patient visit) <b> </b></li> 051 * <li>4: TXA (Document notification segment) <b> </b></li> 052 * <li>5: OBX (Observation segment) <b>optional repeating </b></li> 053 * </ul> 054 */ 055//@SuppressWarnings("unused") 056public class DOC_T12_RESULT extends AbstractGroup { 057 058 /** 059 * Creates a new DOC_T12_RESULT group 060 */ 061 public DOC_T12_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(EVN.class, false, false, false); 069 this.add(PID.class, true, false, false); 070 this.add(PV1.class, true, false, false); 071 this.add(TXA.class, true, false, false); 072 this.add(OBX.class, false, true, false); 073 } catch(HL7Exception e) { 074 log.error("Unexpected error creating DOC_T12_RESULT - this is probably a bug in the source code generator.", e); 075 } 076 } 077 078 /** 079 * Returns "2.3" 080 */ 081 public String getVersion() { 082 return "2.3"; 083 } 084 085 086 087 /** 088 * Returns 089 * EVN (Event type) - creates it if necessary 090 */ 091 public EVN getEVN() { 092 EVN retVal = getTyped("EVN", EVN.class); 093 return retVal; 094 } 095 096 097 098 099 /** 100 * Returns 101 * PID (Patient Identification) - creates it if necessary 102 */ 103 public PID getPID() { 104 PID retVal = getTyped("PID", PID.class); 105 return retVal; 106 } 107 108 109 110 111 /** 112 * Returns 113 * PV1 (Patient visit) - creates it if necessary 114 */ 115 public PV1 getPV1() { 116 PV1 retVal = getTyped("PV1", PV1.class); 117 return retVal; 118 } 119 120 121 122 123 /** 124 * Returns 125 * TXA (Document notification segment) - creates it if necessary 126 */ 127 public TXA getTXA() { 128 TXA retVal = getTyped("TXA", TXA.class); 129 return retVal; 130 } 131 132 133 134 135 /** 136 * Returns 137 * the first repetition of 138 * OBX (Observation segment) - creates it if necessary 139 */ 140 public OBX getOBX() { 141 OBX retVal = getTyped("OBX", OBX.class); 142 return retVal; 143 } 144 145 146 /** 147 * Returns a specific repetition of 148 * OBX (Observation segment) - creates it if necessary 149 * 150 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 151 * @throws HL7Exception if the repetition requested is more than one 152 * greater than the number of existing repetitions. 153 */ 154 public OBX getOBX(int rep) { 155 OBX retVal = getTyped("OBX", rep, OBX.class); 156 return retVal; 157 } 158 159 /** 160 * Returns the number of existing repetitions of OBX 161 */ 162 public int getOBXReps() { 163 return getReps("OBX"); 164 } 165 166 /** 167 * <p> 168 * Returns a non-modifiable List containing all current existing repetitions of OBX. 169 * <p> 170 * <p> 171 * Note that unlike {@link #getOBX()}, this method will not create any reps 172 * if none are already present, so an empty list may be returned. 173 * </p> 174 */ 175 public java.util.List<OBX> getOBXAll() throws HL7Exception { 176 return getAllAsList("OBX", OBX.class); 177 } 178 179 /** 180 * Inserts a specific repetition of OBX (Observation segment) 181 * @see AbstractGroup#insertRepetition(Structure, int) 182 */ 183 public void insertOBX(OBX structure, int rep) throws HL7Exception { 184 super.insertRepetition("OBX", structure, rep); 185 } 186 187 188 /** 189 * Inserts a specific repetition of OBX (Observation segment) 190 * @see AbstractGroup#insertRepetition(Structure, int) 191 */ 192 public OBX insertOBX(int rep) throws HL7Exception { 193 return (OBX)super.insertRepetition("OBX", rep); 194 } 195 196 197 /** 198 * Removes a specific repetition of OBX (Observation segment) 199 * @see AbstractGroup#removeRepetition(String, int) 200 */ 201 public OBX removeOBX(int rep) throws HL7Exception { 202 return (OBX)super.removeRepetition("OBX", rep); 203 } 204 205 206 207} 208