Skip to main content

HS.FHIR.DTL.vR4.Model.Element.MedicinalProductPharmaceutical.routeOfAdministration

class HS.FHIR.DTL.vR4.Model.Element.MedicinalProductPharmaceutical.routeOfAdministration extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

The path by which the pharmaceutical product is taken into or makes contact with the body.

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 = MedicinalProductPharmaceutical.routeOfAdministration;
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 = MedicinalProductPharmaceutical.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.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Coded expression for the route.

any FHIR4 code from any ValueSet may be used.

Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property firstDose as HS.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "firstDose", XMLPROJECTION = "ELEMENT");
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.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "maxDosePerDay", XMLPROJECTION = "ELEMENT");
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.FHIR.DTL.vR4.Model.Datatype.Ratio (XMLNAME = "maxDosePerTreatmentPeriod", XMLPROJECTION = "ELEMENT");
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.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "maxSingleDose", XMLPROJECTION = "ELEMENT");
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.FHIR.DTL.vR4.Model.Datatype.Duration (XMLNAME = "maxTreatmentPeriod", XMLPROJECTION = "ELEMENT");
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 targetSpecies as list of HS.FHIR.DTL.vR4.Model.Element.MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies (XMLNAME = "targetSpecies", XMLPROJECTION = "ELEMENT");
BackboneElement

A species for which this route applies.

Property methods: targetSpeciesBuildValueArray(), targetSpeciesCollectionToDisplay(), targetSpeciesCollectionToOdbc(), targetSpeciesDisplayToCollection(), targetSpeciesGet(), targetSpeciesGetObject(), targetSpeciesGetObjectId(), targetSpeciesGetSwizzled(), targetSpeciesIsValid(), targetSpeciesOdbcToCollection(), targetSpeciesSet(), targetSpeciesSetObject(), targetSpeciesSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab