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