ca.uhn.hl7v2.model.v24.segment
Class BHS

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.BHS

All Implemented Interfaces:

Segment, Structure, Serializable

public class BHS
extends AbstractSegment

Represents an HL7 BHS message segment (Batch Header). This segment has the following fields:

• BHS-1: Batch Field Separator (ST)
• BHS-2: Batch Encoding Characters (ST)
• BHS-3: Batch Sending Application (ST) optional
• BHS-4: Batch Sending Facility (ST) optional
• BHS-5: Batch Receiving Application (ST) optional
• BHS-6: Batch Receiving Facility (ST) optional
• BHS-7: Batch Creation Date/Time (TS) optional
• BHS-8: Batch Security (ST) optional
• BHS-9: Batch Name/ID/Type (ST) optional
• BHS-10: Batch Comment (ST) optional
• BHS-11: Batch Control ID (ST) optional
• BHS-12: Reference Batch Control ID (ST) optional

See Also:

Serialized Form

Constructor Summary

BHS(Group parent, ModelClassFactory factory)
Creates a new BHS segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
ST	getBatchComment() Returns BHS-10: "Batch Comment" - creates it if necessary
ST	getBatchControlID() Returns BHS-11: "Batch Control ID" - creates it if necessary
TS	getBatchCreationDateTime() Returns BHS-7: "Batch Creation Date/Time" - creates it if necessary
ST	getBatchEncodingCharacters() Returns BHS-2: "Batch Encoding Characters" - creates it if necessary
ST	getBatchFieldSeparator() Returns BHS-1: "Batch Field Separator" - creates it if necessary
ST	getBatchNameIDType() Returns BHS-9: "Batch Name/ID/Type" - creates it if necessary
ST	getBatchReceivingApplication() Returns BHS-5: "Batch Receiving Application" - creates it if necessary
ST	getBatchReceivingFacility() Returns BHS-6: "Batch Receiving Facility" - creates it if necessary
ST	getBatchSecurity() Returns BHS-8: "Batch Security" - creates it if necessary
ST	getBatchSendingApplication() Returns BHS-3: "Batch Sending Application" - creates it if necessary
ST	getBatchSendingFacility() Returns BHS-4: "Batch Sending Facility" - creates it if necessary
ST	getBhs1_BatchFieldSeparator() Returns BHS-1: "Batch Field Separator" - creates it if necessary
ST	getBhs10_BatchComment() Returns BHS-10: "Batch Comment" - creates it if necessary
ST	getBhs11_BatchControlID() Returns BHS-11: "Batch Control ID" - creates it if necessary
ST	getBhs12_ReferenceBatchControlID() Returns BHS-12: "Reference Batch Control ID" - creates it if necessary
ST	getBhs2_BatchEncodingCharacters() Returns BHS-2: "Batch Encoding Characters" - creates it if necessary
ST	getBhs3_BatchSendingApplication() Returns BHS-3: "Batch Sending Application" - creates it if necessary
ST	getBhs4_BatchSendingFacility() Returns BHS-4: "Batch Sending Facility" - creates it if necessary
ST	getBhs5_BatchReceivingApplication() Returns BHS-5: "Batch Receiving Application" - creates it if necessary
ST	getBhs6_BatchReceivingFacility() Returns BHS-6: "Batch Receiving Facility" - creates it if necessary
TS	getBhs7_BatchCreationDateTime() Returns BHS-7: "Batch Creation Date/Time" - creates it if necessary
ST	getBhs8_BatchSecurity() Returns BHS-8: "Batch Security" - creates it if necessary
ST	getBhs9_BatchNameIDType() Returns BHS-9: "Batch Name/ID/Type" - creates it if necessary
ST	getReferenceBatchControlID() Returns BHS-12: "Reference Batch Control ID" - creates it if necessary

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BHS

public BHS(Group parent,
           ModelClassFactory factory)

Creates a new BHS segment

Method Detail

getBatchFieldSeparator

public ST getBatchFieldSeparator()

Returns BHS-1: "Batch Field Separator" - creates it if necessary

getBhs1_BatchFieldSeparator

public ST getBhs1_BatchFieldSeparator()

Returns BHS-1: "Batch Field Separator" - creates it if necessary

getBatchEncodingCharacters

public ST getBatchEncodingCharacters()

Returns BHS-2: "Batch Encoding Characters" - creates it if necessary

getBhs2_BatchEncodingCharacters

public ST getBhs2_BatchEncodingCharacters()

Returns BHS-2: "Batch Encoding Characters" - creates it if necessary

getBatchSendingApplication

public ST getBatchSendingApplication()

Returns BHS-3: "Batch Sending Application" - creates it if necessary

getBhs3_BatchSendingApplication

public ST getBhs3_BatchSendingApplication()

Returns BHS-3: "Batch Sending Application" - creates it if necessary

getBatchSendingFacility

public ST getBatchSendingFacility()

Returns BHS-4: "Batch Sending Facility" - creates it if necessary

getBhs4_BatchSendingFacility

public ST getBhs4_BatchSendingFacility()

Returns BHS-4: "Batch Sending Facility" - creates it if necessary

getBatchReceivingApplication

public ST getBatchReceivingApplication()

Returns BHS-5: "Batch Receiving Application" - creates it if necessary

getBhs5_BatchReceivingApplication

public ST getBhs5_BatchReceivingApplication()

Returns BHS-5: "Batch Receiving Application" - creates it if necessary

getBatchReceivingFacility

public ST getBatchReceivingFacility()

Returns BHS-6: "Batch Receiving Facility" - creates it if necessary

getBhs6_BatchReceivingFacility

public ST getBhs6_BatchReceivingFacility()

Returns BHS-6: "Batch Receiving Facility" - creates it if necessary

getBatchCreationDateTime

public TS getBatchCreationDateTime()

Returns BHS-7: "Batch Creation Date/Time" - creates it if necessary

getBhs7_BatchCreationDateTime

public TS getBhs7_BatchCreationDateTime()

Returns BHS-7: "Batch Creation Date/Time" - creates it if necessary

getBatchSecurity

public ST getBatchSecurity()

Returns BHS-8: "Batch Security" - creates it if necessary

getBhs8_BatchSecurity

public ST getBhs8_BatchSecurity()

Returns BHS-8: "Batch Security" - creates it if necessary

getBatchNameIDType

public ST getBatchNameIDType()

Returns BHS-9: "Batch Name/ID/Type" - creates it if necessary

getBhs9_BatchNameIDType

public ST getBhs9_BatchNameIDType()

Returns BHS-9: "Batch Name/ID/Type" - creates it if necessary

getBatchComment

public ST getBatchComment()

Returns BHS-10: "Batch Comment" - creates it if necessary

getBhs10_BatchComment

public ST getBhs10_BatchComment()

Returns BHS-10: "Batch Comment" - creates it if necessary

getBatchControlID

public ST getBatchControlID()

Returns BHS-11: "Batch Control ID" - creates it if necessary

getBhs11_BatchControlID

public ST getBhs11_BatchControlID()

Returns BHS-11: "Batch Control ID" - creates it if necessary

getReferenceBatchControlID

public ST getReferenceBatchControlID()

Returns BHS-12: "Reference Batch Control ID" - creates it if necessary

getBhs12_ReferenceBatchControlID

public ST getBhs12_ReferenceBatchControlID()

Returns BHS-12: "Reference Batch Control ID" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment