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.v26.group;
35
36 import ca.uhn.hl7v2.model.v26.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 DOC_T12_RESULT 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: EVN (Event Type) <b>optional </b></li>
49 * <li>2: PID (Patient Identification) <b> </b></li>
50 * <li>3: PV1 (Patient Visit) <b> </b></li>
51 * <li>4: TXA (Transcription Document Header) <b> </b></li>
52 * <li>5: OBX (Observation/Result) <b>optional repeating </b></li>
53 * </ul>
54 */
55 //@SuppressWarnings("unused")
56 public class DOC_T12_RESULT extends AbstractGroup {
57
58 /**
59 * Creates a new DOC_T12_RESULT group
60 */
61 public DOC_T12_RESULT(Group parent, ModelClassFactory factory) {
62 super(parent, factory);
63 init(factory);
64 }
65
66 private void init(ModelClassFactory factory) {
67 try {
68 this.add(EVN.class, false, false, false);
69 this.add(PID.class, true, false, false);
70 this.add(PV1.class, true, false, false);
71 this.add(TXA.class, true, false, false);
72 this.add(OBX.class, false, true, false);
73 } catch(HL7Exception e) {
74 log.error("Unexpected error creating DOC_T12_RESULT - this is probably a bug in the source code generator.", e);
75 }
76 }
77
78 /**
79 * Returns "2.6"
80 */
81 public String getVersion() {
82 return "2.6";
83 }
84
85
86
87 /**
88 * Returns
89 * EVN (Event Type) - creates it if necessary
90 */
91 public EVN getEVN() {
92 EVN retVal = getTyped("EVN", EVN.class);
93 return retVal;
94 }
95
96
97
98
99 /**
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 (Transcription Document Header) - 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/Result) - 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/Result) - 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/Result)
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/Result)
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/Result)
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