ca.uhn.hl7v2.model.v25.message.OUL_R24 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 OUL_R24 message structure (see chapter 7.3.9). This structure contains the
* following elements:
*
* - 1: MSH (Message Header)
* - 2: SFT (Software Segment) optional repeating
* - 3: NTE (Notes and Comments) optional
* - 4: OUL_R24_PATIENT (a Group object) optional
* - 5: OUL_R24_VISIT (a Group object) optional
* - 6: OUL_R24_ORDER (a Group object) repeating
* - 7: DSC (Continuation Pointer) optional
*
*/
public class OUL_R24 extends AbstractMessage {
/**
* Creates a new OUL_R24 message with DefaultModelClassFactory.
*/
public OUL_R24() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new OUL_R24 message with custom ModelClassFactory.
*/
public OUL_R24(ModelClassFactory factory) {
super(factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(MSH.class, true, false);
this.add(SFT.class, false, true);
this.add(NTE.class, false, false);
this.add(OUL_R24_PATIENT.class, false, false);
this.add(OUL_R24_VISIT.class, false, false);
this.add(OUL_R24_ORDER.class, true, true);
this.add(DSC.class, false, false);
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error creating OUL_R24 - 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
* 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
* NTE (Notes and Comments) - creates it if necessary
*/
public NTE getNTE() {
NTE ret = null;
try {
ret = (NTE)this.get("NTE");
} 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
* PATIENT (a Group object) - creates it if necessary
*/
public OUL_R24_PATIENT getPATIENT() {
OUL_R24_PATIENT ret = null;
try {
ret = (OUL_R24_PATIENT)this.get("PATIENT");
} 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
* VISIT (a Group object) - creates it if necessary
*/
public OUL_R24_VISIT getVISIT() {
OUL_R24_VISIT ret = null;
try {
ret = (OUL_R24_VISIT)this.get("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
* ORDER (a Group object) - creates it if necessary
*/
public OUL_R24_ORDER getORDER() {
OUL_R24_ORDER ret = null;
try {
ret = (OUL_R24_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 OUL_R24_ORDER getORDER(int rep) {
OUL_R24_ORDER ret = null;
try {
ret = (OUL_R24_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(OUL_R24_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 OUL_R24_ORDER insertORDER(int rep) throws HL7Exception {
return (OUL_R24_ORDER)super.insertRepetition("ORDER", rep);
}
/**
* Removes a specific repetition of ORDER (a Group object)
* @see AbstractGroup\#removeRepetition(String, int)
*/
public OUL_R24_ORDER removeORDER(int rep) throws HL7Exception {
return (OUL_R24_ORDER)super.removeRepetition("ORDER", rep);
}
/**
* Returns
* DSC (Continuation Pointer) - creates it if necessary
*/
public DSC getDSC() {
DSC ret = null;
try {
ret = (DSC)this.get("DSC");
} 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;
}
}