Skip to main content

HS.FHIR.DTL.vR4.Model.Element.Dosage

class HS.FHIR.DTL.vR4.Model.Element.Dosage extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

How the medication is/was taken or should be taken.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = Dosage;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = Dosage;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property additionalInstruction as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "additionalInstruction", XMLPROJECTION = "ELEMENT");
CodeableConcept

Supplemental instruction or warnings to the patient - e.g. \"with meals\", \"may cause drowsiness\"

any FHIR4 code may be used; additional-instruction-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: additionalInstructionBuildValueArray(), additionalInstructionCollectionToDisplay(), additionalInstructionCollectionToOdbc(), additionalInstructionDisplayToCollection(), additionalInstructionGet(), additionalInstructionGetObject(), additionalInstructionGetObjectId(), additionalInstructionGetSwizzled(), additionalInstructionIsValid(), additionalInstructionOdbcToCollection(), additionalInstructionSet(), additionalInstructionSetObject(), additionalInstructionSetObjectId()
property asNeededBoolean as %Boolean (XMLNAME = "asNeededBoolean", XMLPROJECTION = "ATTRIBUTE");
boolean

Take \"as needed\" (for x)

Property methods: asNeededBooleanDisplayToLogical(), asNeededBooleanGet(), asNeededBooleanIsValid(), asNeededBooleanLogicalToDisplay(), asNeededBooleanLogicalToXSD(), asNeededBooleanNormalize(), asNeededBooleanSet(), asNeededBooleanXSDToLogical()
property asNeededCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "asNeededCodeableConcept", XMLPROJECTION = "ELEMENT");
CodeableConcept

Take \"as needed\" (for x)

any FHIR4 code may be used; medication-as-needed-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: asNeededCodeableConceptGet(), asNeededCodeableConceptGetSwizzled(), asNeededCodeableConceptIsValid(), asNeededCodeableConceptNewObject(), asNeededCodeableConceptSet()
property doseAndRate as list of HS.FHIR.DTL.vR4.Model.Element.Dosage.doseAndRate (XMLNAME = "doseAndRate", XMLPROJECTION = "ELEMENT");
Element

Amount of medication administered.

Property methods: doseAndRateBuildValueArray(), doseAndRateCollectionToDisplay(), doseAndRateCollectionToOdbc(), doseAndRateDisplayToCollection(), doseAndRateGet(), doseAndRateGetObject(), doseAndRateGetObjectId(), doseAndRateGetSwizzled(), doseAndRateIsValid(), doseAndRateOdbcToCollection(), doseAndRateSet(), doseAndRateSetObject(), doseAndRateSetObjectId()
property maxDosePerAdministration as HS.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "maxDosePerAdministration", XMLPROJECTION = "ELEMENT");
Quantity

Upper limit on medication per administration.

Property methods: maxDosePerAdministrationGet(), maxDosePerAdministrationGetSwizzled(), maxDosePerAdministrationIsValid(), maxDosePerAdministrationNewObject(), maxDosePerAdministrationSet()
property maxDosePerLifetime as HS.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "maxDosePerLifetime", XMLPROJECTION = "ELEMENT");
Quantity

Upper limit on medication per lifetime of the patient.

Property methods: maxDosePerLifetimeGet(), maxDosePerLifetimeGetSwizzled(), maxDosePerLifetimeIsValid(), maxDosePerLifetimeNewObject(), maxDosePerLifetimeSet()
property maxDosePerPeriod as HS.FHIR.DTL.vR4.Model.Datatype.Ratio (XMLNAME = "maxDosePerPeriod", XMLPROJECTION = "ELEMENT");
Ratio

Upper limit on medication per unit of time.

Property methods: maxDosePerPeriodGet(), maxDosePerPeriodGetSwizzled(), maxDosePerPeriodIsValid(), maxDosePerPeriodNewObject(), maxDosePerPeriodSet()
property method as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "method", XMLPROJECTION = "ELEMENT");
CodeableConcept

Technique for administering medication.

any FHIR4 code may be used; administration-method-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: methodGet(), methodGetSwizzled(), methodIsValid(), methodNewObject(), methodSet()
property patientInstruction as %String (MAXLEN = 1000000, XMLNAME = "patientInstruction", XMLPROJECTION = "ATTRIBUTE");
string

Patient or consumer oriented instructions.

Property methods: patientInstructionDisplayToLogical(), patientInstructionGet(), patientInstructionIsValid(), patientInstructionLogicalToDisplay(), patientInstructionLogicalToOdbc(), patientInstructionNormalize(), patientInstructionSet()
property route as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "route", XMLPROJECTION = "ELEMENT");
CodeableConcept

How drug should enter body.

any FHIR4 code may be used; route-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: routeGet(), routeGetSwizzled(), routeIsValid(), routeNewObject(), routeSet()
property sequence as %Integer (XMLNAME = "sequence", XMLPROJECTION = "ATTRIBUTE");
integer

The order of the dosage instructions.

Property methods: sequenceDisplayToLogical(), sequenceGet(), sequenceIsValid(), sequenceLogicalToDisplay(), sequenceNormalize(), sequenceSet(), sequenceXSDToLogical()
property site as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "site", XMLPROJECTION = "ELEMENT");
CodeableConcept

Body site to administer to.

any FHIR4 code may be used; approach-site-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: siteGet(), siteGetSwizzled(), siteIsValid(), siteNewObject(), siteSet()
property text as %String (MAXLEN = 1000000, XMLNAME = "text", XMLPROJECTION = "ATTRIBUTE");
string

Free text dosage instructions e.g. SIG.

Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()
property timing as HS.FHIR.DTL.vR4.Model.Datatype.Timing (XMLNAME = "timing", XMLPROJECTION = "ELEMENT");
Timing

When medication should be administered.

Property methods: timingGet(), timingGetSwizzled(), timingIsValid(), timingNewObject(), timingSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab