| Pharmacy UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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 |
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 |
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 |
Pointer to information about counselling or education provided to the Patient or to the Patient's representative |
«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. |
String | 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 |
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 |
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::Common::ActionPerformed | ||
basedOn, bodySite, complication, complicationDetail, duration, enactsPlan, focalDevice, followUp, fulfillsOrder, fulfillsPromise, nonCompletionTimeframe, outcome, partOf, performancePeriod, performer, procedureModifier, report, researchStudy, status, statusReason, timesPerformed, topicCode, usedCode, usedReference, wasCompleted |
Attributes inherited from FHIM::Common::ActionStatement | ||
category, currentStatus, description, indication, inputFinding, instantiatesCanonical, instantiatesUri, insurance, intent, justification, location, method, outputFinding, precondition, reasonCode, reasonNarrative, reasonReference, relevantHistory, scope, supportingInformation, usingDevice, wasReported |
Attributes inherited from FHIM::Common::ClinicalStatement | ||
clinicalDataSource, contentVersion, contextCode, encounter, note, recordStatus, relatedClinicalInformation, sourceRecordType, sourceSystem, subjectGroup, subjectOfInformation, subjectOfRecord, temporalContext, topicCode, cosigned, recorded, signed, verified |
Attributes inherited from FHIM::Common::InformationEntry | ||
identifier |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | OutpatientMedicationDispense |
Name Expression | |
Namespace | Pharmacy |
Owned Template Signature | |
Owner | Pharmacy |
Owning Template Parameter | |
Package | Pharmacy |
Qualified Name | FHIM::Pharmacy::OutpatientMedicationDispense |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
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.
Aggregation | None |
Alias | |
Association | outpatientMedicationDispense_couponRedemption |
Association End | |
Class | OutpatientMedicationDispense |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | couponRedemption |
Name Expression | |
Namespace | OutpatientMedicationDispense |
Opposite | |
Owner | OutpatientMedicationDispense |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::OutpatientMedicationDispense::couponRedemption |
Stereotype | |
Template Parameter | |
Type | CouponRedemption |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | OutpatientMedicationDispense |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | deliveryModality |
Name Expression | |
Namespace | OutpatientMedicationDispense |
Opposite | |
Owner | OutpatientMedicationDispense |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::OutpatientMedicationDispense::deliveryModality |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public PatientEducationPerformed patientEducationPerformed
Pointer to information about counselling or education provided to the Patient or to the Patient's representative
Aggregation | None |
Alias | |
Association | outpatientMedicationDispense_patientEducationPerformed |
Association End | |
Class | OutpatientMedicationDispense |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | patientEducationPerformed |
Name Expression | |
Namespace | OutpatientMedicationDispense |
Opposite | |
Owner | OutpatientMedicationDispense |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::OutpatientMedicationDispense::patientEducationPerformed |
Stereotype | |
Template Parameter | |
Type | PatientEducationPerformed |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | OutpatientMedicationDispense |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | paymentType |
Name Expression | |
Namespace | OutpatientMedicationDispense |
Opposite | |
Owner | OutpatientMedicationDispense |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::OutpatientMedicationDispense::paymentType |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String salesTransactionId
"A reference identifier assigned to the sale transaction as assigned by the merchant." - NCPDP Telecommunication (Field 681-ZF, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | OutpatientMedicationDispense |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | salesTransactionId |
Name Expression | |
Namespace | OutpatientMedicationDispense |
Opposite | |
Owner | OutpatientMedicationDispense |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::OutpatientMedicationDispense::salesTransactionId |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | OutpatientMedicationDispense |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | salesTransactionTime |
Name Expression | |
Namespace | OutpatientMedicationDispense |
Opposite | |
Owner | OutpatientMedicationDispense |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::OutpatientMedicationDispense::salesTransactionTime |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | OutpatientMedicationDispense |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | wasPatientCounseled |
Name Expression | |
Namespace | OutpatientMedicationDispense |
Opposite | |
Owner | OutpatientMedicationDispense |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::OutpatientMedicationDispense::wasPatientCounseled |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Pharmacy UML Documentation |
Summary:AttributesProperties | Detail:Attributes |