Class SAC

All Implemented Interfaces:
Segment, Structure, Visitable, Serializable

public class SAC extends AbstractSegment

Represents an HL7 SAC message segment (Specimen Container detail). This segment has the following fields:

  • SAC-1: External Accession Identifier (EI) optional
  • SAC-2: Accession Identifier (EI) optional
  • SAC-3: Container Identifier (EI) optional
  • SAC-4: Primary (parent) Container Identifier (EI) optional
  • SAC-5: Equipment Container Identifier (EI) optional
  • SAC-6: Specimen Source (SPS) optional
  • SAC-7: Registration Date/Time (TS) optional
  • SAC-8: Container Status (CE) optional
  • SAC-9: Carrier Type (CE) optional
  • SAC-10: Carrier Identifier (EI) optional
  • SAC-11: Position in Carrier (NA) optional
  • SAC-12: Tray Type - SAC (CE) optional
  • SAC-13: Tray Identifier (EI) optional
  • SAC-14: Position in Tray (NA) optional
  • SAC-15: Location (CE) optional repeating
  • SAC-16: Container Height (NM) optional
  • SAC-17: Container Diameter (NM) optional
  • SAC-18: Barrier Delta (NM) optional
  • SAC-19: Bottom Delta (NM) optional
  • SAC-20: Container Height/Diameter/Delta Units (CE) optional
  • SAC-21: Container Volume (NM) optional
  • SAC-22: Available Specimen Volume (NM) optional
  • SAC-23: Initial Specimen Volume (NM) optional
  • SAC-24: Volume Units (CE) optional
  • SAC-25: Separator Type (CE) optional
  • SAC-26: Cap Type (CE) optional
  • SAC-27: Additive (CWE) optional repeating
  • SAC-28: Specimen Component (CE) optional
  • SAC-29: Dilution Factor (SN) optional
  • SAC-30: Treatment (CE) optional
  • SAC-31: Temperature (SN) optional
  • SAC-32: Hemolysis Index (NM) optional
  • SAC-33: Hemolysis Index Units (CE) optional
  • SAC-34: Lipemia Index (NM) optional
  • SAC-35: Lipemia Index Units (CE) optional
  • SAC-36: Icterus Index (NM) optional
  • SAC-37: Icterus Index Units (CE) optional
  • SAC-38: Fibrin Index (NM) optional
  • SAC-39: Fibrin Index Units (CE) optional
  • SAC-40: System Induced Contaminants (CE) optional repeating
  • SAC-41: Drug Interference (CE) optional repeating
  • SAC-42: Artificial Blood (CE) optional
  • SAC-43: Special Handling Code (CWE) optional repeating
  • SAC-44: Other Environmental Factors (CE) optional repeating
See Also:
  • Constructor Details

  • Method Details

    • getExternalAccessionIdentifier

      Returns SAC-1: "External Accession Identifier" - creates it if necessary
    • getSac1_ExternalAccessionIdentifier

      Returns SAC-1: "External Accession Identifier" - creates it if necessary
    • getAccessionIdentifier

      Returns SAC-2: "Accession Identifier" - creates it if necessary
    • getSac2_AccessionIdentifier

      Returns SAC-2: "Accession Identifier" - creates it if necessary
    • getContainerIdentifier

      Returns SAC-3: "Container Identifier" - creates it if necessary
    • getSac3_ContainerIdentifier

      Returns SAC-3: "Container Identifier" - creates it if necessary
    • getPrimaryParentContainerIdentifier

      Returns SAC-4: "Primary (parent) Container Identifier" - creates it if necessary
    • getSac4_PrimaryParentContainerIdentifier

      Returns SAC-4: "Primary (parent) Container Identifier" - creates it if necessary
    • getEquipmentContainerIdentifier

      Returns SAC-5: "Equipment Container Identifier" - creates it if necessary
    • getSac5_EquipmentContainerIdentifier

      Returns SAC-5: "Equipment Container Identifier" - creates it if necessary
    • getSpecimenSource

      Returns SAC-6: "Specimen Source" - creates it if necessary
    • getSac6_SpecimenSource

      Returns SAC-6: "Specimen Source" - creates it if necessary
    • getRegistrationDateTime

      Returns SAC-7: "Registration Date/Time" - creates it if necessary
    • getSac7_RegistrationDateTime

      Returns SAC-7: "Registration Date/Time" - creates it if necessary
    • getContainerStatus

      Returns SAC-8: "Container Status" - creates it if necessary
    • getSac8_ContainerStatus

      Returns SAC-8: "Container Status" - creates it if necessary
    • getCarrierType

      public CE getCarrierType()
      Returns SAC-9: "Carrier Type" - creates it if necessary
    • getSac9_CarrierType

      Returns SAC-9: "Carrier Type" - creates it if necessary
    • getCarrierIdentifier

      Returns SAC-10: "Carrier Identifier" - creates it if necessary
    • getSac10_CarrierIdentifier

      Returns SAC-10: "Carrier Identifier" - creates it if necessary
    • getPositionInCarrier

      Returns SAC-11: "Position in Carrier" - creates it if necessary
    • getSac11_PositionInCarrier

      Returns SAC-11: "Position in Carrier" - creates it if necessary
    • getTrayTypeSAC

      public CE getTrayTypeSAC()
      Returns SAC-12: "Tray Type - SAC" - creates it if necessary
    • getSac12_TrayTypeSAC

      Returns SAC-12: "Tray Type - SAC" - creates it if necessary
    • getTrayIdentifier

      Returns SAC-13: "Tray Identifier" - creates it if necessary
    • getSac13_TrayIdentifier

      Returns SAC-13: "Tray Identifier" - creates it if necessary
    • getPositionInTray

      Returns SAC-14: "Position in Tray" - creates it if necessary
    • getSac14_PositionInTray

      Returns SAC-14: "Position in Tray" - creates it if necessary
    • getLocation

      public CE[] getLocation()
      Returns all repetitions of Location (SAC-15).
    • getSac15_Location

      public CE[] getSac15_Location()
      Returns all repetitions of Location (SAC-15).
    • getLocationReps

      public int getLocationReps()
      Returns a count of the current number of repetitions of Location (SAC-15). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getLocation

      public CE getLocation(int rep)
      Returns a specific repetition of SAC-15: "Location" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getSac15_Location

      public CE getSac15_Location(int rep)
      Returns a specific repetition of SAC-15: "Location" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getSac15_LocationReps

      public int getSac15_LocationReps()
      Returns a count of the current number of repetitions of Location (SAC-15). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertLocation

      public CE insertLocation(int rep) throws HL7Exception
      Inserts a repetition of SAC-15: "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)
    • insertSac15_Location

      public CE insertSac15_Location(int rep) throws HL7Exception
      Inserts a repetition of SAC-15: "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)
    • removeLocation

      public CE removeLocation(int rep) throws HL7Exception
      Removes a repetition of SAC-15: "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)
    • removeSac15_Location

      public CE removeSac15_Location(int rep) throws HL7Exception
      Removes a repetition of SAC-15: "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)
    • getContainerHeight

      Returns SAC-16: "Container Height" - creates it if necessary
    • getSac16_ContainerHeight

      Returns SAC-16: "Container Height" - creates it if necessary
    • getContainerDiameter

      Returns SAC-17: "Container Diameter" - creates it if necessary
    • getSac17_ContainerDiameter

      Returns SAC-17: "Container Diameter" - creates it if necessary
    • getBarrierDelta

      public NM getBarrierDelta()
      Returns SAC-18: "Barrier Delta" - creates it if necessary
    • getSac18_BarrierDelta

      Returns SAC-18: "Barrier Delta" - creates it if necessary
    • getBottomDelta

      public NM getBottomDelta()
      Returns SAC-19: "Bottom Delta" - creates it if necessary
    • getSac19_BottomDelta

      Returns SAC-19: "Bottom Delta" - creates it if necessary
    • getContainerHeightDiameterDeltaUnits

      Returns SAC-20: "Container Height/Diameter/Delta Units" - creates it if necessary
    • getSac20_ContainerHeightDiameterDeltaUnits

      Returns SAC-20: "Container Height/Diameter/Delta Units" - creates it if necessary
    • getContainerVolume

      Returns SAC-21: "Container Volume" - creates it if necessary
    • getSac21_ContainerVolume

      Returns SAC-21: "Container Volume" - creates it if necessary
    • getAvailableSpecimenVolume

      Returns SAC-22: "Available Specimen Volume" - creates it if necessary
    • getSac22_AvailableSpecimenVolume

      Returns SAC-22: "Available Specimen Volume" - creates it if necessary
    • getInitialSpecimenVolume

      Returns SAC-23: "Initial Specimen Volume" - creates it if necessary
    • getSac23_InitialSpecimenVolume

      Returns SAC-23: "Initial Specimen Volume" - creates it if necessary
    • getVolumeUnits

      public CE getVolumeUnits()
      Returns SAC-24: "Volume Units" - creates it if necessary
    • getSac24_VolumeUnits

      Returns SAC-24: "Volume Units" - creates it if necessary
    • getSeparatorType

      public CE getSeparatorType()
      Returns SAC-25: "Separator Type" - creates it if necessary
    • getSac25_SeparatorType

      Returns SAC-25: "Separator Type" - creates it if necessary
    • getCapType

      public CE getCapType()
      Returns SAC-26: "Cap Type" - creates it if necessary
    • getSac26_CapType

      public CE getSac26_CapType()
      Returns SAC-26: "Cap Type" - creates it if necessary
    • getAdditive

      public CWE[] getAdditive()
      Returns all repetitions of Additive (SAC-27).
    • getSac27_Additive

      public CWE[] getSac27_Additive()
      Returns all repetitions of Additive (SAC-27).
    • getAdditiveReps

      public int getAdditiveReps()
      Returns a count of the current number of repetitions of Additive (SAC-27). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getAdditive

      public CWE getAdditive(int rep)
      Returns a specific repetition of SAC-27: "Additive" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getSac27_Additive

      public CWE getSac27_Additive(int rep)
      Returns a specific repetition of SAC-27: "Additive" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getSac27_AdditiveReps

      public int getSac27_AdditiveReps()
      Returns a count of the current number of repetitions of Additive (SAC-27). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertAdditive

      public CWE insertAdditive(int rep) throws HL7Exception
      Inserts a repetition of SAC-27: "Additive" 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)
    • insertSac27_Additive

      public CWE insertSac27_Additive(int rep) throws HL7Exception
      Inserts a repetition of SAC-27: "Additive" 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)
    • removeAdditive

      public CWE removeAdditive(int rep) throws HL7Exception
      Removes a repetition of SAC-27: "Additive" 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)
    • removeSac27_Additive

      public CWE removeSac27_Additive(int rep) throws HL7Exception
      Removes a repetition of SAC-27: "Additive" 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)
    • getSpecimenComponent

      Returns SAC-28: "Specimen Component" - creates it if necessary
    • getSac28_SpecimenComponent

      Returns SAC-28: "Specimen Component" - creates it if necessary
    • getDilutionFactor

      Returns SAC-29: "Dilution Factor" - creates it if necessary
    • getSac29_DilutionFactor

      Returns SAC-29: "Dilution Factor" - creates it if necessary
    • getTreatment

      public CE getTreatment()
      Returns SAC-30: "Treatment" - creates it if necessary
    • getSac30_Treatment

      Returns SAC-30: "Treatment" - creates it if necessary
    • getTemperature

      public SN getTemperature()
      Returns SAC-31: "Temperature" - creates it if necessary
    • getSac31_Temperature

      Returns SAC-31: "Temperature" - creates it if necessary
    • getHemolysisIndex

      Returns SAC-32: "Hemolysis Index" - creates it if necessary
    • getSac32_HemolysisIndex

      Returns SAC-32: "Hemolysis Index" - creates it if necessary
    • getHemolysisIndexUnits

      Returns SAC-33: "Hemolysis Index Units" - creates it if necessary
    • getSac33_HemolysisIndexUnits

      Returns SAC-33: "Hemolysis Index Units" - creates it if necessary
    • getLipemiaIndex

      public NM getLipemiaIndex()
      Returns SAC-34: "Lipemia Index" - creates it if necessary
    • getSac34_LipemiaIndex

      Returns SAC-34: "Lipemia Index" - creates it if necessary
    • getLipemiaIndexUnits

      Returns SAC-35: "Lipemia Index Units" - creates it if necessary
    • getSac35_LipemiaIndexUnits

      Returns SAC-35: "Lipemia Index Units" - creates it if necessary
    • getIcterusIndex

      public NM getIcterusIndex()
      Returns SAC-36: "Icterus Index" - creates it if necessary
    • getSac36_IcterusIndex

      Returns SAC-36: "Icterus Index" - creates it if necessary
    • getIcterusIndexUnits

      Returns SAC-37: "Icterus Index Units" - creates it if necessary
    • getSac37_IcterusIndexUnits

      Returns SAC-37: "Icterus Index Units" - creates it if necessary
    • getFibrinIndex

      public NM getFibrinIndex()
      Returns SAC-38: "Fibrin Index" - creates it if necessary
    • getSac38_FibrinIndex

      Returns SAC-38: "Fibrin Index" - creates it if necessary
    • getFibrinIndexUnits

      Returns SAC-39: "Fibrin Index Units" - creates it if necessary
    • getSac39_FibrinIndexUnits

      Returns SAC-39: "Fibrin Index Units" - creates it if necessary
    • getSystemInducedContaminants

      Returns all repetitions of System Induced Contaminants (SAC-40).
    • getSac40_SystemInducedContaminants

      Returns all repetitions of System Induced Contaminants (SAC-40).
    • getSystemInducedContaminantsReps

      Returns a count of the current number of repetitions of System Induced Contaminants (SAC-40). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getSystemInducedContaminants

      public CE getSystemInducedContaminants(int rep)
      Returns a specific repetition of SAC-40: "System Induced Contaminants" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getSac40_SystemInducedContaminants

      Returns a specific repetition of SAC-40: "System Induced Contaminants" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getSac40_SystemInducedContaminantsReps

      Returns a count of the current number of repetitions of System Induced Contaminants (SAC-40). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertSystemInducedContaminants

      Inserts a repetition of SAC-40: "System Induced Contaminants" 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)
    • insertSac40_SystemInducedContaminants

      Inserts a repetition of SAC-40: "System Induced Contaminants" 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)
    • removeSystemInducedContaminants

      Removes a repetition of SAC-40: "System Induced Contaminants" 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)
    • removeSac40_SystemInducedContaminants

      Removes a repetition of SAC-40: "System Induced Contaminants" 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)
    • getDrugInterference

      public CE[] getDrugInterference()
      Returns all repetitions of Drug Interference (SAC-41).
    • getSac41_DrugInterference

      Returns all repetitions of Drug Interference (SAC-41).
    • getDrugInterferenceReps

      Returns a count of the current number of repetitions of Drug Interference (SAC-41). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getDrugInterference

      public CE getDrugInterference(int rep)
      Returns a specific repetition of SAC-41: "Drug Interference" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getSac41_DrugInterference

      public CE getSac41_DrugInterference(int rep)
      Returns a specific repetition of SAC-41: "Drug Interference" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getSac41_DrugInterferenceReps

      Returns a count of the current number of repetitions of Drug Interference (SAC-41). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertDrugInterference

      public CE insertDrugInterference(int rep) throws HL7Exception
      Inserts a repetition of SAC-41: "Drug Interference" 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)
    • insertSac41_DrugInterference

      public CE insertSac41_DrugInterference(int rep) throws HL7Exception
      Inserts a repetition of SAC-41: "Drug Interference" 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)
    • removeDrugInterference

      public CE removeDrugInterference(int rep) throws HL7Exception
      Removes a repetition of SAC-41: "Drug Interference" 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)
    • removeSac41_DrugInterference

      public CE removeSac41_DrugInterference(int rep) throws HL7Exception
      Removes a repetition of SAC-41: "Drug Interference" 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)
    • getArtificialBlood

      Returns SAC-42: "Artificial Blood" - creates it if necessary
    • getSac42_ArtificialBlood

      Returns SAC-42: "Artificial Blood" - creates it if necessary
    • getSpecialHandlingCode

      Returns all repetitions of Special Handling Code (SAC-43).
    • getSac43_SpecialHandlingCode

      Returns all repetitions of Special Handling Code (SAC-43).
    • getSpecialHandlingCodeReps

      Returns a count of the current number of repetitions of Special Handling Code (SAC-43). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getSpecialHandlingCode

      public CWE getSpecialHandlingCode(int rep)
      Returns a specific repetition of SAC-43: "Special Handling Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getSac43_SpecialHandlingCode

      Returns a specific repetition of SAC-43: "Special Handling Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getSac43_SpecialHandlingCodeReps

      Returns a count of the current number of repetitions of Special Handling Code (SAC-43). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertSpecialHandlingCode

      public CWE insertSpecialHandlingCode(int rep) throws HL7Exception
      Inserts a repetition of SAC-43: "Special Handling 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)
    • insertSac43_SpecialHandlingCode

      Inserts a repetition of SAC-43: "Special Handling 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)
    • removeSpecialHandlingCode

      public CWE removeSpecialHandlingCode(int rep) throws HL7Exception
      Removes a repetition of SAC-43: "Special Handling 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)
    • removeSac43_SpecialHandlingCode

      Removes a repetition of SAC-43: "Special Handling 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)
    • getOtherEnvironmentalFactors

      Returns all repetitions of Other Environmental Factors (SAC-44).
    • getSac44_OtherEnvironmentalFactors

      Returns all repetitions of Other Environmental Factors (SAC-44).
    • getOtherEnvironmentalFactorsReps

      Returns a count of the current number of repetitions of Other Environmental Factors (SAC-44). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • getOtherEnvironmentalFactors

      public CE getOtherEnvironmentalFactors(int rep)
      Returns a specific repetition of SAC-44: "Other Environmental Factors" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getSac44_OtherEnvironmentalFactors

      Returns a specific repetition of SAC-44: "Other Environmental Factors" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)
    • getSac44_OtherEnvironmentalFactorsReps

      Returns a count of the current number of repetitions of Other Environmental Factors (SAC-44). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.
    • insertOtherEnvironmentalFactors

      Inserts a repetition of SAC-44: "Other Environmental Factors" 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)
    • insertSac44_OtherEnvironmentalFactors

      Inserts a repetition of SAC-44: "Other Environmental Factors" 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)
    • removeOtherEnvironmentalFactors

      Removes a repetition of SAC-44: "Other Environmental Factors" 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)
    • removeSac44_OtherEnvironmentalFactors

      Removes a repetition of SAC-44: "Other Environmental Factors" 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