Skip to main content

HS.FHIRModel.R4.MedicinalProductPharmaceuticalX.RouteOfAdministration

class HS.FHIRModel.R4.MedicinalProductPharmaceuticalX.RouteOfAdministration extends HS.FHIRModel.FHIRClassSuper

*****************************************
** MedicinalProductPharmaceuticalX.RouteOfAdministration generated class schema
*****************************************
A pharmaceutical product described in terms of its composition and dose form.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_MEDICINALPRODUCTPHARMACEUTICALX_ROUTEOFADMINISTRATION;
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 code as HS.FHIRModel.R4.CodeableConcept [ Required ];
Coded expression for the route.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
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 firstDose as HS.FHIRModel.R4.Quantity;
The first dose (dose quantity) administered in humans can be specified, for a product under investigation, using a numerical value and its unit of measurement.
Property methods: firstDoseGet(), firstDoseGetSwizzled(), firstDoseIsValid(), firstDoseNewObject(), firstDoseSet()
property maxDosePerDay as HS.FHIRModel.R4.Quantity;
The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered as per the protocol referenced in the clinical trial authorisation.
Property methods: maxDosePerDayGet(), maxDosePerDayGetSwizzled(), maxDosePerDayIsValid(), maxDosePerDayNewObject(), maxDosePerDaySet()
property maxDosePerTreatmentPeriod as HS.FHIRModel.R4.Ratio;
The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.
Property methods: maxDosePerTreatmentPeriodGet(), maxDosePerTreatmentPeriodGetSwizzled(), maxDosePerTreatmentPeriodIsValid(), maxDosePerTreatmentPeriodNewObject(), maxDosePerTreatmentPeriodSet()
property maxSingleDose as HS.FHIRModel.R4.Quantity;
The maximum single dose that can be administered as per the protocol of a clinical trial can be specified using a numerical value and its unit of measurement.
Property methods: maxSingleDoseGet(), maxSingleDoseGetSwizzled(), maxSingleDoseIsValid(), maxSingleDoseNewObject(), maxSingleDoseSet()
property maxTreatmentPeriod as HS.FHIRModel.R4.Duration;
The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.
Property methods: maxTreatmentPeriodGet(), maxTreatmentPeriodGetSwizzled(), maxTreatmentPeriodIsValid(), maxTreatmentPeriodNewObject(), maxTreatmentPeriodSet()
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()
A species for which this route applies.
Property methods: targetSpeciesGet(), targetSpeciesGetSwizzled(), targetSpeciesIsValid(), targetSpeciesNewObject(), targetSpeciesSet()

Methods

method IncludeCode()
method IncludeExtension()
method IncludeFirstDose()
method IncludeMaxDosePerDay()
method IncludeMaxDosePerTreatmentPeriod()
method IncludeMaxSingleDose()
method IncludeMaxTreatmentPeriod()
method IncludeModifierExtension()
method IncludeTargetSpecies()
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