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

Class IPC

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

Represents an HL7 IPC message segment (Imaging Procedure Control Segment). This segment has the following fields:

  • IPC-1: Accession Identifier (EI)
  • IPC-2: Requested Procedure ID (EI)
  • IPC-3: Study Instance UID (EI)
  • IPC-4: Scheduled Procedure Step ID (EI)
  • IPC-5: Modality (CE) optional
  • IPC-6: Protocol Code (CE) optional repeating
  • IPC-7: Scheduled Station Name (EI) optional
  • IPC-8: Scheduled Procedure Step Location (CE) optional repeating
  • IPC-9: Scheduled AE Title (ST) optional
See Also:

  • Constructor Details

  • Method Details

    • getAccessionIdentifier

      public EI getAccessionIdentifier()
      Returns IPC-1: "Accession Identifier" - creates it if necessary

    • getIpc1_AccessionIdentifier

      public EI getIpc1_AccessionIdentifier()
      Returns IPC-1: "Accession Identifier" - creates it if necessary

    • getRequestedProcedureID

      public EI getRequestedProcedureID()
      Returns IPC-2: "Requested Procedure ID" - creates it if necessary

    • getIpc2_RequestedProcedureID

      public EI getIpc2_RequestedProcedureID()
      Returns IPC-2: "Requested Procedure ID" - creates it if necessary

    • getStudyInstanceUID

      public EI getStudyInstanceUID()
      Returns IPC-3: "Study Instance UID" - creates it if necessary

    • getIpc3_StudyInstanceUID

      public EI getIpc3_StudyInstanceUID()
      Returns IPC-3: "Study Instance UID" - creates it if necessary

    • getScheduledProcedureStepID

      public EI getScheduledProcedureStepID()
      Returns IPC-4: "Scheduled Procedure Step ID" - creates it if necessary

    • getIpc4_ScheduledProcedureStepID

      public EI getIpc4_ScheduledProcedureStepID()
      Returns IPC-4: "Scheduled Procedure Step ID" - creates it if necessary

    • getModality

      public CE getModality()
      Returns IPC-5: "Modality" - creates it if necessary

    • getIpc5_Modality

      public CE getIpc5_Modality()
      Returns IPC-5: "Modality" - creates it if necessary

    • getProtocolCode

      public CE[] getProtocolCode()
      Returns all repetitions of Protocol Code (IPC-6).

    • getIpc6_ProtocolCode

      public CE[] getIpc6_ProtocolCode()
      Returns all repetitions of Protocol Code (IPC-6).

    • getProtocolCodeReps

      public int getProtocolCodeReps()
      Returns a count of the current number of repetitions of Protocol Code (IPC-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getProtocolCode

      public CE getProtocolCode(int rep)
      Returns a specific repetition of IPC-6: "Protocol Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIpc6_ProtocolCode

      public CE getIpc6_ProtocolCode(int rep)
      Returns a specific repetition of IPC-6: "Protocol Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIpc6_ProtocolCodeReps

      public int getIpc6_ProtocolCodeReps()
      Returns a count of the current number of repetitions of Protocol Code (IPC-6). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertProtocolCode

      public CE insertProtocolCode(int rep) throws HL7Exception
      Inserts a repetition of IPC-6: "Protocol Code" 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)

    • insertIpc6_ProtocolCode

      public CE insertIpc6_ProtocolCode(int rep) throws HL7Exception
      Inserts a repetition of IPC-6: "Protocol Code" 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)

    • removeProtocolCode

      public CE removeProtocolCode(int rep) throws HL7Exception
      Removes a repetition of IPC-6: "Protocol Code" 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)

    • removeIpc6_ProtocolCode

      public CE removeIpc6_ProtocolCode(int rep) throws HL7Exception
      Removes a repetition of IPC-6: "Protocol Code" 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)

    • getScheduledStationName

      public EI getScheduledStationName()
      Returns IPC-7: "Scheduled Station Name" - creates it if necessary

    • getIpc7_ScheduledStationName

      public EI getIpc7_ScheduledStationName()
      Returns IPC-7: "Scheduled Station Name" - creates it if necessary

    • getScheduledProcedureStepLocation

      public CE[] getScheduledProcedureStepLocation()
      Returns all repetitions of Scheduled Procedure Step Location (IPC-8).

    • getIpc8_ScheduledProcedureStepLocation

      public CE[] getIpc8_ScheduledProcedureStepLocation()
      Returns all repetitions of Scheduled Procedure Step Location (IPC-8).

    • getScheduledProcedureStepLocationReps

      public int getScheduledProcedureStepLocationReps()
      Returns a count of the current number of repetitions of Scheduled Procedure Step Location (IPC-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getScheduledProcedureStepLocation

      public CE getScheduledProcedureStepLocation(int rep)
      Returns a specific repetition of IPC-8: "Scheduled Procedure Step Location" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIpc8_ScheduledProcedureStepLocation

      public CE getIpc8_ScheduledProcedureStepLocation(int rep)
      Returns a specific repetition of IPC-8: "Scheduled Procedure Step Location" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getIpc8_ScheduledProcedureStepLocationReps

      public int getIpc8_ScheduledProcedureStepLocationReps()
      Returns a count of the current number of repetitions of Scheduled Procedure Step Location (IPC-8). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertScheduledProcedureStepLocation

      public CE insertScheduledProcedureStepLocation(int rep) throws HL7Exception
      Inserts a repetition of IPC-8: "Scheduled Procedure Step Location" 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)

    • insertIpc8_ScheduledProcedureStepLocation

      public CE insertIpc8_ScheduledProcedureStepLocation(int rep) throws HL7Exception
      Inserts a repetition of IPC-8: "Scheduled Procedure Step Location" 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)

    • removeScheduledProcedureStepLocation

      public CE removeScheduledProcedureStepLocation(int rep) throws HL7Exception
      Removes a repetition of IPC-8: "Scheduled Procedure Step Location" 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)

    • removeIpc8_ScheduledProcedureStepLocation

      public CE removeIpc8_ScheduledProcedureStepLocation(int rep) throws HL7Exception
      Removes a repetition of IPC-8: "Scheduled Procedure Step Location" 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)

    • getScheduledAETitle

      public ST getScheduledAETitle()
      Returns IPC-9: "Scheduled AE Title" - creates it if necessary

    • getIpc9_ScheduledAETitle

      public ST getIpc9_ScheduledAETitle()
      Returns IPC-9: "Scheduled AE Title" - creates it if necessary

    • createNewTypeWithoutReflection

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