Skip to main content

HS.FHIR.vSTU3.Model.Resource.MedicationRequest.DispenseRequest

deprecated class HS.FHIR.vSTU3.Model.Resource.MedicationRequest.DispenseRequest extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

Property Inventory

Method 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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = MedicationRequest.DispenseRequest;
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 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 = MedicationRequest.DispenseRequest;
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 expectedSupplyDuration as HS.FHIR.vSTU3.Model.Base.Duration (XMLNAME = "expectedSupplyDuration", XMLPROJECTION = "ELEMENT");
Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.
Property methods: expectedSupplyDurationGet(), expectedSupplyDurationGetSwizzled(), expectedSupplyDurationIsValid(), expectedSupplyDurationNewObject(), expectedSupplyDurationSet()
property numberOfRepeatsAllowed as HS.FHIR.vSTU3.Model.Datatype.PositiveInt (XMLNAME = "numberOfRepeatsAllowed", XMLPROJECTION = "ELEMENT");
An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets.
Property methods: numberOfRepeatsAllowedGet(), numberOfRepeatsAllowedGetSwizzled(), numberOfRepeatsAllowedIsValid(), numberOfRepeatsAllowedNewObject(), numberOfRepeatsAllowedSet()
property performer as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
Indicates the intended dispensing Organization specified by the prescriber.
Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property quantity as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "quantity", XMLPROJECTION = "ELEMENT");
The amount that is to be dispensed for one fill.
Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
property validityPeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "validityPeriod", XMLPROJECTION = "ELEMENT");
This indicates the validity period of a prescription (stale dating the Prescription).
Property methods: validityPeriodGet(), validityPeriodGetSwizzled(), validityPeriodIsValid(), validityPeriodNewObject(), validityPeriodSet()

Methods

deprecated method SetNumberOfRepeatsAllowed(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "numberOfRepeatsAllowed" property.
deprecated method SetPerformer(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "performer" property.
deprecated method SetQuantity(pValue As %String = "", pComparator As %String = "", pUnit As %String = "", pSystem As %String = "", pCode As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "quantity" property.
deprecated method SetValidityPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "validityPeriod" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab