ca.uhn.hl7v2.model.v26.message.SRM_S01 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.v26.message;
import ca.uhn.hl7v2.model.v26.group.*;
import ca.uhn.hl7v2.model.v26.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 SRM_S01 message structure (see chapter 10.3). This structure contains the
* following elements:
*
* - 1: MSH (Message Header)
* - 2: ARQ (Appointment Request)
* - 3: APR (Appointment Preferences) optional
* - 4: NTE (Notes and Comments) optional repeating
* - 5: SRM_S01_PATIENT (a Group object) optional repeating
* - 6: SRM_S01_RESOURCES (a Group object) repeating
*
*/
public class SRM_S01 extends AbstractMessage {
/**
* Creates a new SRM_S01 message with DefaultModelClassFactory.
*/
public SRM_S01() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new SRM_S01 message with custom ModelClassFactory.
*/
public SRM_S01(ModelClassFactory factory) {
super(factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(MSH.class, true, false);
this.add(ARQ.class, true, false);
this.add(APR.class, false, false);
this.add(NTE.class, false, true);
this.add(SRM_S01_PATIENT.class, false, true);
this.add(SRM_S01_RESOURCES.class, true, true);
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error creating SRM_S01 - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.6"
*/
public String getVersion() {
return "2.6";
}
/**
* 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
* ARQ (Appointment Request) - creates it if necessary
*/
public ARQ getARQ() {
ARQ ret = null;
try {
ret = (ARQ)this.get("ARQ");
} 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
* APR (Appointment Preferences) - creates it if necessary
*/
public APR getAPR() {
APR ret = null;
try {
ret = (APR)this.get("APR");
} 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
* 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 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) {
NTE ret = null;
try {
ret = (NTE)this.get("NTE", 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 NTE
*/
public int getNTEReps() {
int reps = -1;
try {
reps = this.getAll("NTE").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 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);
}
/**
* Returns
* the first repetition of
* PATIENT (a Group object) - creates it if necessary
*/
public SRM_S01_PATIENT getPATIENT() {
SRM_S01_PATIENT ret = null;
try {
ret = (SRM_S01_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 a specific repetition of
* PATIENT (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 SRM_S01_PATIENT getPATIENT(int rep) {
SRM_S01_PATIENT ret = null;
try {
ret = (SRM_S01_PATIENT)this.get("PATIENT", 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 PATIENT
*/
public int getPATIENTReps() {
int reps = -1;
try {
reps = this.getAll("PATIENT").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 PATIENT (a Group object)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public void insertPATIENT(SRM_S01_PATIENT structure, int rep) throws HL7Exception {
super.insertRepetition( "PATIENT", structure, rep);
}
/**
* Inserts a specific repetition of PATIENT (a Group object)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public SRM_S01_PATIENT insertPATIENT(int rep) throws HL7Exception {
return (SRM_S01_PATIENT)super.insertRepetition("PATIENT", rep);
}
/**
* Removes a specific repetition of PATIENT (a Group object)
* @see AbstractGroup\#removeRepetition(String, int)
*/
public SRM_S01_PATIENT removePATIENT(int rep) throws HL7Exception {
return (SRM_S01_PATIENT)super.removeRepetition("PATIENT", rep);
}
/**
* Returns
* the first repetition of
* RESOURCES (a Group object) - creates it if necessary
*/
public SRM_S01_RESOURCES getRESOURCES() {
SRM_S01_RESOURCES ret = null;
try {
ret = (SRM_S01_RESOURCES)this.get("RESOURCES");
} 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
* RESOURCES (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 SRM_S01_RESOURCES getRESOURCES(int rep) {
SRM_S01_RESOURCES ret = null;
try {
ret = (SRM_S01_RESOURCES)this.get("RESOURCES", 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 RESOURCES
*/
public int getRESOURCESReps() {
int reps = -1;
try {
reps = this.getAll("RESOURCES").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 RESOURCES (a Group object)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public void insertRESOURCES(SRM_S01_RESOURCES structure, int rep) throws HL7Exception {
super.insertRepetition( "RESOURCES", structure, rep);
}
/**
* Inserts a specific repetition of RESOURCES (a Group object)
* @see AbstractGroup\#insertRepetition(Structure, int)
*/
public SRM_S01_RESOURCES insertRESOURCES(int rep) throws HL7Exception {
return (SRM_S01_RESOURCES)super.insertRepetition("RESOURCES", rep);
}
/**
* Removes a specific repetition of RESOURCES (a Group object)
* @see AbstractGroup\#removeRepetition(String, int)
*/
public SRM_S01_RESOURCES removeRESOURCES(int rep) throws HL7Exception {
return (SRM_S01_RESOURCES)super.removeRepetition("RESOURCES", rep);
}
}