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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class PSH
extends AbstractSegment

Represents an HL7 PSH message segment (Product Summary Header). This segment has the following fields:

• PSH-1: Report Type (ST)
• PSH-2: Report Form Identifier (ST) optional
• PSH-3: Report Date (TS)
• PSH-4: Report Interval Start Date (TS) optional
• PSH-5: Report Interval End Date (TS) optional
• PSH-6: Quantity Manufactured (CQ) optional
• PSH-7: Quantity Distributed (CQ) optional
• PSH-8: Quantity Distributed Method (ID) optional
• PSH-9: Quantity Distributed Comment (FT) optional
• PSH-10: Quantity in Use (CQ) optional
• PSH-11: Quantity in Use Method (ID) optional
• PSH-12: Quantity in Use Comment (FT) optional
• PSH-13: Number of Product Experience Reports Filed by Facility (NM) optional repeating
• PSH-14: Number of Product Experience Reports Filed by Distributor (NM) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
NM[]	getNumberOfProductExperienceReportsFiledByDistributor() Returns all repetitions of Number of Product Experience Reports Filed by Distributor (PSH-14).
NM	getNumberOfProductExperienceReportsFiledByDistributor(int rep) Returns a specific repetition of PSH-14: "Number of Product Experience Reports Filed by Distributor" - creates it if necessary
int	getNumberOfProductExperienceReportsFiledByDistributorReps() Returns a count of the current number of repetitions of Number of Product Experience Reports Filed by Distributor (PSH-14).
NM[]	getNumberOfProductExperienceReportsFiledByFacility() Returns all repetitions of Number of Product Experience Reports Filed by Facility (PSH-13).
NM	getNumberOfProductExperienceReportsFiledByFacility(int rep) Returns a specific repetition of PSH-13: "Number of Product Experience Reports Filed by Facility" - creates it if necessary
int	getNumberOfProductExperienceReportsFiledByFacilityReps() Returns a count of the current number of repetitions of Number of Product Experience Reports Filed by Facility (PSH-13).
ST	getPsh1_ReportType() Returns PSH-1: "Report Type" - creates it if necessary
CQ	getPsh10_QuantityInUse() Returns PSH-10: "Quantity in Use" - creates it if necessary
ID	getPsh11_QuantityInUseMethod() Returns PSH-11: "Quantity in Use Method" - creates it if necessary
FT	getPsh12_QuantityInUseComment() Returns PSH-12: "Quantity in Use Comment" - creates it if necessary
NM	getPsh13_NumberOfProductExperienceReportsFiledByFacility(int rep) Returns a specific repetition of PSH-13: "Number of Product Experience Reports Filed by Facility" - creates it if necessary
int	getPsh13_NumberOfProductExperienceReportsFiledByFacilityReps() Returns a count of the current number of repetitions of Number of Product Experience Reports Filed by Facility (PSH-13).
NM	getPsh14_NumberOfProductExperienceReportsFiledByDistributor(int rep) Returns a specific repetition of PSH-14: "Number of Product Experience Reports Filed by Distributor" - creates it if necessary
int	getPsh14_NumberOfProductExperienceReportsFiledByDistributorReps() Returns a count of the current number of repetitions of Number of Product Experience Reports Filed by Distributor (PSH-14).
ST	getPsh2_ReportFormIdentifier() Returns PSH-2: "Report Form Identifier" - creates it if necessary
TS	getPsh3_ReportDate() Returns PSH-3: "Report Date" - creates it if necessary
TS	getPsh4_ReportIntervalStartDate() Returns PSH-4: "Report Interval Start Date" - creates it if necessary
TS	getPsh5_ReportIntervalEndDate() Returns PSH-5: "Report Interval End Date" - creates it if necessary
CQ	getPsh6_QuantityManufactured() Returns PSH-6: "Quantity Manufactured" - creates it if necessary
CQ	getPsh7_QuantityDistributed() Returns PSH-7: "Quantity Distributed" - creates it if necessary
ID	getPsh8_QuantityDistributedMethod() Returns PSH-8: "Quantity Distributed Method" - creates it if necessary
FT	getPsh9_QuantityDistributedComment() Returns PSH-9: "Quantity Distributed Comment" - creates it if necessary
CQ	getQuantityDistributed() Returns PSH-7: "Quantity Distributed" - creates it if necessary
FT	getQuantityDistributedComment() Returns PSH-9: "Quantity Distributed Comment" - creates it if necessary
ID	getQuantityDistributedMethod() Returns PSH-8: "Quantity Distributed Method" - creates it if necessary
CQ	getQuantityInUse() Returns PSH-10: "Quantity in Use" - creates it if necessary
FT	getQuantityInUseComment() Returns PSH-12: "Quantity in Use Comment" - creates it if necessary
ID	getQuantityInUseMethod() Returns PSH-11: "Quantity in Use Method" - creates it if necessary
CQ	getQuantityManufactured() Returns PSH-6: "Quantity Manufactured" - creates it if necessary
TS	getReportDate() Returns PSH-3: "Report Date" - creates it if necessary
ST	getReportFormIdentifier() Returns PSH-2: "Report Form Identifier" - creates it if necessary
TS	getReportIntervalEndDate() Returns PSH-5: "Report Interval End Date" - creates it if necessary
TS	getReportIntervalStartDate() Returns PSH-4: "Report Interval Start Date" - creates it if necessary
ST	getReportType() Returns PSH-1: "Report Type" - creates it if necessary
NM	insertNumberOfProductExperienceReportsFiledByDistributor(int rep) Inserts a repetition of PSH-14: "Number of Product Experience Reports Filed by Distributor" at a specific index
NM	insertNumberOfProductExperienceReportsFiledByFacility(int rep) Inserts a repetition of PSH-13: "Number of Product Experience Reports Filed by Facility" at a specific index
NM	insertPsh13_NumberOfProductExperienceReportsFiledByFacility(int rep) Inserts a repetition of PSH-13: "Number of Product Experience Reports Filed by Facility" at a specific index
NM	insertPsh14_NumberOfProductExperienceReportsFiledByDistributor(int rep) Inserts a repetition of PSH-14: "Number of Product Experience Reports Filed by Distributor" at a specific index
NM	removeNumberOfProductExperienceReportsFiledByDistributor(int rep) Removes a repetition of PSH-14: "Number of Product Experience Reports Filed by Distributor" at a specific index
NM	removeNumberOfProductExperienceReportsFiledByFacility(int rep) Removes a repetition of PSH-13: "Number of Product Experience Reports Filed by Facility" at a specific index
NM	removePsh13_NumberOfProductExperienceReportsFiledByFacility(int rep) Removes a repetition of PSH-13: "Number of Product Experience Reports Filed by Facility" at a specific index
NM	removePsh14_NumberOfProductExperienceReportsFiledByDistributor(int rep) Removes a repetition of PSH-14: "Number of Product Experience Reports Filed by Distributor" at a specific index

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

PSH

public PSH(Group parent,
           ModelClassFactory factory)

Creates a new PSH segment

Method Detail

getReportType

public ST getReportType()

Returns PSH-1: "Report Type" - creates it if necessary

getPsh1_ReportType

public ST getPsh1_ReportType()

Returns PSH-1: "Report Type" - creates it if necessary

getReportFormIdentifier

public ST getReportFormIdentifier()

Returns PSH-2: "Report Form Identifier" - creates it if necessary

getPsh2_ReportFormIdentifier

public ST getPsh2_ReportFormIdentifier()

Returns PSH-2: "Report Form Identifier" - creates it if necessary

getReportDate

public TS getReportDate()

Returns PSH-3: "Report Date" - creates it if necessary

getPsh3_ReportDate

public TS getPsh3_ReportDate()

Returns PSH-3: "Report Date" - creates it if necessary

getReportIntervalStartDate

public TS getReportIntervalStartDate()

Returns PSH-4: "Report Interval Start Date" - creates it if necessary

getPsh4_ReportIntervalStartDate

public TS getPsh4_ReportIntervalStartDate()

Returns PSH-4: "Report Interval Start Date" - creates it if necessary

getReportIntervalEndDate

public TS getReportIntervalEndDate()

Returns PSH-5: "Report Interval End Date" - creates it if necessary

getPsh5_ReportIntervalEndDate

public TS getPsh5_ReportIntervalEndDate()

Returns PSH-5: "Report Interval End Date" - creates it if necessary

getQuantityManufactured

public CQ getQuantityManufactured()

Returns PSH-6: "Quantity Manufactured" - creates it if necessary

getPsh6_QuantityManufactured

public CQ getPsh6_QuantityManufactured()

Returns PSH-6: "Quantity Manufactured" - creates it if necessary

getQuantityDistributed

public CQ getQuantityDistributed()

Returns PSH-7: "Quantity Distributed" - creates it if necessary

getPsh7_QuantityDistributed

public CQ getPsh7_QuantityDistributed()

Returns PSH-7: "Quantity Distributed" - creates it if necessary

getQuantityDistributedMethod

public ID getQuantityDistributedMethod()

Returns PSH-8: "Quantity Distributed Method" - creates it if necessary

getPsh8_QuantityDistributedMethod

public ID getPsh8_QuantityDistributedMethod()

Returns PSH-8: "Quantity Distributed Method" - creates it if necessary

getQuantityDistributedComment

public FT getQuantityDistributedComment()

Returns PSH-9: "Quantity Distributed Comment" - creates it if necessary

getPsh9_QuantityDistributedComment

public FT getPsh9_QuantityDistributedComment()

Returns PSH-9: "Quantity Distributed Comment" - creates it if necessary

getQuantityInUse

public CQ getQuantityInUse()

Returns PSH-10: "Quantity in Use" - creates it if necessary

getPsh10_QuantityInUse

public CQ getPsh10_QuantityInUse()

Returns PSH-10: "Quantity in Use" - creates it if necessary

getQuantityInUseMethod

public ID getQuantityInUseMethod()

Returns PSH-11: "Quantity in Use Method" - creates it if necessary

getPsh11_QuantityInUseMethod

public ID getPsh11_QuantityInUseMethod()

Returns PSH-11: "Quantity in Use Method" - creates it if necessary

getQuantityInUseComment

public FT getQuantityInUseComment()

Returns PSH-12: "Quantity in Use Comment" - creates it if necessary

getPsh12_QuantityInUseComment

public FT getPsh12_QuantityInUseComment()

Returns PSH-12: "Quantity in Use Comment" - creates it if necessary

getNumberOfProductExperienceReportsFiledByFacility

public NM[] getNumberOfProductExperienceReportsFiledByFacility()

Returns all repetitions of Number of Product Experience Reports Filed by Facility (PSH-13).

getNumberOfProductExperienceReportsFiledByFacilityReps

public int getNumberOfProductExperienceReportsFiledByFacilityReps()

Returns a count of the current number of repetitions of Number of Product Experience Reports Filed by Facility (PSH-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getNumberOfProductExperienceReportsFiledByFacility

public NM getNumberOfProductExperienceReportsFiledByFacility(int rep)

Returns a specific repetition of PSH-13: "Number of Product Experience Reports Filed by Facility" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPsh13_NumberOfProductExperienceReportsFiledByFacility

public NM getPsh13_NumberOfProductExperienceReportsFiledByFacility(int rep)

Returns a specific repetition of PSH-13: "Number of Product Experience Reports Filed by Facility" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPsh13_NumberOfProductExperienceReportsFiledByFacilityReps

public int getPsh13_NumberOfProductExperienceReportsFiledByFacilityReps()

Returns a count of the current number of repetitions of Number of Product Experience Reports Filed by Facility (PSH-13). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertNumberOfProductExperienceReportsFiledByFacility

public NM insertNumberOfProductExperienceReportsFiledByFacility(int rep)
                                                         throws HL7Exception

Inserts a repetition of PSH-13: "Number of Product Experience Reports Filed by Facility" 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)

insertPsh13_NumberOfProductExperienceReportsFiledByFacility

public NM insertPsh13_NumberOfProductExperienceReportsFiledByFacility(int rep)
                                                               throws HL7Exception

Inserts a repetition of PSH-13: "Number of Product Experience Reports Filed by Facility" 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)

removeNumberOfProductExperienceReportsFiledByFacility

public NM removeNumberOfProductExperienceReportsFiledByFacility(int rep)
                                                         throws HL7Exception

Removes a repetition of PSH-13: "Number of Product Experience Reports Filed by Facility" 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)

removePsh13_NumberOfProductExperienceReportsFiledByFacility

public NM removePsh13_NumberOfProductExperienceReportsFiledByFacility(int rep)
                                                               throws HL7Exception

Removes a repetition of PSH-13: "Number of Product Experience Reports Filed by Facility" 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)

getNumberOfProductExperienceReportsFiledByDistributor

public NM[] getNumberOfProductExperienceReportsFiledByDistributor()

Returns all repetitions of Number of Product Experience Reports Filed by Distributor (PSH-14).

getNumberOfProductExperienceReportsFiledByDistributorReps

public int getNumberOfProductExperienceReportsFiledByDistributorReps()

Returns a count of the current number of repetitions of Number of Product Experience Reports Filed by Distributor (PSH-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getNumberOfProductExperienceReportsFiledByDistributor

public NM getNumberOfProductExperienceReportsFiledByDistributor(int rep)

Returns a specific repetition of PSH-14: "Number of Product Experience Reports Filed by Distributor" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPsh14_NumberOfProductExperienceReportsFiledByDistributor

public NM getPsh14_NumberOfProductExperienceReportsFiledByDistributor(int rep)

Returns a specific repetition of PSH-14: "Number of Product Experience Reports Filed by Distributor" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPsh14_NumberOfProductExperienceReportsFiledByDistributorReps

public int getPsh14_NumberOfProductExperienceReportsFiledByDistributorReps()

Returns a count of the current number of repetitions of Number of Product Experience Reports Filed by Distributor (PSH-14). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertNumberOfProductExperienceReportsFiledByDistributor

public NM insertNumberOfProductExperienceReportsFiledByDistributor(int rep)
                                                            throws HL7Exception

Inserts a repetition of PSH-14: "Number of Product Experience Reports Filed by Distributor" 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)

insertPsh14_NumberOfProductExperienceReportsFiledByDistributor

public NM insertPsh14_NumberOfProductExperienceReportsFiledByDistributor(int rep)
                                                                  throws HL7Exception

Inserts a repetition of PSH-14: "Number of Product Experience Reports Filed by Distributor" 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)

removeNumberOfProductExperienceReportsFiledByDistributor

public NM removeNumberOfProductExperienceReportsFiledByDistributor(int rep)
                                                            throws HL7Exception

Removes a repetition of PSH-14: "Number of Product Experience Reports Filed by Distributor" 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)

removePsh14_NumberOfProductExperienceReportsFiledByDistributor

public NM removePsh14_NumberOfProductExperienceReportsFiledByDistributor(int rep)
                                                                  throws HL7Exception

Removes a repetition of PSH-14: "Number of Product Experience Reports Filed by Distributor" 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