Pharmacy
Class OutpatientMedicationDispense

This class contains information about the provision of a medication to a patient or care provider under the authority of the owning Pharmacy Promise in an outpatient or retail setting.

Attributes
CouponRedemption couponRedemption couponRedemption

Pointer to information about the patient's use of a manufacturers coupon to reduce the patient's out-of-pocket cost for the prescription.

«CS» Code deliveryModality deliveryModality

This optional property indicates whether the medication dispensed was or will be: a) mailed to the patient, b) picked up at the pharmacy, or c) given to a clinician to take to the patient (e.g., a visiting nurse). This property is anticipated to be used primarily for workflow or tracking purposes.

PatientEducationPerformed patientEducationPerformed patientEducationPerformed

Pointer to information about counselling or education provided to the Patient or to the Patient's representative

«CS» Code paymentType paymentType

"The type of prescription benefit plan that adjudicated and paid for the prescription." - NCPDP Telecommunication (Field A29-ZS, Data Dictionary 201104).
"Code identifying the type of payment, i.e. how it was paid for." - ASAP Standard for PDMP, DSP16: Classification Code for Payment Type. Possible values include: Private pay (cash, charge, credit Card); Medicaid; Medicare; Commercial insurance; Military installations and VA; Workers' Compensation; Indian nations; or Other.

String salesTransactionId salesTransactionId

"A reference identifier assigned to the sale transaction as assigned by the merchant." - NCPDP Telecommunication (Field 681-ZF, Data Dictionary 201104).

«TS» PointInTime salesTransactionTime salesTransactionTime

The actual date and time the medication was released for inventory purposes and copay billing if applicable. (VistA). In the commercial sector, "release date" typically corresponds to the date/time that the patient took possession of the medication.
"This field is used to determine the date the prescription was dispensed (left the pharmacy), not the date it was prepared. This date could be captured from the point-of-sale (POS) system, if the pharmacy has a POS system, and there is a bidirectional flow with the pharmacy management system in order to capture and report this date. Or it could be captured and reported from a will-call management system integrated with the pharmacy management system." - ASAP Standard for PDMP, DSP17: Date Sold

«CS» Code wasPatientCounseled wasPatientCounseled

Captures whether or not the Patient (or Patient's representative) received counseling regarding the dispensed medication. Note that this property is a code in order to capture situations where the patient refused counselling. Thus the valid values for this field are currently defined as: Yes, the patient was counselled, No, the patient, was not counselled, or the Patient refused counselling. Note also that this property could potentially be calculated based on the presence of an associated Patient Education record. The PatientEducation.levelOfUnderstanding property includes Refused as a possible value.

Attributes inherited from FHIM::Pharmacy::PharmacyDispense FHIM::Pharmacy::PharmacyDispense
actualStrength actualStrength, dateTimeDispensed dateTimeDispensed, dateTimeFilled dateTimeFilled, daysSupply daysSupply, detectedIssue detectedIssue, dispensedDrug dispensedDrug, dispenseCategory dispenseCategory, dispenseMethod dispenseMethod, dispenseNotes dispenseNotes, dispenser dispenser, dispenseRecipient dispenseRecipient, dispenseToLocation dispenseToLocation, dispensingDevice dispensingDevice, dispensingInstructions dispensingInstructions, filler filler, fillSequenceNumber fillSequenceNumber, isCompound isCompound, kind kind, needsHumanReview needsHumanReview, partialFill partialFill, patientInstructions patientInstructions, pharmacist pharmacist, pharmacy pharmacy, pharmacyPromise pharmacyPromise, productSelectionCode productSelectionCode, reasonNotPerformed reasonNotPerformed, quantityDispensed quantityDispensed, specialPackaging specialPackaging, substitutionCode substitutionCode, wasSubstituted wasSubstituted

Attributes inherited from FHIM::Common::ActionPerformed FHIM::Common::ActionPerformed
basedOn basedOn, bodySite bodySite, complication complication, complicationDetail complicationDetail, duration duration, enactsPlan enactsPlan, focalDevice focalDevice, followUp followUp, fulfillsOrder fulfillsOrder, fulfillsPromise fulfillsPromise, nonCompletionTimeframe nonCompletionTimeframe, outcome outcome, partOf partOf, performancePeriod performancePeriod, performer performer, procedureModifier procedureModifier, report report, researchStudy researchStudy, status status, statusReason statusReason, timesPerformed timesPerformed, topicCode topicCode, usedCode usedCode, usedReference usedReference, wasCompleted wasCompleted

Attributes inherited from FHIM::Common::ActionStatement FHIM::Common::ActionStatement
category category, currentStatus currentStatus, description description, indication indication, inputFinding inputFinding, instantiatesCanonical instantiatesCanonical, instantiatesUri instantiatesUri, insurance insurance, intent intent, justification justification, location location, method method, outputFinding outputFinding, precondition precondition, reasonCode reasonCode, reasonNarrative reasonNarrative, reasonReference reasonReference, relevantHistory relevantHistory, scope scope, supportingInformation supportingInformation, usingDevice usingDevice, wasReported wasReported

Attributes inherited from FHIM::Common::ClinicalStatement FHIM::Common::ClinicalStatement
clinicalDataSource clinicalDataSource, contentVersion contentVersion, contextCode contextCode, encounter encounter, note note, recordStatus recordStatus, relatedClinicalInformation relatedClinicalInformation, sourceRecordType sourceRecordType, sourceSystem sourceSystem, subjectGroup subjectGroup, subjectOfInformation subjectOfInformation, subjectOfRecord subjectOfRecord, temporalContext temporalContext, topicCode topicCode, cosigned cosigned, recorded recorded, signed signed, verified verified

Attributes inherited from FHIM::Common::InformationEntry FHIM::Common::InformationEntry
identifier identifier

Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameOutpatientMedicationDispense
Name Expression
NamespacePharmacy
Owned Template Signature
OwnerPharmacy
Owning Template Parameter
PackagePharmacy
Qualified NameFHIM::Pharmacy::OutpatientMedicationDispense
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 couponRedemption
Public CouponRedemption couponRedemption

Pointer to information about the patient's use of a manufacturers coupon to reduce the patient's out-of-pocket cost for the prescription.

Constraints:
Properties:

AggregationNone
Alias
AssociationoutpatientMedicationDispense_couponRedemption
Association End
ClassOutpatientMedicationDispense
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamecouponRedemption
Name Expression
NamespaceOutpatientMedicationDispense
Opposite
OwnerOutpatientMedicationDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::OutpatientMedicationDispense::couponRedemption
Stereotype
Template Parameter
TypeCouponRedemption
Upper1
Upper Value(1)
VisibilityPublic


 deliveryModality
Public «CS» Code deliveryModality

This optional property indicates whether the medication dispensed was or will be: a) mailed to the patient, b) picked up at the pharmacy, or c) given to a clinician to take to the patient (e.g., a visiting nurse). This property is anticipated to be used primarily for workflow or tracking purposes.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOutpatientMedicationDispense
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamedeliveryModality
Name Expression
NamespaceOutpatientMedicationDispense
Opposite
OwnerOutpatientMedicationDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::OutpatientMedicationDispense::deliveryModality
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 patientEducationPerformed
Public PatientEducationPerformed patientEducationPerformed

Pointer to information about counselling or education provided to the Patient or to the Patient's representative

Constraints:
Properties:

AggregationNone
Alias
AssociationoutpatientMedicationDispense_patientEducationPerformed
Association End
ClassOutpatientMedicationDispense
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamepatientEducationPerformed
Name Expression
NamespaceOutpatientMedicationDispense
Opposite
OwnerOutpatientMedicationDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::OutpatientMedicationDispense::patientEducationPerformed
Stereotype
Template Parameter
TypePatientEducationPerformed
Upper1
Upper Value(1)
VisibilityPublic


 paymentType
Public «CS» Code paymentType

"The type of prescription benefit plan that adjudicated and paid for the prescription." - NCPDP Telecommunication (Field A29-ZS, Data Dictionary 201104).
"Code identifying the type of payment, i.e. how it was paid for." - ASAP Standard for PDMP, DSP16: Classification Code for Payment Type. Possible values include: Private pay (cash, charge, credit Card); Medicaid; Medicare; Commercial insurance; Military installations and VA; Workers' Compensation; Indian nations; or Other.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOutpatientMedicationDispense
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamepaymentType
Name Expression
NamespaceOutpatientMedicationDispense
Opposite
OwnerOutpatientMedicationDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::OutpatientMedicationDispense::paymentType
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 salesTransactionId
Public String salesTransactionId

"A reference identifier assigned to the sale transaction as assigned by the merchant." - NCPDP Telecommunication (Field 681-ZF, Data Dictionary 201104).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOutpatientMedicationDispense
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamesalesTransactionId
Name Expression
NamespaceOutpatientMedicationDispense
Opposite
OwnerOutpatientMedicationDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::OutpatientMedicationDispense::salesTransactionId
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 salesTransactionTime
Public «TS» PointInTime salesTransactionTime

The actual date and time the medication was released for inventory purposes and copay billing if applicable. (VistA). In the commercial sector, "release date" typically corresponds to the date/time that the patient took possession of the medication.
"This field is used to determine the date the prescription was dispensed (left the pharmacy), not the date it was prepared. This date could be captured from the point-of-sale (POS) system, if the pharmacy has a POS system, and there is a bidirectional flow with the pharmacy management system in order to capture and report this date. Or it could be captured and reported from a will-call management system integrated with the pharmacy management system." - ASAP Standard for PDMP, DSP17: Date Sold

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOutpatientMedicationDispense
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamesalesTransactionTime
Name Expression
NamespaceOutpatientMedicationDispense
Opposite
OwnerOutpatientMedicationDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::OutpatientMedicationDispense::salesTransactionTime
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 wasPatientCounseled
Public «CS» Code wasPatientCounseled

Captures whether or not the Patient (or Patient's representative) received counseling regarding the dispensed medication. Note that this property is a code in order to capture situations where the patient refused counselling. Thus the valid values for this field are currently defined as: Yes, the patient was counselled, No, the patient, was not counselled, or the Patient refused counselling. Note also that this property could potentially be calculated based on the presence of an associated Patient Education record. The PatientEducation.levelOfUnderstanding property includes Refused as a possible value.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassOutpatientMedicationDispense
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamewasPatientCounseled
Name Expression
NamespaceOutpatientMedicationDispense
Opposite
OwnerOutpatientMedicationDispense
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::OutpatientMedicationDispense::wasPatientCounseled
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic