Package ca.uhn.hl7v2.model.v251.segment

Class ECD

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

Represents an HL7 ECD message segment (Equipment Command). This segment has the following fields:

  • ECD-1: Reference Command Number (NM)
  • ECD-2: Remote Control Command (CE)
  • ECD-3: Response Required (ID) optional
  • ECD-4: Requested Completion Time (TQ) optional
  • ECD-5: Parameters (TX) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getReferenceCommandNumber

      public NM getReferenceCommandNumber()
      Returns ECD-1: "Reference Command Number" - creates it if necessary

    • getEcd1_ReferenceCommandNumber

      public NM getEcd1_ReferenceCommandNumber()
      Returns ECD-1: "Reference Command Number" - creates it if necessary

    • getRemoteControlCommand

      public CE getRemoteControlCommand()
      Returns ECD-2: "Remote Control Command" - creates it if necessary

    • getEcd2_RemoteControlCommand

      public CE getEcd2_RemoteControlCommand()
      Returns ECD-2: "Remote Control Command" - creates it if necessary

    • getResponseRequired

      public ID getResponseRequired()
      Returns ECD-3: "Response Required" - creates it if necessary

    • getEcd3_ResponseRequired

      public ID getEcd3_ResponseRequired()
      Returns ECD-3: "Response Required" - creates it if necessary

    • getRequestedCompletionTime

      public TQ getRequestedCompletionTime()
      Returns ECD-4: "Requested Completion Time" - creates it if necessary

    • getEcd4_RequestedCompletionTime

      public TQ getEcd4_RequestedCompletionTime()
      Returns ECD-4: "Requested Completion Time" - creates it if necessary

    • getParameters

      public TX[] getParameters()
      Returns all repetitions of Parameters (ECD-5).

    • getEcd5_Parameters

      public TX[] getEcd5_Parameters()
      Returns all repetitions of Parameters (ECD-5).

    • getParametersReps

      public int getParametersReps()
      Returns a count of the current number of repetitions of Parameters (ECD-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getParameters

      public TX getParameters(int rep)
      Returns a specific repetition of ECD-5: "Parameters" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getEcd5_Parameters

      public TX getEcd5_Parameters(int rep)
      Returns a specific repetition of ECD-5: "Parameters" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getEcd5_ParametersReps

      public int getEcd5_ParametersReps()
      Returns a count of the current number of repetitions of Parameters (ECD-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertParameters

      public TX insertParameters(int rep) throws HL7Exception
      Inserts a repetition of ECD-5: "Parameters" 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)

    • insertEcd5_Parameters

      public TX insertEcd5_Parameters(int rep) throws HL7Exception
      Inserts a repetition of ECD-5: "Parameters" 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)

    • removeParameters

      public TX removeParameters(int rep) throws HL7Exception
      Removes a repetition of ECD-5: "Parameters" 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)

    • removeEcd5_Parameters

      public TX removeEcd5_Parameters(int rep) throws HL7Exception
      Removes a repetition of ECD-5: "Parameters" 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