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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class IAM
extends AbstractSegment

Represents an HL7 IAM message segment (Patient adverse reaction information - unique iden). This segment has the following fields:

• IAM-1: Set ID - IAM (SI)
• IAM-2: Allergen Type Code (CE) optional
• IAM-3: Allergen Code/Mnemonic/Description (CE)
• IAM-4: Allergy Severity Code (CE) optional
• IAM-5: Allergy Reaction Code (ST) optional repeating
• IAM-6: Allergy Action Code (CNE)
• IAM-7: Allergy Unique Identifier (EI)
• IAM-8: Action Reason (ST) optional
• IAM-9: Sensitivity to Causative Agent Code (CE) optional
• IAM-10: Allergen Group Code/Mnemonic/Description (CE) optional
• IAM-11: Onset Date (DT) optional
• IAM-12: Onset Date Text (ST) optional
• IAM-13: Reported Date/Time (TS) optional
• IAM-14: Reported By (XPN) optional
• IAM-15: Relationship to Patient Code (CE) optional
• IAM-16: Alert Device Code (CE) optional
• IAM-17: Allergy Clinical Status Code (CE) optional
• IAM-18: Statused by Person (XCN) optional
• IAM-19: Statused by Organization (XON) optional
• IAM-20: Statused at Date/Time (TS) optional

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
ST	getActionReason() Returns IAM-8: "Action Reason" - creates it if necessary
CE	getAlertDeviceCode() Returns IAM-16: "Alert Device Code" - creates it if necessary
CE	getAllergenCodeMnemonicDescription() Returns IAM-3: "Allergen Code/Mnemonic/Description" - creates it if necessary
CE	getAllergenGroupCodeMnemonicDescription() Returns IAM-10: "Allergen Group Code/Mnemonic/Description" - creates it if necessary
CE	getAllergenTypeCode() Returns IAM-2: "Allergen Type Code" - creates it if necessary
CNE	getAllergyActionCode() Returns IAM-6: "Allergy Action Code" - creates it if necessary
CE	getAllergyClinicalStatusCode() Returns IAM-17: "Allergy Clinical Status Code" - creates it if necessary
ST[]	getAllergyReactionCode() Returns all repetitions of Allergy Reaction Code (IAM-5).
ST	getAllergyReactionCode(int rep) Returns a specific repetition of IAM-5: "Allergy Reaction Code" - creates it if necessary
int	getAllergyReactionCodeReps() Returns a count of the current number of repetitions of Allergy Reaction Code (IAM-5).
CE	getAllergySeverityCode() Returns IAM-4: "Allergy Severity Code" - creates it if necessary
EI	getAllergyUniqueIdentifier() Returns IAM-7: "Allergy Unique Identifier" - creates it if necessary
SI	getIam1_SetIDIAM() Returns IAM-1: "Set ID - IAM" - creates it if necessary
CE	getIam10_AllergenGroupCodeMnemonicDescription() Returns IAM-10: "Allergen Group Code/Mnemonic/Description" - creates it if necessary
DT	getIam11_OnsetDate() Returns IAM-11: "Onset Date" - creates it if necessary
ST	getIam12_OnsetDateText() Returns IAM-12: "Onset Date Text" - creates it if necessary
TS	getIam13_ReportedDateTime() Returns IAM-13: "Reported Date/Time" - creates it if necessary
XPN	getIam14_ReportedBy() Returns IAM-14: "Reported By" - creates it if necessary
CE	getIam15_RelationshipToPatientCode() Returns IAM-15: "Relationship to Patient Code" - creates it if necessary
CE	getIam16_AlertDeviceCode() Returns IAM-16: "Alert Device Code" - creates it if necessary
CE	getIam17_AllergyClinicalStatusCode() Returns IAM-17: "Allergy Clinical Status Code" - creates it if necessary
XCN	getIam18_StatusedByPerson() Returns IAM-18: "Statused by Person" - creates it if necessary
XON	getIam19_StatusedByOrganization() Returns IAM-19: "Statused by Organization" - creates it if necessary
CE	getIam2_AllergenTypeCode() Returns IAM-2: "Allergen Type Code" - creates it if necessary
TS	getIam20_StatusedAtDateTime() Returns IAM-20: "Statused at Date/Time" - creates it if necessary
CE	getIam3_AllergenCodeMnemonicDescription() Returns IAM-3: "Allergen Code/Mnemonic/Description" - creates it if necessary
CE	getIam4_AllergySeverityCode() Returns IAM-4: "Allergy Severity Code" - creates it if necessary
ST	getIam5_AllergyReactionCode(int rep) Returns a specific repetition of IAM-5: "Allergy Reaction Code" - creates it if necessary
int	getIam5_AllergyReactionCodeReps() Returns a count of the current number of repetitions of Allergy Reaction Code (IAM-5).
CNE	getIam6_AllergyActionCode() Returns IAM-6: "Allergy Action Code" - creates it if necessary
EI	getIam7_AllergyUniqueIdentifier() Returns IAM-7: "Allergy Unique Identifier" - creates it if necessary
ST	getIam8_ActionReason() Returns IAM-8: "Action Reason" - creates it if necessary
CE	getIam9_SensitivityToCausativeAgentCode() Returns IAM-9: "Sensitivity to Causative Agent Code" - creates it if necessary
DT	getOnsetDate() Returns IAM-11: "Onset Date" - creates it if necessary
ST	getOnsetDateText() Returns IAM-12: "Onset Date Text" - creates it if necessary
CE	getRelationshipToPatientCode() Returns IAM-15: "Relationship to Patient Code" - creates it if necessary
XPN	getReportedBy() Returns IAM-14: "Reported By" - creates it if necessary
TS	getReportedDateTime() Returns IAM-13: "Reported Date/Time" - creates it if necessary
CE	getSensitivityToCausativeAgentCode() Returns IAM-9: "Sensitivity to Causative Agent Code" - creates it if necessary
SI	getSetIDIAM() Returns IAM-1: "Set ID - IAM" - creates it if necessary
TS	getStatusedAtDateTime() Returns IAM-20: "Statused at Date/Time" - creates it if necessary
XON	getStatusedByOrganization() Returns IAM-19: "Statused by Organization" - creates it if necessary
XCN	getStatusedByPerson() Returns IAM-18: "Statused by Person" - creates it if necessary
ST	insertAllergyReactionCode(int rep) Inserts a repetition of IAM-5: "Allergy Reaction Code" at a specific index
ST	insertIam5_AllergyReactionCode(int rep) Inserts a repetition of IAM-5: "Allergy Reaction Code" at a specific index
ST	removeAllergyReactionCode(int rep) Removes a repetition of IAM-5: "Allergy Reaction Code" at a specific index
ST	removeIam5_AllergyReactionCode(int rep) Removes a repetition of IAM-5: "Allergy Reaction Code" 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

IAM

public IAM(Group parent,
           ModelClassFactory factory)

Creates a new IAM segment

Method Detail

getSetIDIAM

public SI getSetIDIAM()

Returns IAM-1: "Set ID - IAM" - creates it if necessary

getIam1_SetIDIAM

public SI getIam1_SetIDIAM()

Returns IAM-1: "Set ID - IAM" - creates it if necessary

getAllergenTypeCode

public CE getAllergenTypeCode()

Returns IAM-2: "Allergen Type Code" - creates it if necessary

getIam2_AllergenTypeCode

public CE getIam2_AllergenTypeCode()

Returns IAM-2: "Allergen Type Code" - creates it if necessary

getAllergenCodeMnemonicDescription

public CE getAllergenCodeMnemonicDescription()

Returns IAM-3: "Allergen Code/Mnemonic/Description" - creates it if necessary

getIam3_AllergenCodeMnemonicDescription

public CE getIam3_AllergenCodeMnemonicDescription()

Returns IAM-3: "Allergen Code/Mnemonic/Description" - creates it if necessary

getAllergySeverityCode

public CE getAllergySeverityCode()

Returns IAM-4: "Allergy Severity Code" - creates it if necessary

getIam4_AllergySeverityCode

public CE getIam4_AllergySeverityCode()

Returns IAM-4: "Allergy Severity Code" - creates it if necessary

getAllergyReactionCode

public ST[] getAllergyReactionCode()

Returns all repetitions of Allergy Reaction Code (IAM-5).

getAllergyReactionCodeReps

public int getAllergyReactionCodeReps()

Returns a count of the current number of repetitions of Allergy Reaction Code (IAM-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getAllergyReactionCode

public ST getAllergyReactionCode(int rep)

Returns a specific repetition of IAM-5: "Allergy Reaction Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getIam5_AllergyReactionCode

public ST getIam5_AllergyReactionCode(int rep)

Returns a specific repetition of IAM-5: "Allergy Reaction Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getIam5_AllergyReactionCodeReps

public int getIam5_AllergyReactionCodeReps()

Returns a count of the current number of repetitions of Allergy Reaction Code (IAM-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertAllergyReactionCode

public ST insertAllergyReactionCode(int rep)
                             throws HL7Exception

Inserts a repetition of IAM-5: "Allergy Reaction 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)

insertIam5_AllergyReactionCode

public ST insertIam5_AllergyReactionCode(int rep)
                                  throws HL7Exception

Inserts a repetition of IAM-5: "Allergy Reaction 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)

removeAllergyReactionCode

public ST removeAllergyReactionCode(int rep)
                             throws HL7Exception

Removes a repetition of IAM-5: "Allergy Reaction 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)

removeIam5_AllergyReactionCode

public ST removeIam5_AllergyReactionCode(int rep)
                                  throws HL7Exception

Removes a repetition of IAM-5: "Allergy Reaction 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)

getAllergyActionCode

public CNE getAllergyActionCode()

Returns IAM-6: "Allergy Action Code" - creates it if necessary

getIam6_AllergyActionCode

public CNE getIam6_AllergyActionCode()

Returns IAM-6: "Allergy Action Code" - creates it if necessary

getAllergyUniqueIdentifier

public EI getAllergyUniqueIdentifier()

Returns IAM-7: "Allergy Unique Identifier" - creates it if necessary

getIam7_AllergyUniqueIdentifier

public EI getIam7_AllergyUniqueIdentifier()

Returns IAM-7: "Allergy Unique Identifier" - creates it if necessary

getActionReason

public ST getActionReason()

Returns IAM-8: "Action Reason" - creates it if necessary

getIam8_ActionReason

public ST getIam8_ActionReason()

Returns IAM-8: "Action Reason" - creates it if necessary

getSensitivityToCausativeAgentCode

public CE getSensitivityToCausativeAgentCode()

Returns IAM-9: "Sensitivity to Causative Agent Code" - creates it if necessary

getIam9_SensitivityToCausativeAgentCode

public CE getIam9_SensitivityToCausativeAgentCode()

Returns IAM-9: "Sensitivity to Causative Agent Code" - creates it if necessary

getAllergenGroupCodeMnemonicDescription

public CE getAllergenGroupCodeMnemonicDescription()

Returns IAM-10: "Allergen Group Code/Mnemonic/Description" - creates it if necessary

getIam10_AllergenGroupCodeMnemonicDescription

public CE getIam10_AllergenGroupCodeMnemonicDescription()

Returns IAM-10: "Allergen Group Code/Mnemonic/Description" - creates it if necessary

getOnsetDate

public DT getOnsetDate()

Returns IAM-11: "Onset Date" - creates it if necessary

getIam11_OnsetDate

public DT getIam11_OnsetDate()

Returns IAM-11: "Onset Date" - creates it if necessary

getOnsetDateText

public ST getOnsetDateText()

Returns IAM-12: "Onset Date Text" - creates it if necessary

getIam12_OnsetDateText

public ST getIam12_OnsetDateText()

Returns IAM-12: "Onset Date Text" - creates it if necessary

getReportedDateTime

public TS getReportedDateTime()

Returns IAM-13: "Reported Date/Time" - creates it if necessary

getIam13_ReportedDateTime

public TS getIam13_ReportedDateTime()

Returns IAM-13: "Reported Date/Time" - creates it if necessary

getReportedBy

public XPN getReportedBy()

Returns IAM-14: "Reported By" - creates it if necessary

getIam14_ReportedBy

public XPN getIam14_ReportedBy()

Returns IAM-14: "Reported By" - creates it if necessary

getRelationshipToPatientCode

public CE getRelationshipToPatientCode()

Returns IAM-15: "Relationship to Patient Code" - creates it if necessary

getIam15_RelationshipToPatientCode

public CE getIam15_RelationshipToPatientCode()

Returns IAM-15: "Relationship to Patient Code" - creates it if necessary

getAlertDeviceCode

public CE getAlertDeviceCode()

Returns IAM-16: "Alert Device Code" - creates it if necessary

getIam16_AlertDeviceCode

public CE getIam16_AlertDeviceCode()

Returns IAM-16: "Alert Device Code" - creates it if necessary

getAllergyClinicalStatusCode

public CE getAllergyClinicalStatusCode()

Returns IAM-17: "Allergy Clinical Status Code" - creates it if necessary

getIam17_AllergyClinicalStatusCode

public CE getIam17_AllergyClinicalStatusCode()

Returns IAM-17: "Allergy Clinical Status Code" - creates it if necessary

getStatusedByPerson

public XCN getStatusedByPerson()

Returns IAM-18: "Statused by Person" - creates it if necessary

getIam18_StatusedByPerson

public XCN getIam18_StatusedByPerson()

Returns IAM-18: "Statused by Person" - creates it if necessary

getStatusedByOrganization

public XON getStatusedByOrganization()

Returns IAM-19: "Statused by Organization" - creates it if necessary

getIam19_StatusedByOrganization

public XON getIam19_StatusedByOrganization()

Returns IAM-19: "Statused by Organization" - creates it if necessary

getStatusedAtDateTime

public TS getStatusedAtDateTime()

Returns IAM-20: "Statused at Date/Time" - creates it if necessary

getIam20_StatusedAtDateTime

public TS getIam20_StatusedAtDateTime()

Returns IAM-20: "Statused at Date/Time" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment