Package ca.uhn.hl7v2.model.v23.segment

Class GOL

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v23.segment.GOL
All Implemented Interfaces:
Segment, Structure, Visitable, Serializable
public class GOL extends AbstractSegment

Represents an HL7 GOL message segment (Goal Detail). This segment has the following fields:

  • GOL-1: Action Code (ID)
  • GOL-2: Action Date/Time (TS)
  • GOL-3: Goal ID (CE)
  • 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 (TS) optional
  • GOL-8: Expected Goal Achievement Date/Time (TS) optional
  • GOL-9: Goal Classification (CE) optional
  • GOL-10: Goal Management Discipline (CE) optional
  • GOL-11: Current Goal Review Status (CE) optional
  • GOL-12: Current Goal Review Date/Time (TS) optional
  • GOL-13: Next Goal Review Date/Time (TS) optional
  • GOL-14: Previous Goal Review Date/Time (TS) optional
  • GOL-15: Goal Review Interval (TQ) optional
  • GOL-16: Goal Evaluation (CE) optional
  • GOL-17: Goal Evaluation Comment (ST) optional repeating
  • GOL-18: Goal Life Cycle Status (CE) optional
  • GOL-19: Goal Life Cycle Status Date/Time (TS) optional
  • GOL-20: Goal Target Type (CE) optional repeating
  • GOL-21: Goal Target Name (XPN) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getActionCode

      public ID getActionCode()
      Returns GOL-1: "Action Code" - creates it if necessary

    • getGol1_ActionCode

      public ID getGol1_ActionCode()
      Returns GOL-1: "Action Code" - creates it if necessary

    • getActionDateTime

      public TS getActionDateTime()
      Returns GOL-2: "Action Date/Time" - creates it if necessary

    • getGol2_ActionDateTime

      public TS getGol2_ActionDateTime()
      Returns GOL-2: "Action Date/Time" - creates it if necessary

    • getGoalID

      public CE getGoalID()
      Returns GOL-3: "Goal ID" - creates it if necessary

    • getGol3_GoalID

      public CE getGol3_GoalID()
      Returns GOL-3: "Goal ID" - creates it if necessary

    • getGoalInstanceID

      public EI getGoalInstanceID()
      Returns GOL-4: "Goal Instance ID" - creates it if necessary

    • getGol4_GoalInstanceID

      public EI getGol4_GoalInstanceID()
      Returns GOL-4: "Goal Instance ID" - creates it if necessary

    • getEpisodeOfCareID

      public EI getEpisodeOfCareID()
      Returns GOL-5: "Episode of Care ID" - creates it if necessary

    • getGol5_EpisodeOfCareID

      public EI getGol5_EpisodeOfCareID()
      Returns GOL-5: "Episode of Care ID" - creates it if necessary

    • getGoalListPriority

      public NM getGoalListPriority()
      Returns GOL-6: "Goal List Priority" - creates it if necessary

    • getGol6_GoalListPriority

      public NM getGol6_GoalListPriority()
      Returns GOL-6: "Goal List Priority" - creates it if necessary

    • getGoalEstablishedDateTime

      public TS getGoalEstablishedDateTime()
      Returns GOL-7: "Goal Established Date/Time" - creates it if necessary

    • getGol7_GoalEstablishedDateTime

      public TS getGol7_GoalEstablishedDateTime()
      Returns GOL-7: "Goal Established Date/Time" - creates it if necessary

    • getExpectedGoalAchievementDateTime

      public TS getExpectedGoalAchievementDateTime()
      Returns GOL-8: "Expected Goal Achievement Date/Time" - creates it if necessary

    • getGol8_ExpectedGoalAchievementDateTime

      public TS getGol8_ExpectedGoalAchievementDateTime()
      Returns GOL-8: "Expected Goal Achievement Date/Time" - creates it if necessary

    • getGoalClassification

      public CE getGoalClassification()
      Returns GOL-9: "Goal Classification" - creates it if necessary

    • getGol9_GoalClassification

      public CE getGol9_GoalClassification()
      Returns GOL-9: "Goal Classification" - creates it if necessary

    • getGoalManagementDiscipline

      public CE getGoalManagementDiscipline()
      Returns GOL-10: "Goal Management Discipline" - creates it if necessary

    • getGol10_GoalManagementDiscipline

      public CE getGol10_GoalManagementDiscipline()
      Returns GOL-10: "Goal Management Discipline" - creates it if necessary

    • getCurrentGoalReviewStatus

      public CE getCurrentGoalReviewStatus()
      Returns GOL-11: "Current Goal Review Status" - creates it if necessary

    • getGol11_CurrentGoalReviewStatus

      public CE getGol11_CurrentGoalReviewStatus()
      Returns GOL-11: "Current Goal Review Status" - creates it if necessary

    • getCurrentGoalReviewDateTime

      public TS getCurrentGoalReviewDateTime()
      Returns GOL-12: "Current Goal Review Date/Time" - creates it if necessary

    • getGol12_CurrentGoalReviewDateTime

      public TS getGol12_CurrentGoalReviewDateTime()
      Returns GOL-12: "Current Goal Review Date/Time" - creates it if necessary

    • getNextGoalReviewDateTime

      public TS getNextGoalReviewDateTime()
      Returns GOL-13: "Next Goal Review Date/Time" - creates it if necessary

    • getGol13_NextGoalReviewDateTime

      public TS getGol13_NextGoalReviewDateTime()
      Returns GOL-13: "Next Goal Review Date/Time" - creates it if necessary

    • getPreviousGoalReviewDateTime

      public TS getPreviousGoalReviewDateTime()
      Returns GOL-14: "Previous Goal Review Date/Time" - creates it if necessary

    • getGol14_PreviousGoalReviewDateTime

      public TS getGol14_PreviousGoalReviewDateTime()
      Returns GOL-14: "Previous Goal Review Date/Time" - creates it if necessary

    • getGoalReviewInterval

      public TQ getGoalReviewInterval()
      Returns GOL-15: "Goal Review Interval" - creates it if necessary

    • getGol15_GoalReviewInterval

      public TQ getGol15_GoalReviewInterval()
      Returns GOL-15: "Goal Review Interval" - creates it if necessary

    • getGoalEvaluation

      public CE getGoalEvaluation()
      Returns GOL-16: "Goal Evaluation" - creates it if necessary

    • getGol16_GoalEvaluation

      public CE getGol16_GoalEvaluation()
      Returns GOL-16: "Goal Evaluation" - creates it if necessary

    • getGoalEvaluationComment

      public ST[] getGoalEvaluationComment()
      Returns all repetitions of Goal Evaluation Comment (GOL-17).

    • getGol17_GoalEvaluationComment

      public ST[] getGol17_GoalEvaluationComment()
      Returns all repetitions of Goal Evaluation Comment (GOL-17).

    • getGoalEvaluationCommentReps

      public int getGoalEvaluationCommentReps()
      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.

    • getGoalEvaluationComment

      public ST getGoalEvaluationComment(int rep)
      Returns a specific repetition of GOL-17: "Goal Evaluation Comment" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getGol17_GoalEvaluationComment

      public ST getGol17_GoalEvaluationComment(int rep)
      Returns a specific repetition of GOL-17: "Goal Evaluation Comment" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getGol17_GoalEvaluationCommentReps

      public int getGol17_GoalEvaluationCommentReps()
      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.

    • insertGoalEvaluationComment

      public ST insertGoalEvaluationComment(int rep) throws HL7Exception
      Inserts a repetition of GOL-17: "Goal Evaluation Comment" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertGol17_GoalEvaluationComment

      public ST insertGol17_GoalEvaluationComment(int rep) throws HL7Exception
      Inserts a repetition of GOL-17: "Goal Evaluation Comment" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeGoalEvaluationComment

      public ST removeGoalEvaluationComment(int rep) throws HL7Exception
      Removes a repetition of GOL-17: "Goal Evaluation Comment" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeGol17_GoalEvaluationComment

      public ST removeGol17_GoalEvaluationComment(int rep) throws HL7Exception
      Removes a repetition of GOL-17: "Goal Evaluation Comment" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • getGoalLifeCycleStatus

      public CE getGoalLifeCycleStatus()
      Returns GOL-18: "Goal Life Cycle Status" - creates it if necessary

    • getGol18_GoalLifeCycleStatus

      public CE getGol18_GoalLifeCycleStatus()
      Returns GOL-18: "Goal Life Cycle Status" - creates it if necessary

    • getGoalLifeCycleStatusDateTime

      public TS getGoalLifeCycleStatusDateTime()
      Returns GOL-19: "Goal Life Cycle Status Date/Time" - creates it if necessary

    • getGol19_GoalLifeCycleStatusDateTime

      public TS getGol19_GoalLifeCycleStatusDateTime()
      Returns GOL-19: "Goal Life Cycle Status Date/Time" - creates it if necessary

    • getGoalTargetType

      public CE[] getGoalTargetType()
      Returns all repetitions of Goal Target Type (GOL-20).

    • getGol20_GoalTargetType

      public CE[] getGol20_GoalTargetType()
      Returns all repetitions of Goal Target Type (GOL-20).

    • getGoalTargetTypeReps

      public int getGoalTargetTypeReps()
      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.

    • getGoalTargetType

      public CE getGoalTargetType(int rep)
      Returns a specific repetition of GOL-20: "Goal Target Type" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getGol20_GoalTargetType

      public CE getGol20_GoalTargetType(int rep)
      Returns a specific repetition of GOL-20: "Goal Target Type" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getGol20_GoalTargetTypeReps

      public int getGol20_GoalTargetTypeReps()
      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.

    • insertGoalTargetType

      public CE insertGoalTargetType(int rep) throws HL7Exception
      Inserts a repetition of GOL-20: "Goal Target Type" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertGol20_GoalTargetType

      public CE insertGol20_GoalTargetType(int rep) throws HL7Exception
      Inserts a repetition of GOL-20: "Goal Target Type" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeGoalTargetType

      public CE removeGoalTargetType(int rep) throws HL7Exception
      Removes a repetition of GOL-20: "Goal Target Type" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeGol20_GoalTargetType

      public CE removeGol20_GoalTargetType(int rep) throws HL7Exception
      Removes a repetition of GOL-20: "Goal Target Type" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • getGoalTargetName

      public XPN[] getGoalTargetName()
      Returns all repetitions of Goal Target Name (GOL-21).

    • getGol21_GoalTargetName

      public XPN[] getGol21_GoalTargetName()
      Returns all repetitions of Goal Target Name (GOL-21).

    • getGoalTargetNameReps

      public int getGoalTargetNameReps()
      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.

    • getGoalTargetName

      public XPN getGoalTargetName(int rep)
      Returns a specific repetition of GOL-21: "Goal Target Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getGol21_GoalTargetName

      public XPN getGol21_GoalTargetName(int rep)
      Returns a specific repetition of GOL-21: "Goal Target Name" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getGol21_GoalTargetNameReps

      public int getGol21_GoalTargetNameReps()
      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.

    • insertGoalTargetName

      public XPN insertGoalTargetName(int rep) throws HL7Exception
      Inserts a repetition of GOL-21: "Goal Target Name" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • insertGol21_GoalTargetName

      public XPN insertGol21_GoalTargetName(int rep) throws HL7Exception
      Inserts a repetition of GOL-21: "Goal Target Name" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeGoalTargetName

      public XPN removeGoalTargetName(int rep) throws HL7Exception
      Removes a repetition of GOL-21: "Goal Target Name" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • removeGol21_GoalTargetName

      public XPN removeGol21_GoalTargetName(int rep) throws HL7Exception
      Removes a repetition of GOL-21: "Goal Target Name" at a specific index
      Parameters:
      rep - The repetition index (0-indexed)
      Throws:
      HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

    • createNewTypeWithoutReflection

      protected Type createNewTypeWithoutReflection(int field)
      Overrides:
      createNewTypeWithoutReflection in class AbstractSegment