ca.uhn.hl7v2.model.v23.message.RRI_I15 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.v23.message;
import ca.uhn.hl7v2.model.v23.group.*;
import ca.uhn.hl7v2.model.v23.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 RRI_I15 message structure (see chapter ?). This structure contains the
* following elements:
*
* - 1: MSH (Message header segment)
* - 2: MSA (Message acknowledgement segment) optional
* - 3: RF1 (Referral Information Segment) optional
* - 4: RRI_I15_AUTHORIZATION (a Group object) optional
* - 5: RRI_I15_PROVIDER (a Group object) repeating
* - 6: PID (Patient Identification)
* - 7: ACC (Accident) optional
* - 8: DG1 (Diagnosis) optional repeating
* - 9: DRG (Diagnosis Related Group) optional repeating
* - 10: AL1 (Patient allergy information) optional repeating
* - 11: RRI_I15_PROCEDURE (a Group object) optional repeating
* - 12: RRI_I15_RESULTS (a Group object) optional repeating
* - 13: RRI_I15_VISIT (a Group object) optional
* - 14: NTE (Notes and comments segment) optional repeating
*
*/
//@SuppressWarnings("unused")
public class RRI_I15 extends AbstractMessage {
/**
* Creates a new RRI_I15 message with DefaultModelClassFactory.
*/
public RRI_I15() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new RRI_I15 message with custom ModelClassFactory.
*/
public RRI_I15(ModelClassFactory factory) {
super(factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(MSH.class, true, false);
this.add(MSA.class, false, false);
this.add(RF1.class, false, false);
this.add(RRI_I15_AUTHORIZATION.class, false, false);
this.add(RRI_I15_PROVIDER.class, true, true);
this.add(PID.class, true, false);
this.add(ACC.class, false, false);
this.add(DG1.class, false, true);
this.add(DRG.class, false, true);
this.add(AL1.class, false, true);
this.add(RRI_I15_PROCEDURE.class, false, true);
this.add(RRI_I15_RESULTS.class, false, true);
this.add(RRI_I15_VISIT.class, false, false);
this.add(NTE.class, false, true);
} catch(HL7Exception e) {
log.error("Unexpected error creating RRI_I15 - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.3"
*/
public String getVersion() {
return "2.3";
}
/**
*
* Returns
* MSH (Message header segment) - creates it if necessary
*
*
*
*/
public MSH getMSH() {
return getTyped("MSH", MSH.class);
}
/**
*
* Returns
* MSA (Message acknowledgement segment) - creates it if necessary
*
*
*
*/
public MSA getMSA() {
return getTyped("MSA", MSA.class);
}
/**
*
* Returns
* RF1 (Referral Information Segment) - creates it if necessary
*
*
*
*/
public RF1 getRF1() {
return getTyped("RF1", RF1.class);
}
/**
*
* Returns
* AUTHORIZATION (a Group object) - creates it if necessary
*
*
*
*/
public RRI_I15_AUTHORIZATION getAUTHORIZATION() {
return getTyped("AUTHORIZATION", RRI_I15_AUTHORIZATION.class);
}
/**
*
* Returns
* the first repetition of
* PROVIDER (a Group object) - creates it if necessary
*
*
*
*/
public RRI_I15_PROVIDER getPROVIDER() {
return getTyped("PROVIDER", RRI_I15_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 RRI_I15_PROVIDER getPROVIDER(int rep) {
return getTyped("PROVIDER", rep, RRI_I15_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", RRI_I15_PROVIDER.class);
}
/**
*
* Inserts a specific repetition of PROVIDER (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertPROVIDER(RRI_I15_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 RRI_I15_PROVIDER insertPROVIDER(int rep) throws HL7Exception {
return (RRI_I15_PROVIDER)super.insertRepetition("PROVIDER", rep);
}
/**
*
* Removes a specific repetition of PROVIDER (a Group object)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public RRI_I15_PROVIDER removePROVIDER(int rep) throws HL7Exception {
return (RRI_I15_PROVIDER)super.removeRepetition("PROVIDER", rep);
}
/**
*
* Returns
* PID (Patient Identification) - creates it if necessary
*
*
*
*/
public PID getPID() {
return getTyped("PID", PID.class);
}
/**
*
* Returns
* ACC (Accident) - creates it if necessary
*
*
*
*/
public ACC getACC() {
return getTyped("ACC", ACC.class);
}
/**
*
* Returns
* the first repetition of
* DG1 (Diagnosis) - creates it if necessary
*
*
*
*/
public DG1 getDG1() {
return getTyped("DG1", DG1.class);
}
/**
*
* Returns a specific repetition of
* DG1 (Diagnosis) - 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 DG1 getDG1(int rep) {
return getTyped("DG1", rep, DG1.class);
}
/**
*
* Returns the number of existing repetitions of DG1
*
*
*/
public int getDG1Reps() {
return getReps("DG1");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of DG1.
*
*
* Note that unlike {@link #getDG1()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getDG1All() throws HL7Exception {
return getAllAsList("DG1", DG1.class);
}
/**
*
* Inserts a specific repetition of DG1 (Diagnosis)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertDG1(DG1 structure, int rep) throws HL7Exception {
super.insertRepetition( "DG1", structure, rep);
}
/**
*
* Inserts a specific repetition of DG1 (Diagnosis)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public DG1 insertDG1(int rep) throws HL7Exception {
return (DG1)super.insertRepetition("DG1", rep);
}
/**
*
* Removes a specific repetition of DG1 (Diagnosis)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public DG1 removeDG1(int rep) throws HL7Exception {
return (DG1)super.removeRepetition("DG1", rep);
}
/**
*
* Returns
* the first repetition of
* DRG (Diagnosis Related Group) - creates it if necessary
*
*
*
*/
public DRG getDRG() {
return getTyped("DRG", DRG.class);
}
/**
*
* Returns a specific repetition of
* DRG (Diagnosis Related Group) - 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 DRG getDRG(int rep) {
return getTyped("DRG", rep, DRG.class);
}
/**
*
* Returns the number of existing repetitions of DRG
*
*
*/
public int getDRGReps() {
return getReps("DRG");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of DRG.
*
*
* Note that unlike {@link #getDRG()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getDRGAll() throws HL7Exception {
return getAllAsList("DRG", DRG.class);
}
/**
*
* Inserts a specific repetition of DRG (Diagnosis Related Group)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertDRG(DRG structure, int rep) throws HL7Exception {
super.insertRepetition( "DRG", structure, rep);
}
/**
*
* Inserts a specific repetition of DRG (Diagnosis Related Group)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public DRG insertDRG(int rep) throws HL7Exception {
return (DRG)super.insertRepetition("DRG", rep);
}
/**
*
* Removes a specific repetition of DRG (Diagnosis Related Group)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public DRG removeDRG(int rep) throws HL7Exception {
return (DRG)super.removeRepetition("DRG", rep);
}
/**
*
* Returns
* the first repetition of
* AL1 (Patient allergy information) - creates it if necessary
*
*
*
*/
public AL1 getAL1() {
return getTyped("AL1", AL1.class);
}
/**
*
* Returns a specific repetition of
* AL1 (Patient allergy information) - 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 AL1 getAL1(int rep) {
return getTyped("AL1", rep, AL1.class);
}
/**
*
* Returns the number of existing repetitions of AL1
*
*
*/
public int getAL1Reps() {
return getReps("AL1");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of AL1.
*
*
* Note that unlike {@link #getAL1()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getAL1All() throws HL7Exception {
return getAllAsList("AL1", AL1.class);
}
/**
*
* Inserts a specific repetition of AL1 (Patient allergy information)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertAL1(AL1 structure, int rep) throws HL7Exception {
super.insertRepetition( "AL1", structure, rep);
}
/**
*
* Inserts a specific repetition of AL1 (Patient allergy information)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public AL1 insertAL1(int rep) throws HL7Exception {
return (AL1)super.insertRepetition("AL1", rep);
}
/**
*
* Removes a specific repetition of AL1 (Patient allergy information)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public AL1 removeAL1(int rep) throws HL7Exception {
return (AL1)super.removeRepetition("AL1", rep);
}
/**
*
* Returns
* the first repetition of
* PROCEDURE (a Group object) - creates it if necessary
*
*
*
*/
public RRI_I15_PROCEDURE getPROCEDURE() {
return getTyped("PROCEDURE", RRI_I15_PROCEDURE.class);
}
/**
*
* Returns a specific repetition of
* PROCEDURE (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 RRI_I15_PROCEDURE getPROCEDURE(int rep) {
return getTyped("PROCEDURE", rep, RRI_I15_PROCEDURE.class);
}
/**
*
* Returns the number of existing repetitions of PROCEDURE
*
*
*/
public int getPROCEDUREReps() {
return getReps("PROCEDURE");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of PROCEDURE.
*
*
* Note that unlike {@link #getPROCEDURE()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getPROCEDUREAll() throws HL7Exception {
return getAllAsList("PROCEDURE", RRI_I15_PROCEDURE.class);
}
/**
*
* Inserts a specific repetition of PROCEDURE (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertPROCEDURE(RRI_I15_PROCEDURE structure, int rep) throws HL7Exception {
super.insertRepetition( "PROCEDURE", structure, rep);
}
/**
*
* Inserts a specific repetition of PROCEDURE (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public RRI_I15_PROCEDURE insertPROCEDURE(int rep) throws HL7Exception {
return (RRI_I15_PROCEDURE)super.insertRepetition("PROCEDURE", rep);
}
/**
*
* Removes a specific repetition of PROCEDURE (a Group object)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public RRI_I15_PROCEDURE removePROCEDURE(int rep) throws HL7Exception {
return (RRI_I15_PROCEDURE)super.removeRepetition("PROCEDURE", rep);
}
/**
*
* Returns
* the first repetition of
* RESULTS (a Group object) - creates it if necessary
*
*
*
*/
public RRI_I15_RESULTS getRESULTS() {
return getTyped("RESULTS", RRI_I15_RESULTS.class);
}
/**
*
* Returns a specific repetition of
* RESULTS (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 RRI_I15_RESULTS getRESULTS(int rep) {
return getTyped("RESULTS", rep, RRI_I15_RESULTS.class);
}
/**
*
* Returns the number of existing repetitions of RESULTS
*
*
*/
public int getRESULTSReps() {
return getReps("RESULTS");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of RESULTS.
*
*
* Note that unlike {@link #getRESULTS()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getRESULTSAll() throws HL7Exception {
return getAllAsList("RESULTS", RRI_I15_RESULTS.class);
}
/**
*
* Inserts a specific repetition of RESULTS (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertRESULTS(RRI_I15_RESULTS structure, int rep) throws HL7Exception {
super.insertRepetition( "RESULTS", structure, rep);
}
/**
*
* Inserts a specific repetition of RESULTS (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public RRI_I15_RESULTS insertRESULTS(int rep) throws HL7Exception {
return (RRI_I15_RESULTS)super.insertRepetition("RESULTS", rep);
}
/**
*
* Removes a specific repetition of RESULTS (a Group object)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public RRI_I15_RESULTS removeRESULTS(int rep) throws HL7Exception {
return (RRI_I15_RESULTS)super.removeRepetition("RESULTS", rep);
}
/**
*
* Returns
* VISIT (a Group object) - creates it if necessary
*
*
*
*/
public RRI_I15_VISIT getVISIT() {
return getTyped("VISIT", RRI_I15_VISIT.class);
}
/**
*
* Returns
* the first repetition of
* NTE (Notes and comments segment) - creates it if necessary
*
*
*
*/
public NTE getNTE() {
return getTyped("NTE", NTE.class);
}
/**
*
* Returns a specific repetition of
* NTE (Notes and comments segment) - 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 segment)
*
*
*
* @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 segment)
*
*
*
* @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 segment)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public NTE removeNTE(int rep) throws HL7Exception {
return (NTE)super.removeRepetition("NTE", rep);
}
}