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

Class SPM

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

Represents an HL7 SPM message segment (Specimen). This segment has the following fields:

  • SPM-1: Set ID - SPM (SI) optional
  • SPM-2: Specimen ID (EIP) optional
  • SPM-3: Specimen Parent IDs (EIP) optional repeating
  • SPM-4: Specimen Type (CWE)
  • SPM-5: Specimen Type Modifier (CWE) optional repeating
  • SPM-6: Specimen Additives (CWE) optional repeating
  • SPM-7: Specimen Collection Method (CWE) optional
  • SPM-8: Specimen Source Site (CWE) optional
  • SPM-9: Specimen Source Site Modifier (CWE) optional repeating
  • SPM-10: Specimen Collection Site (CWE) optional
  • SPM-11: Specimen Role (CWE) optional repeating
  • SPM-12: Specimen Collection Amount (CQ) optional
  • SPM-13: Grouped Specimen Count (NM) optional
  • SPM-14: Specimen Description (ST) optional repeating
  • SPM-15: Specimen Handling Code (CWE) optional repeating
  • SPM-16: Specimen Risk Code (CWE) optional repeating
  • SPM-17: Specimen Collection Date/Time (DR) optional
  • SPM-18: Specimen Received Date/Time (TS) optional
  • SPM-19: Specimen Expiration Date/Time (TS) optional
  • SPM-20: Specimen Availability (ID) optional
  • SPM-21: Specimen Reject Reason (CWE) optional repeating
  • SPM-22: Specimen Quality (CWE) optional
  • SPM-23: Specimen Appropriateness (CWE) optional
  • SPM-24: Specimen Condition (CWE) optional repeating
  • SPM-25: Specimen Current Quantity (CQ) optional
  • SPM-26: Number of Specimen Containers (NM) optional
  • SPM-27: Container Type (CWE) optional
  • SPM-28: Container Condition (CWE) optional
  • SPM-29: Specimen Child Role (CWE) optional
See Also:

  • Constructor Details

  • Method Details

    • getSetIDSPM

      public SI getSetIDSPM()
      Returns SPM-1: "Set ID - SPM" - creates it if necessary

    • getSpm1_SetIDSPM

      public SI getSpm1_SetIDSPM()
      Returns SPM-1: "Set ID - SPM" - creates it if necessary

    • getSpecimenID

      public EIP getSpecimenID()
      Returns SPM-2: "Specimen ID" - creates it if necessary

    • getSpm2_SpecimenID

      public EIP getSpm2_SpecimenID()
      Returns SPM-2: "Specimen ID" - creates it if necessary

    • getSpecimenParentIDs

      public EIP[] getSpecimenParentIDs()
      Returns all repetitions of Specimen Parent IDs (SPM-3).

    • getSpm3_SpecimenParentIDs

      public EIP[] getSpm3_SpecimenParentIDs()
      Returns all repetitions of Specimen Parent IDs (SPM-3).

    • getSpecimenParentIDsReps

      public int getSpecimenParentIDsReps()
      Returns a count of the current number of repetitions of Specimen Parent IDs (SPM-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSpecimenParentIDs

      public EIP getSpecimenParentIDs(int rep)
      Returns a specific repetition of SPM-3: "Specimen Parent IDs" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm3_SpecimenParentIDs

      public EIP getSpm3_SpecimenParentIDs(int rep)
      Returns a specific repetition of SPM-3: "Specimen Parent IDs" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm3_SpecimenParentIDsReps

      public int getSpm3_SpecimenParentIDsReps()
      Returns a count of the current number of repetitions of Specimen Parent IDs (SPM-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSpecimenParentIDs

      public EIP insertSpecimenParentIDs(int rep) throws HL7Exception
      Inserts a repetition of SPM-3: "Specimen Parent IDs" 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)

    • insertSpm3_SpecimenParentIDs

      public EIP insertSpm3_SpecimenParentIDs(int rep) throws HL7Exception
      Inserts a repetition of SPM-3: "Specimen Parent IDs" 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)

    • removeSpecimenParentIDs

      public EIP removeSpecimenParentIDs(int rep) throws HL7Exception
      Removes a repetition of SPM-3: "Specimen Parent IDs" 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)

    • removeSpm3_SpecimenParentIDs

      public EIP removeSpm3_SpecimenParentIDs(int rep) throws HL7Exception
      Removes a repetition of SPM-3: "Specimen Parent IDs" 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)

    • getSpecimenType

      public CWE getSpecimenType()
      Returns SPM-4: "Specimen Type" - creates it if necessary

    • getSpm4_SpecimenType

      public CWE getSpm4_SpecimenType()
      Returns SPM-4: "Specimen Type" - creates it if necessary

    • getSpecimenTypeModifier

      public CWE[] getSpecimenTypeModifier()
      Returns all repetitions of Specimen Type Modifier (SPM-5).

    • getSpm5_SpecimenTypeModifier

      public CWE[] getSpm5_SpecimenTypeModifier()
      Returns all repetitions of Specimen Type Modifier (SPM-5).

    • getSpecimenTypeModifierReps

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

    • getSpecimenTypeModifier

      public CWE getSpecimenTypeModifier(int rep)
      Returns a specific repetition of SPM-5: "Specimen Type Modifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm5_SpecimenTypeModifier

      public CWE getSpm5_SpecimenTypeModifier(int rep)
      Returns a specific repetition of SPM-5: "Specimen Type Modifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm5_SpecimenTypeModifierReps

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

    • insertSpecimenTypeModifier

      public CWE insertSpecimenTypeModifier(int rep) throws HL7Exception
      Inserts a repetition of SPM-5: "Specimen Type Modifier" 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)

    • insertSpm5_SpecimenTypeModifier

      public CWE insertSpm5_SpecimenTypeModifier(int rep) throws HL7Exception
      Inserts a repetition of SPM-5: "Specimen Type Modifier" 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)

    • removeSpecimenTypeModifier

      public CWE removeSpecimenTypeModifier(int rep) throws HL7Exception
      Removes a repetition of SPM-5: "Specimen Type Modifier" 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)

    • removeSpm5_SpecimenTypeModifier

      public CWE removeSpm5_SpecimenTypeModifier(int rep) throws HL7Exception
      Removes a repetition of SPM-5: "Specimen Type Modifier" 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)

    • getSpecimenAdditives

      public CWE[] getSpecimenAdditives()
      Returns all repetitions of Specimen Additives (SPM-6).

    • getSpm6_SpecimenAdditives

      public CWE[] getSpm6_SpecimenAdditives()
      Returns all repetitions of Specimen Additives (SPM-6).

    • getSpecimenAdditivesReps

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

    • getSpecimenAdditives

      public CWE getSpecimenAdditives(int rep)
      Returns a specific repetition of SPM-6: "Specimen Additives" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm6_SpecimenAdditives

      public CWE getSpm6_SpecimenAdditives(int rep)
      Returns a specific repetition of SPM-6: "Specimen Additives" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm6_SpecimenAdditivesReps

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

    • insertSpecimenAdditives

      public CWE insertSpecimenAdditives(int rep) throws HL7Exception
      Inserts a repetition of SPM-6: "Specimen Additives" 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)

    • insertSpm6_SpecimenAdditives

      public CWE insertSpm6_SpecimenAdditives(int rep) throws HL7Exception
      Inserts a repetition of SPM-6: "Specimen Additives" 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)

    • removeSpecimenAdditives

      public CWE removeSpecimenAdditives(int rep) throws HL7Exception
      Removes a repetition of SPM-6: "Specimen Additives" 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)

    • removeSpm6_SpecimenAdditives

      public CWE removeSpm6_SpecimenAdditives(int rep) throws HL7Exception
      Removes a repetition of SPM-6: "Specimen Additives" 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)

    • getSpecimenCollectionMethod

      public CWE getSpecimenCollectionMethod()
      Returns SPM-7: "Specimen Collection Method" - creates it if necessary

    • getSpm7_SpecimenCollectionMethod

      public CWE getSpm7_SpecimenCollectionMethod()
      Returns SPM-7: "Specimen Collection Method" - creates it if necessary

    • getSpecimenSourceSite

      public CWE getSpecimenSourceSite()
      Returns SPM-8: "Specimen Source Site" - creates it if necessary

    • getSpm8_SpecimenSourceSite

      public CWE getSpm8_SpecimenSourceSite()
      Returns SPM-8: "Specimen Source Site" - creates it if necessary

    • getSpecimenSourceSiteModifier

      public CWE[] getSpecimenSourceSiteModifier()
      Returns all repetitions of Specimen Source Site Modifier (SPM-9).

    • getSpm9_SpecimenSourceSiteModifier

      public CWE[] getSpm9_SpecimenSourceSiteModifier()
      Returns all repetitions of Specimen Source Site Modifier (SPM-9).

    • getSpecimenSourceSiteModifierReps

      public int getSpecimenSourceSiteModifierReps()
      Returns a count of the current number of repetitions of Specimen Source Site Modifier (SPM-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSpecimenSourceSiteModifier

      public CWE getSpecimenSourceSiteModifier(int rep)
      Returns a specific repetition of SPM-9: "Specimen Source Site Modifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm9_SpecimenSourceSiteModifier

      public CWE getSpm9_SpecimenSourceSiteModifier(int rep)
      Returns a specific repetition of SPM-9: "Specimen Source Site Modifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm9_SpecimenSourceSiteModifierReps

      public int getSpm9_SpecimenSourceSiteModifierReps()
      Returns a count of the current number of repetitions of Specimen Source Site Modifier (SPM-9). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSpecimenSourceSiteModifier

      public CWE insertSpecimenSourceSiteModifier(int rep) throws HL7Exception
      Inserts a repetition of SPM-9: "Specimen Source Site Modifier" 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)

    • insertSpm9_SpecimenSourceSiteModifier

      public CWE insertSpm9_SpecimenSourceSiteModifier(int rep) throws HL7Exception
      Inserts a repetition of SPM-9: "Specimen Source Site Modifier" 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)

    • removeSpecimenSourceSiteModifier

      public CWE removeSpecimenSourceSiteModifier(int rep) throws HL7Exception
      Removes a repetition of SPM-9: "Specimen Source Site Modifier" 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)

    • removeSpm9_SpecimenSourceSiteModifier

      public CWE removeSpm9_SpecimenSourceSiteModifier(int rep) throws HL7Exception
      Removes a repetition of SPM-9: "Specimen Source Site Modifier" 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)

    • getSpecimenCollectionSite

      public CWE getSpecimenCollectionSite()
      Returns SPM-10: "Specimen Collection Site" - creates it if necessary

    • getSpm10_SpecimenCollectionSite

      public CWE getSpm10_SpecimenCollectionSite()
      Returns SPM-10: "Specimen Collection Site" - creates it if necessary

    • getSpecimenRole

      public CWE[] getSpecimenRole()
      Returns all repetitions of Specimen Role (SPM-11).

    • getSpm11_SpecimenRole

      public CWE[] getSpm11_SpecimenRole()
      Returns all repetitions of Specimen Role (SPM-11).

    • getSpecimenRoleReps

      public int getSpecimenRoleReps()
      Returns a count of the current number of repetitions of Specimen Role (SPM-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSpecimenRole

      public CWE getSpecimenRole(int rep)
      Returns a specific repetition of SPM-11: "Specimen Role" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm11_SpecimenRole

      public CWE getSpm11_SpecimenRole(int rep)
      Returns a specific repetition of SPM-11: "Specimen Role" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm11_SpecimenRoleReps

      public int getSpm11_SpecimenRoleReps()
      Returns a count of the current number of repetitions of Specimen Role (SPM-11). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSpecimenRole

      public CWE insertSpecimenRole(int rep) throws HL7Exception
      Inserts a repetition of SPM-11: "Specimen Role" 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)

    • insertSpm11_SpecimenRole

      public CWE insertSpm11_SpecimenRole(int rep) throws HL7Exception
      Inserts a repetition of SPM-11: "Specimen Role" 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)

    • removeSpecimenRole

      public CWE removeSpecimenRole(int rep) throws HL7Exception
      Removes a repetition of SPM-11: "Specimen Role" 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)

    • removeSpm11_SpecimenRole

      public CWE removeSpm11_SpecimenRole(int rep) throws HL7Exception
      Removes a repetition of SPM-11: "Specimen Role" 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)

    • getSpecimenCollectionAmount

      public CQ getSpecimenCollectionAmount()
      Returns SPM-12: "Specimen Collection Amount" - creates it if necessary

    • getSpm12_SpecimenCollectionAmount

      public CQ getSpm12_SpecimenCollectionAmount()
      Returns SPM-12: "Specimen Collection Amount" - creates it if necessary

    • getGroupedSpecimenCount

      public NM getGroupedSpecimenCount()
      Returns SPM-13: "Grouped Specimen Count" - creates it if necessary

    • getSpm13_GroupedSpecimenCount

      public NM getSpm13_GroupedSpecimenCount()
      Returns SPM-13: "Grouped Specimen Count" - creates it if necessary

    • getSpecimenDescription

      public ST[] getSpecimenDescription()
      Returns all repetitions of Specimen Description (SPM-14).

    • getSpm14_SpecimenDescription

      public ST[] getSpm14_SpecimenDescription()
      Returns all repetitions of Specimen Description (SPM-14).

    • getSpecimenDescriptionReps

      public int getSpecimenDescriptionReps()
      Returns a count of the current number of repetitions of Specimen Description (SPM-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSpecimenDescription

      public ST getSpecimenDescription(int rep)
      Returns a specific repetition of SPM-14: "Specimen Description" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm14_SpecimenDescription

      public ST getSpm14_SpecimenDescription(int rep)
      Returns a specific repetition of SPM-14: "Specimen Description" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm14_SpecimenDescriptionReps

      public int getSpm14_SpecimenDescriptionReps()
      Returns a count of the current number of repetitions of Specimen Description (SPM-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSpecimenDescription

      public ST insertSpecimenDescription(int rep) throws HL7Exception
      Inserts a repetition of SPM-14: "Specimen Description" 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)

    • insertSpm14_SpecimenDescription

      public ST insertSpm14_SpecimenDescription(int rep) throws HL7Exception
      Inserts a repetition of SPM-14: "Specimen Description" 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)

    • removeSpecimenDescription

      public ST removeSpecimenDescription(int rep) throws HL7Exception
      Removes a repetition of SPM-14: "Specimen Description" 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)

    • removeSpm14_SpecimenDescription

      public ST removeSpm14_SpecimenDescription(int rep) throws HL7Exception
      Removes a repetition of SPM-14: "Specimen Description" 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)

    • getSpecimenHandlingCode

      public CWE[] getSpecimenHandlingCode()
      Returns all repetitions of Specimen Handling Code (SPM-15).

    • getSpm15_SpecimenHandlingCode

      public CWE[] getSpm15_SpecimenHandlingCode()
      Returns all repetitions of Specimen Handling Code (SPM-15).

    • getSpecimenHandlingCodeReps

      public int getSpecimenHandlingCodeReps()
      Returns a count of the current number of repetitions of Specimen Handling Code (SPM-15). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSpecimenHandlingCode

      public CWE getSpecimenHandlingCode(int rep)
      Returns a specific repetition of SPM-15: "Specimen Handling Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm15_SpecimenHandlingCode

      public CWE getSpm15_SpecimenHandlingCode(int rep)
      Returns a specific repetition of SPM-15: "Specimen Handling Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm15_SpecimenHandlingCodeReps

      public int getSpm15_SpecimenHandlingCodeReps()
      Returns a count of the current number of repetitions of Specimen Handling Code (SPM-15). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSpecimenHandlingCode

      public CWE insertSpecimenHandlingCode(int rep) throws HL7Exception
      Inserts a repetition of SPM-15: "Specimen 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)

    • insertSpm15_SpecimenHandlingCode

      public CWE insertSpm15_SpecimenHandlingCode(int rep) throws HL7Exception
      Inserts a repetition of SPM-15: "Specimen 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)

    • removeSpecimenHandlingCode

      public CWE removeSpecimenHandlingCode(int rep) throws HL7Exception
      Removes a repetition of SPM-15: "Specimen 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)

    • removeSpm15_SpecimenHandlingCode

      public CWE removeSpm15_SpecimenHandlingCode(int rep) throws HL7Exception
      Removes a repetition of SPM-15: "Specimen 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)

    • getSpecimenRiskCode

      public CWE[] getSpecimenRiskCode()
      Returns all repetitions of Specimen Risk Code (SPM-16).

    • getSpm16_SpecimenRiskCode

      public CWE[] getSpm16_SpecimenRiskCode()
      Returns all repetitions of Specimen Risk Code (SPM-16).

    • getSpecimenRiskCodeReps

      public int getSpecimenRiskCodeReps()
      Returns a count of the current number of repetitions of Specimen Risk Code (SPM-16). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSpecimenRiskCode

      public CWE getSpecimenRiskCode(int rep)
      Returns a specific repetition of SPM-16: "Specimen Risk Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm16_SpecimenRiskCode

      public CWE getSpm16_SpecimenRiskCode(int rep)
      Returns a specific repetition of SPM-16: "Specimen Risk Code" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm16_SpecimenRiskCodeReps

      public int getSpm16_SpecimenRiskCodeReps()
      Returns a count of the current number of repetitions of Specimen Risk Code (SPM-16). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSpecimenRiskCode

      public CWE insertSpecimenRiskCode(int rep) throws HL7Exception
      Inserts a repetition of SPM-16: "Specimen Risk 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)

    • insertSpm16_SpecimenRiskCode

      public CWE insertSpm16_SpecimenRiskCode(int rep) throws HL7Exception
      Inserts a repetition of SPM-16: "Specimen Risk 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)

    • removeSpecimenRiskCode

      public CWE removeSpecimenRiskCode(int rep) throws HL7Exception
      Removes a repetition of SPM-16: "Specimen Risk 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)

    • removeSpm16_SpecimenRiskCode

      public CWE removeSpm16_SpecimenRiskCode(int rep) throws HL7Exception
      Removes a repetition of SPM-16: "Specimen Risk 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)

    • getSpecimenCollectionDateTime

      public DR getSpecimenCollectionDateTime()
      Returns SPM-17: "Specimen Collection Date/Time" - creates it if necessary

    • getSpm17_SpecimenCollectionDateTime

      public DR getSpm17_SpecimenCollectionDateTime()
      Returns SPM-17: "Specimen Collection Date/Time" - creates it if necessary

    • getSpecimenReceivedDateTime

      public TS getSpecimenReceivedDateTime()
      Returns SPM-18: "Specimen Received Date/Time" - creates it if necessary

    • getSpm18_SpecimenReceivedDateTime

      public TS getSpm18_SpecimenReceivedDateTime()
      Returns SPM-18: "Specimen Received Date/Time" - creates it if necessary

    • getSpecimenExpirationDateTime

      public TS getSpecimenExpirationDateTime()
      Returns SPM-19: "Specimen Expiration Date/Time" - creates it if necessary

    • getSpm19_SpecimenExpirationDateTime

      public TS getSpm19_SpecimenExpirationDateTime()
      Returns SPM-19: "Specimen Expiration Date/Time" - creates it if necessary

    • getSpecimenAvailability

      public ID getSpecimenAvailability()
      Returns SPM-20: "Specimen Availability" - creates it if necessary

    • getSpm20_SpecimenAvailability

      public ID getSpm20_SpecimenAvailability()
      Returns SPM-20: "Specimen Availability" - creates it if necessary

    • getSpecimenRejectReason

      public CWE[] getSpecimenRejectReason()
      Returns all repetitions of Specimen Reject Reason (SPM-21).

    • getSpm21_SpecimenRejectReason

      public CWE[] getSpm21_SpecimenRejectReason()
      Returns all repetitions of Specimen Reject Reason (SPM-21).

    • getSpecimenRejectReasonReps

      public int getSpecimenRejectReasonReps()
      Returns a count of the current number of repetitions of Specimen Reject Reason (SPM-21). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSpecimenRejectReason

      public CWE getSpecimenRejectReason(int rep)
      Returns a specific repetition of SPM-21: "Specimen Reject Reason" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm21_SpecimenRejectReason

      public CWE getSpm21_SpecimenRejectReason(int rep)
      Returns a specific repetition of SPM-21: "Specimen Reject Reason" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm21_SpecimenRejectReasonReps

      public int getSpm21_SpecimenRejectReasonReps()
      Returns a count of the current number of repetitions of Specimen Reject Reason (SPM-21). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSpecimenRejectReason

      public CWE insertSpecimenRejectReason(int rep) throws HL7Exception
      Inserts a repetition of SPM-21: "Specimen Reject Reason" 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)

    • insertSpm21_SpecimenRejectReason

      public CWE insertSpm21_SpecimenRejectReason(int rep) throws HL7Exception
      Inserts a repetition of SPM-21: "Specimen Reject Reason" 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)

    • removeSpecimenRejectReason

      public CWE removeSpecimenRejectReason(int rep) throws HL7Exception
      Removes a repetition of SPM-21: "Specimen Reject Reason" 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)

    • removeSpm21_SpecimenRejectReason

      public CWE removeSpm21_SpecimenRejectReason(int rep) throws HL7Exception
      Removes a repetition of SPM-21: "Specimen Reject Reason" 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)

    • getSpecimenQuality

      public CWE getSpecimenQuality()
      Returns SPM-22: "Specimen Quality" - creates it if necessary

    • getSpm22_SpecimenQuality

      public CWE getSpm22_SpecimenQuality()
      Returns SPM-22: "Specimen Quality" - creates it if necessary

    • getSpecimenAppropriateness

      public CWE getSpecimenAppropriateness()
      Returns SPM-23: "Specimen Appropriateness" - creates it if necessary

    • getSpm23_SpecimenAppropriateness

      public CWE getSpm23_SpecimenAppropriateness()
      Returns SPM-23: "Specimen Appropriateness" - creates it if necessary

    • getSpecimenCondition

      public CWE[] getSpecimenCondition()
      Returns all repetitions of Specimen Condition (SPM-24).

    • getSpm24_SpecimenCondition

      public CWE[] getSpm24_SpecimenCondition()
      Returns all repetitions of Specimen Condition (SPM-24).

    • getSpecimenConditionReps

      public int getSpecimenConditionReps()
      Returns a count of the current number of repetitions of Specimen Condition (SPM-24). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getSpecimenCondition

      public CWE getSpecimenCondition(int rep)
      Returns a specific repetition of SPM-24: "Specimen Condition" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm24_SpecimenCondition

      public CWE getSpm24_SpecimenCondition(int rep)
      Returns a specific repetition of SPM-24: "Specimen Condition" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getSpm24_SpecimenConditionReps

      public int getSpm24_SpecimenConditionReps()
      Returns a count of the current number of repetitions of Specimen Condition (SPM-24). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertSpecimenCondition

      public CWE insertSpecimenCondition(int rep) throws HL7Exception
      Inserts a repetition of SPM-24: "Specimen Condition" 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)

    • insertSpm24_SpecimenCondition

      public CWE insertSpm24_SpecimenCondition(int rep) throws HL7Exception
      Inserts a repetition of SPM-24: "Specimen Condition" 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)

    • removeSpecimenCondition

      public CWE removeSpecimenCondition(int rep) throws HL7Exception
      Removes a repetition of SPM-24: "Specimen Condition" 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)

    • removeSpm24_SpecimenCondition

      public CWE removeSpm24_SpecimenCondition(int rep) throws HL7Exception
      Removes a repetition of SPM-24: "Specimen Condition" 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)

    • getSpecimenCurrentQuantity

      public CQ getSpecimenCurrentQuantity()
      Returns SPM-25: "Specimen Current Quantity" - creates it if necessary

    • getSpm25_SpecimenCurrentQuantity

      public CQ getSpm25_SpecimenCurrentQuantity()
      Returns SPM-25: "Specimen Current Quantity" - creates it if necessary

    • getNumberOfSpecimenContainers

      public NM getNumberOfSpecimenContainers()
      Returns SPM-26: "Number of Specimen Containers" - creates it if necessary

    • getSpm26_NumberOfSpecimenContainers

      public NM getSpm26_NumberOfSpecimenContainers()
      Returns SPM-26: "Number of Specimen Containers" - creates it if necessary

    • getContainerType

      public CWE getContainerType()
      Returns SPM-27: "Container Type" - creates it if necessary

    • getSpm27_ContainerType

      public CWE getSpm27_ContainerType()
      Returns SPM-27: "Container Type" - creates it if necessary

    • getContainerCondition

      public CWE getContainerCondition()
      Returns SPM-28: "Container Condition" - creates it if necessary

    • getSpm28_ContainerCondition

      public CWE getSpm28_ContainerCondition()
      Returns SPM-28: "Container Condition" - creates it if necessary

    • getSpecimenChildRole

      public CWE getSpecimenChildRole()
      Returns SPM-29: "Specimen Child Role" - creates it if necessary

    • getSpm29_SpecimenChildRole

      public CWE getSpm29_SpecimenChildRole()
      Returns SPM-29: "Specimen Child Role" - creates it if necessary

    • createNewTypeWithoutReflection

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