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