Skip to main content

HS.FHIRModel.R4.MedicationDispense

class HS.FHIRModel.R4.MedicationDispense extends HS.FHIRModel.FHIRClassSuper

*****************************************
** MedicationDispense generated class schema
*****************************************
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 XMLTYPE = R4_MEDICATIONDISPENSE;
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 _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _whenHandedOver as HS.FHIRModel.R4.Element;
Extensions for whenHandedOver
Property methods: _whenHandedOverGet(), _whenHandedOverGetSwizzled(), _whenHandedOverIsValid(), _whenHandedOverNewObject(), _whenHandedOverSet()
property _whenPrepared as HS.FHIRModel.R4.Element;
Extensions for whenPrepared
Property methods: _whenPreparedGet(), _whenPreparedGetSwizzled(), _whenPreparedIsValid(), _whenPreparedNewObject(), _whenPreparedSet()
property authorizingPrescription as HS.FHIRModel.R4.SeqOfReference;
Indicates the medication order that is being dispensed against.
Property methods: authorizingPrescriptionGet(), authorizingPrescriptionGetSwizzled(), authorizingPrescriptionIsValid(), authorizingPrescriptionNewObject(), authorizingPrescriptionSet()
property category as HS.FHIRModel.R4.CodeableConcept;
Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property context as HS.FHIRModel.R4.Reference;
The encounter or episode of care that establishes the context for this event.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property daysSupply as HS.FHIRModel.R4.Quantity;
The amount of medication expressed as a timing amount.
Property methods: daysSupplyGet(), daysSupplyGetSwizzled(), daysSupplyIsValid(), daysSupplyNewObject(), daysSupplySet()
property destination as HS.FHIRModel.R4.Reference;
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 HS.FHIRModel.R4.SeqOfReference;
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: detectedIssueGet(), detectedIssueGetSwizzled(), detectedIssueIsValid(), detectedIssueNewObject(), detectedIssueSet()
property dosageInstruction as HS.FHIRModel.R4.SeqOfDosage;
Indicates how the medication is to be used by the patient.
Property methods: dosageInstructionGet(), dosageInstructionGetSwizzled(), dosageInstructionIsValid(), dosageInstructionNewObject(), dosageInstructionSet()
property eventHistory as HS.FHIRModel.R4.SeqOfReference;
A summary of the events of interest that have occurred, such as when the dispense was verified.
Property methods: eventHistoryGet(), eventHistoryGetSwizzled(), eventHistoryIsValid(), eventHistoryNewObject(), eventHistorySet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property location as HS.FHIRModel.R4.Reference;
The principal physical location where the dispense was performed.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property medicationCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
Property methods: medicationCodeableConceptGet(), medicationCodeableConceptGetSwizzled(), medicationCodeableConceptIsValid(), medicationCodeableConceptNewObject(), medicationCodeableConceptSet()
property medicationReference as HS.FHIRModel.R4.Reference;
Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
Property methods: medicationReferenceGet(), medicationReferenceGetSwizzled(), medicationReferenceIsValid(), medicationReferenceNewObject(), medicationReferenceSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
Extra information about the dispense that could not be conveyed in the other attributes.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property partOf as HS.FHIRModel.R4.SeqOfReference;
The procedure that trigger the dispense.
Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
Indicates who or what performed the event.
Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property quantity as HS.FHIRModel.R4.Quantity;
The amount of medication that has been dispensed. Includes unit of measure.
Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
property receiver as HS.FHIRModel.R4.SeqOfReference;
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: receiverGet(), receiverGetSwizzled(), receiverIsValid(), receiverNewObject(), receiverSet()
property resourceType as %String [ InitialExpression = "MedicationDispense" , Required ];
This is a MedicationDispense resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String;
A code specifying the state of the set of dispense events.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusReasonCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
Indicates the reason why a dispense was not performed.
Property methods: statusReasonCodeableConceptGet(), statusReasonCodeableConceptGetSwizzled(), statusReasonCodeableConceptIsValid(), statusReasonCodeableConceptNewObject(), statusReasonCodeableConceptSet()
property statusReasonReference as HS.FHIRModel.R4.Reference;
Indicates the reason why a dispense was not performed.
Property methods: statusReasonReferenceGet(), statusReasonReferenceGetSwizzled(), statusReasonReferenceIsValid(), statusReasonReferenceNewObject(), statusReasonReferenceSet()
property subject as HS.FHIRModel.R4.Reference;
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()
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 HS.FHIRModel.R4.SeqOfReference;
Additional information that supports the medication being dispensed.
Property methods: supportingInformationGet(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationNewObject(), supportingInformationSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
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 %String;
The time the dispensed product was provided to the patient or their representative.
Property methods: whenHandedOverDisplayToLogical(), whenHandedOverGet(), whenHandedOverIsValid(), whenHandedOverLogicalToDisplay(), whenHandedOverLogicalToOdbc(), whenHandedOverNormalize(), whenHandedOverSet()
property whenPrepared as %String;
The time when the dispensed product was packaged and reviewed.
Property methods: whenPreparedDisplayToLogical(), whenPreparedGet(), whenPreparedIsValid(), whenPreparedLogicalToDisplay(), whenPreparedLogicalToOdbc(), whenPreparedNormalize(), whenPreparedSet()

Methods

method IncludeAuthorizingPrescription()
method IncludeCategory()
method IncludeContained()
method IncludeContext()
method IncludeDaysSupply()
method IncludeDestination()
method IncludeDetectedIssue()
method IncludeDosageInstruction()
method IncludeEventHistory()
method IncludeExtension()
method IncludeIdentifier()
method IncludeLocation()
method IncludeMedicationCodeableConcept()
method IncludeMedicationReference()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludePartOf()
method IncludePerformer()
method IncludeQuantity()
method IncludeReceiver()
method IncludeStatusReasonCodeableConcept()
method IncludeStatusReasonReference()
method IncludeSubject()
method IncludeSubstitution()
method IncludeSupportingInformation()
method IncludeText()
method IncludeType()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab