Skip to main content

HS.FHIR.vSTU3.Model.Resource.MedicationDispense.Substitution

deprecated class HS.FHIR.vSTU3.Model.Resource.MedicationDispense.Substitution extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

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 = MedicationDispense.Substitution;
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 = MedicationDispense.Substitution;
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 reason as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.
Property methods: reasonBuildValueArray(), reasonCollectionToDisplay(), reasonCollectionToOdbc(), reasonDisplayToCollection(), reasonGet(), reasonGetObject(), reasonGetObjectId(), reasonGetSwizzled(), reasonIsValid(), reasonOdbcToCollection(), reasonSet(), reasonSetObject(), reasonSetObjectId()
property responsibleParty as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "responsibleParty", XMLPROJECTION = "ELEMENT");
The person or organization that has primary responsibility for the substitution.
Property methods: responsiblePartyBuildValueArray(), responsiblePartyCollectionToDisplay(), responsiblePartyCollectionToOdbc(), responsiblePartyDisplayToCollection(), responsiblePartyGet(), responsiblePartyGetObject(), responsiblePartyGetObjectId(), responsiblePartyGetSwizzled(), responsiblePartyIsValid(), responsiblePartyOdbcToCollection(), responsiblePartySet(), responsiblePartySetObject(), responsiblePartySetObjectId()
property type as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
A code signifying whether a different drug was dispensed from what was prescribed.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property wasSubstituted as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "wasSubstituted", XMLPROJECTION = "ELEMENT") [ Required ];
True if the dispenser dispensed a different drug or product from what was prescribed.
Property methods: wasSubstitutedGet(), wasSubstitutedGetSwizzled(), wasSubstitutedIsValid(), wasSubstitutedNewObject(), wasSubstitutedSet()

Methods

deprecated method SetReason(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reason" property.
deprecated method SetResponsibleParty(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "responsibleParty" property.
deprecated method SetType(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "type" property.
deprecated method SetWasSubstituted(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 "wasSubstituted" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab