Skip to main content

HS.FHIRModel.R4.Dosage

class HS.FHIRModel.R4.Dosage extends HS.FHIRModel.FHIRClassSuper

*****************************************
** Dosage generated class schema
*****************************************
Indicates how the medication is/was taken or should be taken by the patient.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_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 _asNeededBoolean as HS.FHIRModel.R4.Element;
Extensions for asNeededBoolean
Property methods: _asNeededBooleanGet(), _asNeededBooleanGetSwizzled(), _asNeededBooleanIsValid(), _asNeededBooleanNewObject(), _asNeededBooleanSet()
property _patientInstruction as HS.FHIRModel.R4.Element;
Extensions for patientInstruction
Property methods: _patientInstructionGet(), _patientInstructionGetSwizzled(), _patientInstructionIsValid(), _patientInstructionNewObject(), _patientInstructionSet()
property _sequence as HS.FHIRModel.R4.Element;
Extensions for sequence
Property methods: _sequenceGet(), _sequenceGetSwizzled(), _sequenceIsValid(), _sequenceNewObject(), _sequenceSet()
property _text as HS.FHIRModel.R4.Element;
Extensions for text
Property methods: _textGet(), _textGetSwizzled(), _textIsValid(), _textNewObject(), _textSet()
property additionalInstruction as HS.FHIRModel.R4.SeqOfCodeableConcept;
Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").
Property methods: additionalInstructionGet(), additionalInstructionGetSwizzled(), additionalInstructionIsValid(), additionalInstructionNewObject(), additionalInstructionSet()
property asNeededBoolean as %Boolean;
Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
Property methods: asNeededBooleanDisplayToLogical(), asNeededBooleanGet(), asNeededBooleanIsValid(), asNeededBooleanLogicalToDisplay(), asNeededBooleanLogicalToXSD(), asNeededBooleanNormalize(), asNeededBooleanSet(), asNeededBooleanXSDToLogical()
property asNeededCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
Property methods: asNeededCodeableConceptGet(), asNeededCodeableConceptGetSwizzled(), asNeededCodeableConceptIsValid(), asNeededCodeableConceptNewObject(), asNeededCodeableConceptSet()
The amount of medication administered.
Property methods: doseAndRateGet(), doseAndRateGetSwizzled(), doseAndRateIsValid(), doseAndRateNewObject(), doseAndRateSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property maxDosePerAdministration as HS.FHIRModel.R4.Quantity;
Upper limit on medication per administration.
Property methods: maxDosePerAdministrationGet(), maxDosePerAdministrationGetSwizzled(), maxDosePerAdministrationIsValid(), maxDosePerAdministrationNewObject(), maxDosePerAdministrationSet()
property maxDosePerLifetime as HS.FHIRModel.R4.Quantity;
Upper limit on medication per lifetime of the patient.
Property methods: maxDosePerLifetimeGet(), maxDosePerLifetimeGetSwizzled(), maxDosePerLifetimeIsValid(), maxDosePerLifetimeNewObject(), maxDosePerLifetimeSet()
property maxDosePerPeriod as HS.FHIRModel.R4.Ratio;
Upper limit on medication per unit of time.
Property methods: maxDosePerPeriodGet(), maxDosePerPeriodGetSwizzled(), maxDosePerPeriodIsValid(), maxDosePerPeriodNewObject(), maxDosePerPeriodSet()
property method as HS.FHIRModel.R4.CodeableConcept;
Technique for administering medication.
Property methods: methodGet(), methodGetSwizzled(), methodIsValid(), methodNewObject(), methodSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property patientInstruction as %String;
Instructions in terms that are understood by the patient or consumer.
Property methods: patientInstructionDisplayToLogical(), patientInstructionGet(), patientInstructionIsValid(), patientInstructionLogicalToDisplay(), patientInstructionLogicalToOdbc(), patientInstructionNormalize(), patientInstructionSet()
property route as HS.FHIRModel.R4.CodeableConcept;
How drug should enter body.
Property methods: routeGet(), routeGetSwizzled(), routeIsValid(), routeNewObject(), routeSet()
property sequence as %Integer;
Indicates the order in which the dosage instructions should be applied or interpreted.
Property methods: sequenceDisplayToLogical(), sequenceGet(), sequenceIsValid(), sequenceLogicalToDisplay(), sequenceNormalize(), sequenceSet(), sequenceXSDToLogical()
Body site to administer to.
Property methods: siteGet(), siteGetSwizzled(), siteIsValid(), siteNewObject(), siteSet()
property text as %String;
Free text dosage instructions e.g. SIG.
Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()
property timing as HS.FHIRModel.R4.Timing;
When medication should be administered.
Property methods: timingGet(), timingGetSwizzled(), timingIsValid(), timingNewObject(), timingSet()

Methods

method IncludeAdditionalInstruction()
method IncludeAsNeededCodeableConcept()
method IncludeDoseAndRate()
method IncludeExtension()
method IncludeMaxDosePerAdministration()
method IncludeMaxDosePerLifetime()
method IncludeMaxDosePerPeriod()
method IncludeMethod()
method IncludeModifierExtension()
method IncludeRoute()
method IncludeSite()
method IncludeTiming()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab