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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class FHS
extends AbstractSegment

Represents an HL7 FHS message segment (File Header). This segment has the following fields:

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

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
ST	getFhs1_FileFieldSeparator() Returns FHS-1: "File Field Separator" - creates it if necessary
ST	getFhs10_FileHeaderComment() Returns FHS-10: "File Header Comment" - creates it if necessary
ST	getFhs11_FileControlID() Returns FHS-11: "File Control ID" - creates it if necessary
ST	getFhs12_ReferenceFileControlID() Returns FHS-12: "Reference File Control ID" - creates it if necessary
ST	getFhs2_FileEncodingCharacters() Returns FHS-2: "File Encoding Characters" - creates it if necessary
ST	getFhs3_FileSendingApplication() Returns FHS-3: "File Sending Application" - creates it if necessary
ST	getFhs4_FileSendingFacility() Returns FHS-4: "File Sending Facility" - creates it if necessary
ST	getFhs5_FileReceivingApplication() Returns FHS-5: "File Receiving Application" - creates it if necessary
ST	getFhs6_FileReceivingFacility() Returns FHS-6: "File Receiving Facility" - creates it if necessary
TS	getFhs7_FileCreationDateTime() Returns FHS-7: "File Creation Date/Time" - creates it if necessary
ST	getFhs8_FileSecurity() Returns FHS-8: "File Security" - creates it if necessary
ST	getFhs9_FileNameID() Returns FHS-9: "File Name/ID" - creates it if necessary
ST	getFileControlID() Returns FHS-11: "File Control ID" - creates it if necessary
TS	getFileCreationDateTime() Returns FHS-7: "File Creation Date/Time" - creates it if necessary
ST	getFileEncodingCharacters() Returns FHS-2: "File Encoding Characters" - creates it if necessary
ST	getFileFieldSeparator() Returns FHS-1: "File Field Separator" - creates it if necessary
ST	getFileHeaderComment() Returns FHS-10: "File Header Comment" - creates it if necessary
ST	getFileNameID() Returns FHS-9: "File Name/ID" - creates it if necessary
ST	getFileReceivingApplication() Returns FHS-5: "File Receiving Application" - creates it if necessary
ST	getFileReceivingFacility() Returns FHS-6: "File Receiving Facility" - creates it if necessary
ST	getFileSecurity() Returns FHS-8: "File Security" - creates it if necessary
ST	getFileSendingApplication() Returns FHS-3: "File Sending Application" - creates it if necessary
ST	getFileSendingFacility() Returns FHS-4: "File Sending Facility" - creates it if necessary
ST	getReferenceFileControlID() Returns FHS-12: "Reference File 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

FHS

public FHS(Group parent,
           ModelClassFactory factory)

Creates a new FHS segment

Method Detail

getFileFieldSeparator

public ST getFileFieldSeparator()

Returns FHS-1: "File Field Separator" - creates it if necessary

getFhs1_FileFieldSeparator

public ST getFhs1_FileFieldSeparator()

Returns FHS-1: "File Field Separator" - creates it if necessary

getFileEncodingCharacters

public ST getFileEncodingCharacters()

Returns FHS-2: "File Encoding Characters" - creates it if necessary

getFhs2_FileEncodingCharacters

public ST getFhs2_FileEncodingCharacters()

Returns FHS-2: "File Encoding Characters" - creates it if necessary

getFileSendingApplication

public ST getFileSendingApplication()

Returns FHS-3: "File Sending Application" - creates it if necessary

getFhs3_FileSendingApplication

public ST getFhs3_FileSendingApplication()

Returns FHS-3: "File Sending Application" - creates it if necessary

getFileSendingFacility

public ST getFileSendingFacility()

Returns FHS-4: "File Sending Facility" - creates it if necessary

getFhs4_FileSendingFacility

public ST getFhs4_FileSendingFacility()

Returns FHS-4: "File Sending Facility" - creates it if necessary

getFileReceivingApplication

public ST getFileReceivingApplication()

Returns FHS-5: "File Receiving Application" - creates it if necessary

getFhs5_FileReceivingApplication

public ST getFhs5_FileReceivingApplication()

Returns FHS-5: "File Receiving Application" - creates it if necessary

getFileReceivingFacility

public ST getFileReceivingFacility()

Returns FHS-6: "File Receiving Facility" - creates it if necessary

getFhs6_FileReceivingFacility

public ST getFhs6_FileReceivingFacility()

Returns FHS-6: "File Receiving Facility" - creates it if necessary

getFileCreationDateTime

public TS getFileCreationDateTime()

Returns FHS-7: "File Creation Date/Time" - creates it if necessary

getFhs7_FileCreationDateTime

public TS getFhs7_FileCreationDateTime()

Returns FHS-7: "File Creation Date/Time" - creates it if necessary

getFileSecurity

public ST getFileSecurity()

Returns FHS-8: "File Security" - creates it if necessary

getFhs8_FileSecurity

public ST getFhs8_FileSecurity()

Returns FHS-8: "File Security" - creates it if necessary

getFileNameID

public ST getFileNameID()

Returns FHS-9: "File Name/ID" - creates it if necessary

getFhs9_FileNameID

public ST getFhs9_FileNameID()

Returns FHS-9: "File Name/ID" - creates it if necessary

getFileHeaderComment

public ST getFileHeaderComment()

Returns FHS-10: "File Header Comment" - creates it if necessary

getFhs10_FileHeaderComment

public ST getFhs10_FileHeaderComment()

Returns FHS-10: "File Header Comment" - creates it if necessary

getFileControlID

public ST getFileControlID()

Returns FHS-11: "File Control ID" - creates it if necessary

getFhs11_FileControlID

public ST getFhs11_FileControlID()

Returns FHS-11: "File Control ID" - creates it if necessary

getReferenceFileControlID

public ST getReferenceFileControlID()

Returns FHS-12: "Reference File Control ID" - creates it if necessary

getFhs12_ReferenceFileControlID

public ST getFhs12_ReferenceFileControlID()

Returns FHS-12: "Reference File Control ID" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment