ca.uhn.hl7v2.model.v26.message.SIU_S12 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 ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
import ca.uhn.hl7v2.model.*;
/**
* Represents a SIU_S12 message structure (see chapter 10.4). This structure contains the
* following elements:
*
* - 1: MSH (Message Header)
* - 2: SCH (Scheduling Activity Information)
* - 3: TQ1 (Timing/Quantity) optional repeating
* - 4: NTE (Notes and Comments) optional repeating
* - 5: SIU_S12_PATIENT (a Group object) optional repeating
* - 6: SIU_S12_RESOURCES (a Group object) repeating
*
*/
//@SuppressWarnings("unused")
public class SIU_S12 extends AbstractMessage {
/**
* Creates a new SIU_S12 message with DefaultModelClassFactory.
*/
public SIU_S12() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new SIU_S12 message with custom ModelClassFactory.
*/
public SIU_S12(ModelClassFactory factory) {
super(factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(MSH.class, true, false);
this.add(SCH.class, true, false);
this.add(TQ1.class, false, true);
this.add(NTE.class, false, true);
this.add(SIU_S12_PATIENT.class, false, true);
this.add(SIU_S12_RESOURCES.class, true, true);
} catch(HL7Exception e) {
log.error("Unexpected error creating SIU_S12 - 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
* SCH (Scheduling Activity Information) - creates it if necessary
*
*
*
*/
public SCH getSCH() {
return getTyped("SCH", SCH.class);
}
/**
*
* Returns
* the first repetition of
* TQ1 (Timing/Quantity) - creates it if necessary
*
*
*
*/
public TQ1 getTQ1() {
return getTyped("TQ1", TQ1.class);
}
/**
*
* Returns a specific repetition of
* TQ1 (Timing/Quantity) - 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 TQ1 getTQ1(int rep) {
return getTyped("TQ1", rep, TQ1.class);
}
/**
*
* Returns the number of existing repetitions of TQ1
*
*
*/
public int getTQ1Reps() {
return getReps("TQ1");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of TQ1.
*
*
* Note that unlike {@link #getTQ1()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getTQ1All() throws HL7Exception {
return getAllAsList("TQ1", TQ1.class);
}
/**
*
* Inserts a specific repetition of TQ1 (Timing/Quantity)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertTQ1(TQ1 structure, int rep) throws HL7Exception {
super.insertRepetition( "TQ1", structure, rep);
}
/**
*
* Inserts a specific repetition of TQ1 (Timing/Quantity)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public TQ1 insertTQ1(int rep) throws HL7Exception {
return (TQ1)super.insertRepetition("TQ1", rep);
}
/**
*
* Removes a specific repetition of TQ1 (Timing/Quantity)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public TQ1 removeTQ1(int rep) throws HL7Exception {
return (TQ1)super.removeRepetition("TQ1", rep);
}
/**
*
* 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 java.util.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
* PATIENT (a Group object) - creates it if necessary
*
*
*
*/
public SIU_S12_PATIENT getPATIENT() {
return getTyped("PATIENT", SIU_S12_PATIENT.class);
}
/**
*
* 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 SIU_S12_PATIENT getPATIENT(int rep) {
return getTyped("PATIENT", rep, SIU_S12_PATIENT.class);
}
/**
*
* Returns the number of existing repetitions of PATIENT
*
*
*/
public int getPATIENTReps() {
return getReps("PATIENT");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of PATIENT.
*
*
* Note that unlike {@link #getPATIENT()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getPATIENTAll() throws HL7Exception {
return getAllAsList("PATIENT", SIU_S12_PATIENT.class);
}
/**
*
* Inserts a specific repetition of PATIENT (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertPATIENT(SIU_S12_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 SIU_S12_PATIENT insertPATIENT(int rep) throws HL7Exception {
return (SIU_S12_PATIENT)super.insertRepetition("PATIENT", rep);
}
/**
*
* Removes a specific repetition of PATIENT (a Group object)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public SIU_S12_PATIENT removePATIENT(int rep) throws HL7Exception {
return (SIU_S12_PATIENT)super.removeRepetition("PATIENT", rep);
}
/**
*
* Returns
* the first repetition of
* RESOURCES (a Group object) - creates it if necessary
*
*
*
*/
public SIU_S12_RESOURCES getRESOURCES() {
return getTyped("RESOURCES", SIU_S12_RESOURCES.class);
}
/**
*
* 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 SIU_S12_RESOURCES getRESOURCES(int rep) {
return getTyped("RESOURCES", rep, SIU_S12_RESOURCES.class);
}
/**
*
* Returns the number of existing repetitions of RESOURCES
*
*
*/
public int getRESOURCESReps() {
return getReps("RESOURCES");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of RESOURCES.
*
*
* Note that unlike {@link #getRESOURCES()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getRESOURCESAll() throws HL7Exception {
return getAllAsList("RESOURCES", SIU_S12_RESOURCES.class);
}
/**
*
* Inserts a specific repetition of RESOURCES (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertRESOURCES(SIU_S12_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 SIU_S12_RESOURCES insertRESOURCES(int rep) throws HL7Exception {
return (SIU_S12_RESOURCES)super.insertRepetition("RESOURCES", rep);
}
/**
*
* Removes a specific repetition of RESOURCES (a Group object)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public SIU_S12_RESOURCES removeRESOURCES(int rep) throws HL7Exception {
return (SIU_S12_RESOURCES)super.removeRepetition("RESOURCES", rep);
}
}