ca.uhn.hl7v2.model.v281.segment.GOL 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.v281.segment;
// import ca.uhn.hl7v2.model.v281.group.*;
import ca.uhn.hl7v2.model.v281.datatype.*;
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.Type;
import ca.uhn.hl7v2.model.AbstractSegment;
import ca.uhn.hl7v2.model.Varies;
/**
*Represents an HL7 GOL message segment (Goal Detail).
* This segment has the following fields:
*
* - GOL-1: Action Code (ID)
*
- GOL-2: Action Date/Time (DTM)
*
- GOL-3: Goal ID (CWE)
*
- GOL-4: Goal Instance ID (EI)
*
- GOL-5: Episode of Care ID (EI) optional
*
- GOL-6: Goal List Priority (NM) optional
*
- GOL-7: Goal Established Date/Time (DTM) optional
*
- GOL-8: Expected Goal Achieve Date/Time (DTM) optional
*
- GOL-9: Goal Classification (CWE) optional
*
- GOL-10: Goal Management Discipline (CWE) optional
*
- GOL-11: Current Goal Review Status (CWE) optional
*
- GOL-12: Current Goal Review Date/Time (DTM) optional
*
- GOL-13: Next Goal Review Date/Time (DTM) optional
*
- GOL-14: Previous Goal Review Date/Time (DTM) optional
*
- GOL-15: Goal Review Interval (NULLDT) optional
*
- GOL-16: Goal Evaluation (CWE) optional
*
- GOL-17: Goal Evaluation Comment (ST) optional repeating
*
- GOL-18: Goal Life Cycle Status (CWE) optional
*
- GOL-19: Goal Life Cycle Status Date/Time (DTM) optional
*
- GOL-20: Goal Target Type (CWE) optional repeating
*
- GOL-21: Goal Target Name (XPN) optional repeating
*
- GOL-22: Mood Code (CNE) optional
*
*/
@SuppressWarnings("unused")
public class GOL extends AbstractSegment {
/**
* Creates a new GOL segment
*/
public GOL(Group parent, ModelClassFactory factory) {
super(parent, factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(ID.class, true, 1, 0, new Object[]{ getMessage(), new Integer(206) }, "Action Code");
this.add(DTM.class, true, 1, 0, new Object[]{ getMessage() }, "Action Date/Time");
this.add(CWE.class, true, 1, 0, new Object[]{ getMessage() }, "Goal ID");
this.add(EI.class, true, 1, 0, new Object[]{ getMessage() }, "Goal Instance ID");
this.add(EI.class, false, 1, 0, new Object[]{ getMessage() }, "Episode of Care ID");
this.add(NM.class, false, 1, 0, new Object[]{ getMessage() }, "Goal List Priority");
this.add(DTM.class, false, 1, 0, new Object[]{ getMessage() }, "Goal Established Date/Time");
this.add(DTM.class, false, 1, 0, new Object[]{ getMessage() }, "Expected Goal Achieve Date/Time");
this.add(CWE.class, false, 1, 0, new Object[]{ getMessage() }, "Goal Classification");
this.add(CWE.class, false, 1, 0, new Object[]{ getMessage() }, "Goal Management Discipline");
this.add(CWE.class, false, 1, 0, new Object[]{ getMessage() }, "Current Goal Review Status");
this.add(DTM.class, false, 1, 0, new Object[]{ getMessage() }, "Current Goal Review Date/Time");
this.add(DTM.class, false, 1, 0, new Object[]{ getMessage() }, "Next Goal Review Date/Time");
this.add(DTM.class, false, 1, 0, new Object[]{ getMessage() }, "Previous Goal Review Date/Time");
this.add(NULLDT.class, false, 1, 0, new Object[]{ getMessage() }, "Goal Review Interval");
this.add(CWE.class, false, 1, 0, new Object[]{ getMessage() }, "Goal Evaluation");
this.add(ST.class, false, 0, 0, new Object[]{ getMessage() }, "Goal Evaluation Comment");
this.add(CWE.class, false, 1, 0, new Object[]{ getMessage() }, "Goal Life Cycle Status");
this.add(DTM.class, false, 1, 0, new Object[]{ getMessage() }, "Goal Life Cycle Status Date/Time");
this.add(CWE.class, false, 0, 0, new Object[]{ getMessage() }, "Goal Target Type");
this.add(XPN.class, false, 0, 0, new Object[]{ getMessage() }, "Goal Target Name");
this.add(CNE.class, false, 1, 0, new Object[]{ getMessage() }, "Mood Code");
} catch(HL7Exception e) {
log.error("Unexpected error creating GOL - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns
* GOL-1: "Action Code" - creates it if necessary
*/
public ID getActionCode() {
ID retVal = this.getTypedField(1, 0);
return retVal;
}
/**
* Returns
* GOL-1: "Action Code" - creates it if necessary
*/
public ID getGol1_ActionCode() {
ID retVal = this.getTypedField(1, 0);
return retVal;
}
/**
* Returns
* GOL-2: "Action Date/Time" - creates it if necessary
*/
public DTM getActionDateTime() {
DTM retVal = this.getTypedField(2, 0);
return retVal;
}
/**
* Returns
* GOL-2: "Action Date/Time" - creates it if necessary
*/
public DTM getGol2_ActionDateTime() {
DTM retVal = this.getTypedField(2, 0);
return retVal;
}
/**
* Returns
* GOL-3: "Goal ID" - creates it if necessary
*/
public CWE getGoalID() {
CWE retVal = this.getTypedField(3, 0);
return retVal;
}
/**
* Returns
* GOL-3: "Goal ID" - creates it if necessary
*/
public CWE getGol3_GoalID() {
CWE retVal = this.getTypedField(3, 0);
return retVal;
}
/**
* Returns
* GOL-4: "Goal Instance ID" - creates it if necessary
*/
public EI getGoalInstanceID() {
EI retVal = this.getTypedField(4, 0);
return retVal;
}
/**
* Returns
* GOL-4: "Goal Instance ID" - creates it if necessary
*/
public EI getGol4_GoalInstanceID() {
EI retVal = this.getTypedField(4, 0);
return retVal;
}
/**
* Returns
* GOL-5: "Episode of Care ID" - creates it if necessary
*/
public EI getEpisodeOfCareID() {
EI retVal = this.getTypedField(5, 0);
return retVal;
}
/**
* Returns
* GOL-5: "Episode of Care ID" - creates it if necessary
*/
public EI getGol5_EpisodeOfCareID() {
EI retVal = this.getTypedField(5, 0);
return retVal;
}
/**
* Returns
* GOL-6: "Goal List Priority" - creates it if necessary
*/
public NM getGoalListPriority() {
NM retVal = this.getTypedField(6, 0);
return retVal;
}
/**
* Returns
* GOL-6: "Goal List Priority" - creates it if necessary
*/
public NM getGol6_GoalListPriority() {
NM retVal = this.getTypedField(6, 0);
return retVal;
}
/**
* Returns
* GOL-7: "Goal Established Date/Time" - creates it if necessary
*/
public DTM getGoalEstablishedDateTime() {
DTM retVal = this.getTypedField(7, 0);
return retVal;
}
/**
* Returns
* GOL-7: "Goal Established Date/Time" - creates it if necessary
*/
public DTM getGol7_GoalEstablishedDateTime() {
DTM retVal = this.getTypedField(7, 0);
return retVal;
}
/**
* Returns
* GOL-8: "Expected Goal Achieve Date/Time" - creates it if necessary
*/
public DTM getExpectedGoalAchieveDateTime() {
DTM retVal = this.getTypedField(8, 0);
return retVal;
}
/**
* Returns
* GOL-8: "Expected Goal Achieve Date/Time" - creates it if necessary
*/
public DTM getGol8_ExpectedGoalAchieveDateTime() {
DTM retVal = this.getTypedField(8, 0);
return retVal;
}
/**
* Returns
* GOL-9: "Goal Classification" - creates it if necessary
*/
public CWE getGoalClassification() {
CWE retVal = this.getTypedField(9, 0);
return retVal;
}
/**
* Returns
* GOL-9: "Goal Classification" - creates it if necessary
*/
public CWE getGol9_GoalClassification() {
CWE retVal = this.getTypedField(9, 0);
return retVal;
}
/**
* Returns
* GOL-10: "Goal Management Discipline" - creates it if necessary
*/
public CWE getGoalManagementDiscipline() {
CWE retVal = this.getTypedField(10, 0);
return retVal;
}
/**
* Returns
* GOL-10: "Goal Management Discipline" - creates it if necessary
*/
public CWE getGol10_GoalManagementDiscipline() {
CWE retVal = this.getTypedField(10, 0);
return retVal;
}
/**
* Returns
* GOL-11: "Current Goal Review Status" - creates it if necessary
*/
public CWE getCurrentGoalReviewStatus() {
CWE retVal = this.getTypedField(11, 0);
return retVal;
}
/**
* Returns
* GOL-11: "Current Goal Review Status" - creates it if necessary
*/
public CWE getGol11_CurrentGoalReviewStatus() {
CWE retVal = this.getTypedField(11, 0);
return retVal;
}
/**
* Returns
* GOL-12: "Current Goal Review Date/Time" - creates it if necessary
*/
public DTM getCurrentGoalReviewDateTime() {
DTM retVal = this.getTypedField(12, 0);
return retVal;
}
/**
* Returns
* GOL-12: "Current Goal Review Date/Time" - creates it if necessary
*/
public DTM getGol12_CurrentGoalReviewDateTime() {
DTM retVal = this.getTypedField(12, 0);
return retVal;
}
/**
* Returns
* GOL-13: "Next Goal Review Date/Time" - creates it if necessary
*/
public DTM getNextGoalReviewDateTime() {
DTM retVal = this.getTypedField(13, 0);
return retVal;
}
/**
* Returns
* GOL-13: "Next Goal Review Date/Time" - creates it if necessary
*/
public DTM getGol13_NextGoalReviewDateTime() {
DTM retVal = this.getTypedField(13, 0);
return retVal;
}
/**
* Returns
* GOL-14: "Previous Goal Review Date/Time" - creates it if necessary
*/
public DTM getPreviousGoalReviewDateTime() {
DTM retVal = this.getTypedField(14, 0);
return retVal;
}
/**
* Returns
* GOL-14: "Previous Goal Review Date/Time" - creates it if necessary
*/
public DTM getGol14_PreviousGoalReviewDateTime() {
DTM retVal = this.getTypedField(14, 0);
return retVal;
}
/**
* Returns
* GOL-15: "Goal Review Interval" - creates it if necessary
*/
public NULLDT getGoalReviewInterval() {
NULLDT retVal = this.getTypedField(15, 0);
return retVal;
}
/**
* Returns
* GOL-15: "Goal Review Interval" - creates it if necessary
*/
public NULLDT getGol15_GoalReviewInterval() {
NULLDT retVal = this.getTypedField(15, 0);
return retVal;
}
/**
* Returns
* GOL-16: "Goal Evaluation" - creates it if necessary
*/
public CWE getGoalEvaluation() {
CWE retVal = this.getTypedField(16, 0);
return retVal;
}
/**
* Returns
* GOL-16: "Goal Evaluation" - creates it if necessary
*/
public CWE getGol16_GoalEvaluation() {
CWE retVal = this.getTypedField(16, 0);
return retVal;
}
/**
* Returns all repetitions of Goal Evaluation Comment (GOL-17).
*/
public ST[] getGoalEvaluationComment() {
ST[] retVal = this.getTypedField(17, new ST[0]);
return retVal;
}
/**
* Returns all repetitions of Goal Evaluation Comment (GOL-17).
*/
public ST[] getGol17_GoalEvaluationComment() {
ST[] retVal = this.getTypedField(17, new ST[0]);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Goal Evaluation Comment (GOL-17).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getGoalEvaluationCommentReps() {
return this.getReps(17);
}
/**
* Returns a specific repetition of
* GOL-17: "Goal Evaluation Comment" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public ST getGoalEvaluationComment(int rep) {
ST retVal = this.getTypedField(17, rep);
return retVal;
}
/**
* Returns a specific repetition of
* GOL-17: "Goal Evaluation Comment" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public ST getGol17_GoalEvaluationComment(int rep) {
ST retVal = this.getTypedField(17, rep);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Goal Evaluation Comment (GOL-17).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getGol17_GoalEvaluationCommentReps() {
return this.getReps(17);
}
/**
* Inserts a repetition of
* GOL-17: "Goal Evaluation Comment" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public ST insertGoalEvaluationComment(int rep) throws HL7Exception {
return (ST) super.insertRepetition(17, rep);
}
/**
* Inserts a repetition of
* GOL-17: "Goal Evaluation Comment" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public ST insertGol17_GoalEvaluationComment(int rep) throws HL7Exception {
return (ST) super.insertRepetition(17, rep);
}
/**
* Removes a repetition of
* GOL-17: "Goal Evaluation Comment" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public ST removeGoalEvaluationComment(int rep) throws HL7Exception {
return (ST) super.removeRepetition(17, rep);
}
/**
* Removes a repetition of
* GOL-17: "Goal Evaluation Comment" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public ST removeGol17_GoalEvaluationComment(int rep) throws HL7Exception {
return (ST) super.removeRepetition(17, rep);
}
/**
* Returns
* GOL-18: "Goal Life Cycle Status" - creates it if necessary
*/
public CWE getGoalLifeCycleStatus() {
CWE retVal = this.getTypedField(18, 0);
return retVal;
}
/**
* Returns
* GOL-18: "Goal Life Cycle Status" - creates it if necessary
*/
public CWE getGol18_GoalLifeCycleStatus() {
CWE retVal = this.getTypedField(18, 0);
return retVal;
}
/**
* Returns
* GOL-19: "Goal Life Cycle Status Date/Time" - creates it if necessary
*/
public DTM getGoalLifeCycleStatusDateTime() {
DTM retVal = this.getTypedField(19, 0);
return retVal;
}
/**
* Returns
* GOL-19: "Goal Life Cycle Status Date/Time" - creates it if necessary
*/
public DTM getGol19_GoalLifeCycleStatusDateTime() {
DTM retVal = this.getTypedField(19, 0);
return retVal;
}
/**
* Returns all repetitions of Goal Target Type (GOL-20).
*/
public CWE[] getGoalTargetType() {
CWE[] retVal = this.getTypedField(20, new CWE[0]);
return retVal;
}
/**
* Returns all repetitions of Goal Target Type (GOL-20).
*/
public CWE[] getGol20_GoalTargetType() {
CWE[] retVal = this.getTypedField(20, new CWE[0]);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Goal Target Type (GOL-20).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getGoalTargetTypeReps() {
return this.getReps(20);
}
/**
* Returns a specific repetition of
* GOL-20: "Goal Target Type" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public CWE getGoalTargetType(int rep) {
CWE retVal = this.getTypedField(20, rep);
return retVal;
}
/**
* Returns a specific repetition of
* GOL-20: "Goal Target Type" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public CWE getGol20_GoalTargetType(int rep) {
CWE retVal = this.getTypedField(20, rep);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Goal Target Type (GOL-20).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getGol20_GoalTargetTypeReps() {
return this.getReps(20);
}
/**
* Inserts a repetition of
* GOL-20: "Goal Target Type" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public CWE insertGoalTargetType(int rep) throws HL7Exception {
return (CWE) super.insertRepetition(20, rep);
}
/**
* Inserts a repetition of
* GOL-20: "Goal Target Type" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public CWE insertGol20_GoalTargetType(int rep) throws HL7Exception {
return (CWE) super.insertRepetition(20, rep);
}
/**
* Removes a repetition of
* GOL-20: "Goal Target Type" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public CWE removeGoalTargetType(int rep) throws HL7Exception {
return (CWE) super.removeRepetition(20, rep);
}
/**
* Removes a repetition of
* GOL-20: "Goal Target Type" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public CWE removeGol20_GoalTargetType(int rep) throws HL7Exception {
return (CWE) super.removeRepetition(20, rep);
}
/**
* Returns all repetitions of Goal Target Name (GOL-21).
*/
public XPN[] getGoalTargetName() {
XPN[] retVal = this.getTypedField(21, new XPN[0]);
return retVal;
}
/**
* Returns all repetitions of Goal Target Name (GOL-21).
*/
public XPN[] getGol21_GoalTargetName() {
XPN[] retVal = this.getTypedField(21, new XPN[0]);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Goal Target Name (GOL-21).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getGoalTargetNameReps() {
return this.getReps(21);
}
/**
* Returns a specific repetition of
* GOL-21: "Goal Target Name" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public XPN getGoalTargetName(int rep) {
XPN retVal = this.getTypedField(21, rep);
return retVal;
}
/**
* Returns a specific repetition of
* GOL-21: "Goal Target Name" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public XPN getGol21_GoalTargetName(int rep) {
XPN retVal = this.getTypedField(21, rep);
return retVal;
}
/**
* Returns a count of the current number of repetitions of Goal Target Name (GOL-21).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getGol21_GoalTargetNameReps() {
return this.getReps(21);
}
/**
* Inserts a repetition of
* GOL-21: "Goal Target Name" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public XPN insertGoalTargetName(int rep) throws HL7Exception {
return (XPN) super.insertRepetition(21, rep);
}
/**
* Inserts a repetition of
* GOL-21: "Goal Target Name" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public XPN insertGol21_GoalTargetName(int rep) throws HL7Exception {
return (XPN) super.insertRepetition(21, rep);
}
/**
* Removes a repetition of
* GOL-21: "Goal Target Name" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public XPN removeGoalTargetName(int rep) throws HL7Exception {
return (XPN) super.removeRepetition(21, rep);
}
/**
* Removes a repetition of
* GOL-21: "Goal Target Name" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public XPN removeGol21_GoalTargetName(int rep) throws HL7Exception {
return (XPN) super.removeRepetition(21, rep);
}
/**
* Returns
* GOL-22: "Mood Code" - creates it if necessary
*/
public CNE getMoodCode() {
CNE retVal = this.getTypedField(22, 0);
return retVal;
}
/**
* Returns
* GOL-22: "Mood Code" - creates it if necessary
*/
public CNE getGol22_MoodCode() {
CNE retVal = this.getTypedField(22, 0);
return retVal;
}
/** {@inheritDoc} */
protected Type createNewTypeWithoutReflection(int field) {
switch (field) {
case 0: return new ID(getMessage(), new Integer( 206 ));
case 1: return new DTM(getMessage());
case 2: return new CWE(getMessage());
case 3: return new EI(getMessage());
case 4: return new EI(getMessage());
case 5: return new NM(getMessage());
case 6: return new DTM(getMessage());
case 7: return new DTM(getMessage());
case 8: return new CWE(getMessage());
case 9: return new CWE(getMessage());
case 10: return new CWE(getMessage());
case 11: return new DTM(getMessage());
case 12: return new DTM(getMessage());
case 13: return new DTM(getMessage());
case 14: return new NULLDT(getMessage());
case 15: return new CWE(getMessage());
case 16: return new ST(getMessage());
case 17: return new CWE(getMessage());
case 18: return new DTM(getMessage());
case 19: return new CWE(getMessage());
case 20: return new XPN(getMessage());
case 21: return new CNE(getMessage());
default: return null;
}
}
}