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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class PDA
extends AbstractSegment

Represents an HL7 PDA message segment (Patient death and autopsy). This segment has the following fields:

• PDA-1: Death Cause Code (CE) optional repeating
• PDA-2: Death Location (PL) optional
• PDA-3: Death Certified Indicator (ID) optional
• PDA-4: Death Certificate Signed Date/Time (TS) optional
• PDA-5: Death Certified By (XCN) optional
• PDA-6: Autopsy Indicator (ID) optional
• PDA-7: Autopsy Start and End Date/Time (DR) optional
• PDA-8: Autopsy Performed By (XCN) optional
• PDA-9: Coroner Indicator (ID) optional

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
ID	getAutopsyIndicator() Returns PDA-6: "Autopsy Indicator" - creates it if necessary
XCN	getAutopsyPerformedBy() Returns PDA-8: "Autopsy Performed By" - creates it if necessary
DR	getAutopsyStartAndEndDateTime() Returns PDA-7: "Autopsy Start and End Date/Time" - creates it if necessary
ID	getCoronerIndicator() Returns PDA-9: "Coroner Indicator" - creates it if necessary
CE[]	getDeathCauseCode() Returns all repetitions of Death Cause Code (PDA-1).
CE	getDeathCauseCode(int rep) Returns a specific repetition of PDA-1: "Death Cause Code" - creates it if necessary
int	getDeathCauseCodeReps() Returns a count of the current number of repetitions of Death Cause Code (PDA-1).
TS	getDeathCertificateSignedDateTime() Returns PDA-4: "Death Certificate Signed Date/Time" - creates it if necessary
XCN	getDeathCertifiedBy() Returns PDA-5: "Death Certified By" - creates it if necessary
ID	getDeathCertifiedIndicator() Returns PDA-3: "Death Certified Indicator" - creates it if necessary
PL	getDeathLocation() Returns PDA-2: "Death Location" - creates it if necessary
CE	getPda1_DeathCauseCode(int rep) Returns a specific repetition of PDA-1: "Death Cause Code" - creates it if necessary
int	getPda1_DeathCauseCodeReps() Returns a count of the current number of repetitions of Death Cause Code (PDA-1).
PL	getPda2_DeathLocation() Returns PDA-2: "Death Location" - creates it if necessary
ID	getPda3_DeathCertifiedIndicator() Returns PDA-3: "Death Certified Indicator" - creates it if necessary
TS	getPda4_DeathCertificateSignedDateTime() Returns PDA-4: "Death Certificate Signed Date/Time" - creates it if necessary
XCN	getPda5_DeathCertifiedBy() Returns PDA-5: "Death Certified By" - creates it if necessary
ID	getPda6_AutopsyIndicator() Returns PDA-6: "Autopsy Indicator" - creates it if necessary
DR	getPda7_AutopsyStartAndEndDateTime() Returns PDA-7: "Autopsy Start and End Date/Time" - creates it if necessary
XCN	getPda8_AutopsyPerformedBy() Returns PDA-8: "Autopsy Performed By" - creates it if necessary
ID	getPda9_CoronerIndicator() Returns PDA-9: "Coroner Indicator" - creates it if necessary
CE	insertDeathCauseCode(int rep) Inserts a repetition of PDA-1: "Death Cause Code" at a specific index
CE	insertPda1_DeathCauseCode(int rep) Inserts a repetition of PDA-1: "Death Cause Code" at a specific index
CE	removeDeathCauseCode(int rep) Removes a repetition of PDA-1: "Death Cause Code" at a specific index
CE	removePda1_DeathCauseCode(int rep) Removes a repetition of PDA-1: "Death Cause 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

PDA

public PDA(Group parent,
           ModelClassFactory factory)

Creates a new PDA segment

Method Detail

getDeathCauseCode

public CE[] getDeathCauseCode()

Returns all repetitions of Death Cause Code (PDA-1).

getDeathCauseCodeReps

public int getDeathCauseCodeReps()

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

getDeathCauseCode

public CE getDeathCauseCode(int rep)

Returns a specific repetition of PDA-1: "Death Cause Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPda1_DeathCauseCode

public CE getPda1_DeathCauseCode(int rep)

Returns a specific repetition of PDA-1: "Death Cause Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getPda1_DeathCauseCodeReps

public int getPda1_DeathCauseCodeReps()

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

insertDeathCauseCode

public CE insertDeathCauseCode(int rep)
                        throws HL7Exception

Inserts a repetition of PDA-1: "Death Cause 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)

insertPda1_DeathCauseCode

public CE insertPda1_DeathCauseCode(int rep)
                             throws HL7Exception

Inserts a repetition of PDA-1: "Death Cause 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)

removeDeathCauseCode

public CE removeDeathCauseCode(int rep)
                        throws HL7Exception

Removes a repetition of PDA-1: "Death Cause 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)

removePda1_DeathCauseCode

public CE removePda1_DeathCauseCode(int rep)
                             throws HL7Exception

Removes a repetition of PDA-1: "Death Cause 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)

getDeathLocation

public PL getDeathLocation()

Returns PDA-2: "Death Location" - creates it if necessary

getPda2_DeathLocation

public PL getPda2_DeathLocation()

Returns PDA-2: "Death Location" - creates it if necessary

getDeathCertifiedIndicator

public ID getDeathCertifiedIndicator()

Returns PDA-3: "Death Certified Indicator" - creates it if necessary

getPda3_DeathCertifiedIndicator

public ID getPda3_DeathCertifiedIndicator()

Returns PDA-3: "Death Certified Indicator" - creates it if necessary

getDeathCertificateSignedDateTime

public TS getDeathCertificateSignedDateTime()

Returns PDA-4: "Death Certificate Signed Date/Time" - creates it if necessary

getPda4_DeathCertificateSignedDateTime

public TS getPda4_DeathCertificateSignedDateTime()

Returns PDA-4: "Death Certificate Signed Date/Time" - creates it if necessary

getDeathCertifiedBy

public XCN getDeathCertifiedBy()

Returns PDA-5: "Death Certified By" - creates it if necessary

getPda5_DeathCertifiedBy

public XCN getPda5_DeathCertifiedBy()

Returns PDA-5: "Death Certified By" - creates it if necessary

getAutopsyIndicator

public ID getAutopsyIndicator()

Returns PDA-6: "Autopsy Indicator" - creates it if necessary

getPda6_AutopsyIndicator

public ID getPda6_AutopsyIndicator()

Returns PDA-6: "Autopsy Indicator" - creates it if necessary

getAutopsyStartAndEndDateTime

public DR getAutopsyStartAndEndDateTime()

Returns PDA-7: "Autopsy Start and End Date/Time" - creates it if necessary

getPda7_AutopsyStartAndEndDateTime

public DR getPda7_AutopsyStartAndEndDateTime()

Returns PDA-7: "Autopsy Start and End Date/Time" - creates it if necessary

getAutopsyPerformedBy

public XCN getAutopsyPerformedBy()

Returns PDA-8: "Autopsy Performed By" - creates it if necessary

getPda8_AutopsyPerformedBy

public XCN getPda8_AutopsyPerformedBy()

Returns PDA-8: "Autopsy Performed By" - creates it if necessary

getCoronerIndicator

public ID getCoronerIndicator()

Returns PDA-9: "Coroner Indicator" - creates it if necessary

getPda9_CoronerIndicator

public ID getPda9_CoronerIndicator()

Returns PDA-9: "Coroner Indicator" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment