ca.uhn.hl7v2.model.v26.message.ORU_R30 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.v26.message;
import ca.uhn.hl7v2.model.v26.group.*;
import ca.uhn.hl7v2.model.v26.segment.*;
import java.util.List;
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 ORU_R30 message structure (see chapter 7.3.4). This structure contains the
* following elements:
*
* - 1: MSH (Message Header)
* - 2: SFT (Software Segment) optional repeating
* - 3: UAC (User Authentication Credential Segment) optional
* - 4: PID (Patient Identification)
* - 5: PD1 (Patient Additional Demographic) optional
* - 6: OBX (Observation/Result) optional repeating
* - 7: ORU_R30_VISIT (a Group object) optional
* - 8: ORC (Common Order)
* - 9: OBR (Observation Request)
* - 10: NTE (Notes and Comments) optional repeating
* - 11: ROL (Role) optional repeating
* - 12: ORU_R30_TIMING_QTY (a Group object) optional repeating
* - 13: ORU_R30_OBSERVATION (a Group object) repeating
*
*/
public class ORU_R30 extends AbstractMessage {
/**
* Creates a new ORU_R30 message with DefaultModelClassFactory.
*/
public ORU_R30() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new ORU_R30 message with custom ModelClassFactory.
*/
public ORU_R30(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(UAC.class, false, false);
this.add(PID.class, true, false);
this.add(PD1.class, false, false);
this.add(OBX.class, false, true);
this.add(ORU_R30_VISIT.class, false, false);
this.add(ORC.class, true, false);
this.add(OBR.class, true, false);
this.add(NTE.class, false, true);
this.add(ROL.class, false, true);
this.add(ORU_R30_TIMING_QTY.class, false, true);
this.add(ORU_R30_OBSERVATION.class, true, true);
} catch(HL7Exception e) {
log.error("Unexpected error creating ORU_R30 - 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() {
return getTyped("MSH", MSH.class);
}
/**
* Returns
* the first repetition of
* SFT (Software Segment) - creates it if necessary
*/
public SFT getSFT() {
return getTyped("SFT", SFT.class);
}
/**
* 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) {
return getTyped("SFT", rep, SFT.class);
}
/**
* Returns the number of existing repetitions of SFT
*/
public int getSFTReps() {
return getReps("SFT");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of SFT.
*
*
* Note that unlike {@link #getSFT()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getSFTAll() throws HL7Exception {
return getAllAsList("SFT", SFT.class);
}
/**
* 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
* UAC (User Authentication Credential Segment) - creates it if necessary
*/
public UAC getUAC() {
return getTyped("UAC", UAC.class);
}
/**
* Returns
* PID (Patient Identification) - creates it if necessary
*/
public PID getPID() {
return getTyped("PID", PID.class);
}
/**
* Returns
* PD1 (Patient Additional Demographic) - creates it if necessary
*/
public PD1 getPD1() {
return getTyped("PD1", PD1.class);
}
/**
* Returns
* the first repetition of
* OBX (Observation/Result) - creates it if necessary
*/
public OBX getOBX() {
return getTyped("OBX", OBX.class);
}
/**
* Returns a specific repetition of
* OBX (Observation/Result) - 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 OBX getOBX(int rep) {
return getTyped("OBX", rep, OBX.class);
}
/**
* Returns the number of existing repetitions of OBX
*/
public int getOBXReps() {
return getReps("OBX");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of OBX.
*
*
* Note that unlike {@link #getOBX()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getOBXAll() throws HL7Exception {
return getAllAsList("OBX", OBX.class);
}
/**
* Inserts a specific repetition of OBX (Observation/Result)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertOBX(OBX structure, int rep) throws HL7Exception {
super.insertRepetition( "OBX", structure, rep);
}
/**
* Inserts a specific repetition of OBX (Observation/Result)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public OBX insertOBX(int rep) throws HL7Exception {
return (OBX)super.insertRepetition("OBX", rep);
}
/**
* Removes a specific repetition of OBX (Observation/Result)
* @see AbstractGroup#removeRepetition(String, int)
*/
public OBX removeOBX(int rep) throws HL7Exception {
return (OBX)super.removeRepetition("OBX", rep);
}
/**
* Returns
* VISIT (a Group object) - creates it if necessary
*/
public ORU_R30_VISIT getVISIT() {
return getTyped("VISIT", ORU_R30_VISIT.class);
}
/**
* Returns
* ORC (Common Order) - creates it if necessary
*/
public ORC getORC() {
return getTyped("ORC", ORC.class);
}
/**
* Returns
* OBR (Observation Request) - creates it if necessary
*/
public OBR getOBR() {
return getTyped("OBR", OBR.class);
}
/**
* Returns
* the first repetition of
* NTE (Notes and Comments) - creates it if necessary
*/
public NTE getNTE() {
return getTyped("NTE", NTE.class);
}
/**
* 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) {
return getTyped("NTE", rep, NTE.class);
}
/**
* 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
* the first repetition of
* ROL (Role) - creates it if necessary
*/
public ROL getROL() {
return getTyped("ROL", ROL.class);
}
/**
* Returns a specific repetition of
* ROL (Role) - 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 ROL getROL(int rep) {
return getTyped("ROL", rep, ROL.class);
}
/**
* Returns the number of existing repetitions of ROL
*/
public int getROLReps() {
return getReps("ROL");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of ROL.
*
*
* Note that unlike {@link #getROL()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getROLAll() throws HL7Exception {
return getAllAsList("ROL", ROL.class);
}
/**
* Inserts a specific repetition of ROL (Role)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertROL(ROL structure, int rep) throws HL7Exception {
super.insertRepetition( "ROL", structure, rep);
}
/**
* Inserts a specific repetition of ROL (Role)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public ROL insertROL(int rep) throws HL7Exception {
return (ROL)super.insertRepetition("ROL", rep);
}
/**
* Removes a specific repetition of ROL (Role)
* @see AbstractGroup#removeRepetition(String, int)
*/
public ROL removeROL(int rep) throws HL7Exception {
return (ROL)super.removeRepetition("ROL", rep);
}
/**
* Returns
* the first repetition of
* TIMING_QTY (a Group object) - creates it if necessary
*/
public ORU_R30_TIMING_QTY getTIMING_QTY() {
return getTyped("TIMING_QTY", ORU_R30_TIMING_QTY.class);
}
/**
* Returns a specific repetition of
* TIMING_QTY (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 ORU_R30_TIMING_QTY getTIMING_QTY(int rep) {
return getTyped("TIMING_QTY", rep, ORU_R30_TIMING_QTY.class);
}
/**
* Returns the number of existing repetitions of TIMING_QTY
*/
public int getTIMING_QTYReps() {
return getReps("TIMING_QTY");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of TIMING_QTY.
*
*
* Note that unlike {@link #getTIMING_QTY()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getTIMING_QTYAll() throws HL7Exception {
return getAllAsList("TIMING_QTY", ORU_R30_TIMING_QTY.class);
}
/**
* Inserts a specific repetition of TIMING_QTY (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertTIMING_QTY(ORU_R30_TIMING_QTY structure, int rep) throws HL7Exception {
super.insertRepetition( "TIMING_QTY", structure, rep);
}
/**
* Inserts a specific repetition of TIMING_QTY (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public ORU_R30_TIMING_QTY insertTIMING_QTY(int rep) throws HL7Exception {
return (ORU_R30_TIMING_QTY)super.insertRepetition("TIMING_QTY", rep);
}
/**
* Removes a specific repetition of TIMING_QTY (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public ORU_R30_TIMING_QTY removeTIMING_QTY(int rep) throws HL7Exception {
return (ORU_R30_TIMING_QTY)super.removeRepetition("TIMING_QTY", rep);
}
/**
* Returns
* the first repetition of
* OBSERVATION (a Group object) - creates it if necessary
*/
public ORU_R30_OBSERVATION getOBSERVATION() {
return getTyped("OBSERVATION", ORU_R30_OBSERVATION.class);
}
/**
* 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 ORU_R30_OBSERVATION getOBSERVATION(int rep) {
return getTyped("OBSERVATION", rep, ORU_R30_OBSERVATION.class);
}
/**
* 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", ORU_R30_OBSERVATION.class);
}
/**
* Inserts a specific repetition of OBSERVATION (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertOBSERVATION(ORU_R30_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 ORU_R30_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception {
return (ORU_R30_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
}
/**
* Removes a specific repetition of OBSERVATION (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public ORU_R30_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception {
return (ORU_R30_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
}
}