Skip to main content

HS.FHIR.vDSTU2.Model.Resource.MedicationOrder

deprecated class HS.FHIR.vDSTU2.Model.Resource.MedicationOrder extends HS.FHIR.vDSTU2.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.

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 XMLNAME = MedicationOrder;
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 = 0;
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.

Properties

property dateEnded as HS.FHIR.vDSTU2.Model.Datatype.DateTime (XMLNAME = "dateEnded");
The date (and perhaps time) when the prescription was stopped.
Property methods: dateEndedGet(), dateEndedGetSwizzled(), dateEndedIsValid(), dateEndedNewObject(), dateEndedSet()
property dateWritten as HS.FHIR.vDSTU2.Model.Datatype.DateTime (XMLNAME = "dateWritten");
The date (and perhaps time) when the prescription was written.
Property methods: dateWrittenGet(), dateWrittenGetSwizzled(), dateWrittenIsValid(), dateWrittenNewObject(), dateWrittenSet()
property dispenseRequest as HS.FHIR.vDSTU2.Model.Resource.MedicationOrder.DispenseRequest (XMLNAME = "dispenseRequest");
Indicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription). Note that this information is NOT always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
Property methods: dispenseRequestGet(), dispenseRequestGetSwizzled(), dispenseRequestIsValid(), dispenseRequestNewObject(), dispenseRequestSet()
property dosageInstruction as list of HS.FHIR.vDSTU2.Model.Resource.MedicationOrder.DosageInstruction (XMLNAME = "dosageInstruction", XMLPROJECTION = "ELEMENT");
Indicates how the medication is to be used by the patient.
Property methods: dosageInstructionBuildValueArray(), dosageInstructionCollectionToDisplay(), dosageInstructionCollectionToOdbc(), dosageInstructionDisplayToCollection(), dosageInstructionGet(), dosageInstructionGetObject(), dosageInstructionGetObjectId(), dosageInstructionGetSwizzled(), dosageInstructionIsValid(), dosageInstructionOdbcToCollection(), dosageInstructionSet(), dosageInstructionSetObject(), dosageInstructionSetObjectId()
property encounter as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "encounter");
A link to a resource that identifies the particular occurrence of contact between patient and health care provider.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property identifier as list of HS.FHIR.vDSTU2.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records have to be tracked through an entire system.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property medicationCodeableConcept as HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "medicationCodeableConcept");
Property methods: medicationCodeableConceptGet(), medicationCodeableConceptGetSwizzled(), medicationCodeableConceptIsValid(), medicationCodeableConceptNewObject(), medicationCodeableConceptSet()
property medicationReference as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "medicationReference");
Property methods: medicationReferenceGet(), medicationReferenceGetSwizzled(), medicationReferenceIsValid(), medicationReferenceNewObject(), medicationReferenceSet()
property note as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "note");
Extra information about the prescription that could not be conveyed by the other attributes.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property patient as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "patient");
A link to a resource representing the person to whom the medication will be given.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property prescriber as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "prescriber");
The healthcare professional responsible for authorizing the prescription.
Property methods: prescriberGet(), prescriberGetSwizzled(), prescriberIsValid(), prescriberNewObject(), prescriberSet()
property priorPrescription as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "priorPrescription");
A link to a resource representing an earlier order or prescription that this order supersedes.
Property methods: priorPrescriptionGet(), priorPrescriptionGetSwizzled(), priorPrescriptionIsValid(), priorPrescriptionNewObject(), priorPrescriptionSet()
property reasonCodeableConcept as HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "reasonCodeableConcept");
Property methods: reasonCodeableConceptGet(), reasonCodeableConceptGetSwizzled(), reasonCodeableConceptIsValid(), reasonCodeableConceptNewObject(), reasonCodeableConceptSet()
property reasonEnded as HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "reasonEnded");
The reason why the prescription was stopped, if it was.
Property methods: reasonEndedGet(), reasonEndedGetSwizzled(), reasonEndedIsValid(), reasonEndedNewObject(), reasonEndedSet()
property reasonReference as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "reasonReference");
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property status as HS.FHIR.vDSTU2.Model.Base.MedicationOrderStatus (XMLNAME = "status");
A code specifying the state of the order. Generally this will be active or completed state.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property substitution as HS.FHIR.vDSTU2.Model.Resource.MedicationOrder.Substitution (XMLNAME = "substitution");
Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.
Property methods: substitutionGet(), substitutionGetSwizzled(), substitutionIsValid(), substitutionNewObject(), substitutionSet()

Methods

deprecated method SetDateEnded(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 "dateEnded" property.
deprecated method SetDateWritten(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 "dateWritten" property.
deprecated method SetEncounter(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 "encounter" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetMedicationCodeableConcept(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 "medicationCodeableConcept" property.
deprecated method SetMedicationReference(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 "medicationReference" property.
deprecated method SetNote(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 "note" property.
deprecated method SetPatient(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 "patient" property.
deprecated method SetPrescriber(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 "prescriber" property.
deprecated method SetPriorPrescription(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 "priorPrescription" property.
deprecated method SetReasonCodeableConcept(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 "reasonCodeableConcept" property.
deprecated method SetReasonEnded(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 "reasonEnded" property.
deprecated method SetReasonReference(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 "reasonReference" property.
deprecated method SetStatus(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 "status" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab