| Pharmacy UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
This class contains information about a Pharmacy Order, commonly referred to as a prescription. This class represents the prescription from the perspective of the filling system (i.e., the pharmacy) whereas the Pharmacy Request represents the prescription from the ordering system (i.e., the prescriber). This class is a subtype of the more general Healthcare Promise, which describes properties common to all types or Orders from the filling system perspective– this class adds those properties which are specific to medication orders. This class is called Pharmacy Promise rather than Pharmacy Order following the HL7 V3 convention to use the term Promise to indicate that it is from the filling system’s perspective. There are many properties which are identical to the Order; this is because the pharmacy may change the order, within prescribed limits, for example substituting a generic drug for a brand-named one.
Attributes | ||
«TS» PointInTime | appointmentTime | |
PharmacyDispense | dispense |
Pointer to information about the provision of a medication to a Patient or care provider under the authority of the owning Pharmacy Promise. In other words, this is a collection of dispensing events associated with the (pharmacy systems's view of the ) Order. |
Dosage | dosage |
Pointer to information used to describe how the medication should be taken by the Patient, as described by the Pharmacist (the pharmacist can change the ordered dosage under certain circumstances). |
«TS» PointInTime | expirationDate | |
PractitionerParticipation | finisher |
A pharmacy personnel who reviews the order and makes any required changes that are allowed under the usual and customary boundaries. The end result of this activity is an order that can be fulfilled. This role also called verifier, or perfecter. |
Boolean | isHospitalSuppliedSelfAdministered |
A flag indicating that the medication given to the patient is to be self administered and is to be supplied by the hospitals pharmacy while they are an inpatient. |
Boolean | isSelfAdministered |
A flag indicating that the medication given to the patient is to be self administered. |
«TS» PointInTime | lastDispenseDate |
The most recent date (and optionally time) that the medication was distributed to a patient, patient care-giver, or the location at which the patient is receiving care."Date/time of the most recent refill or dose dispensed." - HL7 Version 2.8, RXE-18. |
Boolean | needsHumanReview |
This optional property is included for compatibility with HL7 version 2. It is used in version 2 messaging to convey that a warning is present in the dispensing instructions field and that downstream applications are expected to alert the human user to the presence of the warning."Yes - Indicates that a warning is present. The application receiving the encoded order needs to warn the person administering the drug or treatment to pay attention to the text in RXE-21-pharmacy/treatment special dispensing instructions. No - Indicates no warning " - HL7 Version 2.8, RXE-20. |
Integer | numberOfRefillsOrDosesDispensed |
"Number of refills remaining." - HL7 Version 2.8, RXE-17 (Number of Refills/Doses Dispensed). |
Integer | numberOfRefillsRemaining |
Indicates the number of times the order may be filled without additional authorization. It is calculated by substracting the number of fills already completed from the number of fills authorized by the prescriber."This field is conditional because it is required when a prescription is dispensed to an outpatient. It is not relevant to inpatient treatment orders." - HL7 Version 2.8, RXD-8."Number of refills remaining." - HL7 Version 2.8, RXE-16 (Number of Refills Remaining). |
PatientReportedMedication | patientReportedMedication |
Pointer to information about medication(s) which the patient reports to be using. |
Pharmacy | pharmacy |
"Specifies the pharmacy that will dispense or has dispensed the prescription." - HL7 Version 2.8, RXO-32."Specifies the address of the dispensing facility." - HL7 Version 2.8, RXO-33."Contains the telecommunication contact information for the pharmacy." - HL7 Version 2.8, RXO-36. |
PharmacyGeneratedOrderModification | pharmacyGeneratedOrderModification |
Pointer to information concerning any changes made to the original order by the pharmacist."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." - HL7 FHIR, MedicationDispense.substitution |
DiagnosisListEntry | pharmacyInferredDiagnosis |
Many claims require a diagnosis in order to be adjudicated, especially in workers compensation situations or where multiple payers are involved. In those cases and where the pharmacy does not have a diagnosis supplied by the prescriber, the pharmacy may infer a diagnosis based on the medication or services ordered. See field 6813 of the NCPDP SCRIPT DRU segment. |
OrderablePharmacyItem | promisedItem |
Pointer to the medication or pharmacy-stocked item that the Pharmacy has agreed to supply to the Patient. This will normally be the same as the one ordered by the prescriber, but may be different under certain pre-defined conditions. For example, the provider may have ordered a brand-name drug, but indicated that a generic substitution is authorized, and the pharmacy may have substituted a generic drug. Other situations include changes due to inventory at hand, for example the prescriber may have ordered 10 mg tablets, but only 5 mg tablets were available."Identifies the medical substance or treatment that has been ordered to be given to the patient, as encoded by the pharmacy or treatment supplier" - HL7 Version 2.8, RXE-2."This field accommodates the identification of any codes that might be associated with the pharmaceutical substance. Common codes include: the Generic Product Identifier (GPI), Generic Code Number_Sequence Number (GCN_SEQNO), National Drug Code (NDC)." - HL7 Version 2.8, RXE-31. |
«IVL_TS» Period | requestedAdministrationTime |
Specifies when the service is to be performed and how frequently. Note that this is a complex data type that may indicate specific times or intervals (e.g., 10:00 AM, MWF, etc). |
«PQ» TimeQuantity | requestedDuration |
The duration of an order as requested by the ordering clinician. The duration would be expressed as a number of days, weeks, hours, etc. Note that this length of time might be determined by a business rule of the facilty. For example, most facilties will have a limit of 7 days for antibiotics, and 3 days for schedule 1 drugs. |
ReturnToStock | returnToStock |
Pointer to information about the reversal of a provision of a medication to a patient or care provider under the authority of the owning Pharmacy Promise. |
«CS» Code | scheduleType |
"This describes the type of schedule for the dispensing of the medication(s) that make up the order. PRE-OP orders are usually considered to be ON-CALL orders, and orders dispensed as MULTI-DOSE CONTAINERS are usually considered to be FILL ON REQUEST orders. C=Continuous, O=One Time, P=PRN, R=Fill On Request, OC=On Call." (VistA) |
«CS» Code | substitutionCode |
If the Pharmacist has changed the kind of medication to be dispensed to the patient from the one originally ordered by the prescriber, this property provides a categorization of the kind of substitution that was made."Refer to HL7 Table 0167 - Substitution Status in Chapter 2C for suggested values." - HL7 Version 2.8, RXD-11."Refer to HL7 Table 0167 - Substitution Status in Chapter 2C for suggested values." - HL7 Version 2.8, RXE-9."Product/Service Substitution, coded" - NCPDP Script (Field 4457, Data Dictionary 201104)"Code indicating whether or not the prescriber’s instructions regarding generic substitution were followed." - NCPDP Telecommunication (Field 408-D8, Data Dictionary 201104).-----Possible values include (from HL7 Table 167): No substitute was dispensed. This is equivalent to the default (null) value; A generic substitution was dispensed; A therapeutic substitution was dispensed; No product selection indicated; Substitution not allowed by prescriber; Substitution allowed - patient requested product dispensed; Substitution allowed - pharmacist selected product dispensed; Substitution allowed - generic drug not in stock; Substitution allowed - brand drug dispensed as a generic; Substitution not allowed - brand drug mandated by law; Substitution allowed - generic drug not available in marketplace.-----Possible values include (From NCPDP ECL):No Product Selection IndicatedSubstitution Not Allowed by PrescriberSubstitution Allowed - Patient Requested Product DispensedSubstitution Allowed - Pharmacist Selected Product DispensedSubstitution Allowed - Generic Drug Not in StockSubstitution Allowed - Brand Drug Dispensed as a Generic OverrideSubstitution Not Allowed - Brand Drug Mandated by LawSubstitution Allowed - Generic Drug Not Available in MarketplaceSubstitution Allowed By Prescriber but Plan Requests Brand - Patient's Plan Requested Brand Product To Be Dispensed |
Attributes inherited from FHIM::Orders::Promise | ||
chargeToPracticeCode, chargeToPracticeCost, dateAccepted, discontinueDate, expectedAvailabilityDate, fillerOrderId, fillerSupplementalInfo, order, orderModality, precautionProtocolInvoked, priority, promisingOrganization, promisingProvider, scheduledDateTime, status, statusChangeDateTime, statusModifier |
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 | EntryPoint |
Name | PharmacyPromise |
Name Expression | |
Namespace | Pharmacy |
Owned Template Signature | |
Owner | Pharmacy |
Owning Template Parameter | |
Package | Pharmacy |
Qualified Name | FHIM::Pharmacy::PharmacyPromise |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public «TS» PointInTime appointmentTime
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | appointmentTime |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::appointmentTime |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public PharmacyDispense dispense
Pointer to information about the provision of a medication to a Patient or care provider under the authority of the owning Pharmacy Promise. In other words, this is a collection of dispensing events associated with the (pharmacy systems's view of the ) Order.
Aggregation | None |
Alias | |
Association | pharmacyPromise_dispense |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | false |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | dispense |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::dispense |
Stereotype | |
Template Parameter | |
Type | PharmacyDispense |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Dosage dosage
Pointer to information used to describe how the medication should be taken by the Patient, as described by the Pharmacist (the pharmacist can change the ordered dosage under certain circumstances).
Aggregation | None |
Alias | |
Association | pharmacyPromise_dosage |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | * |
Name | dosage |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::dosage |
Stereotype | |
Template Parameter | |
Type | Dosage |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «TS» PointInTime expirationDate
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | expirationDate |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::expirationDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public PractitionerParticipation finisher
A pharmacy personnel who reviews the order and makes any required changes that are allowed under the usual and customary boundaries. The end result of this activity is an order that can be fulfilled. This role also called verifier, or perfecter.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | finisher |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::finisher |
Stereotype | |
Template Parameter | |
Type | PractitionerParticipation |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Boolean isHospitalSuppliedSelfAdministered
A flag indicating that the medication given to the patient is to be self administered and is to be supplied by the hospitals pharmacy while they are an inpatient.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | isHospitalSuppliedSelfAdministered |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::isHospitalSuppliedSelfAdministered |
Stereotype | |
Template Parameter | |
Type | Boolean |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Boolean isSelfAdministered
A flag indicating that the medication given to the patient is to be self administered.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | isSelfAdministered |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::isSelfAdministered |
Stereotype | |
Template Parameter | |
Type | Boolean |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime lastDispenseDate
The most recent date (and optionally time) that the medication was distributed to a patient, patient care-giver, or the location at which the patient is receiving care."Date/time of the most recent refill or dose dispensed." - HL7 Version 2.8, RXE-18.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | lastDispenseDate |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::lastDispenseDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Boolean needsHumanReview
This optional property is included for compatibility with HL7 version 2. It is used in version 2 messaging to convey that a warning is present in the dispensing instructions field and that downstream applications are expected to alert the human user to the presence of the warning."Yes - Indicates that a warning is present. The application receiving the encoded order needs to warn the person administering the drug or treatment to pay attention to the text in RXE-21-pharmacy/treatment special dispensing instructions. No - Indicates no warning " - HL7 Version 2.8, RXE-20.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | needsHumanReview |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::needsHumanReview |
Stereotype | |
Template Parameter | |
Type | Boolean |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Integer numberOfRefillsOrDosesDispensed
"Number of refills remaining." - HL7 Version 2.8, RXE-17 (Number of Refills/Doses Dispensed).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | numberOfRefillsOrDosesDispensed |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::numberOfRefillsOrDosesDispensed |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Integer numberOfRefillsRemaining
Indicates the number of times the order may be filled without additional authorization. It is calculated by substracting the number of fills already completed from the number of fills authorized by the prescriber."This field is conditional because it is required when a prescription is dispensed to an outpatient. It is not relevant to inpatient treatment orders." - HL7 Version 2.8, RXD-8."Number of refills remaining." - HL7 Version 2.8, RXE-16 (Number of Refills Remaining).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | numberOfRefillsRemaining |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::numberOfRefillsRemaining |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public PatientReportedMedication patientReportedMedication
Pointer to information about medication(s) which the patient reports to be using.
Aggregation | None |
Alias | |
Association | pharmacyPromise_patientReportedMedication |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | false |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | patientReportedMedication |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::patientReportedMedication |
Stereotype | |
Template Parameter | |
Type | PatientReportedMedication |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Pharmacy pharmacy
"Specifies the pharmacy that will dispense or has dispensed the prescription." - HL7 Version 2.8, RXO-32."Specifies the address of the dispensing facility." - HL7 Version 2.8, RXO-33."Contains the telecommunication contact information for the pharmacy." - HL7 Version 2.8, RXO-36.
Aggregation | None |
Alias | |
Association | pharmacyPromise_pharmacy |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | pharmacy |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::pharmacy |
Stereotype | |
Template Parameter | |
Type | Pharmacy |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public PharmacyGeneratedOrderModification pharmacyGeneratedOrderModification
Pointer to information concerning any changes made to the original order by the pharmacist."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." - HL7 FHIR, MedicationDispense.substitution
Aggregation | None |
Alias | |
Association | pharmacyPromise_pharmacyGeneratedOrderModification |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | * |
Name | pharmacyGeneratedOrderModification |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::pharmacyGeneratedOrderModification |
Stereotype | |
Template Parameter | |
Type | PharmacyGeneratedOrderModification |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public DiagnosisListEntry pharmacyInferredDiagnosis
Many claims require a diagnosis in order to be adjudicated, especially in workers compensation situations or where multiple payers are involved. In those cases and where the pharmacy does not have a diagnosis supplied by the prescriber, the pharmacy may infer a diagnosis based on the medication or services ordered. See field 6813 of the NCPDP SCRIPT DRU segment.
Aggregation | None |
Alias | |
Association | pharmacyPromise_pharmacyInferredDiagnosis |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | * |
Name | pharmacyInferredDiagnosis |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::pharmacyInferredDiagnosis |
Stereotype | |
Template Parameter | |
Type | DiagnosisListEntry |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public OrderablePharmacyItem promisedItem
Pointer to the medication or pharmacy-stocked item that the Pharmacy has agreed to supply to the Patient. This will normally be the same as the one ordered by the prescriber, but may be different under certain pre-defined conditions. For example, the provider may have ordered a brand-name drug, but indicated that a generic substitution is authorized, and the pharmacy may have substituted a generic drug. Other situations include changes due to inventory at hand, for example the prescriber may have ordered 10 mg tablets, but only 5 mg tablets were available."Identifies the medical substance or treatment that has been ordered to be given to the patient, as encoded by the pharmacy or treatment supplier" - HL7 Version 2.8, RXE-2."This field accommodates the identification of any codes that might be associated with the pharmaceutical substance. Common codes include: the Generic Product Identifier (GPI), Generic Code Number_Sequence Number (GCN_SEQNO), National Drug Code (NDC)." - HL7 Version 2.8, RXE-31.
Aggregation | None |
Alias | |
Association | pharmacyPromise_promisedItem |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | promisedItem |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::promisedItem |
Stereotype | |
Template Parameter | |
Type | OrderablePharmacyItem |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «IVL_TS» Period requestedAdministrationTime
Specifies when the service is to be performed and how frequently. Note that this is a complex data type that may indicate specific times or intervals (e.g., 10:00 AM, MWF, etc).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyPromise |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | true |
Is Read Only | false |
Is Static | false |
Is Unique | false |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | requestedAdministrationTime |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::requestedAdministrationTime |
Stereotype | |
Template Parameter | |
Type | «IVL_TS» Period |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «PQ» TimeQuantity requestedDuration
The duration of an order as requested by the ordering clinician. The duration would be expressed as a number of days, weeks, hours, etc. Note that this length of time might be determined by a business rule of the facilty. For example, most facilties will have a limit of 7 days for antibiotics, and 3 days for schedule 1 drugs.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | requestedDuration |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::requestedDuration |
Stereotype | |
Template Parameter | |
Type | «PQ» TimeQuantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public ReturnToStock returnToStock
Pointer to information about the reversal of a provision of a medication to a patient or care provider under the authority of the owning Pharmacy Promise.
Aggregation | None |
Alias | |
Association | pharmacyPromise_returnToStock |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | * |
Name | returnToStock |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::returnToStock |
Stereotype | |
Template Parameter | |
Type | ReturnToStock |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code scheduleType
"This describes the type of schedule for the dispensing of the medication(s) that make up the order. PRE-OP orders are usually considered to be ON-CALL orders, and orders dispensed as MULTI-DOSE CONTAINERS are usually considered to be FILL ON REQUEST orders. C=Continuous, O=One Time, P=PRN, R=Fill On Request, OC=On Call." (VistA)
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | scheduleType |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::scheduleType |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code substitutionCode
If the Pharmacist has changed the kind of medication to be dispensed to the patient from the one originally ordered by the prescriber, this property provides a categorization of the kind of substitution that was made."Refer to HL7 Table 0167 - Substitution Status in Chapter 2C for suggested values." - HL7 Version 2.8, RXD-11."Refer to HL7 Table 0167 - Substitution Status in Chapter 2C for suggested values." - HL7 Version 2.8, RXE-9."Product/Service Substitution, coded" - NCPDP Script (Field 4457, Data Dictionary 201104)"Code indicating whether or not the prescriber’s instructions regarding generic substitution were followed." - NCPDP Telecommunication (Field 408-D8, Data Dictionary 201104).-----Possible values include (from HL7 Table 167): No substitute was dispensed. This is equivalent to the default (null) value; A generic substitution was dispensed; A therapeutic substitution was dispensed; No product selection indicated; Substitution not allowed by prescriber; Substitution allowed - patient requested product dispensed; Substitution allowed - pharmacist selected product dispensed; Substitution allowed - generic drug not in stock; Substitution allowed - brand drug dispensed as a generic; Substitution not allowed - brand drug mandated by law; Substitution allowed - generic drug not available in marketplace.-----Possible values include (From NCPDP ECL):No Product Selection IndicatedSubstitution Not Allowed by PrescriberSubstitution Allowed - Patient Requested Product DispensedSubstitution Allowed - Pharmacist Selected Product DispensedSubstitution Allowed - Generic Drug Not in StockSubstitution Allowed - Brand Drug Dispensed as a Generic OverrideSubstitution Not Allowed - Brand Drug Mandated by LawSubstitution Allowed - Generic Drug Not Available in MarketplaceSubstitution Allowed By Prescriber but Plan Requests Brand - Patient's Plan Requested Brand Product To Be Dispensed
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyPromise |
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 | substitutionCode |
Name Expression | |
Namespace | «EntryPoint» PharmacyPromise |
Opposite | |
Owner | «EntryPoint» PharmacyPromise |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyPromise::substitutionCode |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Pharmacy UML Documentation |
Summary:AttributesProperties | Detail:Attributes |