Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

HS.SDA3.DosageStep

serial class HS.SDA3.DosageStep extends HS.SDA3.SuperClass

This class represents each dosage step for a Medication or Vaccination.
There may be only one step, where the drug is prescribed with just one
dosage, or there can be several steps, such 20mg QID for 3 days, then 10mg
BID for 5 days. DosageSteps are captured in snapshot mode. This means that
any time DosageSteps are passed in for a Medication or Vaccination, the
existing list is cleared before the inbound DosageSteps are saved.

Property Inventory

Properties

property ActionCode as %String (XMLIO = "OUT");

Not used.

Property methods: ActionCodeDisplayToLogical(), ActionCodeGet(), ActionCodeIsValid(), ActionCodeLogicalToDisplay(), ActionCodeLogicalToOdbc(), ActionCodeNormalize(), ActionCodeSet()

property ActionScope as %String;

Not used.

Property methods: ActionScopeDisplayToLogical(), ActionScopeGet(), ActionScopeIsValid(), ActionScopeLogicalToDisplay(), ActionScopeLogicalToOdbc(), ActionScopeNormalize(), ActionScopeSet()

property CodedInstruction as HS.SDA3.CodeTableDetail.Instruction;

Supplemental instruction or warnings to the patient

Property methods: CodedInstructionGet(), CodedInstructionGetObject(), CodedInstructionGetObjectId(), CodedInstructionGetSwizzled(), CodedInstructionIsEmpty(), CodedInstructionIsValid(), CodedInstructionNewObject(), CodedInstructionSet(), CodedInstructionSetObject(), CodedInstructionSetObjectId(), CodedInstructionUnSwizzle()

property ConditionText as %String);

Free text that describes the conditions under which the
drug is to be given.
HL7: TQ1-10 : ConditionText

Property methods: ConditionTextDisplayToLogical(), ConditionTextGet(), ConditionTextIsValid(), ConditionTextLogicalToDisplay(), ConditionTextLogicalToOdbc(), ConditionTextNormalize(), ConditionTextSet()

property Conjunction as %String);

Indicates that a second TQ1 segment is to follow Allowed values
are A = Asynchronous, C = Actuation Time, S = Synchronous.
If the TQ1 segment is repeated in the message, this field must be
populated with the appropriate Conjunction code indicating the
sequencing of the following TQ1 segment.
HL7: TQ1-12 : Conjunction

Property methods: ConjunctionDisplayToLogical(), ConjunctionGet(), ConjunctionIsValid(), ConjunctionLogicalToDisplay(), ConjunctionLogicalToOdbc(), ConjunctionNormalize(), ConjunctionSet()

property DoseQuantity as HS.SDA3.Numeric;

Size of dose (e.g. the 20 in 20mg)

Viewer cache:
OEORIDoseQty is also where the DoseQuantity of the parent order is stored.
However, if the DoseQuantity of the first DosageStep in the list is not
null, it will overwrite this value.

HL7: TQ1-2.1 : Quantity.Quantity
VIEWERLIB: User.HS.OEOrdItem(OEORIDoseQty)
VIEWERLIB: User.HS.OEOrdItem(ChildOEOrdExec)->User.HS.OEOrdExec(OEOREPhQtyOrd)

Property methods: DoseQuantityDisplayToLogical(), DoseQuantityGet(), DoseQuantityIsValid(), DoseQuantityLogicalToDisplay(), DoseQuantityNormalize(), DoseQuantitySet(), DoseQuantityXSDToLogical()

property DoseUoM as HS.SDA3.CodeTableDetail.UoM;

Units for DoseQuantity (e.g. the mg in 20mg)

Viewer cache:
OEORIUnitDR is also where the DoseUoM of the parent order is stored.
However, if the DoseUoM of the first DosageStep in the list is not null, it
will overwrite this value.

HL7: TQ1-2.2 : Quantity.Units
SDATableName=UoM, ViewerClass=User.HS.CTUOM
VIEWERLIB: User.HS.OEOrdItem(OEORIUnitDR)
VIEWERLIB: User.HS.OEOrdItem(ChildOEOrdExec)->User.HS.OEOrdExec(OEORECTUOMDR)

Property methods: DoseUoMGet(), DoseUoMGetObject(), DoseUoMGetObjectId(), DoseUoMGetSwizzled(), DoseUoMIsEmpty(), DoseUoMIsValid(), DoseUoMNewObject(), DoseUoMSet(), DoseUoMSetObject(), DoseUoMSetObjectId(), DoseUoMUnSwizzle()

property Duration as HS.SDA3.CodeTableDetail.Duration;

Duration of the step (e.g. input could be start time and duration)

Viewer cache:
OEORIDuratDR is also where the Duration of the parent order is stored.
However if the Duration of the first DosageStep in the list is not null, it
will overwrite this value.

HL7: TQ1-6.1 : Service Duration.Quantity
SDATableName=Duration, ViewerClass=User.HS.PHCDuration
VIEWERLIB: User.HS.OEOrdItem(OEORIDuratDR)
VIEWERLIB: User.HS.OEOrdItem(ChildOEOrdExec)->User.HS.OEOrdExec(OEOREPHCDurationDR)

Property methods: DurationGet(), DurationGetObject(), DurationGetObjectId(), DurationGetSwizzled(), DurationIsEmpty(), DurationIsValid(), DurationNewObject(), DurationSet(), DurationSetObject(), DurationSetObjectId(), DurationUnSwizzle()

property DurationUOM as HS.SDA3.CodeTableDetail.UoM;

Units for Duration. HL7: TQ1-6.2 : Service Duration.Units

Property methods: DurationUOMGet(), DurationUOMGetObject(), DurationUOMGetObjectId(), DurationUOMGetSwizzled(), DurationUOMIsEmpty(), DurationUOMIsValid(), DurationUOMNewObject(), DurationUOMSet(), DurationUOMSetObject(), DurationUOMSetObjectId(), DurationUOMUnSwizzle()

property EncounterNumber as %String (MAXLEN = 220);

Number identifying encounter associated with this dosage step.

Property methods: EncounterNumberDisplayToLogical(), EncounterNumberGet(), EncounterNumberIsValid(), EncounterNumberLogicalToDisplay(), EncounterNumberLogicalToOdbc(), EncounterNumberNormalize(), EncounterNumberSet()

property EventTime as list of HS.SDA3.TimeStamp;

Lists times that the DosageStep event is to occur.

Property methods: EventTimeBuildValueArray(), EventTimeCollectionToDisplay(), EventTimeCollectionToOdbc(), EventTimeDisplayToCollection(), EventTimeDisplayToLogical(), EventTimeGet(), EventTimeGetObject(), EventTimeGetObjectId(), EventTimeGetSwizzled(), EventTimeIsValid(), EventTimeLogicalToDisplay(), EventTimeLogicalToTimeStamp(), EventTimeLogicalToXSD(), EventTimeNormalize(), EventTimeOdbcToCollection(), EventTimeOdbcToLogical(), EventTimeSet(), EventTimeSetObject(), EventTimeSetObjectId(), EventTimeXSDToLogical()

property ExplicitTimes as list of HS.SDA3.ExplicitTime;

Lists explicit times for service item.
HL7: TQ1-4 : Explicit Time

Property methods: ExplicitTimesBuildValueArray(), ExplicitTimesCollectionToDisplay(), ExplicitTimesCollectionToOdbc(), ExplicitTimesDisplayToCollection(), ExplicitTimesGet(), ExplicitTimesGetObject(), ExplicitTimesGetObjectId(), ExplicitTimesGetSwizzled(), ExplicitTimesIsValid(), ExplicitTimesOdbcToCollection(), ExplicitTimesSet(), ExplicitTimesSetObject(), ExplicitTimesSetObjectId()

property Extension as HS.Local.SDA3.DosageStepExtension;

Property methods: ExtensionGet(), ExtensionGetObject(), ExtensionGetObjectId(), ExtensionGetSwizzled(), ExtensionIsEmpty(), ExtensionIsValid(), ExtensionNewObject(), ExtensionSet(), ExtensionSetObject(), ExtensionSetObjectId(), ExtensionUnSwizzle()

property ExternalId as %String (MAXLEN = 220);

Identifier copied from the source system.

Property methods: ExternalIdDisplayToLogical(), ExternalIdGet(), ExternalIdIsValid(), ExternalIdLogicalToDisplay(), ExternalIdLogicalToOdbc(), ExternalIdNormalize(), ExternalIdSet()

property Frequency as HS.SDA3.CodeTableDetail.Frequency;

How often (e.g. Code=QID, Desc=QID, Factor=4)
QID is Latin, meaning 4x a day. BID means 2x day, etc.

Viewer cache:
OEORIPHFreqDR is also where the Frequency of the parent order is stored.
However, if the Frequency of the first DosageStep in the list is not null,
it will overwrite this value.

SDATableName=Frequency, ViewerClass=User.HS.PHCFreq
VIEWERLIB: User.HS.OEOrdItem(OEORIPHFreqDR)
VIEWERLIB: User.HS.OEOrdItem(ChildOEOrdExec)->User.HS.OEOrdExec(OEOREPHCFreqDR)

Property methods: FrequencyGet(), FrequencyGetObject(), FrequencyGetObjectId(), FrequencyGetSwizzled(), FrequencyIsEmpty(), FrequencyIsValid(), FrequencyNewObject(), FrequencySet(), FrequencySetObject(), FrequencySetObjectId(), FrequencyUnSwizzle()

property FromTime as HS.SDA3.TimeStamp;

The Start Date/Time of the step

Viewer cache:
OEORISttDat and OEORISttTim are where the FromTime of the parent order is
stored. However if the FromTime of the first DosageStep in the list is not
null, it will overwrite these values.

HL7: TQ1-7 : Start Date/Time
VIEWERLIB: User.HS.OEOrdItem(OEORISttDat) + User.HS.OEOrdItem(OEORISttTim)
VIEWERLIB: User.HS.OEOrdItem(ChildOEOrdExec)->User.HS.OEOrdExec(OEOREExSttDat)
VIEWERLIB: User.HS.OEOrdItem(ChildOEOrdExec)->User.HS.OEOrdExec(OEOREExSttTim)

Property methods: FromTimeDisplayToLogical(), FromTimeGet(), FromTimeIsValid(), FromTimeLogicalToDisplay(), FromTimeLogicalToTimeStamp(), FromTimeLogicalToXSD(), FromTimeNormalize(), FromTimeOdbcToLogical(), FromTimeSet(), FromTimeXSDToLogical()

property MaxDoseDenominator as HS.SDA3.Quantity;

The maximum dose denominator allowed for the dosage step.

Property methods: MaxDoseDenominatorGet(), MaxDoseDenominatorGetObject(), MaxDoseDenominatorGetObjectId(), MaxDoseDenominatorGetSwizzled(), MaxDoseDenominatorIsEmpty(), MaxDoseDenominatorIsValid(), MaxDoseDenominatorNewObject(), MaxDoseDenominatorSet(), MaxDoseDenominatorSetObject(), MaxDoseDenominatorSetObjectId(), MaxDoseDenominatorUnSwizzle()

property MaxDoseNumerator as HS.SDA3.Quantity;

The maximum dose numerator allowed for the dosage step.

Property methods: MaxDoseNumeratorGet(), MaxDoseNumeratorGetObject(), MaxDoseNumeratorGetObjectId(), MaxDoseNumeratorGetSwizzled(), MaxDoseNumeratorIsEmpty(), MaxDoseNumeratorIsValid(), MaxDoseNumeratorNewObject(), MaxDoseNumeratorSet(), MaxDoseNumeratorSetObject(), MaxDoseNumeratorSetObjectId(), MaxDoseNumeratorUnSwizzle()

property OccDurationQuantity as HS.SDA3.CodeTableDetail.Duration;

The duration for which a single performance of a service
is requested.
HL7: TQ1-13.1 : Occurence Duration.Quantity

Property methods: OccDurationQuantityGet(), OccDurationQuantityGetObject(), OccDurationQuantityGetObjectId(), OccDurationQuantityGetSwizzled(), OccDurationQuantityIsEmpty(), OccDurationQuantityIsValid(), OccDurationQuantityNewObject(), OccDurationQuantitySet(), OccDurationQuantitySetObject(), OccDurationQuantitySetObjectId(), OccDurationQuantityUnSwizzle()

property OccDurationUOM as HS.SDA3.CodeTableDetail.UoM;

The units for the occurrence duration quantity. HL7: TQ1-13.2 : Occurence Duration.Units

Property methods: OccDurationUOMGet(), OccDurationUOMGetObject(), OccDurationUOMGetObjectId(), OccDurationUOMGetSwizzled(), OccDurationUOMIsEmpty(), OccDurationUOMIsValid(), OccDurationUOMNewObject(), OccDurationUOMSet(), OccDurationUOMSetObject(), OccDurationUOMSetObjectId(), OccDurationUOMUnSwizzle()

property PatientInstruction as %String);

Patient or consumer oriented instructions

Property methods: PatientInstructionDisplayToLogical(), PatientInstructionGet(), PatientInstructionIsValid(), PatientInstructionLogicalToDisplay(), PatientInstructionLogicalToOdbc(), PatientInstructionNormalize(), PatientInstructionSet()

property Priorities as list of HS.SDA3.CodeTableDetail.Priority;

The urgency of the request.
HL7: TQ1-9 : Priority

Property methods: PrioritiesBuildValueArray(), PrioritiesCollectionToDisplay(), PrioritiesCollectionToOdbc(), PrioritiesDisplayToCollection(), PrioritiesGet(), PrioritiesGetObject(), PrioritiesGetObjectId(), PrioritiesGetSwizzled(), PrioritiesIsValid(), PrioritiesOdbcToCollection(), PrioritiesSet(), PrioritiesSetObject(), PrioritiesSetObjectId()

property RateQuantity as HS.SDA3.Numeric;

The amount of medication per unit of time.

Property methods: RateQuantityDisplayToLogical(), RateQuantityGet(), RateQuantityIsValid(), RateQuantityLogicalToDisplay(), RateQuantityNormalize(), RateQuantitySet(), RateQuantityXSDToLogical()

property RateUoM as HS.SDA3.CodeTableDetail.UoM;

The units for the rate quantity.

Property methods: RateUoMGet(), RateUoMGetObject(), RateUoMGetObjectId(), RateUoMGetSwizzled(), RateUoMIsEmpty(), RateUoMIsValid(), RateUoMNewObject(), RateUoMSet(), RateUoMSetObject(), RateUoMSetObjectId(), RateUoMUnSwizzle()

property RelativeTimes as list of HS.SDA3.RelativeTime;

The interval between schedules for service request
or bottle records. If relative time is present, it
should override explicit time.
HL7: TQ1-5 : Relative Time

Property methods: RelativeTimesBuildValueArray(), RelativeTimesCollectionToDisplay(), RelativeTimesCollectionToOdbc(), RelativeTimesDisplayToCollection(), RelativeTimesGet(), RelativeTimesGetObject(), RelativeTimesGetObjectId(), RelativeTimesGetSwizzled(), RelativeTimesIsValid(), RelativeTimesOdbcToCollection(), RelativeTimesSet(), RelativeTimesSetObject(), RelativeTimesSetObjectId()

property RepeatOffset as HS.SDA3.Numeric;

The offset for repeat dosages.

Property methods: RepeatOffsetDisplayToLogical(), RepeatOffsetGet(), RepeatOffsetIsValid(), RepeatOffsetLogicalToDisplay(), RepeatOffsetNormalize(), RepeatOffsetSet(), RepeatOffsetXSDToLogical()

property RepeatTiming as HS.SDA3.CodeTableDetail.EventTiming;

Indicates the timing of repeat dosages.

Property methods: RepeatTimingGet(), RepeatTimingGetObject(), RepeatTimingGetObjectId(), RepeatTimingGetSwizzled(), RepeatTimingIsEmpty(), RepeatTimingIsValid(), RepeatTimingNewObject(), RepeatTimingSet(), RepeatTimingSetObject(), RepeatTimingSetObjectId(), RepeatTimingUnSwizzle()

property Route as HS.SDA3.CodeTableDetail.Route;

How dosage drug should enter the body.

Property methods: RouteGet(), RouteGetObject(), RouteGetObjectId(), RouteGetSwizzled(), RouteIsEmpty(), RouteIsValid(), RouteNewObject(), RouteSet(), RouteSetObject(), RouteSetObjectId(), RouteUnSwizzle()

property Sequence as HS.SDA3.Numeric;

Used to indicate concurrency of dosing based on Conjunction

Property methods: SequenceDisplayToLogical(), SequenceGet(), SequenceIsValid(), SequenceLogicalToDisplay(), SequenceNormalize(), SequenceSet(), SequenceXSDToLogical()

property Site as HS.SDA3.CodeTableDetail.BodyPart;

The site on the body where the drug is to be administered.

Property methods: SiteGet(), SiteGetObject(), SiteGetObjectId(), SiteGetSwizzled(), SiteIsEmpty(), SiteIsValid(), SiteNewObject(), SiteSet(), SiteSetObject(), SiteSetObjectId(), SiteUnSwizzle()

property TextInstruction as %String);

Text instructions/directions
Length subject to the total streamlet size limit - 3,000,000

Viewer cache:
OEORIDepProcNotes is also where the TextInstruction of the parent order is
stored. However, if the TextInstruction of the first DosageStep in the list
is not null, it will overwrite this value.

VIEWERLIB: User.HS.OEOrdItem(OEORIDepProcNotes)
VIEWERLIB: User.HS.OEOrdItem(ChildOEOrdExec)->User.HS.OEOrdExec(OEOREDesc)

Property methods: TextInstructionDisplayToLogical(), TextInstructionGet(), TextInstructionIsValid(), TextInstructionLogicalToDisplay(), TextInstructionLogicalToOdbc(), TextInstructionNormalize(), TextInstructionSet()

property ToTime as HS.SDA3.TimeStamp;

The End Date/Time of the step

Viewer cache:
OEORIEndDat and OEORIEndTim are where the ToTime of the parent order is
stored. However if the ToTime of the first DosageStep in the list is not
null, it will overwrite these values.

HL7: TQ1-8 : End Date/Time
VIEWERLIB: User.HS.OEOrdItem(OEORIEndDat) + User.HS.OEOrdItem(OEORIEndTim)
VIEWERLIB: User.HS.OEOrdItem(ChildOEOrdExec)->User.HS.OEOrdExec(OEOREExEnDat)
VIEWERLIB: User.HS.OEOrdItem(ChildOEOrdExec)->User.HS.OEOrdExec(OEOREExEnTim)

Property methods: ToTimeDisplayToLogical(), ToTimeGet(), ToTimeIsValid(), ToTimeLogicalToDisplay(), ToTimeLogicalToTimeStamp(), ToTimeLogicalToXSD(), ToTimeNormalize(), ToTimeOdbcToLogical(), ToTimeSet(), ToTimeXSDToLogical()

property TotalOccurrences as HS.SDA3.Numeric;

The total number of occurrences of a service that should
result from this service request.
HL7: TQ1-14 : Total Occurrences

Property methods: TotalOccurrencesDisplayToLogical(), TotalOccurrencesGet(), TotalOccurrencesIsValid(), TotalOccurrencesLogicalToDisplay(), TotalOccurrencesNormalize(), TotalOccurrencesSet(), TotalOccurrencesXSDToLogical()

property UpdatedOn as HS.SDA3.TimeStamp;

Not used.

Property methods: UpdatedOnDisplayToLogical(), UpdatedOnGet(), UpdatedOnIsValid(), UpdatedOnLogicalToDisplay(), UpdatedOnLogicalToTimeStamp(), UpdatedOnLogicalToXSD(), UpdatedOnNormalize(), UpdatedOnOdbcToLogical(), UpdatedOnSet(), UpdatedOnXSDToLogical()

Inherited Members

Inherited Properties

Inherited Methods

Feedback