ca.infoway.messagebuilder.model.pcs_mr2007_v02_r02.pharmacy.merged
Class UnfilledPrescriptionQueryParametersBean

java.lang.Object
  ca.infoway.messagebuilder.model.MessagePartBean
      ca.infoway.messagebuilder.model.pcs_mr2007_v02_r02.pharmacy.merged.UnfilledPrescriptionQueryParametersBean

All Implemented Interfaces:

NullFlavorSupport, Serializable

public class UnfilledPrescriptionQueryParametersBean
extends MessagePartBean

Business Name: UnfilledPrescriptionQueryParameters

PORX_MT060270CA.ParameterList: (no business name)

Root class for query definition

Defines the set of parameters that may be used to filter the query response.

PORX_MT060240CA.ParameterList: Unfilled Prescription Query Parameters

Root class for query definition

Defines the set of parameters that may be used to filter the query response.

See Also:

Serialized Form

Constructor Summary

UnfilledPrescriptionQueryParametersBean()

Method Summary

Interval<Date>	getAdministrationEffectivePeriodValue() Business Name: AdministrationEffectivePeriod
Identifier	getPrescriberProviderIDValue() Business Name: PrescriberProviderID
List<ActStatus>	getPrescriptionStatusValue() Business Name: PrescriptionStatuses
PrescriptionDispenseFilterCode	getRxDispenseIndicatorValue() Business Name: RxDispenseIndicator
void	setAdministrationEffectivePeriodValue(Interval<Date> administrationEffectivePeriodValue) Business Name: AdministrationEffectivePeriod
void	setPrescriberProviderIDValue(Identifier prescriberProviderIDValue) Business Name: PrescriberProviderID
void	setRxDispenseIndicatorValue(PrescriptionDispenseFilterCode rxDispenseIndicatorValue) Business Name: RxDispenseIndicator

Methods inherited from class ca.infoway.messagebuilder.model.MessagePartBean

getField, getNullFlavor, getNullFlavor, getSpecializationType, hasNullFlavor, hasNullFlavor, setNullFlavor, setNullFlavor, setSpecializationType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnfilledPrescriptionQueryParametersBean

public UnfilledPrescriptionQueryParametersBean()

Method Detail

getAdministrationEffectivePeriodValue

public Interval<Date> getAdministrationEffectivePeriodValue()

Business Name: AdministrationEffectivePeriod

Un-merged Business Name: AdministrationEffectivePeriod

Relationship: PORX_MT060270CA.AdministrationEffectivePeriod.value

Conformance/Cardinality: MANDATORY (1)

Allows the requester to specify the administration period of interest for the retrieval. Useful for constraining run-away queries.

Indicates the administration period for which the request/query applies.

Filter the result set to include only those medication records (prescription order, prescription dispense and other active medication) for which the patient was deemed to be taking the drug within the specified period.

Un-merged Business Name: AdministrationEffectivePeriod

Relationship: PORX_MT060240CA.AdministrationEffectivePeriod.value

Conformance/Cardinality: MANDATORY (1)

Allows the requester to specify the administration period of interest for the retrieval. Useful for constraining run-away queries.

Indicates the administration period for which the request/query applies.

Filter the result set to include only those medication records (prescription order, prescription dispense and other active medication) for which the patient was deemed to be taking the drug within the specified period.

setAdministrationEffectivePeriodValue

public void setAdministrationEffectivePeriodValue(Interval<Date> administrationEffectivePeriodValue)

Business Name: AdministrationEffectivePeriod

Un-merged Business Name: AdministrationEffectivePeriod

Relationship: PORX_MT060270CA.AdministrationEffectivePeriod.value

Conformance/Cardinality: MANDATORY (1)

Allows the requester to specify the administration period of interest for the retrieval. Useful for constraining run-away queries.

Indicates the administration period for which the request/query applies.

Filter the result set to include only those medication records (prescription order, prescription dispense and other active medication) for which the patient was deemed to be taking the drug within the specified period.

Un-merged Business Name: AdministrationEffectivePeriod

Relationship: PORX_MT060240CA.AdministrationEffectivePeriod.value

Conformance/Cardinality: MANDATORY (1)

Allows the requester to specify the administration period of interest for the retrieval. Useful for constraining run-away queries.

Indicates the administration period for which the request/query applies.

Filter the result set to include only those medication records (prescription order, prescription dispense and other active medication) for which the patient was deemed to be taking the drug within the specified period.

getPrescriberProviderIDValue

public Identifier getPrescriberProviderIDValue()

Business Name: PrescriberProviderID

Un-merged Business Name: PrescriberProviderID

Relationship: PORX_MT060270CA.PrescriberProviderID.value

Conformance/Cardinality: MANDATORY (1)

Allows for the retrieval of prescriptions based on a specific prescriber.

Identifier of the prescriber who created and/or supervised the prescriptions being retrieved.

The result set will be filtered to only include records which were either directly created by this provider, or were created 'under the supervision' of this provider.

setPrescriberProviderIDValue

public void setPrescriberProviderIDValue(Identifier prescriberProviderIDValue)

Business Name: PrescriberProviderID

Un-merged Business Name: PrescriberProviderID

Relationship: PORX_MT060270CA.PrescriberProviderID.value

Conformance/Cardinality: MANDATORY (1)

Allows for the retrieval of prescriptions based on a specific prescriber.

Identifier of the prescriber who created and/or supervised the prescriptions being retrieved.

The result set will be filtered to only include records which were either directly created by this provider, or were created 'under the supervision' of this provider.

getPrescriptionStatusValue

public List<ActStatus> getPrescriptionStatusValue()

Business Name: PrescriptionStatuses

Un-merged Business Name: PrescriptionStatuses

Relationship: PORX_MT060240CA.PrescriptionStatus.value

Conformance/Cardinality: MANDATORY (1)

Allows for the retrieval of patient prescriptions and dispenses based on the lifecycle state of the prescription.

Indicates that prescriptions of a specific statuses are to be included in the result set. Allowable prescription status codes are: 'ABORTED, ACTIVE', 'COMPLETED', and 'SUSPENDED'.

getRxDispenseIndicatorValue

public PrescriptionDispenseFilterCode getRxDispenseIndicatorValue()

Business Name: RxDispenseIndicator

Un-merged Business Name: RxDispenseIndicator

Relationship: PORX_MT060240CA.RxDispenseIndicator.value

Conformance/Cardinality: MANDATORY (1)

Allows for finer sub-set of prescriptions to be retrieved based on the fill status of the prescription.

A coded value indicating the dispensing (fill) status of the prescription to be included in the result set. The only allowable Rx Dispense Indicators is ND (Never Dispensed).

setRxDispenseIndicatorValue

public void setRxDispenseIndicatorValue(PrescriptionDispenseFilterCode rxDispenseIndicatorValue)

Business Name: RxDispenseIndicator

Un-merged Business Name: RxDispenseIndicator

Relationship: PORX_MT060240CA.RxDispenseIndicator.value

Conformance/Cardinality: MANDATORY (1)

Allows for finer sub-set of prescriptions to be retrieved based on the fill status of the prescription.

A coded value indicating the dispensing (fill) status of the prescription to be included in the result set. The only allowable Rx Dispense Indicators is ND (Never Dispensed).