ca.uhn.hl7v2.model.v24.group.RAS_O17_ORDER 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)
* 2002. 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.group;
import ca.uhn.hl7v2.model.v24.segment.*;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
import ca.uhn.hl7v2.model.AbstractMessage;
import ca.uhn.hl7v2.model.Group;
import ca.uhn.hl7v2.model.AbstractGroup;
import ca.uhn.hl7v2.model.GenericSegment;
/**
* Represents a RAS_O17_ORDER group structure (a Group object).
* A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
* This Group contains the following elements:
*
*
* - 1: ORC (Common Order)
* - 2: RAS_O17_ORDER_DETAIL (a Group object) optional
* - 3: RAS_O17_ENCODING (a Group object) optional
* - 4: RXA (Pharmacy/Treatment Administration) repeating
* - 5: RXR (Pharmacy/Treatment Route)
* - 6: RAS_O17_OBSERVATION (a Group object) optional repeating
* - 7: CTI (Clinical Trial Identification) optional repeating
*
*/
@SuppressWarnings("unused")
public class RAS_O17_ORDER extends AbstractGroup {
/**
* Creates a new RAS_O17_ORDER group
*/
public RAS_O17_ORDER(Group parent, ModelClassFactory factory) {
super(parent, factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(ORC.class, true, false);
this.add(RAS_O17_ORDER_DETAIL.class, false, false);
this.add(RAS_O17_ENCODING.class, false, false);
this.add(RXA.class, true, true);
this.add(RXR.class, true, false);
this.add(RAS_O17_OBSERVATION.class, false, true);
this.add(CTI.class, false, true);
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error creating RAS_O17_ORDER - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.4"
*/
public String getVersion() {
return "2.4";
}
/**
* Returns
* ORC (Common Order) - creates it if necessary
*/
public ORC getORC() {
ORC ret = null;
try {
ret = (ORC)this.get("ORC");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* ORDER_DETAIL (a Group object) - creates it if necessary
*/
public RAS_O17_ORDER_DETAIL getORDER_DETAIL() {
RAS_O17_ORDER_DETAIL ret = null;
try {
ret = (RAS_O17_ORDER_DETAIL)this.get("ORDER_DETAIL");
} catch(HL7Exception e) {
LoggerFactory.getLogger(getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
throw new RuntimeException(e);
}
return ret;
}
/**
* Returns
* ENCODING (a Group object) - creates it if necessary
*/
public RAS_O17_ENCODING getENCODING() {
RAS_O17_ENCODING ret = null;
try {
ret = (RAS_O17_ENCODING)this.get("ENCODING");
} catch(HL7Exception e) {
LoggerFactory.getLogger(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
* RXA (Pharmacy/Treatment Administration) - creates it if necessary
*/
public RXA getRXA() {
RXA ret = null;
try {
ret = (RXA)this.get("RXA");
} catch(HL7Exception e) {
LoggerFactory.getLogger(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
* RXA (Pharmacy/Treatment Administration) - 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 RXA getRXA(int rep) {
RXA ret = null;
try {
ret = (RXA)this.get("RXA", rep);
} catch(HL7Exception e) {
LoggerFactory.getLogger(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 RXA
*/
public int getRXAReps() {
int reps = -1;
try {
reps = this.getAll("RXA").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
LoggerFactory.getLogger(getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of RXA.
*
*
* Note that unlike {@link #getRXA()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getRXAAll() throws HL7Exception {
return this.getAllAsList("RXA", RXA.class);
}
/**
* Inserts a specific repetition of RXA (Pharmacy/Treatment Administration)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertRXA(RXA structure, int rep) throws HL7Exception {
super.insertRepetition("RXA", structure, rep);
}
/**
* Inserts a specific repetition of RXA (Pharmacy/Treatment Administration)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public RXA insertRXA(int rep) throws HL7Exception {
return (RXA)super.insertRepetition("RXA", rep);
}
/**
* Removes a specific repetition of RXA (Pharmacy/Treatment Administration)
* @see AbstractGroup#removeRepetition(String, int)
*/
public RXA removeRXA(int rep) throws HL7Exception {
return (RXA)super.removeRepetition("RXA", rep);
}
/**
* Returns
* RXR (Pharmacy/Treatment Route) - creates it if necessary
*/
public RXR getRXR() {
RXR ret = null;
try {
ret = (RXR)this.get("RXR");
} catch(HL7Exception e) {
LoggerFactory.getLogger(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
* OBSERVATION (a Group object) - creates it if necessary
*/
public RAS_O17_OBSERVATION getOBSERVATION() {
RAS_O17_OBSERVATION ret = null;
try {
ret = (RAS_O17_OBSERVATION)this.get("OBSERVATION");
} catch(HL7Exception e) {
LoggerFactory.getLogger(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
* OBSERVATION (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 RAS_O17_OBSERVATION getOBSERVATION(int rep) {
RAS_O17_OBSERVATION ret = null;
try {
ret = (RAS_O17_OBSERVATION)this.get("OBSERVATION", rep);
} catch(HL7Exception e) {
LoggerFactory.getLogger(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 OBSERVATION
*/
public int getOBSERVATIONReps() {
int reps = -1;
try {
reps = this.getAll("OBSERVATION").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
LoggerFactory.getLogger(getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
*
*
* Note that unlike {@link #getOBSERVATION()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getOBSERVATIONAll() throws HL7Exception {
return this.getAllAsList("OBSERVATION", RAS_O17_OBSERVATION.class);
}
/**
* Inserts a specific repetition of OBSERVATION (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertOBSERVATION(RAS_O17_OBSERVATION structure, int rep) throws HL7Exception {
super.insertRepetition("OBSERVATION", structure, rep);
}
/**
* Inserts a specific repetition of OBSERVATION (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public RAS_O17_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception {
return (RAS_O17_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
}
/**
* Removes a specific repetition of OBSERVATION (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public RAS_O17_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception {
return (RAS_O17_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
}
/**
* Returns
* the first repetition of
* CTI (Clinical Trial Identification) - creates it if necessary
*/
public CTI getCTI() {
CTI ret = null;
try {
ret = (CTI)this.get("CTI");
} catch(HL7Exception e) {
LoggerFactory.getLogger(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
* CTI (Clinical Trial Identification) - 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 CTI getCTI(int rep) {
CTI ret = null;
try {
ret = (CTI)this.get("CTI", rep);
} catch(HL7Exception e) {
LoggerFactory.getLogger(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 CTI
*/
public int getCTIReps() {
int reps = -1;
try {
reps = this.getAll("CTI").length;
} catch (HL7Exception e) {
String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
LoggerFactory.getLogger(getClass()).error(message, e);
throw new RuntimeException(message);
}
return reps;
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of CTI.
*
*
* Note that unlike {@link #getCTI()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getCTIAll() throws HL7Exception {
return this.getAllAsList("CTI", CTI.class);
}
/**
* Inserts a specific repetition of CTI (Clinical Trial Identification)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertCTI(CTI structure, int rep) throws HL7Exception {
super.insertRepetition("CTI", structure, rep);
}
/**
* Inserts a specific repetition of CTI (Clinical Trial Identification)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public CTI insertCTI(int rep) throws HL7Exception {
return (CTI)super.insertRepetition("CTI", rep);
}
/**
* Removes a specific repetition of CTI (Clinical Trial Identification)
* @see AbstractGroup#removeRepetition(String, int)
*/
public CTI removeCTI(int rep) throws HL7Exception {
return (CTI)super.removeRepetition("CTI", rep);
}
}