HS.SDA3.Medication
serial class HS.SDA3.Medication extends HS.SDA3.SuperClass, HS.SDA3.AbstractMedication
HS.SDA3.Medication corresponds to the CDA Medications section, the Medications Administered section, and the Hospital Discharge Medications section.Property Inventory
- ActionScope
- Actors
- AsNeeded
- Context
- DispenseEndTime
- DispenseOrganization
- DispensePractitioner
- DispenseQuantity
- DoNotPerform
- EventTime
- Extension
- Identifiers
- IndicationCoded
- Ingredient
- IsReported
- ManufacturerName
- ManufacturerOrganization
- OrderUnits
- PriorMedication
- ReasonReference
- Reporter
- RequestIntent
- WasSubstituted
Parameters
parameter ORDERITEMTYPE = MED;
Inherited description: Must be filled in on descendent class
This will determine the order type of the order item
This will determine the order type of the order item
Properties
property ActionScope;
Optional scope used to qualify ActionCode "I" or "C"
May be "ADMISSION", "DISCHARGE", "ADMINISTERED", "MEDICATIONS", or null.
For any other value, an error will be logged and the streamlet will not be
processed. If a valid, non-null ActionScope is given, then only Medications
with a matching (case-insensitive) value for PharmacyStatus will be
inactivated or cleared. If ActionScope is null, then every matching
Medication will be deleted. See the annotation on the superclass property
for more information on how ActionScope is used.
VIEWERLIB: Not stored
May be "ADMISSION", "DISCHARGE", "ADMINISTERED", "MEDICATIONS", or null.
For any other value, an error will be logged and the streamlet will not be
processed. If a valid, non-null ActionScope is given, then only Medications
with a matching (case-insensitive) value for PharmacyStatus will be
inactivated or cleared. If ActionScope is null, then every matching
Medication will be deleted. See the annotation on the superclass property
for more information on how ActionScope is used.
VIEWERLIB: Not stored
Property methods: ActionScopeDisplayToLogical(), ActionScopeGet(), ActionScopeIsValid(), ActionScopeLogicalToDisplay(), ActionScopeLogicalToOdbc(), ActionScopeNormalize(), ActionScopeSet()
property Actors as list of HS.SDA3.Reference;
Property methods: ActorsBuildValueArray(), ActorsCollectionToDisplay(), ActorsCollectionToOdbc(), ActorsDisplayToCollection(), ActorsGet(), ActorsGetObject(), ActorsGetObjectId(), ActorsGetSwizzled(), ActorsIsValid(), ActorsOdbcToCollection(), ActorsSet(), ActorsSetObject(), ActorsSetObjectId()
property AsNeeded as HS.SDA3.Boolean;
Property methods: AsNeededDisplayToLogical(), AsNeededGet(), AsNeededIsValid(), AsNeededIsValidDT(), AsNeededLogicalToDisplay(), AsNeededLogicalToXSD(), AsNeededNormalize(), AsNeededSet(), AsNeededXSDToLogical()
property Context as %String (MAXLEN = 250);
Specifies the context for the medication data.
This field is used to determine which Medication-related FHIR resource to produce.
Values may include 'request' for MedicationRequest, 'dispense' for MedicationDispense, or 'statement' for MedicationStatement.
MedicationStatement is the default resource if this field is null.
VIEWERLIB: Not stored
Property methods: ContextDisplayToLogical(), ContextGet(), ContextIsValid(), ContextLogicalToDisplay(), ContextLogicalToOdbc(), ContextNormalize(), ContextSet()
property DispenseEndTime as HS.SDA3.TimeStamp;
Property methods: DispenseEndTimeDisplayToLogical(), DispenseEndTimeGet(), DispenseEndTimeIsValid(), DispenseEndTimeLogicalToDisplay(), DispenseEndTimeLogicalToTimeStamp(), DispenseEndTimeLogicalToXSD(), DispenseEndTimeNormalize(), DispenseEndTimeOdbcToLogical(), DispenseEndTimeSet(), DispenseEndTimeXSDToLogical()
property DispenseOrganization as list of HS.SDA3.CodeTableDetail.Organization;
Property methods: DispenseOrganizationBuildValueArray(), DispenseOrganizationCollectionToDisplay(), DispenseOrganizationCollectionToOdbc(), DispenseOrganizationDisplayToCollection(), DispenseOrganizationGet(), DispenseOrganizationGetObject(), DispenseOrganizationGetObjectId(), DispenseOrganizationGetSwizzled(), DispenseOrganizationIsValid(), DispenseOrganizationOdbcToCollection(), DispenseOrganizationSet(), DispenseOrganizationSetObject(), DispenseOrganizationSetObjectId()
property DispensePractitioner as list of HS.SDA3.CodeTableDetail.CareProvider;
Property methods: DispensePractitionerBuildValueArray(), DispensePractitionerCollectionToDisplay(), DispensePractitionerCollectionToOdbc(), DispensePractitionerDisplayToCollection(), DispensePractitionerGet(), DispensePractitionerGetObject(), DispensePractitionerGetObjectId(), DispensePractitionerGetSwizzled(), DispensePractitionerIsValid(), DispensePractitionerOdbcToCollection(), DispensePractitionerSet(), DispensePractitionerSetObject(), DispensePractitionerSetObjectId()
property DispenseQuantity as HS.SDA3.Quantity;
Property methods: DispenseQuantityGet(), DispenseQuantityGetObject(), DispenseQuantityGetObjectId(), DispenseQuantityGetSwizzled(), DispenseQuantityIsEmpty(), DispenseQuantityIsValid(), DispenseQuantityNewObject(), DispenseQuantitySet(), DispenseQuantitySetObject(), DispenseQuantitySetObjectId(), DispenseQuantityUnSwizzle()
property DoNotPerform as HS.SDA3.Boolean;
Property methods: DoNotPerformDisplayToLogical(), DoNotPerformGet(), DoNotPerformIsValid(), DoNotPerformIsValidDT(), DoNotPerformLogicalToDisplay(), DoNotPerformLogicalToXSD(), DoNotPerformNormalize(), DoNotPerformSet(), DoNotPerformXSDToLogical()
property EventTime as HS.SDA3.TimeStamp;
Property methods: EventTimeDisplayToLogical(), EventTimeGet(), EventTimeIsValid(), EventTimeLogicalToDisplay(), EventTimeLogicalToTimeStamp(), EventTimeLogicalToXSD(), EventTimeNormalize(), EventTimeOdbcToLogical(), EventTimeSet(), EventTimeXSDToLogical()
property Extension as HS.Local.SDA3.MedicationExtension;
Property methods: ExtensionGet(), ExtensionGetObject(), ExtensionGetObjectId(), ExtensionGetSwizzled(), ExtensionIsEmpty(), ExtensionIsValid(), ExtensionNewObject(), ExtensionSet(), ExtensionSetObject(), ExtensionSetObjectId(), ExtensionUnSwizzle()
property Identifiers as list of HS.SDA3.Identifier;
Property methods: IdentifiersBuildValueArray(), IdentifiersCollectionToDisplay(), IdentifiersCollectionToOdbc(), IdentifiersDisplayToCollection(), IdentifiersGet(), IdentifiersGetObject(), IdentifiersGetObjectId(), IdentifiersGetSwizzled(), IdentifiersIsValid(), IdentifiersOdbcToCollection(), IdentifiersSet(), IdentifiersSetObject(), IdentifiersSetObjectId()
property IndicationCoded as HS.SDA3.CodeTableDetail.Indication;
Property methods: IndicationCodedGet(), IndicationCodedGetObject(), IndicationCodedGetObjectId(), IndicationCodedGetSwizzled(), IndicationCodedIsEmpty(), IndicationCodedIsValid(), IndicationCodedNewObject(), IndicationCodedSet(), IndicationCodedSetObject(), IndicationCodedSetObjectId(), IndicationCodedUnSwizzle()
property Ingredient as HS.SDA3.CodeTableDetail.Ingredient;
Mapped to .ingredient.itemCodeableConcept in medication resource in FHIR
Property methods: IngredientGet(), IngredientGetObject(), IngredientGetObjectId(), IngredientGetSwizzled(), IngredientIsEmpty(), IngredientIsValid(), IngredientNewObject(), IngredientSet(), IngredientSetObject(), IngredientSetObjectId(), IngredientUnSwizzle()
property IsReported as HS.SDA3.Boolean;
Indicates if this record was captured as a secondary 'reported' record rather than
as an original primary source-of-truth record.
VIEWERLIB: Not stored
Property methods: IsReportedDisplayToLogical(), IsReportedGet(), IsReportedIsValid(), IsReportedIsValidDT(), IsReportedLogicalToDisplay(), IsReportedLogicalToXSD(), IsReportedNormalize(), IsReportedSet(), IsReportedXSDToLogical()
property ManufacturerName as %String (MAXLEN = 220);
Name of Manfacturer Organization
Property methods: ManufacturerNameDisplayToLogical(), ManufacturerNameGet(), ManufacturerNameIsValid(), ManufacturerNameLogicalToDisplay(), ManufacturerNameLogicalToOdbc(), ManufacturerNameNormalize(), ManufacturerNameSet()
property ManufacturerOrganization as HS.SDA3.CodeTableDetail.Organization;
Reference to manufacturer organization object
Property methods: ManufacturerOrganizationGet(), ManufacturerOrganizationGetObject(), ManufacturerOrganizationGetObjectId(), ManufacturerOrganizationGetSwizzled(), ManufacturerOrganizationIsEmpty(), ManufacturerOrganizationIsValid(), ManufacturerOrganizationNewObject(), ManufacturerOrganizationSet(), ManufacturerOrganizationSetObject(), ManufacturerOrganizationSetObjectId(), ManufacturerOrganizationUnSwizzle()
property OrderUnits as HS.SDA3.CodeTableDetail.UoM;
Property methods: OrderUnitsGet(), OrderUnitsGetObject(), OrderUnitsGetObjectId(), OrderUnitsGetSwizzled(), OrderUnitsIsEmpty(), OrderUnitsIsValid(), OrderUnitsNewObject(), OrderUnitsSet(), OrderUnitsSetObject(), OrderUnitsSetObjectId(), OrderUnitsUnSwizzle()
property PriorMedication as HS.SDA3.Reference;
Referece to other medication object
Property methods: PriorMedicationGet(), PriorMedicationGetObject(), PriorMedicationGetObjectId(), PriorMedicationGetSwizzled(), PriorMedicationIsEmpty(), PriorMedicationIsValid(), PriorMedicationNewObject(), PriorMedicationSet(), PriorMedicationSetObject(), PriorMedicationSetObjectId(), PriorMedicationUnSwizzle()
property ReasonReference as list of HS.SDA3.Reference;
References to relevant reasons for Medication
Property methods: ReasonReferenceBuildValueArray(), ReasonReferenceCollectionToDisplay(), ReasonReferenceCollectionToOdbc(), ReasonReferenceDisplayToCollection(), ReasonReferenceGet(), ReasonReferenceGetObject(), ReasonReferenceGetObjectId(), ReasonReferenceGetSwizzled(), ReasonReferenceIsValid(), ReasonReferenceOdbcToCollection(), ReasonReferenceSet(), ReasonReferenceSetObject(), ReasonReferenceSetObjectId()
property Reporter as HS.SDA3.CodeTableDetail.CareProvider;
Property methods: ReporterGet(), ReporterGetObject(), ReporterGetObjectId(), ReporterGetSwizzled(), ReporterIsEmpty(), ReporterIsValid(), ReporterNewObject(), ReporterSet(), ReporterSetObject(), ReporterSetObjectId(), ReporterUnSwizzle()
property RequestIntent as HS.SDA3.CodeTableDetail.MedicationRequestIntent;
Relevant to Medication Requests, this represents whether a request is a proposal,
plan, or an original order.
VIEWERLIB: Not stored
Property methods: RequestIntentGet(), RequestIntentGetObject(), RequestIntentGetObjectId(), RequestIntentGetSwizzled(), RequestIntentIsEmpty(), RequestIntentIsValid(), RequestIntentNewObject(), RequestIntentSet(), RequestIntentSetObject(), RequestIntentSetObjectId(), RequestIntentUnSwizzle()
property WasSubstituted as HS.SDA3.Boolean;
Relevant to Medication Dispense, whether a substitution was or was not performed on the dispense
Property methods: WasSubstitutedDisplayToLogical(), WasSubstitutedGet(), WasSubstitutedIsValid(), WasSubstitutedIsValidDT(), WasSubstitutedLogicalToDisplay(), WasSubstitutedLogicalToXSD(), WasSubstitutedNormalize(), WasSubstitutedSet(), WasSubstitutedXSDToLogical()
Inherited Members
Inherited Properties
- ActionCode
- Administrations
- AuthorizationTime
- CallbackNumber
- Categories
- Category
- Comments
- ComponentMeds
- Condition
- ConfidentialityCode
- ConsultationDepartment
- CustomPairs
- DosageForm
- DosageSteps
- DoseQuantity
- DoseUoM
- DrugProduct
- Duration
- EncounterNumber
- EnteredAt
- EnteredBy
- EnteredOn
- EnteringOrganization
- ExternalId
- FillerAssigningAuthority
- FillerId
- Frequency
- FromTime
- GroupAssigningAuthority
- GroupId
- Indication
- Intent
- MaxDoseQuantity
- NumberOfRefills
- OrderCategory
- OrderGroup
- OrderItem
- OrderQuantity
- OrderReasonReferences
- OrderedBy
- PharmacyStatus
- PlacerAssigningAuthority
- PlacerId
- PrescriptionNumber
- Priority
- ProvenanceIds
- RateAmount
- RateTimeUnit
- RateUnits
- ReassessmentTime
- ReceivingLocation
- RefillDescription
- RefillNumber
- ResultCopiesTo
- Route
- SdaID
- SourceFormat
- Specimen
- SpecimenCollectedTime
- SpecimenReceivedTime
- Status
- StrengthVolume
- StrengthVolumeUnits
- TextInstruction
- ToTime
- UpdatedOn
- VerifiedBy
- VerifiedByOrganization
- VerifiedComments
Inherited Methods
- %AddToSaveSet()
- %AddToSyncSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %Delete()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %GetSwizzleObject()
- %IsA()
- %IsModified()
- %IsNull()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %OnBeforeAddToSync()
- %OnDetermineClass()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %SerializeObject()
- %SetModified()
- %SyncObjectIn()
- %SyncTransport()
- %ValidateObject()
- EndXMLList()
- GetStreamletClass()
- IsDefined()
- LogIgnoredTag()
- LogicalToOdbc()
- OdbcToLogical()
- StartXMLList()
- ToQuickXML()
- ToQuickXMLStream()
- ToQuickXMLString()
- Translate()
- UpdateSDA()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLImportSDAString()
- XMLImportSDAStringUnknown()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- old()