Pharmacy
Class PharmacyRequest

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 _startDate

The date on which the patient is to begin (or began, if historical) consuming the ordered medication.

«TS» PointInTime _stopDate _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 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 areRefillsAuthorizedAsNeeded

Indicates whether the prescriber has authorized additional fills of this order as needed.

HealthcareProvider deliverTo 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 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 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 dosage

Pointer to information used to describe how the medication should be taken by the Patient, as ordered by the prescriber.

DrugCoverageStatus drugCoverageStatus drugCoverageStatus

Pointer to a set of (zero to many) coverage statuses for the prescribed drug.

DrugUseEvaluation drugUseEvaluation drugUseEvaluation

Pointer to the results of a Drug Use Evaluation (DUE) or a Drug Utilization Review (DUR).

«TS» PointInTime expirationDate 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 priorAuthorization

Pointer to information concerning a prior authorization already issued by a payer.

PractitionerParticipation supervisor 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 Segment
Pointer to the person who is managerially responsible for the prescriber. Usually used in long-term care settings.

«CS» Code treatmentType 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 FHIM::Orders::Order
advanceBeneficiaryNoticeCode advanceBeneficiaryNoticeCode, advanceBeneficiaryNoticeDate advanceBeneficiaryNoticeDate, advanceBeneficiaryNoticeOverrideReason advanceBeneficiaryNoticeOverrideReason, alternatePlacerOrderId alternatePlacerOrderId, basedOn basedOn, billingInformation billingInformation, callbackPhone callbackPhone, confidentialityCode confidentialityCode, dangerCode dangerCode, dateTimeBegin dateTimeBegin, dateTimeCompleted dateTimeCompleted, dateTimeEnd dateTimeEnd, dateTimeNeeded dateTimeNeeded, dateTimeOrdered dateTimeOrdered, diagnosisList diagnosisList, doNotPerform doNotPerform, duplicateProcedureReason duplicateProcedureReason, enteringLocation enteringLocation, expectedPerformer expectedPerformer, expectedPerformerType expectedPerformerType, isEscortRequired isEscortRequired, isInpatientOrder isInpatientOrder, occurrenceTiming occurrenceTiming, orderAction orderAction, orderingFacility orderingFacility, orderingOrganization orderingOrganization, orderingProvider orderingProvider, patientInstructions patientInstructions, patientLocation patientLocation, placerOrderId placerOrderId, placerSupplementalInfo placerSupplementalInfo, plannedPatientTransportComment plannedPatientTransportComment, precautionProtocolInvoked precautionProtocolInvoked, priority priority, promise promise, reasonForStudy reasonForStudy, releaseStatus releaseStatus, relevantClinicalInformation relevantClinicalInformation, resultCopiesTo resultCopiesTo, resultHandling resultHandling, setOfOrders setOfOrders, standingOrder standingOrder, status status, statusModifier statusModifier, suggestedPrecaution suggestedPrecaution, transportationArrangementResponsibility transportationArrangementResponsibility, transportationMode transportationMode, wasTransportArranged wasTransportArranged

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

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

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

Properties:

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

Attribute Details

 _startDate
Public «TS» PointInTime _startDate

The date on which the patient is to begin (or began, if historical) consuming the ordered medication.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Name_startDate
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::_startDate
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 _stopDate
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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Name_stopDate
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::_stopDate
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 allowSubstitutions
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

Constraints:
Properties:

AggregationNone
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 Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameallowSubstitutions
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::allowSubstitutions
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 areRefillsAuthorizedAsNeeded
Public Boolean areRefillsAuthorizedAsNeeded

Indicates whether the prescriber has authorized additional fills of this order as needed.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameareRefillsAuthorizedAsNeeded
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::areRefillsAuthorizedAsNeeded
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 deliverTo
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.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamedeliverTo
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::deliverTo
Stereotype
Template Parameter
TypeHealthcareProvider
Upper1
Upper Value(1)
VisibilityPublic


 deliverToLocation
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.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamedeliverToLocation
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::deliverToLocation
Stereotype
Template Parameter
Type
Upper1
Upper Value(1)
VisibilityPublic


 dispensingInstructions
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.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamedispensingInstructions
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::dispensingInstructions
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 dosage
Public Dosage dosage

Pointer to information used to describe how the medication should be taken by the Patient, as ordered by the prescriber.

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyRequest_dosage
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namedosage
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::dosage
Stereotype
Template Parameter
TypeDosage
Upper*
Upper Value(*)
VisibilityPublic


 drugCoverageStatus
Public DrugCoverageStatus drugCoverageStatus

Pointer to a set of (zero to many) coverage statuses for the prescribed drug.

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyRequest_drugCoverageStatus
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamedrugCoverageStatus
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::drugCoverageStatus
Stereotype
Template Parameter
TypeDrugCoverageStatus
Upper*
Upper Value(*)
VisibilityPublic


 drugUseEvaluation
Public DrugUseEvaluation drugUseEvaluation

Pointer to the results of a Drug Use Evaluation (DUE) or a Drug Utilization Review (DUR).

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyRequest_drugUseEvaluation
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamedrugUseEvaluation
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::drugUseEvaluation
Stereotype
Template Parameter
TypeDrugUseEvaluation
Upper*
Upper Value(*)
VisibilityPublic


 expirationDate
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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameexpirationDate
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::expirationDate
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 frequency
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).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namefrequency
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::frequency
Stereotype
Template Parameter
Type«IVL_TS» Period
Upper1
Upper Value(1)
VisibilityPublic


 frequencyCode
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.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Terminologies[
HL7_FHIR_R4 TimingAbbreviation http://hl7.org/fhir/ValueSet/timing-abbreviation
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamefrequencyCode
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::frequencyCode
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 indication
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

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyRequest_indication
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameindication
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::indication
Stereotype
Template Parameter
TypeIndication
Upper*
Upper Value(*)
VisibilityPublic


 intendedDuration
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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameintendedDuration
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::intendedDuration
Stereotype
Template Parameter
Type«IVL_TS» Period
Upper1
Upper Value(1)
VisibilityPublic


 intendedDurationCode
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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameintendedDurationCode
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::intendedDurationCode
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 neededNoLaterThan
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)

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameneededNoLaterThan
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::neededNoLaterThan
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 needsHumanReview
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.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameneedsHumanReview
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::needsHumanReview
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 numberOfRefillsAuthorized
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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamenumberOfRefillsAuthorized
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::numberOfRefillsAuthorized
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 orderedItem
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

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyRequest_orderedItem
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NameorderedItem
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::orderedItem
Stereotype
Template Parameter
TypeOrderablePharmacyItem
Upper1
Upper Value(1)
VisibilityPublic


 patientInstructions
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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamepatientInstructions
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::patientInstructions
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 pharmacy
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.

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyRequest_pharmacy
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namepharmacy
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::pharmacy
Stereotype
Template Parameter
TypePharmacy
Upper1
Upper Value(1)
VisibilityPublic


 pharmacyOrderCategory
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.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamepharmacyOrderCategory
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::pharmacyOrderCategory
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 pharmacyOrderSetting
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

Constraints:
Properties:

AggregationNone
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 Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamepharmacyOrderSetting
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::pharmacyOrderSetting
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 prescriberAgent
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.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameprescriberAgent
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::prescriberAgent
Stereotype
Template Parameter
TypePractitionerParticipation
Upper1
Upper Value(1)
VisibilityPublic


 priorAuthorization
Public PriorAuthorization priorAuthorization

Pointer to information concerning a prior authorization already issued by a payer.

Constraints:
Properties:

AggregationNone
Alias
AssociationpharmacyRequest_priorAuthorization
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamepriorAuthorization
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::priorAuthorization
Stereotype
Template Parameter
TypePriorAuthorization
Upper1
Upper Value(1)
VisibilityPublic


 supervisor
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 Segment
Pointer to the person who is managerially responsible for the prescriber. Usually used in long-term care settings.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namesupervisor
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::supervisor
Stereotype
Template Parameter
TypePractitionerParticipation
Upper1
Upper Value(1)
VisibilityPublic


 treatmentType
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.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«EntryPoint» PharmacyRequest
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NametreatmentType
Name Expression
Namespace«EntryPoint» PharmacyRequest
Opposite
Owner«EntryPoint» PharmacyRequest
Owning Association
Owning Template Parameter
Qualified NameFHIM::Pharmacy::PharmacyRequest::treatmentType
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic