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.v23.message;
035
036import ca.uhn.hl7v2.model.v23.group.*;
037import ca.uhn.hl7v2.model.v23.segment.*;
038
039import java.util.List;
040
041import ca.uhn.hl7v2.HL7Exception;
042import ca.uhn.hl7v2.parser.ModelClassFactory;
043import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
044import ca.uhn.hl7v2.model.AbstractMessage;
045
046/**
047 * <p>Represents a CRM_C05 message structure (see chapter ?). This structure contains the 
048 * following elements: </p>
049 * <ul>
050                 * <li>1: MSH (Message header segment) <b> </b></li>
051                 * <li>2: CRM_C05_PATIENT (a Group object) <b> repeating</b></li>
052 * </ul>
053 */
054@SuppressWarnings("unused")
055public class CRM_C05 extends AbstractMessage  {
056
057    /**
058     * Creates a new CRM_C05 message with DefaultModelClassFactory. 
059     */ 
060    public CRM_C05() { 
061       this(new DefaultModelClassFactory());
062    }
063
064    /** 
065     * Creates a new CRM_C05 message with custom ModelClassFactory.
066     */
067    public CRM_C05(ModelClassFactory factory) {
068       super(factory);
069       init(factory);
070    }
071
072    private void init(ModelClassFactory factory) {
073       try {
074                          this.add(MSH.class, true, false);
075                          this.add(CRM_C05_PATIENT.class, true, true);
076       } catch(HL7Exception e) {
077          log.error("Unexpected error creating CRM_C05 - this is probably a bug in the source code generator.", e);
078       }
079    }
080
081    /** 
082     * Returns "2.3"
083     */
084    public String getVersion() {
085       return "2.3";
086    }
087
088
089
090    /**
091     * Returns
092     * MSH (Message header segment) - creates it if necessary
093     */
094    public MSH getMSH() { 
095       return getTyped("MSH", MSH.class);
096    }
097
098
099
100
101    /**
102     * Returns
103     * the first repetition of 
104     * PATIENT (a Group object) - creates it if necessary
105     */
106    public CRM_C05_PATIENT getPATIENT() { 
107       return getTyped("PATIENT", CRM_C05_PATIENT.class);
108    }
109
110
111    /**
112     * Returns a specific repetition of
113     * PATIENT (a Group object) - creates it if necessary
114     *
115     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
116     * @throws HL7Exception if the repetition requested is more than one 
117     *     greater than the number of existing repetitions.
118     */
119    public CRM_C05_PATIENT getPATIENT(int rep) { 
120       return getTyped("PATIENT", rep, CRM_C05_PATIENT.class);
121    }
122
123    /** 
124     * Returns the number of existing repetitions of PATIENT 
125     */ 
126    public int getPATIENTReps() { 
127        return getReps("PATIENT");
128    } 
129
130    /** 
131     * <p>
132     * Returns a non-modifiable List containing all current existing repetitions of PATIENT.
133     * <p>
134     * <p>
135     * Note that unlike {@link #getPATIENT()}, this method will not create any reps
136     * if none are already present, so an empty list may be returned.
137     * </p>
138     */ 
139    public List<CRM_C05_PATIENT> getPATIENTAll() throws HL7Exception {
140        return getAllAsList("PATIENT", CRM_C05_PATIENT.class);
141    } 
142
143    /**
144     * Inserts a specific repetition of PATIENT (a Group object)
145     * @see AbstractGroup#insertRepetition(Structure, int) 
146     */
147    public void insertPATIENT(CRM_C05_PATIENT structure, int rep) throws HL7Exception { 
148       super.insertRepetition( "PATIENT", structure, rep);
149    }
150
151
152    /**
153     * Inserts a specific repetition of PATIENT (a Group object)
154     * @see AbstractGroup#insertRepetition(Structure, int) 
155     */
156    public CRM_C05_PATIENT insertPATIENT(int rep) throws HL7Exception { 
157       return (CRM_C05_PATIENT)super.insertRepetition("PATIENT", rep);
158    }
159
160
161    /**
162     * Removes a specific repetition of PATIENT (a Group object)
163     * @see AbstractGroup#removeRepetition(String, int) 
164     */
165    public CRM_C05_PATIENT removePATIENT(int rep) throws HL7Exception { 
166       return (CRM_C05_PATIENT)super.removeRepetition("PATIENT", rep);
167    }
168
169
170
171}
172