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