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

Class DB1

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

Represents an HL7 DB1 message segment (Disability). This segment has the following fields:

  • DB1-1: Set ID - DB1 (SI)
  • DB1-2: Disabled Person Code (IS) optional
  • DB1-3: Disabled Person Identifier (CX) optional repeating
  • DB1-4: Disability Indicator (ID) optional
  • DB1-5: Disability Start Date (DT) optional
  • DB1-6: Disability End Date (DT) optional
  • DB1-7: Disability Return to Work Date (DT) optional
  • DB1-8: Disability Unable to Work Date (DT) optional
See Also:

  • Constructor Details

  • Method Details

    • getSetIDDB1

      public SI getSetIDDB1()
      Returns DB1-1: "Set ID - DB1" - creates it if necessary

    • getDb11_SetIDDB1

      public SI getDb11_SetIDDB1()
      Returns DB1-1: "Set ID - DB1" - creates it if necessary

    • getDisabledPersonCode

      public IS getDisabledPersonCode()
      Returns DB1-2: "Disabled Person Code" - creates it if necessary

    • getDb12_DisabledPersonCode

      public IS getDb12_DisabledPersonCode()
      Returns DB1-2: "Disabled Person Code" - creates it if necessary

    • getDisabledPersonIdentifier

      public CX[] getDisabledPersonIdentifier()
      Returns all repetitions of Disabled Person Identifier (DB1-3).

    • getDb13_DisabledPersonIdentifier

      public CX[] getDb13_DisabledPersonIdentifier()
      Returns all repetitions of Disabled Person Identifier (DB1-3).

    • getDisabledPersonIdentifierReps

      public int getDisabledPersonIdentifierReps()
      Returns a count of the current number of repetitions of Disabled Person Identifier (DB1-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • getDisabledPersonIdentifier

      public CX getDisabledPersonIdentifier(int rep)
      Returns a specific repetition of DB1-3: "Disabled Person Identifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getDb13_DisabledPersonIdentifier

      public CX getDb13_DisabledPersonIdentifier(int rep)
      Returns a specific repetition of DB1-3: "Disabled Person Identifier" - creates it if necessary
      Parameters:
      rep - The repetition index (0-indexed)

    • getDb13_DisabledPersonIdentifierReps

      public int getDb13_DisabledPersonIdentifierReps()
      Returns a count of the current number of repetitions of Disabled Person Identifier (DB1-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

    • insertDisabledPersonIdentifier

      public CX insertDisabledPersonIdentifier(int rep) throws HL7Exception
      Inserts a repetition of DB1-3: "Disabled Person Identifier" 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)

    • insertDb13_DisabledPersonIdentifier

      public CX insertDb13_DisabledPersonIdentifier(int rep) throws HL7Exception
      Inserts a repetition of DB1-3: "Disabled Person Identifier" 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)

    • removeDisabledPersonIdentifier

      public CX removeDisabledPersonIdentifier(int rep) throws HL7Exception
      Removes a repetition of DB1-3: "Disabled Person Identifier" 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)

    • removeDb13_DisabledPersonIdentifier

      public CX removeDb13_DisabledPersonIdentifier(int rep) throws HL7Exception
      Removes a repetition of DB1-3: "Disabled Person Identifier" 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)

    • getDisabilityIndicator

      public ID getDisabilityIndicator()
      Returns DB1-4: "Disability Indicator" - creates it if necessary

    • getDb14_DisabilityIndicator

      public ID getDb14_DisabilityIndicator()
      Returns DB1-4: "Disability Indicator" - creates it if necessary

    • getDisabilityStartDate

      public DT getDisabilityStartDate()
      Returns DB1-5: "Disability Start Date" - creates it if necessary

    • getDb15_DisabilityStartDate

      public DT getDb15_DisabilityStartDate()
      Returns DB1-5: "Disability Start Date" - creates it if necessary

    • getDisabilityEndDate

      public DT getDisabilityEndDate()
      Returns DB1-6: "Disability End Date" - creates it if necessary

    • getDb16_DisabilityEndDate

      public DT getDb16_DisabilityEndDate()
      Returns DB1-6: "Disability End Date" - creates it if necessary

    • getDisabilityReturnToWorkDate

      public DT getDisabilityReturnToWorkDate()
      Returns DB1-7: "Disability Return to Work Date" - creates it if necessary

    • getDb17_DisabilityReturnToWorkDate

      public DT getDb17_DisabilityReturnToWorkDate()
      Returns DB1-7: "Disability Return to Work Date" - creates it if necessary

    • getDisabilityUnableToWorkDate

      public DT getDisabilityUnableToWorkDate()
      Returns DB1-8: "Disability Unable to Work Date" - creates it if necessary

    • getDb18_DisabilityUnableToWorkDate

      public DT getDb18_DisabilityUnableToWorkDate()
      Returns DB1-8: "Disability Unable to Work Date" - creates it if necessary

    • createNewTypeWithoutReflection

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