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.v27.group;
35
36 import ca.uhn.hl7v2.model.v27.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 EHC_E12_REQUEST 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: CTD (Contact Data) <b>optional </b></li>
49 * <li>2: OBR (Observation Request) <b> </b></li>
50 * <li>3: NTE (Notes and Comments) <b>optional </b></li>
51 * <li>4: OBX (Observation/Result) <b>optional repeating </b></li>
52 * </ul>
53 */
54 //@SuppressWarnings("unused")
55 public class EHC_E12_REQUEST extends AbstractGroup {
56
57 /**
58 * Creates a new EHC_E12_REQUEST group
59 */
60 public EHC_E12_REQUEST(Group parent, ModelClassFactory factory) {
61 super(parent, factory);
62 init(factory);
63 }
64
65 private void init(ModelClassFactory factory) {
66 try {
67 this.add(CTD.class, false, false, false);
68 this.add(OBR.class, true, false, false);
69 this.add(NTE.class, false, false, false);
70 this.add(OBX.class, false, true, false);
71 } catch(HL7Exception e) {
72 log.error("Unexpected error creating EHC_E12_REQUEST - this is probably a bug in the source code generator.", e);
73 }
74 }
75
76 /**
77 * Returns "2.7"
78 */
79 public String getVersion() {
80 return "2.7";
81 }
82
83
84
85 /**
86 * Returns
87 * CTD (Contact Data) - creates it if necessary
88 */
89 public CTD getCTD() {
90 CTD retVal = getTyped("CTD", CTD.class);
91 return retVal;
92 }
93
94
95
96
97 /**
98 * Returns
99 * OBR (Observation Request) - creates it if necessary
100 */
101 public OBR getOBR() {
102 OBR retVal = getTyped("OBR", OBR.class);
103 return retVal;
104 }
105
106
107
108
109 /**
110 * Returns
111 * NTE (Notes and Comments) - creates it if necessary
112 */
113 public NTE getNTE() {
114 NTE retVal = getTyped("NTE", NTE.class);
115 return retVal;
116 }
117
118
119
120
121 /**
122 * Returns
123 * the first repetition of
124 * OBX (Observation/Result) - creates it if necessary
125 */
126 public OBX getOBX() {
127 OBX retVal = getTyped("OBX", OBX.class);
128 return retVal;
129 }
130
131
132 /**
133 * Returns a specific repetition of
134 * OBX (Observation/Result) - creates it if necessary
135 *
136 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
137 * @throws HL7Exception if the repetition requested is more than one
138 * greater than the number of existing repetitions.
139 */
140 public OBX getOBX(int rep) {
141 OBX retVal = getTyped("OBX", rep, OBX.class);
142 return retVal;
143 }
144
145 /**
146 * Returns the number of existing repetitions of OBX
147 */
148 public int getOBXReps() {
149 return getReps("OBX");
150 }
151
152 /**
153 * <p>
154 * Returns a non-modifiable List containing all current existing repetitions of OBX.
155 * <p>
156 * <p>
157 * Note that unlike {@link #getOBX()}, this method will not create any reps
158 * if none are already present, so an empty list may be returned.
159 * </p>
160 */
161 public java.util.List<OBX> getOBXAll() throws HL7Exception {
162 return getAllAsList("OBX", OBX.class);
163 }
164
165 /**
166 * Inserts a specific repetition of OBX (Observation/Result)
167 * @see AbstractGroup#insertRepetition(Structure, int)
168 */
169 public void insertOBX(OBX structure, int rep) throws HL7Exception {
170 super.insertRepetition("OBX", structure, rep);
171 }
172
173
174 /**
175 * Inserts a specific repetition of OBX (Observation/Result)
176 * @see AbstractGroup#insertRepetition(Structure, int)
177 */
178 public OBX insertOBX(int rep) throws HL7Exception {
179 return (OBX)super.insertRepetition("OBX", rep);
180 }
181
182
183 /**
184 * Removes a specific repetition of OBX (Observation/Result)
185 * @see AbstractGroup#removeRepetition(String, int)
186 */
187 public OBX removeOBX(int rep) throws HL7Exception {
188 return (OBX)super.removeRepetition("OBX", rep);
189 }
190
191
192
193 }
194