ca.uhn.hl7v2.model.v26.message.PPR_PC1 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 PPR_PC1 message structure (see chapter 12.3.2). 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: PPR_PC1_PATIENT_VISIT (a Group object) optional
* - 6: PPR_PC1_PROBLEM (a Group object) repeating
*
*/
//@SuppressWarnings("unused")
public class PPR_PC1 extends AbstractMessage {
/**
* Creates a new PPR_PC1 message with DefaultModelClassFactory.
*/
public PPR_PC1() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new PPR_PC1 message with custom ModelClassFactory.
*/
public PPR_PC1(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(PPR_PC1_PATIENT_VISIT.class, false, false);
this.add(PPR_PC1_PROBLEM.class, true, true);
} catch(HL7Exception e) {
log.error("Unexpected error creating PPR_PC1 - 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 java.util.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
* PATIENT_VISIT (a Group object) - creates it if necessary
*
*
*
*/
public PPR_PC1_PATIENT_VISIT getPATIENT_VISIT() {
return getTyped("PATIENT_VISIT", PPR_PC1_PATIENT_VISIT.class);
}
/**
*
* Returns
* the first repetition of
* PROBLEM (a Group object) - creates it if necessary
*
*
*
*/
public PPR_PC1_PROBLEM getPROBLEM() {
return getTyped("PROBLEM", PPR_PC1_PROBLEM.class);
}
/**
*
* Returns a specific repetition of
* PROBLEM (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 PPR_PC1_PROBLEM getPROBLEM(int rep) {
return getTyped("PROBLEM", rep, PPR_PC1_PROBLEM.class);
}
/**
*
* Returns the number of existing repetitions of PROBLEM
*
*
*/
public int getPROBLEMReps() {
return getReps("PROBLEM");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of PROBLEM.
*
*
* Note that unlike {@link #getPROBLEM()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*
*/
public java.util.List getPROBLEMAll() throws HL7Exception {
return getAllAsList("PROBLEM", PPR_PC1_PROBLEM.class);
}
/**
*
* Inserts a specific repetition of PROBLEM (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertPROBLEM(PPR_PC1_PROBLEM structure, int rep) throws HL7Exception {
super.insertRepetition( "PROBLEM", structure, rep);
}
/**
*
* Inserts a specific repetition of PROBLEM (a Group object)
*
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public PPR_PC1_PROBLEM insertPROBLEM(int rep) throws HL7Exception {
return (PPR_PC1_PROBLEM)super.insertRepetition("PROBLEM", rep);
}
/**
*
* Removes a specific repetition of PROBLEM (a Group object)
*
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public PPR_PC1_PROBLEM removePROBLEM(int rep) throws HL7Exception {
return (PPR_PC1_PROBLEM)super.removeRepetition("PROBLEM", rep);
}
}