| 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 mail-order setting. This class adds shipping information to the properties defined in the parent Outpatient Medication Dispense class.
Attributes | ||
String | carrier |
A carrier is “an individual or company, as a railroad or steamship line, engaged in transporting passengers or goods for profit” (dictionary.com). This property identifies the shipping organization that took custody of the medication in order to deliver it to the patient. This property is currently modeled as a string although it is conceivable that it could be modeled as a code or an id if one wanted to have a controlled list of carriers. Since such a list is not readily available, and because there are many smaller carriers, we chose to leave this as a string. |
«TS» PointInTime | dateTimeMailed |
The date and time that a shipping organization (e.g., US Postal Service, Federal Express) took custody of the medication from the Pharmacy in order to deliver it to the patient. This date/time effectively becomes the dispense date/time as this is when the medication leaves the control of the Pharmacy. |
«TS» PointInTime | dateTimeReceived |
The date and time that the shipping organization delivered the medication to the patient, as reported by the shipping organization. This property is optional, as not all deliveries require delivery confirmation. |
String | trackingId |
An identifier issued by the shipping organization used to determine the shipment as it progresses through the various steps of the delivery process. It is used primarily for the patient or mail order pharmacy to inquire on the status of the delivery. |
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 | MailOrderDispense |
Name Expression | |
Namespace | Pharmacy |
Owned Template Signature | |
Owner | Pharmacy |
Owning Template Parameter | |
Package | Pharmacy |
Qualified Name | FHIM::Pharmacy::MailOrderDispense |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public String carrier
A carrier is “an individual or company, as a railroad or steamship line, engaged in transporting passengers or goods for profit” (dictionary.com). This property identifies the shipping organization that took custody of the medication in order to deliver it to the patient. This property is currently modeled as a string although it is conceivable that it could be modeled as a code or an id if one wanted to have a controlled list of carriers. Since such a list is not readily available, and because there are many smaller carriers, we chose to leave this as a string.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MailOrderDispense |
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 | carrier |
Name Expression | |
Namespace | MailOrderDispense |
Opposite | |
Owner | MailOrderDispense |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::MailOrderDispense::carrier |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime dateTimeMailed
The date and time that a shipping organization (e.g., US Postal Service, Federal Express) took custody of the medication from the Pharmacy in order to deliver it to the patient. This date/time effectively becomes the dispense date/time as this is when the medication leaves the control of the Pharmacy.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MailOrderDispense |
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 | dateTimeMailed |
Name Expression | |
Namespace | MailOrderDispense |
Opposite | |
Owner | MailOrderDispense |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::MailOrderDispense::dateTimeMailed |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime dateTimeReceived
The date and time that the shipping organization delivered the medication to the patient, as reported by the shipping organization. This property is optional, as not all deliveries require delivery confirmation.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MailOrderDispense |
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 | dateTimeReceived |
Name Expression | |
Namespace | MailOrderDispense |
Opposite | |
Owner | MailOrderDispense |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::MailOrderDispense::dateTimeReceived |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String trackingId
An identifier issued by the shipping organization used to determine the shipment as it progresses through the various steps of the delivery process. It is used primarily for the patient or mail order pharmacy to inquire on the status of the delivery.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MailOrderDispense |
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 | trackingId |
Name Expression | |
Namespace | MailOrderDispense |
Opposite | |
Owner | MailOrderDispense |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::MailOrderDispense::trackingId |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Pharmacy UML Documentation |
Summary:AttributesProperties | Detail:Attributes |