Skip to main content

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 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.

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.

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.

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 EncounterNumber as %String (MAXLEN = 220);
Not used.
Property methods: EncounterNumberDisplayToLogical(), EncounterNumberGet(), EncounterNumberIsValid(), EncounterNumberLogicalToDisplay(), EncounterNumberLogicalToOdbc(), EncounterNumberNormalize(), EncounterNumberSet()
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);
Not used.
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.

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 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.

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 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

FeedbackOpens in a new tab