001/*
002 * This class is an auto-generated source file for a HAPI
003 * HL7 v2.x standard structure class.
004 *
005 * For more information, visit: http://hl7api.sourceforge.net/
006 * 
007 * The contents of this file are subject to the Mozilla Public License Version 1.1 
008 * (the "License"); you may not use this file except in compliance with the License. 
009 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
010 * Software distributed under the License is distributed on an "AS IS" basis, 
011 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
012 * specific language governing rights and limitations under the License. 
013 * 
014 * The Original Code is "[file_name]".  Description: 
015 * "[one_line_description]" 
016 * 
017 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
018 * 2012.  All Rights Reserved. 
019 * 
020 * Contributor(s): ______________________________________. 
021 * 
022 * Alternatively, the contents of this file may be used under the terms of the 
023 * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
024 * applicable instead of those above.  If you wish to allow use of your version of this 
025 * file only under the terms of the GPL and not to allow others to use your version 
026 * of this file under the MPL, indicate your decision by deleting  the provisions above 
027 * and replace  them with the notice and other provisions required by the GPL License.  
028 * If you do not delete the provisions above, a recipient may use your version of 
029 * this file under either the MPL or the GPL. 
030 * 
031 */
032
033
034package ca.uhn.hl7v2.model.v27.group;
035
036import ca.uhn.hl7v2.model.v27.segment.*;
037
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a PRR_PC5_PATIENT group structure (a Group object).
044 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
045 * This Group contains the following elements:  
046 * </p>
047 * <ul>
048                         * <li>1: PID (Patient Identification) <b>  </b></li>
049                         * <li>2: PRR_PC5_PATIENT_VISIT (a Group object) <b>optional  </b></li>
050                         * <li>3: PRR_PC5_PROBLEM (a Group object) <b> repeating </b></li>
051 * </ul>
052 */
053//@SuppressWarnings("unused")
054public class PRR_PC5_PATIENT extends AbstractGroup {
055
056    /** 
057     * Creates a new PRR_PC5_PATIENT group
058     */
059    public PRR_PC5_PATIENT(Group parent, ModelClassFactory factory) {
060       super(parent, factory);
061       init(factory);
062    }
063
064    private void init(ModelClassFactory factory) {
065       try {
066                                  this.add(PID.class, true, false, false);
067                                  this.add(PRR_PC5_PATIENT_VISIT.class, false, false, false);
068                                  this.add(PRR_PC5_PROBLEM.class, true, true, false);
069       } catch(HL7Exception e) {
070          log.error("Unexpected error creating PRR_PC5_PATIENT - this is probably a bug in the source code generator.", e);
071       }
072    }
073
074    /** 
075     * Returns "2.7"
076     */
077    public String getVersion() {
078       return "2.7";
079    }
080
081
082
083    /**
084     * Returns
085     * PID (Patient Identification) - creates it if necessary
086     */
087    public PID getPID() { 
088       PID retVal = getTyped("PID", PID.class);
089       return retVal;
090    }
091
092
093
094
095    /**
096     * Returns
097     * PATIENT_VISIT (a Group object) - creates it if necessary
098     */
099    public PRR_PC5_PATIENT_VISIT getPATIENT_VISIT() { 
100       PRR_PC5_PATIENT_VISIT retVal = getTyped("PATIENT_VISIT", PRR_PC5_PATIENT_VISIT.class);
101       return retVal;
102    }
103
104
105
106
107    /**
108     * Returns
109     * the first repetition of 
110     * PROBLEM (a Group object) - creates it if necessary
111     */
112    public PRR_PC5_PROBLEM getPROBLEM() { 
113       PRR_PC5_PROBLEM retVal = getTyped("PROBLEM", PRR_PC5_PROBLEM.class);
114       return retVal;
115    }
116
117
118    /**
119     * Returns a specific repetition of
120     * PROBLEM (a Group object) - 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 PRR_PC5_PROBLEM getPROBLEM(int rep) { 
127       PRR_PC5_PROBLEM retVal = getTyped("PROBLEM", rep, PRR_PC5_PROBLEM.class);
128       return retVal;
129    }
130
131    /** 
132     * Returns the number of existing repetitions of PROBLEM 
133     */ 
134    public int getPROBLEMReps() {  
135        return getReps("PROBLEM");
136    } 
137
138    /** 
139     * <p>
140     * Returns a non-modifiable List containing all current existing repetitions of PROBLEM.
141     * <p>
142     * <p>
143     * Note that unlike {@link #getPROBLEM()}, 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<PRR_PC5_PROBLEM> getPROBLEMAll() throws HL7Exception {
148        return getAllAsList("PROBLEM", PRR_PC5_PROBLEM.class);
149    } 
150
151    /**
152     * Inserts a specific repetition of PROBLEM (a Group object)
153     * @see AbstractGroup#insertRepetition(Structure, int) 
154     */
155    public void insertPROBLEM(PRR_PC5_PROBLEM structure, int rep) throws HL7Exception { 
156       super.insertRepetition("PROBLEM", structure, rep);
157    }
158
159
160    /**
161     * Inserts a specific repetition of PROBLEM (a Group object)
162     * @see AbstractGroup#insertRepetition(Structure, int) 
163     */
164    public PRR_PC5_PROBLEM insertPROBLEM(int rep) throws HL7Exception { 
165       return (PRR_PC5_PROBLEM)super.insertRepetition("PROBLEM", rep);
166    }
167
168
169    /**
170     * Removes a specific repetition of PROBLEM (a Group object)
171     * @see AbstractGroup#removeRepetition(String, int) 
172     */
173    public PRR_PC5_PROBLEM removePROBLEM(int rep) throws HL7Exception { 
174       return (PRR_PC5_PROBLEM)super.removeRepetition("PROBLEM", rep);
175    }
176
177
178
179}
180