ca.uhn.hl7v2.model.v251.group.OMG_O19_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)
* 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.v251.group;
import ca.uhn.hl7v2.model.v251.segment.*;
import java.util.List;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.model.*;
/**
* Represents a OMG_O19_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: OMG_O19_TIMING (a Group object) optional repeating
* - 3: OBR (Observation Request)
* - 4: NTE (Notes and Comments) optional repeating
* - 5: CTD (Contact Data) optional
* - 6: DG1 (Diagnosis) optional repeating
* - 7: OMG_O19_OBSERVATION (a Group object) optional repeating
* - 8: OMG_O19_SPECIMEN (a Group object) optional repeating
* - 9: OMG_O19_PRIOR_RESULT (a Group object) optional repeating
* - 10: FT1 (Financial Transaction) optional repeating
* - 11: CTI (Clinical Trial Identification) optional repeating
* - 12: BLG (Billing) optional
*
*/
@SuppressWarnings("unused")
public class OMG_O19_ORDER extends AbstractGroup {
/**
* Creates a new OMG_O19_ORDER group
*/
public OMG_O19_ORDER(Group parent, ModelClassFactory factory) {
super(parent, factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(ORC.class, true, false, false);
this.add(OMG_O19_TIMING.class, false, true, false);
this.add(OBR.class, true, false, false);
this.add(NTE.class, false, true, false);
this.add(CTD.class, false, false, false);
this.add(DG1.class, false, true, false);
this.add(OMG_O19_OBSERVATION.class, false, true, false);
this.add(OMG_O19_SPECIMEN.class, false, true, false);
this.add(OMG_O19_PRIOR_RESULT.class, false, true, false);
this.add(FT1.class, false, true, false);
this.add(CTI.class, false, true, false);
this.add(BLG.class, false, false, false);
} catch(HL7Exception e) {
log.error("Unexpected error creating OMG_O19_ORDER - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.5.1"
*/
public String getVersion() {
return "2.5.1";
}
/**
* Returns
* ORC (Common Order) - creates it if necessary
*/
public ORC getORC() {
ORC retVal = getTyped("ORC", ORC.class);
return retVal;
}
/**
* Returns
* the first repetition of
* TIMING (a Group object) - creates it if necessary
*/
public OMG_O19_TIMING getTIMING() {
OMG_O19_TIMING retVal = getTyped("TIMING", OMG_O19_TIMING.class);
return retVal;
}
/**
* Returns a specific repetition of
* TIMING (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 OMG_O19_TIMING getTIMING(int rep) {
OMG_O19_TIMING retVal = getTyped("TIMING", rep, OMG_O19_TIMING.class);
return retVal;
}
/**
* Returns the number of existing repetitions of TIMING
*/
public int getTIMINGReps() {
return getReps("TIMING");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of TIMING.
*
*
* Note that unlike {@link #getTIMING()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getTIMINGAll() throws HL7Exception {
return getAllAsList("TIMING", OMG_O19_TIMING.class);
}
/**
* Inserts a specific repetition of TIMING (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertTIMING(OMG_O19_TIMING structure, int rep) throws HL7Exception {
super.insertRepetition("TIMING", structure, rep);
}
/**
* Inserts a specific repetition of TIMING (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public OMG_O19_TIMING insertTIMING(int rep) throws HL7Exception {
return (OMG_O19_TIMING)super.insertRepetition("TIMING", rep);
}
/**
* Removes a specific repetition of TIMING (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public OMG_O19_TIMING removeTIMING(int rep) throws HL7Exception {
return (OMG_O19_TIMING)super.removeRepetition("TIMING", rep);
}
/**
* Returns
* OBR (Observation Request) - creates it if necessary
*/
public OBR getOBR() {
OBR retVal = getTyped("OBR", OBR.class);
return retVal;
}
/**
* Returns
* the first repetition of
* NTE (Notes and Comments) - creates it if necessary
*/
public NTE getNTE() {
NTE retVal = getTyped("NTE", NTE.class);
return retVal;
}
/**
* 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 retVal = getTyped("NTE", rep, NTE.class);
return retVal;
}
/**
* 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 List getNTEAll() throws HL7Exception {
return getAllAsList("NTE", NTE.class);
}
/**
* 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
* CTD (Contact Data) - creates it if necessary
*/
public CTD getCTD() {
CTD retVal = getTyped("CTD", CTD.class);
return retVal;
}
/**
* Returns
* the first repetition of
* DG1 (Diagnosis) - creates it if necessary
*/
public DG1 getDG1() {
DG1 retVal = getTyped("DG1", DG1.class);
return retVal;
}
/**
* 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) {
DG1 retVal = getTyped("DG1", rep, DG1.class);
return retVal;
}
/**
* 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 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
* OBSERVATION (a Group object) - creates it if necessary
*/
public OMG_O19_OBSERVATION getOBSERVATION() {
OMG_O19_OBSERVATION retVal = getTyped("OBSERVATION", OMG_O19_OBSERVATION.class);
return retVal;
}
/**
* 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 OMG_O19_OBSERVATION getOBSERVATION(int rep) {
OMG_O19_OBSERVATION retVal = getTyped("OBSERVATION", rep, OMG_O19_OBSERVATION.class);
return retVal;
}
/**
* Returns the number of existing repetitions of OBSERVATION
*/
public int getOBSERVATIONReps() {
return getReps("OBSERVATION");
}
/**
*
* 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 getAllAsList("OBSERVATION", OMG_O19_OBSERVATION.class);
}
/**
* Inserts a specific repetition of OBSERVATION (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertOBSERVATION(OMG_O19_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 OMG_O19_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception {
return (OMG_O19_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
}
/**
* Removes a specific repetition of OBSERVATION (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public OMG_O19_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception {
return (OMG_O19_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
}
/**
* Returns
* the first repetition of
* SPECIMEN (a Group object) - creates it if necessary
*/
public OMG_O19_SPECIMEN getSPECIMEN() {
OMG_O19_SPECIMEN retVal = getTyped("SPECIMEN", OMG_O19_SPECIMEN.class);
return retVal;
}
/**
* Returns a specific repetition of
* SPECIMEN (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 OMG_O19_SPECIMEN getSPECIMEN(int rep) {
OMG_O19_SPECIMEN retVal = getTyped("SPECIMEN", rep, OMG_O19_SPECIMEN.class);
return retVal;
}
/**
* Returns the number of existing repetitions of SPECIMEN
*/
public int getSPECIMENReps() {
return getReps("SPECIMEN");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of SPECIMEN.
*
*
* Note that unlike {@link #getSPECIMEN()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getSPECIMENAll() throws HL7Exception {
return getAllAsList("SPECIMEN", OMG_O19_SPECIMEN.class);
}
/**
* Inserts a specific repetition of SPECIMEN (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertSPECIMEN(OMG_O19_SPECIMEN structure, int rep) throws HL7Exception {
super.insertRepetition("SPECIMEN", structure, rep);
}
/**
* Inserts a specific repetition of SPECIMEN (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public OMG_O19_SPECIMEN insertSPECIMEN(int rep) throws HL7Exception {
return (OMG_O19_SPECIMEN)super.insertRepetition("SPECIMEN", rep);
}
/**
* Removes a specific repetition of SPECIMEN (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public OMG_O19_SPECIMEN removeSPECIMEN(int rep) throws HL7Exception {
return (OMG_O19_SPECIMEN)super.removeRepetition("SPECIMEN", rep);
}
/**
* Returns
* the first repetition of
* PRIOR_RESULT (a Group object) - creates it if necessary
*/
public OMG_O19_PRIOR_RESULT getPRIOR_RESULT() {
OMG_O19_PRIOR_RESULT retVal = getTyped("PRIOR_RESULT", OMG_O19_PRIOR_RESULT.class);
return retVal;
}
/**
* Returns a specific repetition of
* PRIOR_RESULT (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 OMG_O19_PRIOR_RESULT getPRIOR_RESULT(int rep) {
OMG_O19_PRIOR_RESULT retVal = getTyped("PRIOR_RESULT", rep, OMG_O19_PRIOR_RESULT.class);
return retVal;
}
/**
* Returns the number of existing repetitions of PRIOR_RESULT
*/
public int getPRIOR_RESULTReps() {
return getReps("PRIOR_RESULT");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of PRIOR_RESULT.
*
*
* Note that unlike {@link #getPRIOR_RESULT()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getPRIOR_RESULTAll() throws HL7Exception {
return getAllAsList("PRIOR_RESULT", OMG_O19_PRIOR_RESULT.class);
}
/**
* Inserts a specific repetition of PRIOR_RESULT (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertPRIOR_RESULT(OMG_O19_PRIOR_RESULT structure, int rep) throws HL7Exception {
super.insertRepetition("PRIOR_RESULT", structure, rep);
}
/**
* Inserts a specific repetition of PRIOR_RESULT (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public OMG_O19_PRIOR_RESULT insertPRIOR_RESULT(int rep) throws HL7Exception {
return (OMG_O19_PRIOR_RESULT)super.insertRepetition("PRIOR_RESULT", rep);
}
/**
* Removes a specific repetition of PRIOR_RESULT (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public OMG_O19_PRIOR_RESULT removePRIOR_RESULT(int rep) throws HL7Exception {
return (OMG_O19_PRIOR_RESULT)super.removeRepetition("PRIOR_RESULT", rep);
}
/**
* Returns
* the first repetition of
* FT1 (Financial Transaction) - creates it if necessary
*/
public FT1 getFT1() {
FT1 retVal = getTyped("FT1", FT1.class);
return retVal;
}
/**
* Returns a specific repetition of
* FT1 (Financial Transaction) - 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 FT1 getFT1(int rep) {
FT1 retVal = getTyped("FT1", rep, FT1.class);
return retVal;
}
/**
* Returns the number of existing repetitions of FT1
*/
public int getFT1Reps() {
return getReps("FT1");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of FT1.
*
*
* Note that unlike {@link #getFT1()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getFT1All() throws HL7Exception {
return getAllAsList("FT1", FT1.class);
}
/**
* Inserts a specific repetition of FT1 (Financial Transaction)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertFT1(FT1 structure, int rep) throws HL7Exception {
super.insertRepetition("FT1", structure, rep);
}
/**
* Inserts a specific repetition of FT1 (Financial Transaction)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public FT1 insertFT1(int rep) throws HL7Exception {
return (FT1)super.insertRepetition("FT1", rep);
}
/**
* Removes a specific repetition of FT1 (Financial Transaction)
* @see AbstractGroup#removeRepetition(String, int)
*/
public FT1 removeFT1(int rep) throws HL7Exception {
return (FT1)super.removeRepetition("FT1", rep);
}
/**
* Returns
* the first repetition of
* CTI (Clinical Trial Identification) - creates it if necessary
*/
public CTI getCTI() {
CTI retVal = getTyped("CTI", CTI.class);
return retVal;
}
/**
* 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 retVal = getTyped("CTI", rep, CTI.class);
return retVal;
}
/**
* Returns the number of existing repetitions of CTI
*/
public int getCTIReps() {
return getReps("CTI");
}
/**
*
* 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 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);
}
/**
* Returns
* BLG (Billing) - creates it if necessary
*/
public BLG getBLG() {
BLG retVal = getTyped("BLG", BLG.class);
return retVal;
}
}