Package ca.uhn.hl7v2.model.v24.segment

Class ECR

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

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

  • ECR-1: Command Response (CE)
  • ECR-2: Date/Time Completed (TS)
  • ECR-3: Command Response Parameters (ST) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • getCommandResponse

      public CE getCommandResponse()
      Returns ECR-1: "Command Response" - creates it if necessary

    • getEcr1_CommandResponse

      public CE getEcr1_CommandResponse()
      Returns ECR-1: "Command Response" - creates it if necessary

    • getDateTimeCompleted

      public TS getDateTimeCompleted()
      Returns ECR-2: "Date/Time Completed" - creates it if necessary

    • getEcr2_DateTimeCompleted

      public TS getEcr2_DateTimeCompleted()
      Returns ECR-2: "Date/Time Completed" - creates it if necessary

    • getCommandResponseParameters

      public ST[] getCommandResponseParameters()
      Returns all repetitions of Command Response Parameters (ECR-3).

    • getEcr3_CommandResponseParameters

      public ST[] getEcr3_CommandResponseParameters()
      Returns all repetitions of Command Response Parameters (ECR-3).

    • getCommandResponseParametersReps

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

    • getCommandResponseParameters

      public ST getCommandResponseParameters(int rep)
      Returns a specific repetition of ECR-3: "Command Response Parameters" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getEcr3_CommandResponseParameters

      public ST getEcr3_CommandResponseParameters(int rep)
      Returns a specific repetition of ECR-3: "Command Response Parameters" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getEcr3_CommandResponseParametersReps

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

    • insertCommandResponseParameters

      public ST insertCommandResponseParameters(int rep) throws HL7Exception
      Inserts a repetition of ECR-3: "Command Response 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)

    • insertEcr3_CommandResponseParameters

      public ST insertEcr3_CommandResponseParameters(int rep) throws HL7Exception
      Inserts a repetition of ECR-3: "Command Response 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)

    • removeCommandResponseParameters

      public ST removeCommandResponseParameters(int rep) throws HL7Exception
      Removes a repetition of ECR-3: "Command Response 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)

    • removeEcr3_CommandResponseParameters

      public ST removeEcr3_CommandResponseParameters(int rep) throws HL7Exception
      Removes a repetition of ECR-3: "Command Response 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