| Pharmacy UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
This class contains information about a Pharmacy Order, commonly referred to as a prescription. This class is a subtype of the more general Healthcare Order, which describes properties common to all types or Orders – this class adds those properties which are specific to medication orders. It can be said that this represent the prescription from the perspective of the ordering system whereas the Pharmacy Promise represents the prescription from the filling system (i.e., the pharmacy). This class is called Pharmacy Request rather than Pharmacy Order following the HL7 V3 convention to use the term Request instead of Order.
Attributes | ||
«TS» PointInTime | _startDate |
The date on which the patient is to begin (or began, if historical) consuming the ordered medication. |
«TS» PointInTime | _stopDate |
The date on which the Patient is to discontinue consuming (or did discontinue consumption of) the ordered medication."The date (and perhaps time) when the prescription was stopped." - HL7 FHIR, MedicationOrder.dateEnded |
«CS» Code | allowSubstitutions |
This optional property indicates whether the prescriber has authorized the pharmacy to fill the order with a generic drug when the prescriber used a brand-name drug, or to fill the order with a therapeutically equivalent drug."Following are the values: N=Substitutions are NOT authorized; G=Allow generic substitutions; T=Allow therapeutic substitutions" - HL7 Version 2.8, RXO-9."True if the prescriber allows a different drug to be dispensed from what was prescribed." - HL7 FHIR, MedicationOrder.substitution.allowed"Indicates the reason for the substitution, or why substitution must or must not be performed." - HL7 FHIR, MedicationOrder.substitution.reason |
Boolean | areRefillsAuthorizedAsNeeded |
Indicates whether the prescriber has authorized additional fills of this order as needed. |
HealthcareProvider | deliverTo |
Pointer to the clinical provider or agency to which the mediction will be delivered. Added 3/18/2015 to handle the designation in the order of a specialty drug of the provider which should receive for example. For example, an IV medication would not be sent to the patient's home but to the home infusion agency that will administer the medication. |
deliverToLocation |
"Specifies the location of the patient to whom the pharmaceutical substance is to be delivered." - HL7 Version 2.8, RXO-34."Specifies the address, either mailing or physical, to which the prescription should be mailed or delivered." - HL7 Version 2.8, RXO-35. |
|
String | dispensingInstructions |
"Identifies the ordering provider's instructions to the pharmacy or the non-pharmacy treatment provider (e.g., respiratory therapy)." - HL7 Version 2.8, RXO-6. |
Dosage | dosage |
Pointer to information used to describe how the medication should be taken by the Patient, as ordered by the prescriber. |
DrugCoverageStatus | drugCoverageStatus |
Pointer to a set of (zero to many) coverage statuses for the prescribed drug. |
DrugUseEvaluation | drugUseEvaluation |
Pointer to the results of a Drug Use Evaluation (DUE) or a Drug Utilization Review (DUR). |
«TS» PointInTime | expirationDate |
The date after which the order may no longer be filled."This indicates the validity period of a prescription (stale dating the Prescription)." - HL7 FHIR, MedicationOrder.dispenseRequest.validityPeriod |
«IVL_TS» Period | frequency |
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). |
«CS» Code | frequencyCode |
Specifies when the service is to be performed and how frequently. This optional property allows for the frequency to be expressed as a code (or possibly a string), in order to accomodate non-numeric expressions, such as every morning, or during the afternoon shift. Added for Davita, 1/23/2015. |
Indication | indication |
"Identifies the condition or problem for which the drug/treatment was prescribed." - HL7 Version 2.8, RXO-20."Contains the identifier of the condition or problem for which the drug/treatment was prescribed. May repeat if multiple indications are relevant." - HL7 Version 2.8, RXD-21."Can be the reason or the indication for writing the prescription." - HL7 FHIR, MedicationOrder.reasonCode |
«IVL_TS» Period | intendedDuration |
The period of time over which the supplied medication or product is expected to be used, or the length of time the dispense is expected to last."Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last." - HL7 FHIR, MedicationOrder.dispenseRequest.expectedSupplyDuration |
«CS» Code | intendedDurationCode |
The period of time over which the supplied medication or product is expected to be used, or the length of time the dispense is expected to last. This optional property allows for the intended duration to be expressed as a code (or possibly a string), in order to accomodate non-numeric expressions. Added for Davita, 1/23/2015."Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last." - HL7 FHIR, MedicationOrder.dispenseRequest.expectedSupplyDuration |
«TS» PointInTime | neededNoLaterThan |
"Conditional composite for the facility to relay to the long term care pharmacy the timeframe when medication is needed for delivery. When a facility transmits either a new medication order (NEWRX) or request for the re-supply of a medication (RESUPP) to a pharmacy, it would optionally indicate the time by which the medication is needed. The facility could also provide a textual reason why the medication is needed by the time specified. The long term care pharmacy would then use this information to determine whether a special delivery is required, or whether the order could go out with the next scheduled delivery." - NCPDP Script (Field I006) |
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.Indicates whether "the pharmacist or non-pharmacist treatment supplier filling the order needs to pay special attention to the text in the [Dispensing Instructions]. A warning is present." - HL7 Version 2.8, RXO-16. |
Integer | numberOfRefillsAuthorized |
"Defines the number of times the requested dispense amount can be given to the patient, subject to local regulation. Refers to outpatient only." - HL7 Version 2.8, RXO-13."The total original number of refills. Outpatient only" - HL7 Version 2.8, RXE-12."An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets." - HL7 FHIR, MedicationOrder.dispenseRequest.numberOfRepeatsAllowed"Number of refills authorized by the prescriber." - NCPDP Telecommunication (Field 415-DF, Data Dictionary 201104). Note that while the NCPDP Telecommunication structure treats this field as a code, it contains a number from 0-99, where zero means no refills authorized, and 1-98 are the number of refills authorized, and 99 means unlimited refills authorized."The number of refills authorized by the prescriber." - ASAP Standard for PDMP, DSP04: Refills Authorized |
OrderablePharmacyItem | orderedItem |
Pointer to the medication or pharmacy-stocked item that the prescribing clinician has ordered to be supplied to the Patient."Identifies the treatment product or treatment ordered to be given to the patient.... Examples ... include medications and certain devices or supplies, e.g., inhaler spacers, blood glucose monitors, syringes, infusion sets, which might require prescription." - HL7 Version 2.8, RXO-1."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, RXO-24."Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications." - HL7 FHIR, MedicationRequest.medication |
String | patientInstructions |
The complete textual representation of the "sig" (from the Latin "signare" meaning "to sign or mark"), for the prescription. Contains all relevant information about the dosage instructions for the medication prescribed. For example, the sig might say "take twice daily with food"."Identifies the ordering provider's instructions to the patient or to the provider administering the drug or treatment." - HL7 Version 2.8, RXO-7."Identifies the ordering provider's instructions to the patient or to the provider on how to deliver or comply with the ordered procedure." - HL7 CIMI Order.patientInstructions |
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. |
«CS» Code | pharmacyOrderCategory |
This optional property is used to group related medication orders. It is included for compatibility with HL7 version 2."Defines the general category of pharmacy order which may be used to determine the processing path the order will take.... This field may also be used for grouping of related orders for processing and/or reports. For example, Medication Administration Records often group large volume solutions, medications and small volume solutions differently based upon site-specific workflow." - HL7 Version 2.8, RXA-26, RXD-32, and RXO-27. Valid values (from HL7 Table 0480) include: Medication; IV Large Volume Solutions; Other solution as medication orders. |
«CS» Code | pharmacyOrderSetting |
"Indicates where type of medication order and where the medication is expected to be consumed or administered." - HL7 FHIR, MedicationOrder.category. Possible values include: Inpatient, Outpatient, Community"Code indicating how the pharmacy received the prescription" - ASAP Standard for PDMP, DSP12: Transmission Form of Rx Origin Code. Possible values include: Written Prescription; Telephone Prescription; Telephone Emergency Prescription; Fax Prescription; Electronic Prescription; Transferred/Forwarded Rx; Other |
PractitionerParticipation | prescriberAgent |
A person who has been designated to act on behalf of the prescriber. For example, a physician's assistant may be authorized to telephonically authorize refill requests for the prescriber. |
PriorAuthorization | priorAuthorization |
Pointer to information concerning a prior authorization already issued by a payer. |
PractitionerParticipation | supervisor |
"Supervisor information may be needed based upon state law. A supervisor is the supervising physician under whose authority the prescription is being prescribed by the primary care provider." - NCPDP Script, PVD SegmentPointer to the person who is managerially responsible for the prescriber. Usually used in long-term care settings. |
«CS» Code | treatmentType |
"While this field can be used to indicate that the prescription was for opioid dependency treatment when Code 02 is used, it can also be used to provide other reasons for the opioid prescription through use of the additional codes." - ASAP Standard for PDMP, DSP24: Treatment Type. Possible values include: Not used for opioid dependency treatment; Used for opioid dependency treatment; Pain associated with active and aftercare cancer treatment; Palliative care in conjunction with a serious illness; End-of-life and hospice care; A pregnant individual with a pre-existing prescription for opioids; Acute pain for an individual with an existing opioid prescription for chronic pain; Individuals pursuing an active taper of opioid medications; Patient is participating in a pain management contract; Other. |
Attributes inherited from FHIM::Orders::Order | ||
advanceBeneficiaryNoticeCode, advanceBeneficiaryNoticeDate, advanceBeneficiaryNoticeOverrideReason, alternatePlacerOrderId, basedOn, billingInformation, callbackPhone, confidentialityCode, dangerCode, dateTimeBegin, dateTimeCompleted, dateTimeEnd, dateTimeNeeded, dateTimeOrdered, diagnosisList, doNotPerform, duplicateProcedureReason, enteringLocation, expectedPerformer, expectedPerformerType, isEscortRequired, isInpatientOrder, occurrenceTiming, orderAction, orderingFacility, orderingOrganization, orderingProvider, patientInstructions, patientLocation, placerOrderId, placerSupplementalInfo, plannedPatientTransportComment, precautionProtocolInvoked, priority, promise, reasonForStudy, releaseStatus, relevantClinicalInformation, resultCopiesTo, resultHandling, setOfOrders, standingOrder, status, statusModifier, suggestedPrecaution, transportationArrangementResponsibility, transportationMode, wasTransportArranged |
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 | PharmacyRequest |
Name Expression | |
Namespace | Pharmacy |
Owned Template Signature | |
Owner | Pharmacy |
Owning Template Parameter | |
Package | Pharmacy |
Qualified Name | FHIM::Pharmacy::PharmacyRequest |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public «TS» PointInTime _startDate
The date on which the patient is to begin (or began, if historical) consuming the ordered medication.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | _startDate |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::_startDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime _stopDate
The date on which the Patient is to discontinue consuming (or did discontinue consumption of) the ordered medication."The date (and perhaps time) when the prescription was stopped." - HL7 FHIR, MedicationOrder.dateEnded
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | _stopDate |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::_stopDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code allowSubstitutions
This optional property indicates whether the prescriber has authorized the pharmacy to fill the order with a generic drug when the prescriber used a brand-name drug, or to fill the order with a therapeutically equivalent drug."Following are the values: N=Substitutions are NOT authorized; G=Allow generic substitutions; T=Allow therapeutic substitutions" - HL7 Version 2.8, RXO-9."True if the prescriber allows a different drug to be dispensed from what was prescribed." - HL7 FHIR, MedicationOrder.substitution.allowed"Indicates the reason for the substitution, or why substitution must or must not be performed." - HL7 FHIR, MedicationOrder.substitution.reason
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
Terminologies | [ HL7_FHIR_R4 V3 Value SetActSubstanceAdminSubstitutionCode http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode ] |
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 | allowSubstitutions |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::allowSubstitutions |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Boolean areRefillsAuthorizedAsNeeded
Indicates whether the prescriber has authorized additional fills of this order as needed.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | areRefillsAuthorizedAsNeeded |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::areRefillsAuthorizedAsNeeded |
Stereotype | |
Template Parameter | |
Type | Boolean |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public HealthcareProvider deliverTo
Pointer to the clinical provider or agency to which the mediction will be delivered. Added 3/18/2015 to handle the designation in the order of a specialty drug of the provider which should receive for example. For example, an IV medication would not be sent to the patient's home but to the home infusion agency that will administer the medication.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | deliverTo |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::deliverTo |
Stereotype | |
Template Parameter | |
Type | HealthcareProvider |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public deliverToLocation
"Specifies the location of the patient to whom the pharmaceutical substance is to be delivered." - HL7 Version 2.8, RXO-34."Specifies the address, either mailing or physical, to which the prescription should be mailed or delivered." - HL7 Version 2.8, RXO-35.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | deliverToLocation |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::deliverToLocation |
Stereotype | |
Template Parameter | |
Type | |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String dispensingInstructions
"Identifies the ordering provider's instructions to the pharmacy or the non-pharmacy treatment provider (e.g., respiratory therapy)." - HL7 Version 2.8, RXO-6.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | dispensingInstructions |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::dispensingInstructions |
Stereotype | |
Template Parameter | |
Type | String |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Dosage dosage
Pointer to information used to describe how the medication should be taken by the Patient, as ordered by the prescriber.
Aggregation | None |
Alias | |
Association | pharmacyRequest_dosage |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::dosage |
Stereotype | |
Template Parameter | |
Type | Dosage |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public DrugCoverageStatus drugCoverageStatus
Pointer to a set of (zero to many) coverage statuses for the prescribed drug.
Aggregation | None |
Alias | |
Association | pharmacyRequest_drugCoverageStatus |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | drugCoverageStatus |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::drugCoverageStatus |
Stereotype | |
Template Parameter | |
Type | DrugCoverageStatus |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public DrugUseEvaluation drugUseEvaluation
Pointer to the results of a Drug Use Evaluation (DUE) or a Drug Utilization Review (DUR).
Aggregation | None |
Alias | |
Association | pharmacyRequest_drugUseEvaluation |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | drugUseEvaluation |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::drugUseEvaluation |
Stereotype | |
Template Parameter | |
Type | DrugUseEvaluation |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «TS» PointInTime expirationDate
The date after which the order may no longer be filled."This indicates the validity period of a prescription (stale dating the Prescription)." - HL7 FHIR, MedicationOrder.dispenseRequest.validityPeriod
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | expirationDate |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::expirationDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «IVL_TS» Period frequency
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» PharmacyRequest |
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 | frequency |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::frequency |
Stereotype | |
Template Parameter | |
Type | «IVL_TS» Period |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code frequencyCode
Specifies when the service is to be performed and how frequently. This optional property allows for the frequency to be expressed as a code (or possibly a string), in order to accomodate non-numeric expressions, such as every morning, or during the afternoon shift. Added for Davita, 1/23/2015.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
Terminologies | [ HL7_FHIR_R4 TimingAbbreviation http://hl7.org/fhir/ValueSet/timing-abbreviation ] |
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 | frequencyCode |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::frequencyCode |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Indication indication
"Identifies the condition or problem for which the drug/treatment was prescribed." - HL7 Version 2.8, RXO-20."Contains the identifier of the condition or problem for which the drug/treatment was prescribed. May repeat if multiple indications are relevant." - HL7 Version 2.8, RXD-21."Can be the reason or the indication for writing the prescription." - HL7 FHIR, MedicationOrder.reasonCode
Aggregation | None |
Alias | |
Association | pharmacyRequest_indication |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | indication |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::indication |
Stereotype | |
Template Parameter | |
Type | Indication |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «IVL_TS» Period intendedDuration
The period of time over which the supplied medication or product is expected to be used, or the length of time the dispense is expected to last."Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last." - HL7 FHIR, MedicationOrder.dispenseRequest.expectedSupplyDuration
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | intendedDuration |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::intendedDuration |
Stereotype | |
Template Parameter | |
Type | «IVL_TS» Period |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code intendedDurationCode
The period of time over which the supplied medication or product is expected to be used, or the length of time the dispense is expected to last. This optional property allows for the intended duration to be expressed as a code (or possibly a string), in order to accomodate non-numeric expressions. Added for Davita, 1/23/2015."Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last." - HL7 FHIR, MedicationOrder.dispenseRequest.expectedSupplyDuration
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | intendedDurationCode |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::intendedDurationCode |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime neededNoLaterThan
"Conditional composite for the facility to relay to the long term care pharmacy the timeframe when medication is needed for delivery. When a facility transmits either a new medication order (NEWRX) or request for the re-supply of a medication (RESUPP) to a pharmacy, it would optionally indicate the time by which the medication is needed. The facility could also provide a textual reason why the medication is needed by the time specified. The long term care pharmacy would then use this information to determine whether a special delivery is required, or whether the order could go out with the next scheduled delivery." - NCPDP Script (Field I006)
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | neededNoLaterThan |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::neededNoLaterThan |
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.Indicates whether "the pharmacist or non-pharmacist treatment supplier filling the order needs to pay special attention to the text in the [Dispensing Instructions]. A warning is present." - HL7 Version 2.8, RXO-16.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::needsHumanReview |
Stereotype | |
Template Parameter | |
Type | Boolean |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Integer numberOfRefillsAuthorized
"Defines the number of times the requested dispense amount can be given to the patient, subject to local regulation. Refers to outpatient only." - HL7 Version 2.8, RXO-13."The total original number of refills. Outpatient only" - HL7 Version 2.8, RXE-12."An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets." - HL7 FHIR, MedicationOrder.dispenseRequest.numberOfRepeatsAllowed"Number of refills authorized by the prescriber." - NCPDP Telecommunication (Field 415-DF, Data Dictionary 201104). Note that while the NCPDP Telecommunication structure treats this field as a code, it contains a number from 0-99, where zero means no refills authorized, and 1-98 are the number of refills authorized, and 99 means unlimited refills authorized."The number of refills authorized by the prescriber." - ASAP Standard for PDMP, DSP04: Refills Authorized
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | numberOfRefillsAuthorized |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::numberOfRefillsAuthorized |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public OrderablePharmacyItem orderedItem
Pointer to the medication or pharmacy-stocked item that the prescribing clinician has ordered to be supplied to the Patient."Identifies the treatment product or treatment ordered to be given to the patient.... Examples ... include medications and certain devices or supplies, e.g., inhaler spacers, blood glucose monitors, syringes, infusion sets, which might require prescription." - HL7 Version 2.8, RXO-1."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, RXO-24."Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications." - HL7 FHIR, MedicationRequest.medication
Aggregation | None |
Alias | |
Association | pharmacyRequest_orderedItem |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | orderedItem |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::orderedItem |
Stereotype | |
Template Parameter | |
Type | OrderablePharmacyItem |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String patientInstructions
The complete textual representation of the "sig" (from the Latin "signare" meaning "to sign or mark"), for the prescription. Contains all relevant information about the dosage instructions for the medication prescribed. For example, the sig might say "take twice daily with food"."Identifies the ordering provider's instructions to the patient or to the provider administering the drug or treatment." - HL7 Version 2.8, RXO-7."Identifies the ordering provider's instructions to the patient or to the provider on how to deliver or comply with the ordered procedure." - HL7 CIMI Order.patientInstructions
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | patientInstructions |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::patientInstructions |
Stereotype | |
Template Parameter | |
Type | String |
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 | pharmacyRequest_pharmacy |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | pharmacy |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::pharmacy |
Stereotype | |
Template Parameter | |
Type | Pharmacy |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code pharmacyOrderCategory
This optional property is used to group related medication orders. It is included for compatibility with HL7 version 2."Defines the general category of pharmacy order which may be used to determine the processing path the order will take.... This field may also be used for grouping of related orders for processing and/or reports. For example, Medication Administration Records often group large volume solutions, medications and small volume solutions differently based upon site-specific workflow." - HL7 Version 2.8, RXA-26, RXD-32, and RXO-27. Valid values (from HL7 Table 0480) include: Medication; IV Large Volume Solutions; Other solution as medication orders.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | pharmacyOrderCategory |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::pharmacyOrderCategory |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code pharmacyOrderSetting
"Indicates where type of medication order and where the medication is expected to be consumed or administered." - HL7 FHIR, MedicationOrder.category. Possible values include: Inpatient, Outpatient, Community"Code indicating how the pharmacy received the prescription" - ASAP Standard for PDMP, DSP12: Transmission Form of Rx Origin Code. Possible values include: Written Prescription; Telephone Prescription; Telephone Emergency Prescription; Fax Prescription; Electronic Prescription; Transferred/Forwarded Rx; Other
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
Terminologies | [ HL7_FHIR_R4 Medication request category codes http://hl7.org/fhir/ValueSet/medicationrequest-category ] |
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 | pharmacyOrderSetting |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::pharmacyOrderSetting |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public PractitionerParticipation prescriberAgent
A person who has been designated to act on behalf of the prescriber. For example, a physician's assistant may be authorized to telephonically authorize refill requests for the prescriber.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | prescriberAgent |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::prescriberAgent |
Stereotype | |
Template Parameter | |
Type | PractitionerParticipation |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public PriorAuthorization priorAuthorization
Pointer to information concerning a prior authorization already issued by a payer.
Aggregation | None |
Alias | |
Association | pharmacyRequest_priorAuthorization |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | priorAuthorization |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::priorAuthorization |
Stereotype | |
Template Parameter | |
Type | PriorAuthorization |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public PractitionerParticipation supervisor
"Supervisor information may be needed based upon state law. A supervisor is the supervising physician under whose authority the prescription is being prescribed by the primary care provider." - NCPDP Script, PVD SegmentPointer to the person who is managerially responsible for the prescriber. Usually used in long-term care settings.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | supervisor |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::supervisor |
Stereotype | |
Template Parameter | |
Type | PractitionerParticipation |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code treatmentType
"While this field can be used to indicate that the prescription was for opioid dependency treatment when Code 02 is used, it can also be used to provide other reasons for the opioid prescription through use of the additional codes." - ASAP Standard for PDMP, DSP24: Treatment Type. Possible values include: Not used for opioid dependency treatment; Used for opioid dependency treatment; Pain associated with active and aftercare cancer treatment; Palliative care in conjunction with a serious illness; End-of-life and hospice care; A pregnant individual with a pre-existing prescription for opioids; Acute pain for an individual with an existing opioid prescription for chronic pain; Individuals pursuing an active taper of opioid medications; Patient is participating in a pain management contract; Other.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» PharmacyRequest |
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 | treatmentType |
Name Expression | |
Namespace | «EntryPoint» PharmacyRequest |
Opposite | |
Owner | «EntryPoint» PharmacyRequest |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::PharmacyRequest::treatmentType |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Pharmacy UML Documentation |
Summary:AttributesProperties | Detail:Attributes |