Skip to main content

HS.SDA3.Administration

serial class HS.SDA3.Administration extends HS.SDA3.SuperClass

Administration appears in the SDA as a list property (Administrations) of
HS.SDA3.Medication and HS.SDA3.Vaccination. Administrations are not loaded
into the Viewer Cache.

Property Inventory

Properties

property ActionCode as %String;
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 AdministeredAmount as %String;
The amount of medication administered

HL7: RXA-6 : AdministeredAmount
VIEWERLIB: Not stored
Property methods: AdministeredAmountDisplayToLogical(), AdministeredAmountGet(), AdministeredAmountIsValid(), AdministeredAmountLogicalToDisplay(), AdministeredAmountLogicalToOdbc(), AdministeredAmountNormalize(), AdministeredAmountSet()
property AdministeredAtLocation as HS.SDA3.CodeTableDetail.HealthCareFacility;
The location at which the administration took place.

HL7ToSDA3:
RXA-11.1 is parsed to the AdministeredAtLocation Code. HL7ToSDA3 does not
set the Description.

SDATableName=HealthCareFacility, ViewerClass=User.HS.CTLoc
HL7: RXA-11.1 : AdministeredatLocation.PointOfCare VIEWERLIB: Not stored
Property methods: AdministeredAtLocationGet(), AdministeredAtLocationGetObject(), AdministeredAtLocationGetObjectId(), AdministeredAtLocationGetSwizzled(), AdministeredAtLocationIsEmpty(), AdministeredAtLocationIsValid(), AdministeredAtLocationNewObject(), AdministeredAtLocationSet(), AdministeredAtLocationSetObject(), AdministeredAtLocationSetObjectId(), AdministeredAtLocationUnSwizzle()
property AdministeredUnits as %String;
The number of units of medication administered

HL7ToSDA3:
RXA-7 is a coded field. HL7ToSDA3 will get the value from Text (subfield
2), or Identifier (subfield 1) if Text is null.

HL7: RXA-7 : AdministeredUnits
VIEWERLIB: Not stored
Property methods: AdministeredUnitsDisplayToLogical(), AdministeredUnitsGet(), AdministeredUnitsIsValid(), AdministeredUnitsLogicalToDisplay(), AdministeredUnitsLogicalToOdbc(), AdministeredUnitsNormalize(), AdministeredUnitsSet()
property AdministeringProvider as HS.SDA3.CodeTableDetail.CareProvider;
Care provider who did the administration

HL7: RXA-10 : AdministeringProvider
SDATableName=CareProvider, ViewerClass=User.HS.CTCareProv
VIEWERLIB: Not stored

.Name.FamilyName
HL7: RXA-10.2.1 : FamilyNameSurname
.Name.GivenName
HL7: RXA-10.3 : GivenName
.Name.MiddleName
HL7: RXA-10.4 : MiddleName
.Name.NamePrefix
HL7: RXA-10.6 : NamePrefix
.Name.NameSuffix
HL7: RXA-10.7 : Degree
Property methods: AdministeringProviderGet(), AdministeringProviderGetObject(), AdministeringProviderGetObjectId(), AdministeringProviderGetSwizzled(), AdministeringProviderIsEmpty(), AdministeringProviderIsValid(), AdministeringProviderNewObject(), AdministeringProviderSet(), AdministeringProviderSetObject(), AdministeringProviderSetObjectId(), AdministeringProviderUnSwizzle()
property AdministrationNotes as %String);
Notes on the administration
Length subject to the total streamlet size limit - 3,000,000

HL7ToSDA3:
RXA-9 is a coded, repeating field. For each non-null instance of the field,
HL7ToSDA3 will parse Text (piece 2), or Identifier (piece 1) if Text is
null, on a new, CRLF-delimited line.

HL7: RXA-9 : AdministrationNotes
VIEWERLIB: Not stored
Property methods: AdministrationNotesDisplayToLogical(), AdministrationNotesGet(), AdministrationNotesIsValid(), AdministrationNotesLogicalToDisplay(), AdministrationNotesLogicalToOdbc(), AdministrationNotesNormalize(), AdministrationNotesSet()
property AdministrationSite as HS.SDA3.CodeTableDetail.AdministrationSite;
Location a vaccine was administered (e.g. Left Arm)

HL7ToSDA3:
RXR-2 will only be parsed if subfield 1 or 2 is not null.

HL7: RXR-2 : AdministrationSite
VIEWERLIB: Not stored

.Code
HL7: RXR-2.1 : AdministrationSite.Identifier
.Description
HL7: RXR-2.2 : AdministrationSite.Text
.SDACodingStandard
HL7: RXR-2.3 : AdministrationSite.NameofCodingSystem
Property methods: AdministrationSiteGet(), AdministrationSiteGetObject(), AdministrationSiteGetObjectId(), AdministrationSiteGetSwizzled(), AdministrationSiteIsEmpty(), AdministrationSiteIsValid(), AdministrationSiteNewObject(), AdministrationSiteSet(), AdministrationSiteSetObject(), AdministrationSiteSetObjectId(), AdministrationSiteUnSwizzle()
property AdministrationStatus as HS.SDA3.CodeTableDetail.AdministrationStatus;
The completion status of the administration

HL7ToSDA3:
RXA-20 is parsed to the AdministrationStatus Code. HL7ToSDA3 does not set
the Description.

HL7: RXA-20 : CompletionStatus
VIEWERLIB: Not stored
Property methods: AdministrationStatusGet(), AdministrationStatusGetObject(), AdministrationStatusGetObjectId(), AdministrationStatusGetSwizzled(), AdministrationStatusIsEmpty(), AdministrationStatusIsValid(), AdministrationStatusNewObject(), AdministrationStatusSet(), AdministrationStatusSetObject(), AdministrationStatusSetObjectId(), AdministrationStatusUnSwizzle()
property EncounterNumber as %String (MAXLEN = 220);
Not used.
Property methods: EncounterNumberDisplayToLogical(), EncounterNumberGet(), EncounterNumberIsValid(), EncounterNumberLogicalToDisplay(), EncounterNumberLogicalToOdbc(), EncounterNumberNormalize(), EncounterNumberSet()
property EnteredOn as HS.SDA3.TimeStamp;
HL7: RXA-22.1 : SystemEntryDateTime.Time
VIEWERLIB: Not stored
Property methods: EnteredOnDisplayToLogical(), EnteredOnGet(), EnteredOnIsValid(), EnteredOnLogicalToDisplay(), EnteredOnLogicalToTimeStamp(), EnteredOnLogicalToXSD(), EnteredOnNormalize(), EnteredOnOdbcToLogical(), EnteredOnSet(), EnteredOnXSDToLogical()
property ExpiryDate as HS.SDA3.TimeStamp;
The expiry date of the medication administered

HL7ToSDA3:
Though RXA-16 is a repeating field, HL7ToSDA3 will only use the first
instance.

HL7: RXA-16.1 : SubstanceExpirationDate.Time
VIEWERLIB: Not stored
Property methods: ExpiryDateDisplayToLogical(), ExpiryDateGet(), ExpiryDateIsValid(), ExpiryDateLogicalToDisplay(), ExpiryDateLogicalToTimeStamp(), ExpiryDateLogicalToXSD(), ExpiryDateNormalize(), ExpiryDateOdbcToLogical(), ExpiryDateSet(), ExpiryDateXSDToLogical()
property Extension as HS.Local.SDA3.AdministrationExtension;
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 FromTime as HS.SDA3.TimeStamp;
Start time of administration of medication

HL7: RXA-3.1 : DateTimeStartofAdministration.Time
VIEWERLIB: Not stored
Property methods: FromTimeDisplayToLogical(), FromTimeGet(), FromTimeIsValid(), FromTimeLogicalToDisplay(), FromTimeLogicalToTimeStamp(), FromTimeLogicalToXSD(), FromTimeNormalize(), FromTimeOdbcToLogical(), FromTimeSet(), FromTimeXSDToLogical()
property LotNumber as %String;
The lot number of the medication administered

HL7ToSDA3:
Though RXA-15 is a repeating field, HL7ToSDA3 will only use the first
instance.

HL7: RXA-15 : SubstanceLotNumber
VIEWERLIB: Not stored
Property methods: LotNumberDisplayToLogical(), LotNumberGet(), LotNumberIsValid(), LotNumberLogicalToDisplay(), LotNumberLogicalToOdbc(), LotNumberNormalize(), LotNumberSet()
property ManufacturerName as %String (MAXLEN = 32000);
The manufacturer of the medication administered

HL7ToSDA3:
Though RXA-17 is a repeating field, HL7ToSDA3 will only use the first
non-null instance. RXA-17 is also a coded field. HL7ToSDA3 will use Text
(piece 2), or Identifier (piece 1) if Text is null.

HL7: RXA-17 : SubstanceManufacturerName
VIEWERLIB: Not stored
Property methods: ManufacturerNameDisplayToLogical(), ManufacturerNameGet(), ManufacturerNameIsValid(), ManufacturerNameLogicalToDisplay(), ManufacturerNameLogicalToOdbc(), ManufacturerNameNormalize(), ManufacturerNameSet()
property RefusalReason as HS.SDA3.CodeTableDetail.RefusalReason;
Substance/Treatment Refusal Reason

HL7ToSDA3:
RXA-18 will only be parsed if subfield 1 is not null.

HL7: RXA-18 : SubstanceTreatmentRefusalReason
VIEWERLIB: Not stored

.Code
HL7: RXA-18.1 : SubstanceTreatmentRefusalReason.Identifier
.Description
HL7: RXA-18.2 : SubstanceTreatmentRefusalReason.Text
.SDACodingStandard
HL7: RXA-18.3 : SubstanceTreatmentRefusalReason.NameofCodingSystem
Property methods: RefusalReasonGet(), RefusalReasonGetObject(), RefusalReasonGetObjectId(), RefusalReasonGetSwizzled(), RefusalReasonIsEmpty(), RefusalReasonIsValid(), RefusalReasonNewObject(), RefusalReasonSet(), RefusalReasonSetObject(), RefusalReasonSetObjectId(), RefusalReasonUnSwizzle()
property ToTime as HS.SDA3.TimeStamp;
End time of administration of medication

HL7: RXA-4.1 : DateTimeEndofAdministration.Time
VIEWERLIB: Not stored
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