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 OPR_O38_RESPONSE 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: NK1 (Next of Kin / Associated Parties) <b> repeating </b></li>
49 * <li>2: PID (Patient Identification) <b>optional </b></li>
50 * <li>3: OPR_O38_SPECIMEN (a Group object) <b>optional repeating </b></li>
51 * </ul>
52 */
53 //@SuppressWarnings("unused")
54 public class OPR_O38_RESPONSE extends AbstractGroup {
55
56 /**
57 * Creates a new OPR_O38_RESPONSE group
58 */
59 public OPR_O38_RESPONSE(Group parent, ModelClassFactory factory) {
60 super(parent, factory);
61 init(factory);
62 }
63
64 private void init(ModelClassFactory factory) {
65 try {
66 this.add(NK1.class, true, true, false);
67 this.add(PID.class, false, false, false);
68 this.add(OPR_O38_SPECIMEN.class, false, true, false);
69 } catch(HL7Exception e) {
70 log.error("Unexpected error creating OPR_O38_RESPONSE - this is probably a bug in the source code generator.", e);
71 }
72 }
73
74 /**
75 * Returns "2.6"
76 */
77 public String getVersion() {
78 return "2.6";
79 }
80
81
82
83 /**
84 * Returns
85 * the first repetition of
86 * NK1 (Next of Kin / Associated Parties) - creates it if necessary
87 */
88 public NK1 getNK1() {
89 NK1 retVal = getTyped("NK1", NK1.class);
90 return retVal;
91 }
92
93
94 /**
95 * Returns a specific repetition of
96 * NK1 (Next of Kin / Associated Parties) - creates it if necessary
97 *
98 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
99 * @throws HL7Exception if the repetition requested is more than one
100 * greater than the number of existing repetitions.
101 */
102 public NK1 getNK1(int rep) {
103 NK1 retVal = getTyped("NK1", rep, NK1.class);
104 return retVal;
105 }
106
107 /**
108 * Returns the number of existing repetitions of NK1
109 */
110 public int getNK1Reps() {
111 return getReps("NK1");
112 }
113
114 /**
115 * <p>
116 * Returns a non-modifiable List containing all current existing repetitions of NK1.
117 * <p>
118 * <p>
119 * Note that unlike {@link #getNK1()}, this method will not create any reps
120 * if none are already present, so an empty list may be returned.
121 * </p>
122 */
123 public java.util.List<NK1> getNK1All() throws HL7Exception {
124 return getAllAsList("NK1", NK1.class);
125 }
126
127 /**
128 * Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
129 * @see AbstractGroup#insertRepetition(Structure, int)
130 */
131 public void insertNK1(NK1 structure, int rep) throws HL7Exception {
132 super.insertRepetition("NK1", structure, rep);
133 }
134
135
136 /**
137 * Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
138 * @see AbstractGroup#insertRepetition(Structure, int)
139 */
140 public NK1 insertNK1(int rep) throws HL7Exception {
141 return (NK1)super.insertRepetition("NK1", rep);
142 }
143
144
145 /**
146 * Removes a specific repetition of NK1 (Next of Kin / Associated Parties)
147 * @see AbstractGroup#removeRepetition(String, int)
148 */
149 public NK1 removeNK1(int rep) throws HL7Exception {
150 return (NK1)super.removeRepetition("NK1", rep);
151 }
152
153
154
155 /**
156 * Returns
157 * PID (Patient Identification) - creates it if necessary
158 */
159 public PID getPID() {
160 PID retVal = getTyped("PID", PID.class);
161 return retVal;
162 }
163
164
165
166
167 /**
168 * Returns
169 * the first repetition of
170 * SPECIMEN (a Group object) - creates it if necessary
171 */
172 public OPR_O38_SPECIMEN getSPECIMEN() {
173 OPR_O38_SPECIMEN retVal = getTyped("SPECIMEN", OPR_O38_SPECIMEN.class);
174 return retVal;
175 }
176
177
178 /**
179 * Returns a specific repetition of
180 * SPECIMEN (a Group object) - creates it if necessary
181 *
182 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
183 * @throws HL7Exception if the repetition requested is more than one
184 * greater than the number of existing repetitions.
185 */
186 public OPR_O38_SPECIMEN getSPECIMEN(int rep) {
187 OPR_O38_SPECIMEN retVal = getTyped("SPECIMEN", rep, OPR_O38_SPECIMEN.class);
188 return retVal;
189 }
190
191 /**
192 * Returns the number of existing repetitions of SPECIMEN
193 */
194 public int getSPECIMENReps() {
195 return getReps("SPECIMEN");
196 }
197
198 /**
199 * <p>
200 * Returns a non-modifiable List containing all current existing repetitions of SPECIMEN.
201 * <p>
202 * <p>
203 * Note that unlike {@link #getSPECIMEN()}, this method will not create any reps
204 * if none are already present, so an empty list may be returned.
205 * </p>
206 */
207 public java.util.List<OPR_O38_SPECIMEN> getSPECIMENAll() throws HL7Exception {
208 return getAllAsList("SPECIMEN", OPR_O38_SPECIMEN.class);
209 }
210
211 /**
212 * Inserts a specific repetition of SPECIMEN (a Group object)
213 * @see AbstractGroup#insertRepetition(Structure, int)
214 */
215 public void insertSPECIMEN(OPR_O38_SPECIMEN structure, int rep) throws HL7Exception {
216 super.insertRepetition("SPECIMEN", structure, rep);
217 }
218
219
220 /**
221 * Inserts a specific repetition of SPECIMEN (a Group object)
222 * @see AbstractGroup#insertRepetition(Structure, int)
223 */
224 public OPR_O38_SPECIMEN insertSPECIMEN(int rep) throws HL7Exception {
225 return (OPR_O38_SPECIMEN)super.insertRepetition("SPECIMEN", rep);
226 }
227
228
229 /**
230 * Removes a specific repetition of SPECIMEN (a Group object)
231 * @see AbstractGroup#removeRepetition(String, int)
232 */
233 public OPR_O38_SPECIMEN removeSPECIMEN(int rep) throws HL7Exception {
234 return (OPR_O38_SPECIMEN)super.removeRepetition("SPECIMEN", rep);
235 }
236
237
238
239 }
240