ca.uhn.hl7v2.model.v24.message.RPI_I01 Maven / Gradle / Ivy
/*
* This class is an auto-generated source file for a HAPI
* HL7 v2.x standard structure class.
*
* For more information, visit: http://hl7api.sourceforge.net/
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
* specific language governing rights and limitations under the License.
*
* The Original Code is "[file_name]". Description:
* "[one_line_description]"
*
* The Initial Developer of the Original Code is University Health Network. Copyright (C)
* 2012. All Rights Reserved.
*
* Contributor(s): ______________________________________.
*
* Alternatively, the contents of this file may be used under the terms of the
* GNU General Public License (the "GPL"), in which case the provisions of the GPL are
* applicable instead of those above. If you wish to allow use of your version of this
* file only under the terms of the GPL and not to allow others to use your version
* of this file under the MPL, indicate your decision by deleting the provisions above
* and replace them with the notice and other provisions required by the GPL License.
* If you do not delete the provisions above, a recipient may use your version of
* this file under either the MPL or the GPL.
*
*/
package ca.uhn.hl7v2.model.v24.message;
import ca.uhn.hl7v2.model.v24.group.*;
import ca.uhn.hl7v2.model.v24.segment.*;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
import ca.uhn.hl7v2.model.*;
/**
* Represents a RPI_I01 message structure (see chapter 11). This structure contains the
* following elements:
*
* - 1: MSH (Message Header)
* - 2: MSA (Message Acknowledgment)
* - 3: RPI_I01_PROVIDER (a Group object) repeating
* - 4: PID (Patient identification)
* - 5: NK1 (Next of kin / associated parties) optional repeating
* - 6: RPI_I01_GUARANTOR_INSURANCE (a Group object) optional
* - 7: NTE (Notes and Comments) optional repeating
*
*/
//@SuppressWarnings("unused")
public class RPI_I01 extends AbstractMessage {
/**
* Creates a new RPI_I01 message with DefaultModelClassFactory.
*/
public RPI_I01() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new RPI_I01 message with custom ModelClassFactory.
*/
public RPI_I01(ModelClassFactory factory) {
super(factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(MSH.class, true, false);
this.add(MSA.class, true, false);
this.add(RPI_I01_PROVIDER.class, true, true);
this.add(PID.class, true, false);
this.add(NK1.class, false, true);
this.add(RPI_I01_GUARANTOR_INSURANCE.class, false, false);
this.add(NTE.class, false, true);
} catch(HL7Exception e) {
log.error("Unexpected error creating RPI_I01 - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.4"
*/
public String getVersion() {
return "2.4";
}
/**
*
* Returns
* MSH (Message Header) - creates it if necessary
*
*
*
*/
public MSH getMSH() {
return getTyped("MSH", MSH.class);
}
/**
*
* Returns
* MSA (Message Acknowledgment) - creates it if necessary
*
*
*
*/
public MSA getMSA() {
return getTyped("MSA", MSA.class);
}
/**
*
* Returns
* the first repetition of
* PROVIDER (a Group object) - creates it if necessary
*
*
*
*/
public RPI_I01_PROVIDER getPROVIDER() {
return getTyped("PROVIDER", RPI_I01_PROVIDER.class);
}
/**
*
* Returns a specific repetition of
* PROVIDER (a Group object) - creates it if necessary
*
*
*
* @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
* @throws HL7Exception if the repetition requested is more than one
* greater than the number of existing repetitions.
*/
public RPI_I01_PROVIDER getPROVIDER(int rep) {
return getTyped("PROVIDER", rep, RPI_I01_PROVIDER.class);
}
/**
*
* Returns the number of existing repetitions of PROVIDER
*
*
*/
public int getPROVIDERReps() {
return getReps("PROVIDER");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of PROVIDER.
*
*
* Note that unlike {@link #getPROVIDER()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getPROVIDERAll() throws HL7Exception {
return getAllAsList("PROVIDER", RPI_I01_PROVIDER.class);
}
/**
*
* Inserts a specific repetition of PROVIDER (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertPROVIDER(RPI_I01_PROVIDER structure, int rep) throws HL7Exception {
super.insertRepetition( "PROVIDER", structure, rep);
}
/**
*
* Inserts a specific repetition of PROVIDER (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public RPI_I01_PROVIDER insertPROVIDER(int rep) throws HL7Exception {
return (RPI_I01_PROVIDER)super.insertRepetition("PROVIDER", rep);
}
/**
*
* Removes a specific repetition of PROVIDER (a Group object)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public RPI_I01_PROVIDER removePROVIDER(int rep) throws HL7Exception {
return (RPI_I01_PROVIDER)super.removeRepetition("PROVIDER", rep);
}
/**
*
* Returns
* PID (Patient identification) - creates it if necessary
*
*
*
*/
public PID getPID() {
return getTyped("PID", PID.class);
}
/**
*
* Returns
* the first repetition of
* NK1 (Next of kin / associated parties) - creates it if necessary
*
*
*
*/
public NK1 getNK1() {
return getTyped("NK1", NK1.class);
}
/**
*
* Returns a specific repetition of
* NK1 (Next of kin / associated parties) - creates it if necessary
*
*
*
* @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
* @throws HL7Exception if the repetition requested is more than one
* greater than the number of existing repetitions.
*/
public NK1 getNK1(int rep) {
return getTyped("NK1", rep, NK1.class);
}
/**
*
* Returns the number of existing repetitions of NK1
*
*
*/
public int getNK1Reps() {
return getReps("NK1");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of NK1.
*
*
* Note that unlike {@link #getNK1()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getNK1All() throws HL7Exception {
return getAllAsList("NK1", NK1.class);
}
/**
*
* Inserts a specific repetition of NK1 (Next of kin / associated parties)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertNK1(NK1 structure, int rep) throws HL7Exception {
super.insertRepetition( "NK1", structure, rep);
}
/**
*
* Inserts a specific repetition of NK1 (Next of kin / associated parties)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public NK1 insertNK1(int rep) throws HL7Exception {
return (NK1)super.insertRepetition("NK1", rep);
}
/**
*
* Removes a specific repetition of NK1 (Next of kin / associated parties)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public NK1 removeNK1(int rep) throws HL7Exception {
return (NK1)super.removeRepetition("NK1", rep);
}
/**
*
* Returns
* GUARANTOR_INSURANCE (a Group object) - creates it if necessary
*
*
*
*/
public RPI_I01_GUARANTOR_INSURANCE getGUARANTOR_INSURANCE() {
return getTyped("GUARANTOR_INSURANCE", RPI_I01_GUARANTOR_INSURANCE.class);
}
/**
*
* Returns
* the first repetition of
* NTE (Notes and Comments) - creates it if necessary
*
*
*
*/
public NTE getNTE() {
return getTyped("NTE", NTE.class);
}
/**
*
* Returns a specific repetition of
* NTE (Notes and Comments) - creates it if necessary
*
*
*
* @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
* @throws HL7Exception if the repetition requested is more than one
* greater than the number of existing repetitions.
*/
public NTE getNTE(int rep) {
return getTyped("NTE", rep, NTE.class);
}
/**
*
* Returns the number of existing repetitions of NTE
*
*
*/
public int getNTEReps() {
return getReps("NTE");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of NTE.
*
*
* Note that unlike {@link #getNTE()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getNTEAll() throws HL7Exception {
return getAllAsList("NTE", NTE.class);
}
/**
*
* Inserts a specific repetition of NTE (Notes and Comments)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertNTE(NTE structure, int rep) throws HL7Exception {
super.insertRepetition( "NTE", structure, rep);
}
/**
*
* Inserts a specific repetition of NTE (Notes and Comments)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public NTE insertNTE(int rep) throws HL7Exception {
return (NTE)super.insertRepetition("NTE", rep);
}
/**
*
* Removes a specific repetition of NTE (Notes and Comments)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public NTE removeNTE(int rep) throws HL7Exception {
return (NTE)super.removeRepetition("NTE", rep);
}
}