ca.uhn.hl7v2.model.v25.message.VXR_V03 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/
*/
package ca.uhn.hl7v2.model.v25.message;
import ca.uhn.hl7v2.model.v25.group.*;
import ca.uhn.hl7v2.model.v25.segment.*;
import ca.uhn.log.HapiLogFactory;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
import ca.uhn.hl7v2.model.AbstractMessage;
/**
* Represents a VXR_V03 message structure (see chapter 4.17.5). This structure contains the
* following elements:
*
* - 1: MSH (Message Header)
* - 2: MSA (Message Acknowledgment)
* - 3: SFT (Software Segment) optional repeating
* - 4: QRD (Original-Style Query Definition)
* - 5: QRF (Original style query filter) optional
* - 6: PID (Patient Identification)
* - 7: PD1 (Patient Additional Demographic) optional
* - 8: NK1 (Next of Kin / Associated Parties) optional repeating
* - 9: VXR_V03_PATIENT_VISIT (a Group object) optional
* - 10: GT1 (Guarantor) optional repeating
* - 11: VXR_V03_INSURANCE (a Group object) optional repeating
* - 12: VXR_V03_ORDER (a Group object) optional repeating
*
*/
public class VXR_V03 extends AbstractMessage {
/**
* Creates a new VXR_V03 message with DefaultModelClassFactory.
*/
public VXR_V03() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new VXR_V03 message with custom ModelClassFactory.
*/
public VXR_V03(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(SFT.class, false, true);
this.add(QRD.class, true, false);
this.add(QRF.class, false, false);
this.add(PID.class, true, false);
this.add(PD1.class, false, false);
this.add(NK1.class, false, true);
this.add(VXR_V03_PATIENT_VISIT.class, false, false);
this.add(GT1.class, false, true);
this.add(VXR_V03_INSURANCE.class, false, true);
this.add(VXR_V03_ORDER.class, false, true);
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error creating VXR_V03 - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.5"
*/
public String getVersion() {
return "2.5";
}
/**
* Returns
* MSH (Message Header) - creates it if necessary
*/
public MSH getMSH() {
MSH ret = null;
try {
ret = (MSH)this.get("MSH");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* MSA (Message Acknowledgment) - creates it if necessary
*/
public MSA getMSA() {
MSA ret = null;
try {
ret = (MSA)this.get("MSA");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* the first repetition of
* SFT (Software Segment) - creates it if necessary
*/
public SFT getSFT() {
SFT ret = null;
try {
ret = (SFT)this.get("SFT");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns a specific repetition of
* SFT (Software 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 SFT getSFT(int rep) {
SFT ret = null;
try {
ret = (SFT)this.get("SFT", rep);
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns the number of existing repetitions of SFT
*/
public int getSFTReps() {
int reps = -1;
try {
reps = this.getAll("SFT").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
HapiLogFactory.getHapiLog(this.getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* Inserts a specific repetition of SFT (Software Segment)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public void insertSFT(SFT structure, int rep) throws HL7Exception {
super.insertRepetition( "SFT", structure, rep);
}
/**
* Inserts a specific repetition of SFT (Software Segment)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public SFT insertSFT(int rep) throws HL7Exception {
return (SFT)super.insertRepetition("SFT", rep);
}
/**
* Removes a specific repetition of SFT (Software Segment)
* @see AbstractGroup\#removeRepetition(String, int)
*/
public SFT removeSFT(int rep) throws HL7Exception {
return (SFT)super.removeRepetition("SFT", rep);
}
/**
* Returns
* QRD (Original-Style Query Definition) - creates it if necessary
*/
public QRD getQRD() {
QRD ret = null;
try {
ret = (QRD)this.get("QRD");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* QRF (Original style query filter) - creates it if necessary
*/
public QRF getQRF() {
QRF ret = null;
try {
ret = (QRF)this.get("QRF");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* PID (Patient Identification) - creates it if necessary
*/
public PID getPID() {
PID ret = null;
try {
ret = (PID)this.get("PID");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* PD1 (Patient Additional Demographic) - creates it if necessary
*/
public PD1 getPD1() {
PD1 ret = null;
try {
ret = (PD1)this.get("PD1");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* the first repetition of
* NK1 (Next of Kin / Associated Parties) - creates it if necessary
*/
public NK1 getNK1() {
NK1 ret = null;
try {
ret = (NK1)this.get("NK1");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* 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) {
NK1 ret = null;
try {
ret = (NK1)this.get("NK1", rep);
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns the number of existing repetitions of NK1
*/
public int getNK1Reps() {
int reps = -1;
try {
reps = this.getAll("NK1").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
HapiLogFactory.getHapiLog(this.getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* 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
* PATIENT_VISIT (a Group object) - creates it if necessary
*/
public VXR_V03_PATIENT_VISIT getPATIENT_VISIT() {
VXR_V03_PATIENT_VISIT ret = null;
try {
ret = (VXR_V03_PATIENT_VISIT)this.get("PATIENT_VISIT");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* the first repetition of
* GT1 (Guarantor) - creates it if necessary
*/
public GT1 getGT1() {
GT1 ret = null;
try {
ret = (GT1)this.get("GT1");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns a specific repetition of
* GT1 (Guarantor) - 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 GT1 getGT1(int rep) {
GT1 ret = null;
try {
ret = (GT1)this.get("GT1", rep);
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns the number of existing repetitions of GT1
*/
public int getGT1Reps() {
int reps = -1;
try {
reps = this.getAll("GT1").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
HapiLogFactory.getHapiLog(this.getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* Inserts a specific repetition of GT1 (Guarantor)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public void insertGT1(GT1 structure, int rep) throws HL7Exception {
super.insertRepetition( "GT1", structure, rep);
}
/**
* Inserts a specific repetition of GT1 (Guarantor)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public GT1 insertGT1(int rep) throws HL7Exception {
return (GT1)super.insertRepetition("GT1", rep);
}
/**
* Removes a specific repetition of GT1 (Guarantor)
* @see AbstractGroup\#removeRepetition(String, int)
*/
public GT1 removeGT1(int rep) throws HL7Exception {
return (GT1)super.removeRepetition("GT1", rep);
}
/**
* Returns
* the first repetition of
* INSURANCE (a Group object) - creates it if necessary
*/
public VXR_V03_INSURANCE getINSURANCE() {
VXR_V03_INSURANCE ret = null;
try {
ret = (VXR_V03_INSURANCE)this.get("INSURANCE");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns a specific repetition of
* INSURANCE (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 VXR_V03_INSURANCE getINSURANCE(int rep) {
VXR_V03_INSURANCE ret = null;
try {
ret = (VXR_V03_INSURANCE)this.get("INSURANCE", rep);
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns the number of existing repetitions of INSURANCE
*/
public int getINSURANCEReps() {
int reps = -1;
try {
reps = this.getAll("INSURANCE").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
HapiLogFactory.getHapiLog(this.getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* Inserts a specific repetition of INSURANCE (a Group object)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public void insertINSURANCE(VXR_V03_INSURANCE structure, int rep) throws HL7Exception {
super.insertRepetition( "INSURANCE", structure, rep);
}
/**
* Inserts a specific repetition of INSURANCE (a Group object)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public VXR_V03_INSURANCE insertINSURANCE(int rep) throws HL7Exception {
return (VXR_V03_INSURANCE)super.insertRepetition("INSURANCE", rep);
}
/**
* Removes a specific repetition of INSURANCE (a Group object)
* @see AbstractGroup\#removeRepetition(String, int)
*/
public VXR_V03_INSURANCE removeINSURANCE(int rep) throws HL7Exception {
return (VXR_V03_INSURANCE)super.removeRepetition("INSURANCE", rep);
}
/**
* Returns
* the first repetition of
* ORDER (a Group object) - creates it if necessary
*/
public VXR_V03_ORDER getORDER() {
VXR_V03_ORDER ret = null;
try {
ret = (VXR_V03_ORDER)this.get("ORDER");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns a specific repetition of
* ORDER (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 VXR_V03_ORDER getORDER(int rep) {
VXR_V03_ORDER ret = null;
try {
ret = (VXR_V03_ORDER)this.get("ORDER", rep);
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns the number of existing repetitions of ORDER
*/
public int getORDERReps() {
int reps = -1;
try {
reps = this.getAll("ORDER").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
HapiLogFactory.getHapiLog(this.getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
* Inserts a specific repetition of ORDER (a Group object)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public void insertORDER(VXR_V03_ORDER structure, int rep) throws HL7Exception {
super.insertRepetition( "ORDER", structure, rep);
}
/**
* Inserts a specific repetition of ORDER (a Group object)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public VXR_V03_ORDER insertORDER(int rep) throws HL7Exception {
return (VXR_V03_ORDER)super.insertRepetition("ORDER", rep);
}
/**
* Removes a specific repetition of ORDER (a Group object)
* @see AbstractGroup\#removeRepetition(String, int)
*/
public VXR_V03_ORDER removeORDER(int rep) throws HL7Exception {
return (VXR_V03_ORDER)super.removeRepetition("ORDER", rep);
}
}