Skip to main content

HS.FHIR.vSTU3.Model.Resource.MedicationDispense

deprecated class HS.FHIR.vSTU3.Model.Resource.MedicationDispense extends HS.FHIR.vSTU3.Model.Base.DomainResource

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.
If the element is present, it must have either a @value, an @id, or extensions

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 = MedicationDispense;
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.

Properties

property authorizingPrescription as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "authorizingPrescription", XMLPROJECTION = "ELEMENT");
Indicates the medication order that is being dispensed against.
Property methods: authorizingPrescriptionBuildValueArray(), authorizingPrescriptionCollectionToDisplay(), authorizingPrescriptionCollectionToOdbc(), authorizingPrescriptionDisplayToCollection(), authorizingPrescriptionGet(), authorizingPrescriptionGetObject(), authorizingPrescriptionGetObjectId(), authorizingPrescriptionGetSwizzled(), authorizingPrescriptionIsValid(), authorizingPrescriptionOdbcToCollection(), authorizingPrescriptionSet(), authorizingPrescriptionSetObject(), authorizingPrescriptionSetObjectId()
property category as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
Indicates type of medication dispense and where the medication is expected to be consumed or administered.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property context as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
The encounter or episode of care that establishes the context for this event.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property daysSupply as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "daysSupply", XMLPROJECTION = "ELEMENT");
The amount of medication expressed as a timing amount.
Property methods: daysSupplyGet(), daysSupplyGetSwizzled(), daysSupplyIsValid(), daysSupplyNewObject(), daysSupplySet()
property destination as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "destination", XMLPROJECTION = "ELEMENT");
Identification of the facility/location where the medication was shipped to, as part of the dispense event.
Property methods: destinationGet(), destinationGetSwizzled(), destinationIsValid(), destinationNewObject(), destinationSet()
property detectedIssue as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "detectedIssue", XMLPROJECTION = "ELEMENT");
Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
Property methods: detectedIssueBuildValueArray(), detectedIssueCollectionToDisplay(), detectedIssueCollectionToOdbc(), detectedIssueDisplayToCollection(), detectedIssueGet(), detectedIssueGetObject(), detectedIssueGetObjectId(), detectedIssueGetSwizzled(), detectedIssueIsValid(), detectedIssueOdbcToCollection(), detectedIssueSet(), detectedIssueSetObject(), detectedIssueSetObjectId()
property dosageInstruction as list of HS.FHIR.vSTU3.Model.Base.Dosage (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 eventHistory as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "eventHistory", XMLPROJECTION = "ELEMENT");
A summary of the events of interest that have occurred, such as when the dispense was verified.
Property methods: eventHistoryBuildValueArray(), eventHistoryCollectionToDisplay(), eventHistoryCollectionToOdbc(), eventHistoryDisplayToCollection(), eventHistoryGet(), eventHistoryGetObject(), eventHistoryGetObjectId(), eventHistoryGetSwizzled(), eventHistoryIsValid(), eventHistoryOdbcToCollection(), eventHistorySet(), eventHistorySetObject(), eventHistorySetObjectId()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property medicationCodeableConcept as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "medicationCodeableConcept", XMLPROJECTION = "ELEMENT");
Property methods: medicationCodeableConceptGet(), medicationCodeableConceptGetSwizzled(), medicationCodeableConceptIsValid(), medicationCodeableConceptNewObject(), medicationCodeableConceptSet()
property medicationReference as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "medicationReference", XMLPROJECTION = "ELEMENT");
Property methods: medicationReferenceGet(), medicationReferenceGetSwizzled(), medicationReferenceIsValid(), medicationReferenceNewObject(), medicationReferenceSet()
property notDone as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "notDone", XMLPROJECTION = "ELEMENT");
True if the dispense was not performed for some reason.
Property methods: notDoneGet(), notDoneGetSwizzled(), notDoneIsValid(), notDoneNewObject(), notDoneReasonCodeableConceptGet(), notDoneReasonCodeableConceptGetSwizzled(), notDoneReasonCodeableConceptIsValid(), notDoneReasonCodeableConceptNewObject(), notDoneReasonCodeableConceptSet(), notDoneReasonReferenceGet(), notDoneReasonReferenceGetSwizzled(), notDoneReasonReferenceIsValid(), notDoneReasonReferenceNewObject(), notDoneReasonReferenceSet(), notDoneSet()
property notDoneReasonCodeableConcept as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "notDoneReasonCodeableConcept", XMLPROJECTION = "ELEMENT");
Property methods: notDoneReasonCodeableConceptGet(), notDoneReasonCodeableConceptGetSwizzled(), notDoneReasonCodeableConceptIsValid(), notDoneReasonCodeableConceptNewObject(), notDoneReasonCodeableConceptSet()
property notDoneReasonReference as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "notDoneReasonReference", XMLPROJECTION = "ELEMENT");
Property methods: notDoneReasonReferenceGet(), notDoneReasonReferenceGetSwizzled(), notDoneReasonReferenceIsValid(), notDoneReasonReferenceNewObject(), notDoneReasonReferenceSet()
property note as list of HS.FHIR.vSTU3.Model.Base.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Extra information about the dispense that could not be conveyed in the other attributes.
Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property partOf as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
The procedure that the dispense is done because of.
Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property performer as list of HS.FHIR.vSTU3.Model.Resource.MedicationDispense.Performer (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
Indicates who or what performed the event. It should be assumed that the performer is the dispenser of the medication.
Property methods: performerBuildValueArray(), performerCollectionToDisplay(), performerCollectionToOdbc(), performerDisplayToCollection(), performerGet(), performerGetObject(), performerGetObjectId(), performerGetSwizzled(), performerIsValid(), performerOdbcToCollection(), performerSet(), performerSetObject(), performerSetObjectId()
property quantity as HS.FHIR.vSTU3.Model.Base.Quantity (XMLNAME = "quantity", XMLPROJECTION = "ELEMENT");
The amount of medication that has been dispensed. Includes unit of measure.
Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
property receiver as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "receiver", XMLPROJECTION = "ELEMENT");
Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.
Property methods: receiverBuildValueArray(), receiverCollectionToDisplay(), receiverCollectionToOdbc(), receiverDisplayToCollection(), receiverGet(), receiverGetObject(), receiverGetObjectId(), receiverGetSwizzled(), receiverIsValid(), receiverOdbcToCollection(), receiverSet(), receiverSetObject(), receiverSetObjectId()
property status as HS.FHIR.vSTU3.Model.Base.MedicationDispenseStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT");
A code specifying the state of the set of dispense events.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subject as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
A link to a resource representing the person or the group to whom the medication will be given.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property substitution as HS.FHIR.vSTU3.Model.Resource.MedicationDispense.Substitution (XMLNAME = "substitution", XMLPROJECTION = "ELEMENT");
Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
Property methods: substitutionGet(), substitutionGetSwizzled(), substitutionIsValid(), substitutionNewObject(), substitutionSet()
property supportingInformation as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "supportingInformation", XMLPROJECTION = "ELEMENT");
Additional information that supports the medication being dispensed.
Property methods: supportingInformationBuildValueArray(), supportingInformationCollectionToDisplay(), supportingInformationCollectionToOdbc(), supportingInformationDisplayToCollection(), supportingInformationGet(), supportingInformationGetObject(), supportingInformationGetObjectId(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationOdbcToCollection(), supportingInformationSet(), supportingInformationSetObject(), supportingInformationSetObjectId()
property type as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property whenHandedOver as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "whenHandedOver", XMLPROJECTION = "ELEMENT");
The time the dispensed product was provided to the patient or their representative.
Property methods: whenHandedOverGet(), whenHandedOverGetSwizzled(), whenHandedOverIsValid(), whenHandedOverNewObject(), whenHandedOverSet()
property whenPrepared as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "whenPrepared", XMLPROJECTION = "ELEMENT");
The time when the dispensed product was packaged and reviewed.
Property methods: whenPreparedGet(), whenPreparedGetSwizzled(), whenPreparedIsValid(), whenPreparedNewObject(), whenPreparedSet()

Methods

deprecated method SetAuthorizingPrescription(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 "authorizingPrescription" property.
deprecated method SetCategory(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 "category" property.
deprecated method SetContext(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 "context" property.
deprecated method SetDaysSupply(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 "daysSupply" property.
deprecated method SetDestination(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 "destination" property.
deprecated method SetDetectedIssue(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 "detectedIssue" property.
deprecated method SetEventHistory(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 "eventHistory" 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 SetNotDone(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 "notDone" property.
deprecated method SetNotDoneReasonCodeableConcept(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 "notDoneReasonCodeableConcept" property.
deprecated method SetNotDoneReasonReference(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 "notDoneReasonReference" property.
deprecated method SetPartOf(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 "partOf" 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 SetReceiver(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 "receiver" 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.
deprecated method SetSubject(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 "subject" property.
deprecated method SetSupportingInformation(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 "supportingInformation" 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 SetWhenHandedOver(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 "whenHandedOver" property.
deprecated method SetWhenPrepared(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 "whenPrepared" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab