Package ca.uhn.hl7v2.model.v22.segment

Class RXA

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v22.segment.RXA

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable

public class RXA
extends AbstractSegment

Represents an HL7 RXA message segment (PHARMACY AADMINISTRATION). This segment has the following fields:

• RXA-1: Give Sub-ID Counter (NM)
• RXA-2: Administration Sub-ID Counter (NM)
• RXA-3: Date / time start of administration (TS)
• RXA-4: Date / time end of administration (TS)
• RXA-5: Administered Code (CE)
• RXA-6: Administered Amount (NM)
• RXA-7: Administered Units (CE) optional
• RXA-8: Administered Dosage Form (CE) optional
• RXA-9: Administration Notes (ST) optional
• RXA-10: Administering Provider (CN) optional
• RXA-11: Administered-at Location (CM_LA1) optional
• RXA-12: Administered Per (Time Unit) (ST) optional

See Also:

• Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor	Description
RXA(Group parent, ModelClassFactory factory)	Creates a new RXA segment

Method Summary

Modifier and Type	Method	Description
protected Type	createNewTypeWithoutReflection(int field)
NM	getAdministeredAmount()	Returns RXA-6: "Administered Amount" - creates it if necessary
CM_LA1	getAdministeredAtLocation()	Returns RXA-11: "Administered-at Location" - creates it if necessary
CE	getAdministeredCode()	Returns RXA-5: "Administered Code" - creates it if necessary
CE	getAdministeredDosageForm()	Returns RXA-8: "Administered Dosage Form" - creates it if necessary
ST	getAdministeredPerTimeUnit()	Returns RXA-12: "Administered Per (Time Unit)" - creates it if necessary
CE	getAdministeredUnits()	Returns RXA-7: "Administered Units" - creates it if necessary
CN	getAdministeringProvider()	Returns RXA-10: "Administering Provider" - creates it if necessary
ST	getAdministrationNotes()	Returns RXA-9: "Administration Notes" - creates it if necessary
NM	getAdministrationSubIDCounter()	Returns RXA-2: "Administration Sub-ID Counter" - creates it if necessary
TS	getDateTimeEndOfAdministration()	Returns RXA-4: "Date / time end of administration" - creates it if necessary
TS	getDateTimeStartOfAdministration()	Returns RXA-3: "Date / time start of administration" - creates it if necessary
NM	getGiveSubIDCounter()	Returns RXA-1: "Give Sub-ID Counter" - creates it if necessary
NM	getRxa1_GiveSubIDCounter()	Returns RXA-1: "Give Sub-ID Counter" - creates it if necessary
CN	getRxa10_AdministeringProvider()	Returns RXA-10: "Administering Provider" - creates it if necessary
CM_LA1	getRxa11_AdministeredAtLocation()	Returns RXA-11: "Administered-at Location" - creates it if necessary
ST	getRxa12_AdministeredPerTimeUnit()	Returns RXA-12: "Administered Per (Time Unit)" - creates it if necessary
NM	getRxa2_AdministrationSubIDCounter()	Returns RXA-2: "Administration Sub-ID Counter" - creates it if necessary
TS	getRxa3_DateTimeStartOfAdministration()	Returns RXA-3: "Date / time start of administration" - creates it if necessary
TS	getRxa4_DateTimeEndOfAdministration()	Returns RXA-4: "Date / time end of administration" - creates it if necessary
CE	getRxa5_AdministeredCode()	Returns RXA-5: "Administered Code" - creates it if necessary
NM	getRxa6_AdministeredAmount()	Returns RXA-6: "Administered Amount" - creates it if necessary
CE	getRxa7_AdministeredUnits()	Returns RXA-7: "Administered Units" - creates it if necessary
CE	getRxa8_AdministeredDosageForm()	Returns RXA-8: "Administered Dosage Form" - creates it if necessary
ST	getRxa9_AdministrationNotes()	Returns RXA-9: "Administration Notes" - creates it if necessary

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

accept, add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isEmpty, isRequired, main, numFields, parse, provideLocation, removeRepetition

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

getMessage, getParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Details

RXA

public RXA(Group parent,
 ModelClassFactory factory)

Creates a new RXA segment

Method Details

getGiveSubIDCounter

public NM getGiveSubIDCounter()

Returns RXA-1: "Give Sub-ID Counter" - creates it if necessary

getRxa1_GiveSubIDCounter

public NM getRxa1_GiveSubIDCounter()

Returns RXA-1: "Give Sub-ID Counter" - creates it if necessary

getAdministrationSubIDCounter

public NM getAdministrationSubIDCounter()

Returns RXA-2: "Administration Sub-ID Counter" - creates it if necessary

getRxa2_AdministrationSubIDCounter

public NM getRxa2_AdministrationSubIDCounter()

Returns RXA-2: "Administration Sub-ID Counter" - creates it if necessary

getDateTimeStartOfAdministration

public TS getDateTimeStartOfAdministration()

Returns RXA-3: "Date / time start of administration" - creates it if necessary

getRxa3_DateTimeStartOfAdministration

public TS getRxa3_DateTimeStartOfAdministration()

Returns RXA-3: "Date / time start of administration" - creates it if necessary

getDateTimeEndOfAdministration

public TS getDateTimeEndOfAdministration()

Returns RXA-4: "Date / time end of administration" - creates it if necessary

getRxa4_DateTimeEndOfAdministration

public TS getRxa4_DateTimeEndOfAdministration()

Returns RXA-4: "Date / time end of administration" - creates it if necessary

getAdministeredCode

public CE getAdministeredCode()

Returns RXA-5: "Administered Code" - creates it if necessary

getRxa5_AdministeredCode

public CE getRxa5_AdministeredCode()

Returns RXA-5: "Administered Code" - creates it if necessary

getAdministeredAmount

public NM getAdministeredAmount()

Returns RXA-6: "Administered Amount" - creates it if necessary

getRxa6_AdministeredAmount

public NM getRxa6_AdministeredAmount()

Returns RXA-6: "Administered Amount" - creates it if necessary

getAdministeredUnits

public CE getAdministeredUnits()

Returns RXA-7: "Administered Units" - creates it if necessary

getRxa7_AdministeredUnits

public CE getRxa7_AdministeredUnits()

Returns RXA-7: "Administered Units" - creates it if necessary

getAdministeredDosageForm

public CE getAdministeredDosageForm()

Returns RXA-8: "Administered Dosage Form" - creates it if necessary

getRxa8_AdministeredDosageForm

public CE getRxa8_AdministeredDosageForm()

Returns RXA-8: "Administered Dosage Form" - creates it if necessary

getAdministrationNotes

public ST getAdministrationNotes()

Returns RXA-9: "Administration Notes" - creates it if necessary

getRxa9_AdministrationNotes

public ST getRxa9_AdministrationNotes()

Returns RXA-9: "Administration Notes" - creates it if necessary

getAdministeringProvider

public CN getAdministeringProvider()

Returns RXA-10: "Administering Provider" - creates it if necessary

getRxa10_AdministeringProvider

public CN getRxa10_AdministeringProvider()

Returns RXA-10: "Administering Provider" - creates it if necessary

getAdministeredAtLocation

public CM_LA1 getAdministeredAtLocation()

Returns RXA-11: "Administered-at Location" - creates it if necessary

getRxa11_AdministeredAtLocation

public CM_LA1 getRxa11_AdministeredAtLocation()

Returns RXA-11: "Administered-at Location" - creates it if necessary

getAdministeredPerTimeUnit

public ST getAdministeredPerTimeUnit()

Returns RXA-12: "Administered Per (Time Unit)" - creates it if necessary

getRxa12_AdministeredPerTimeUnit

public ST getRxa12_AdministeredPerTimeUnit()

Returns RXA-12: "Administered Per (Time Unit)" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment