ca.infoway.messagebuilder.model.ab_mr2007_v02_r02.pharmacy.merged
Class GenericQueryParametersBean

java.lang.Object
  ca.infoway.messagebuilder.model.MessagePartBean
      ca.infoway.messagebuilder.model.ab_mr2007_v02_r02.pharmacy.merged.GenericQueryParametersBean

All Implemented Interfaces:

NullFlavorSupport, Serializable

public class GenericQueryParametersBean
extends MessagePartBean

PORX_MT060180CA.ParameterList: Medication Profile Generic Query Parameters

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

Root class for query definition

PORX_MT050020CA.ParameterList: Generic Query Parameters

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

Root class for query definition

POME_MT010050CA.ParameterList: Generic Query Parameters

One and only one of Drug Code, Prescribing Indication Code, or Medication Document ID must be specified.

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

Root class for query parameters.

PORX_MT060170CA.ParameterList: Generic Query Parameters

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

Root class for query definition

POME_MT010030CA.ParameterList: Drug Query Parameters

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

Root class for query parameters

POME_MT010090CA.ParameterList: Drug Query Parameters

At least one of drug code or drug name must be specified

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

Root class for query parameters

See Also:

Serialized Form

Constructor Summary

GenericQueryParametersBean()

Method Summary

Interval<Date>	getAdministrationEffectivePeriodValue() Business Name: AdministrationEffectivePeriod
Interval<Date>	getAmendedInTimeRangeValue() Business Name: AmendedInTimeRange
List<Identifier>	getCareCompositionIDValue() Business Name: CareCompositionIDs
List<ActCareEventType>	getCareCompositionTypeValue() Business Name: CareCompositionTypes
DiagnosisValue	getDiagnosisCodeValue() Business Name: DiagnosisCode
List<HasCharacteristicBean>	getDrugCharacteristics() Un-merged Business Name: (no business name specified)
ClinicalDrug	getDrugCodeValue() Business Name: DrugCode
OrderableDrugForm	getDrugFormValue() Business Name: OrderableDrugForm
String	getDrugManufacturerNameValue() Business Name: DrugManufacturerName
String	getDrugNameValue() Business Name: DrugName
RouteOfAdministration	getDrugRouteValue() Business Name: DrugRouteCode
Boolean	getIncludeEventHistoryIndicatorValue() Business Name: IncludeEventHistoryIndicator
Boolean	getIncludeIssuesIndicatorValue() Business Name: IncludeIssuesIndicator
Boolean	getIncludeNotesIndicatorValue() Business Name: IncludeNotesIndicator
Boolean	getIncludePendingChangesIndicatorValue() Business Name: IncludePendingChangesIndicator
IssueFilterCode	getIssueFilterCodeValue() Business Name: IssueFilterCode
Identifier	getMedicationDocumentIDValue() Business Name: MedicationDocumentID
ActMedicationDocumentCode	getMedicationDocumentTypeValue() Business Name: MedicationDocumentType
Boolean	getMostRecentByDrugIndicatorValue() Business Name: MostRecentByDrugIndicator
Boolean	getMostRecentDispenseForEachRxIndicatorValue() Business Name: MostRecentDispenseForEachRxIndicator
ActNonConditionIndicationCode	getOtherIndicationCodeValue() Business Name: OtherIndicationCode
Identifier	getOtherMedicationRecordIdValue() Business Name: OtherMedicationRecordId
Identifier	getPrescriberProviderIDValue() Business Name: PrescriberProviderID
DiagnosisValue	getPrescribingDiagnosisCodeValue() Business Name: PrescribingIndicationDiagnosisCode
SymptomValue	getPrescribingSymptomCodeValue() Business Name: PrescribingIndicationSymptomCode
Identifier	getPrescriptionDispenseNumberValue() Business Name: PrescriptionDispenseNumber
Identifier	getPrescriptionOrderNumberValue() Business Name: PrescriptionOrderNumber
List<ActStatus>	getPrescriptionStatusValue() Business Name: PrescriptionStatuses
List<PrescriptionDispenseFilterCode>	getRxDispenseIndicatorValue() Business Name: RxDispenserIndicators
SymptomValue	getSymptomCodeValue() Business Name: SymptomCode
List<ActTherapyDurationWorkingListCode>	getTreatmentTypeValue() Business Name: TreatmentTypes
void	setAdministrationEffectivePeriodValue(Interval<Date> administrationEffectivePeriodValue) Business Name: AdministrationEffectivePeriod
void	setAmendedInTimeRangeValue(Interval<Date> amendedInTimeRangeValue) Business Name: AmendedInTimeRange
void	setDiagnosisCodeValue(DiagnosisValue diagnosisCodeValue) Business Name: DiagnosisCode
void	setDrugCodeValue(ClinicalDrug drugCodeValue) Business Name: DrugCode
void	setDrugFormValue(OrderableDrugForm drugFormValue) Business Name: OrderableDrugForm
void	setDrugManufacturerNameValue(String drugManufacturerNameValue) Business Name: DrugManufacturerName
void	setDrugNameValue(String drugNameValue) Business Name: DrugName
void	setDrugRouteValue(RouteOfAdministration drugRouteValue) Business Name: DrugRouteCode
void	setIncludeEventHistoryIndicatorValue(Boolean includeEventHistoryIndicatorValue) Business Name: IncludeEventHistoryIndicator
void	setIncludeIssuesIndicatorValue(Boolean includeIssuesIndicatorValue) Business Name: IncludeIssuesIndicator
void	setIncludeNotesIndicatorValue(Boolean includeNotesIndicatorValue) Business Name: IncludeNotesIndicator
void	setIncludePendingChangesIndicatorValue(Boolean includePendingChangesIndicatorValue) Business Name: IncludePendingChangesIndicator
void	setIssueFilterCodeValue(IssueFilterCode issueFilterCodeValue) Business Name: IssueFilterCode
void	setMedicationDocumentIDValue(Identifier medicationDocumentIDValue) Business Name: MedicationDocumentID
void	setMedicationDocumentTypeValue(ActMedicationDocumentCode medicationDocumentTypeValue) Business Name: MedicationDocumentType
void	setMostRecentByDrugIndicatorValue(Boolean mostRecentByDrugIndicatorValue) Business Name: MostRecentByDrugIndicator
void	setMostRecentDispenseForEachRxIndicatorValue(Boolean mostRecentDispenseForEachRxIndicatorValue) Business Name: MostRecentDispenseForEachRxIndicator
void	setOtherIndicationCodeValue(ActNonConditionIndicationCode otherIndicationCodeValue) Business Name: OtherIndicationCode
void	setOtherMedicationRecordIdValue(Identifier otherMedicationRecordIdValue) Business Name: OtherMedicationRecordId
void	setPrescriberProviderIDValue(Identifier prescriberProviderIDValue) Business Name: PrescriberProviderID
void	setPrescribingDiagnosisCodeValue(DiagnosisValue prescribingDiagnosisCodeValue) Business Name: PrescribingIndicationDiagnosisCode
void	setPrescribingSymptomCodeValue(SymptomValue prescribingSymptomCodeValue) Business Name: PrescribingIndicationSymptomCode
void	setPrescriptionDispenseNumberValue(Identifier prescriptionDispenseNumberValue) Business Name: PrescriptionDispenseNumber
void	setPrescriptionOrderNumberValue(Identifier prescriptionOrderNumberValue) Business Name: PrescriptionOrderNumber
void	setSymptomCodeValue(SymptomValue symptomCodeValue) Business Name: SymptomCode

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

GenericQueryParametersBean

public GenericQueryParametersBean()

Method Detail

getAdministrationEffectivePeriodValue

public Interval<Date> getAdministrationEffectivePeriodValue()

Business Name: AdministrationEffectivePeriod

Un-merged Business Name: AdministrationEffectivePeriod

Relationship: PORX_MT060180CA.AdministrationEffectivePeriod.value

Conformance/Cardinality: MANDATORY (1)

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.

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.

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

Un-merged Business Name: AdministrationEffectivePeriod

Relationship: PORX_MT060170CA.AdministrationEffectivePeriod.value

Conformance/Cardinality: MANDATORY (1)

For a prescription indicates the period for which the patient was deemed to be taking the drug.

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

For a prescription indicates the period for which the patient was deemed to be taking the drug.

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

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

setAdministrationEffectivePeriodValue

public void setAdministrationEffectivePeriodValue(Interval<Date> administrationEffectivePeriodValue)

Business Name: AdministrationEffectivePeriod

Un-merged Business Name: AdministrationEffectivePeriod

Relationship: PORX_MT060180CA.AdministrationEffectivePeriod.value

Conformance/Cardinality: MANDATORY (1)

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.

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.

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

Un-merged Business Name: AdministrationEffectivePeriod

Relationship: PORX_MT060170CA.AdministrationEffectivePeriod.value

Conformance/Cardinality: MANDATORY (1)

For a prescription indicates the period for which the patient was deemed to be taking the drug.

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

For a prescription indicates the period for which the patient was deemed to be taking the drug.

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

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

getAmendedInTimeRangeValue

public Interval<Date> getAmendedInTimeRangeValue()

Business Name: AmendedInTimeRange

Un-merged Business Name: AmendedInTimeRange

Relationship: PORX_MT060180CA.AmendedInTimeRange.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the returned records should be filtered to only include those which have been amended in some way (had status changed, been annotated, prescription was dispensed, etc.) within the indicated time-period. This will commonly be used to “retrieve everything that has been amended since xxx”.

Allows the requester to specify the event period of interest for the retrieval of medication records.

Useful for constraining run-away queries.

Allows the requester to specify the event period of interest for the retrieval of medication records.

Useful for constraining run-away queries.

Un-merged Business Name: AmendedInTimeRange

Relationship: PORX_MT060170CA.AmendedInTimeRange.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the returned records should be filtered to only include those which have been amended in some way (had status changed, been annotated, prescription was dispensed, etc.) within the indicated time-period. This will commonly be used to 'retrieve everything that has been amended since xxx'.

Allows the requester to specify the event period of interest for the retrieval of medication records.

Useful for constraining run-away queries.

Allows the requester to specify the event period of interest for the retrieval of medication records.

Useful for constraining run-away queries.

setAmendedInTimeRangeValue

public void setAmendedInTimeRangeValue(Interval<Date> amendedInTimeRangeValue)

Business Name: AmendedInTimeRange

Un-merged Business Name: AmendedInTimeRange

Relationship: PORX_MT060180CA.AmendedInTimeRange.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the returned records should be filtered to only include those which have been amended in some way (had status changed, been annotated, prescription was dispensed, etc.) within the indicated time-period. This will commonly be used to “retrieve everything that has been amended since xxx”.

Allows the requester to specify the event period of interest for the retrieval of medication records.

Useful for constraining run-away queries.

Allows the requester to specify the event period of interest for the retrieval of medication records.

Useful for constraining run-away queries.

Un-merged Business Name: AmendedInTimeRange

Relationship: PORX_MT060170CA.AmendedInTimeRange.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the returned records should be filtered to only include those which have been amended in some way (had status changed, been annotated, prescription was dispensed, etc.) within the indicated time-period. This will commonly be used to 'retrieve everything that has been amended since xxx'.

Allows the requester to specify the event period of interest for the retrieval of medication records.

Useful for constraining run-away queries.

Allows the requester to specify the event period of interest for the retrieval of medication records.

Useful for constraining run-away queries.

getCareCompositionIDValue

public List<Identifier> getCareCompositionIDValue()

Business Name: CareCompositionIDs

Un-merged Business Name: CareCompositionIDs

Relationship: PORX_MT060180CA.CareCompositionID.value

Conformance/Cardinality: MANDATORY (1)

Filters the records retrieved to only include those associated with the specified encounter, episode or care event. If unspecified, no filter is applied.

Note: When matching on care composition id, systems should also retrieve records with a fulfillment id to requisitions associated with the care composition. E.g. When retrieving records associated with an encounter which includes a referral, the retrieved records should also include the care summary created in fulfillment of the referral.

Filters the records retrieved to only include those associated with the specified encounter, episode or care event. If unspecified, no filter is applied.

Note: When matching on care composition id, systems should also retrieve records with a fulfillment id to requisitions associated with the care composition. E.g. When retrieving records associated with an encounter which includes a referral, the retrieved records should also include the care summary created in fulfillment of the referral.

Allows retrieving all records associated with an encounter, episode or care event.

Un-merged Business Name: CareCompositionIDs

Relationship: PORX_MT060170CA.CareCompositionID.value

Conformance/Cardinality: MANDATORY (1)

Filters the records retrieved to only include those associated with the specified encounter, episode or care event. If unspecified, no filter is applied.

Note: When matching on care composition id, systems should also retrieve records with a fulfillment id to requisitions associated with the care composition. E.g. When retrieving records associated with an encounter which includes a referral, the retrieved records should also include the care summary created in fulfillment of the referral.

Filters the records retrieved to only include those associated with the specified encounter, episode or care event. If unspecified, no filter is applied.

Note: When matching on care composition id, systems should also retrieve records with a fulfillment id to requisitions associated with the care composition. E.g. When retrieving records associated with an encounter which includes a referral, the retrieved records should also include the care summary created in fulfillment of the referral.

Allows retrieving all records associated with an encounter, episode or care event.

getCareCompositionTypeValue

public List<ActCareEventType> getCareCompositionTypeValue()

Business Name: CareCompositionTypes

Un-merged Business Name: CareCompositionTypes

Relationship: PORX_MT060180CA.CareCompositionType.value

Conformance/Cardinality: MANDATORY (1)

Filters the records retrieved to only include those associated with the specified 'kind' of encounter, episode or care event. If unspecified, no filter is applied.

Allows retrieving all records associated with a particular type of encounter, episode or care event. E.g.Orthopedic Clinic Encounter, ER encounter, Walk-in encounter, etc.

Un-merged Business Name: CareCompositionTypes

Relationship: PORX_MT060170CA.CareCompositionType.value

Conformance/Cardinality: MANDATORY (1)

Filters the records retrieved to only include those associated with the specified 'kind' of encounter, episode or care event. If unspecified, no filter is applied.

Allows retrieving all records associated with a particular type of encounter, episode or care event. E.g.Orthopedic Clinic Encounter, ER encounter, Walk-in encounter, etc.

getDiagnosisCodeValue

public DiagnosisValue getDiagnosisCodeValue()

Business Name: DiagnosisCode

Un-merged Business Name: DiagnosisCode

Relationship: PORX_MT060180CA.DiagnosisCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified diagnosis indication code.

Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications.

Un-merged Business Name: DiagnosisCode

Relationship: PORX_MT060170CA.DiagnosisCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified diagnosis indication code.

Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications.

setDiagnosisCodeValue

public void setDiagnosisCodeValue(DiagnosisValue diagnosisCodeValue)

Business Name: DiagnosisCode

Un-merged Business Name: DiagnosisCode

Relationship: PORX_MT060180CA.DiagnosisCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified diagnosis indication code.

Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications.

Un-merged Business Name: DiagnosisCode

Relationship: PORX_MT060170CA.DiagnosisCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified diagnosis indication code.

Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications.

getDrugCodeValue

public ClinicalDrug getDrugCodeValue()

Business Name: DrugCode

Un-merged Business Name: DrugCode

Relationship: PORX_MT060180CA.DrugCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified drug. The code may refer to an orderable medication or a higher level drug classification.

Allows for the retrieval of patient prescriptions and/or dispenses based on a specific medication that was ordered and/or dispensed. This will most commonly be used to filter for therapeutic classifications such as "Anti-hypertensives".

Un-merged Business Name: DrugCode

Relationship: PORX_MT050020CA.DrugCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those contraindications pertaining to the specified drug.

The code may refer to an administerable medication, an orderable medication or a higher level drug classification.

The contraindication records retrieve would comprise the drug-drug interactions between this specified and each of the drugs on the patient's profile, as well as drug-disease and drug-allergy contraindications that might result (based on the information on the patient's profile).

Indicates that the result set is to be filtered to include only those contraindications pertaining to the specified drug.

The code may refer to an administerable medication, an orderable medication or a higher level drug classification.

The contraindication records retrieve would comprise the drug-drug interactions between this specified and each of the drugs on the patient's profile, as well as drug-disease and drug-allergy contraindications that might result (based on the information on the patient's profile).

Indicates that the result set is to be filtered to include only those contraindications pertaining to the specified drug.

The code may refer to an administerable medication, an orderable medication or a higher level drug classification.

The contraindication records retrieve would comprise the drug-drug interactions between this specified and each of the drugs on the patient's profile, as well as drug-disease and drug-allergy contraindications that might result (based on the information on the patient's profile).

Allows for the retrieval of all potential contraindications based on a specific medication being introduced onto the patient's medication profile. Contraindications can't be found without specifying the medication, therefore this attribute is mandatory.

This will most commonly be used by providers to test the viability of prescribing/dispensing a medication to a patient (in view of the patient's existing medication profile).

Allows for the retrieval of all potential contraindications based on a specific medication being introduced onto the patient's medication profile. Contraindications can't be found without specifying the medication, therefore this attribute is mandatory.

This will most commonly be used by providers to test the viability of prescribing/dispensing a medication to a patient (in view of the patient's existing medication profile).

Un-merged Business Name: DrugCode

Relationship: POME_MT010050CA.DrugCode.value

Conformance/Cardinality: MANDATORY (1)

An identifier for a type of drug. Types of drugs include: Manufactured drug, generic formulation, generic, therapeutic class, etc.

Allows the requester to retrieve drugs of certain abstraction only. These drug abstractions include: Manufactured drug, generic formulation, generic, therapeutic class, etc.

Un-merged Business Name: DrugCode

Relationship: POME_MT010030CA.DrugCode.value

Conformance/Cardinality: MANDATORY (1)

An identifier for a specific drug product. Types of drugs identified by drug code include: Manufactured drug, generic formulation, generic, therapeutic class, etc.

Allows the requester to retrieve detail information about a specific drug product.

Un-merged Business Name: DrugCode

Relationship: PORX_MT060170CA.DrugCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified drug. The code may refer to an orderable medication or a higher level drug classification.

Allows for the retrieval of patient prescriptions and/or dispenses based on a specific medication that was ordered and/or dispensed. This will most commonly be used to filter for therapeutic classifications such as "Anti-hypertensives".

Un-merged Business Name: DrugCode

Relationship: POME_MT010090CA.DrugCode.value

Conformance/Cardinality: MANDATORY (1)

An identifier that describes a drug at any level of the clinical drug hierarchy. The code may describe (point to) a Manufactured drug, generic drug formulation, generic drug, therapeutic classification, etc.

For example, using a therapeutic class code in the DrugCode parameter would return a list of all drugs that are within that class. Sending a drug name in the DrugName parameter would return a list of all drugs that have that name e.g. sending acetaminophen would return all of the acetaminophen products in the drug data base. By including the DoseForm, DoseRoute, DrugManufacturerName or DrugCharacteristic, the list could be further constrained.

An identifier that describes a drug at any level of the clinical drug hierarchy. The code may describe (point to) a Manufactured drug, generic drug formulation, generic drug, therapeutic classification, etc.

For example, using a therapeutic class code in the DrugCode parameter would return a list of all drugs that are within that class. Sending a drug name in the DrugName parameter would return a list of all drugs that have that name e.g. sending acetaminophen would return all of the acetaminophen products in the drug data base. By including the DoseForm, DoseRoute, DrugManufacturerName or DrugCharacteristic, the list could be further constrained.

Allows the requester to retrieve drugs of certain abstraction only. These drug abstractions include: Manufactured drug, generic formulation, generic, therapeutic class, etc.

setDrugCodeValue

public void setDrugCodeValue(ClinicalDrug drugCodeValue)

Business Name: DrugCode

Un-merged Business Name: DrugCode

Relationship: PORX_MT060180CA.DrugCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified drug. The code may refer to an orderable medication or a higher level drug classification.

Allows for the retrieval of patient prescriptions and/or dispenses based on a specific medication that was ordered and/or dispensed. This will most commonly be used to filter for therapeutic classifications such as "Anti-hypertensives".

Un-merged Business Name: DrugCode

Relationship: PORX_MT050020CA.DrugCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those contraindications pertaining to the specified drug.

The code may refer to an administerable medication, an orderable medication or a higher level drug classification.

The contraindication records retrieve would comprise the drug-drug interactions between this specified and each of the drugs on the patient's profile, as well as drug-disease and drug-allergy contraindications that might result (based on the information on the patient's profile).

Indicates that the result set is to be filtered to include only those contraindications pertaining to the specified drug.

The code may refer to an administerable medication, an orderable medication or a higher level drug classification.

The contraindication records retrieve would comprise the drug-drug interactions between this specified and each of the drugs on the patient's profile, as well as drug-disease and drug-allergy contraindications that might result (based on the information on the patient's profile).

Indicates that the result set is to be filtered to include only those contraindications pertaining to the specified drug.

The code may refer to an administerable medication, an orderable medication or a higher level drug classification.

The contraindication records retrieve would comprise the drug-drug interactions between this specified and each of the drugs on the patient's profile, as well as drug-disease and drug-allergy contraindications that might result (based on the information on the patient's profile).

Allows for the retrieval of all potential contraindications based on a specific medication being introduced onto the patient's medication profile. Contraindications can't be found without specifying the medication, therefore this attribute is mandatory.

This will most commonly be used by providers to test the viability of prescribing/dispensing a medication to a patient (in view of the patient's existing medication profile).

Allows for the retrieval of all potential contraindications based on a specific medication being introduced onto the patient's medication profile. Contraindications can't be found without specifying the medication, therefore this attribute is mandatory.

This will most commonly be used by providers to test the viability of prescribing/dispensing a medication to a patient (in view of the patient's existing medication profile).

Un-merged Business Name: DrugCode

Relationship: POME_MT010050CA.DrugCode.value

Conformance/Cardinality: MANDATORY (1)

An identifier for a type of drug. Types of drugs include: Manufactured drug, generic formulation, generic, therapeutic class, etc.

Allows the requester to retrieve drugs of certain abstraction only. These drug abstractions include: Manufactured drug, generic formulation, generic, therapeutic class, etc.

Un-merged Business Name: DrugCode

Relationship: POME_MT010030CA.DrugCode.value

Conformance/Cardinality: MANDATORY (1)

An identifier for a specific drug product. Types of drugs identified by drug code include: Manufactured drug, generic formulation, generic, therapeutic class, etc.

Allows the requester to retrieve detail information about a specific drug product.

Un-merged Business Name: DrugCode

Relationship: PORX_MT060170CA.DrugCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified drug. The code may refer to an orderable medication or a higher level drug classification.

Allows for the retrieval of patient prescriptions and/or dispenses based on a specific medication that was ordered and/or dispensed. This will most commonly be used to filter for therapeutic classifications such as "Anti-hypertensives".

Un-merged Business Name: DrugCode

Relationship: POME_MT010090CA.DrugCode.value

Conformance/Cardinality: MANDATORY (1)

An identifier that describes a drug at any level of the clinical drug hierarchy. The code may describe (point to) a Manufactured drug, generic drug formulation, generic drug, therapeutic classification, etc.

For example, using a therapeutic class code in the DrugCode parameter would return a list of all drugs that are within that class. Sending a drug name in the DrugName parameter would return a list of all drugs that have that name e.g. sending acetaminophen would return all of the acetaminophen products in the drug data base. By including the DoseForm, DoseRoute, DrugManufacturerName or DrugCharacteristic, the list could be further constrained.

An identifier that describes a drug at any level of the clinical drug hierarchy. The code may describe (point to) a Manufactured drug, generic drug formulation, generic drug, therapeutic classification, etc.

For example, using a therapeutic class code in the DrugCode parameter would return a list of all drugs that are within that class. Sending a drug name in the DrugName parameter would return a list of all drugs that have that name e.g. sending acetaminophen would return all of the acetaminophen products in the drug data base. By including the DoseForm, DoseRoute, DrugManufacturerName or DrugCharacteristic, the list could be further constrained.

Allows the requester to retrieve drugs of certain abstraction only. These drug abstractions include: Manufactured drug, generic formulation, generic, therapeutic class, etc.

getIncludeEventHistoryIndicatorValue

public Boolean getIncludeEventHistoryIndicatorValue()

Business Name: IncludeEventHistoryIndicator

Un-merged Business Name: IncludeEventHistoryIndicator

Relationship: PORX_MT060180CA.IncludeEventHistoryIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not history events associated with a prescription order, prescription dispense and/or other active medications are to be returned along with the detailed information.

"Pending" changes will be returned regardless of the setting of this flag.

Indicates whether or not history events associated with a prescription order, prescription dispense and/or other active medications are to be returned along with the detailed information.

"Pending" changes will be returned regardless of the setting of this flag.

Allows for the flexibility of omitting/including history in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including history in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Un-merged Business Name: IncludeEventHistoryIndicator

Relationship: PORX_MT060170CA.IncludeEventHistoryIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not history events associated with a prescription order, prescription dispense and/or active medications are to be returned along with the detailed information.

"Pending" changes will be returned regardless of the setting of this flag.

Indicates whether or not history events associated with a prescription order, prescription dispense and/or active medications are to be returned along with the detailed information.

"Pending" changes will be returned regardless of the setting of this flag.

Allows for the flexibility of omitting/including history in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including history in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

setIncludeEventHistoryIndicatorValue

public void setIncludeEventHistoryIndicatorValue(Boolean includeEventHistoryIndicatorValue)

Business Name: IncludeEventHistoryIndicator

Un-merged Business Name: IncludeEventHistoryIndicator

Relationship: PORX_MT060180CA.IncludeEventHistoryIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not history events associated with a prescription order, prescription dispense and/or other active medications are to be returned along with the detailed information.

"Pending" changes will be returned regardless of the setting of this flag.

Indicates whether or not history events associated with a prescription order, prescription dispense and/or other active medications are to be returned along with the detailed information.

"Pending" changes will be returned regardless of the setting of this flag.

Allows for the flexibility of omitting/including history in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including history in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Un-merged Business Name: IncludeEventHistoryIndicator

Relationship: PORX_MT060170CA.IncludeEventHistoryIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not history events associated with a prescription order, prescription dispense and/or active medications are to be returned along with the detailed information.

"Pending" changes will be returned regardless of the setting of this flag.

Indicates whether or not history events associated with a prescription order, prescription dispense and/or active medications are to be returned along with the detailed information.

"Pending" changes will be returned regardless of the setting of this flag.

Allows for the flexibility of omitting/including history in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including history in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

getIncludeIssuesIndicatorValue

public Boolean getIncludeIssuesIndicatorValue()

Business Name: IncludeIssuesIndicator

Un-merged Business Name: IncludeIssuesIndicator

Relationship: PORX_MT060180CA.IncludeIssuesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not Issues (detected and/or managed) attached to the prescriptions, dispenses and other active medication records are to be returned along with the detailed information.

Allows for the flexibility of omitting/including issues in the retrieval of medication detail profile data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including issues in the retrieval of medication detail profile data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Un-merged Business Name: IncludeIssuesIndicator

Relationship: PORX_MT060170CA.IncludeIssuesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not Issues (detected and/or managed) attached to the prescriptions, dispenses and other active medication records are to be returned along with the detailed information.

Allows for the flexibility of omitting/including issues in the retrieval of medication detail profile data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including issues in the retrieval of medication detail profile data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

setIncludeIssuesIndicatorValue

public void setIncludeIssuesIndicatorValue(Boolean includeIssuesIndicatorValue)

Business Name: IncludeIssuesIndicator

Un-merged Business Name: IncludeIssuesIndicator

Relationship: PORX_MT060180CA.IncludeIssuesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not Issues (detected and/or managed) attached to the prescriptions, dispenses and other active medication records are to be returned along with the detailed information.

Allows for the flexibility of omitting/including issues in the retrieval of medication detail profile data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including issues in the retrieval of medication detail profile data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Un-merged Business Name: IncludeIssuesIndicator

Relationship: PORX_MT060170CA.IncludeIssuesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not Issues (detected and/or managed) attached to the prescriptions, dispenses and other active medication records are to be returned along with the detailed information.

Allows for the flexibility of omitting/including issues in the retrieval of medication detail profile data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including issues in the retrieval of medication detail profile data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

getIncludeNotesIndicatorValue

public Boolean getIncludeNotesIndicatorValue()

Business Name: IncludeNotesIndicator

Un-merged Business Name: IncludeNotesIndicator

Relationship: PORX_MT060180CA.IncludeNotesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not notes attached to the prescription, dispenses and other active medication records are to be returned along with the detailed information.

Allows for the flexibility of omitting/including notes in the retrieval of information for medication profile detail data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including notes in the retrieval of information for medication profile detail data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Un-merged Business Name: IncludeNotesIndicator

Relationship: PORX_MT060170CA.IncludeNotesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not notes attached to the prescription, dispenses and other active medication records are to be returned along with the detailed information.

Allows for the flexibility of omitting/including notes in the retrieval of information for medication profile detail data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including notes in the retrieval of information for medication profile detail data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

setIncludeNotesIndicatorValue

public void setIncludeNotesIndicatorValue(Boolean includeNotesIndicatorValue)

Business Name: IncludeNotesIndicator

Un-merged Business Name: IncludeNotesIndicator

Relationship: PORX_MT060180CA.IncludeNotesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not notes attached to the prescription, dispenses and other active medication records are to be returned along with the detailed information.

Allows for the flexibility of omitting/including notes in the retrieval of information for medication profile detail data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including notes in the retrieval of information for medication profile detail data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Un-merged Business Name: IncludeNotesIndicator

Relationship: PORX_MT060170CA.IncludeNotesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not notes attached to the prescription, dispenses and other active medication records are to be returned along with the detailed information.

Allows for the flexibility of omitting/including notes in the retrieval of information for medication profile detail data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including notes in the retrieval of information for medication profile detail data.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

getIncludePendingChangesIndicatorValue

public Boolean getIncludePendingChangesIndicatorValue()

Business Name: IncludePendingChangesIndicator

Un-merged Business Name: IncludePendingChangesIndicator

Relationship: PORX_MT060180CA.IncludePendingChangesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether to include future changes (e.g. status changes that aren't effective yet) associated with a prescription order, prescription dispense and/or active medications are to be returned along with the detailed information.

Allows for the flexibility of omitting/including future events in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including future events in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Un-merged Business Name: IncludePendingChangesIndicator

Relationship: PORX_MT060170CA.IncludePendingChangesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether to include future changes (e.g. status changes that aren't effective yet) associated with a prescription order, prescription dispense and/or active medications are to be returned along with the detailed information.

Allows for the flexibility of omitting/including future events in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including future events in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

setIncludePendingChangesIndicatorValue

public void setIncludePendingChangesIndicatorValue(Boolean includePendingChangesIndicatorValue)

Business Name: IncludePendingChangesIndicator

Un-merged Business Name: IncludePendingChangesIndicator

Relationship: PORX_MT060180CA.IncludePendingChangesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether to include future changes (e.g. status changes that aren't effective yet) associated with a prescription order, prescription dispense and/or active medications are to be returned along with the detailed information.

Allows for the flexibility of omitting/including future events in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including future events in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Un-merged Business Name: IncludePendingChangesIndicator

Relationship: PORX_MT060170CA.IncludePendingChangesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether to include future changes (e.g. status changes that aren't effective yet) associated with a prescription order, prescription dispense and/or active medications are to be returned along with the detailed information.

Allows for the flexibility of omitting/including future events in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

Allows for the flexibility of omitting/including future events in the retrieval of the requested information.

Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory.

getIssueFilterCodeValue

public IssueFilterCode getIssueFilterCodeValue()

Business Name: IssueFilterCode

Un-merged Business Name: IssueFilterCode

Relationship: PORX_MT060180CA.IssueFilterCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether records to be returned (e.g. prescription order, prescription dispense and/or other medication) should be filtered to those with at least one persistent un-managed issue (against the record), with at least one persistent issues or should return all records, independent of the presence of persistent issues.

By filtering returned records to include only those which have unmanaged issues or any issues at all, allows a provider to focus on those aspects of care where extra attention is needed. Because the attribute must be known, it is mandatory.

setIssueFilterCodeValue

public void setIssueFilterCodeValue(IssueFilterCode issueFilterCodeValue)

Business Name: IssueFilterCode

Un-merged Business Name: IssueFilterCode

Relationship: PORX_MT060180CA.IssueFilterCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether records to be returned (e.g. prescription order, prescription dispense and/or other medication) should be filtered to those with at least one persistent un-managed issue (against the record), with at least one persistent issues or should return all records, independent of the presence of persistent issues.

By filtering returned records to include only those which have unmanaged issues or any issues at all, allows a provider to focus on those aspects of care where extra attention is needed. Because the attribute must be known, it is mandatory.

getMostRecentByDrugIndicatorValue

public Boolean getMostRecentByDrugIndicatorValue()

Business Name: MostRecentByDrugIndicator

Un-merged Business Name: MostRecentByDrugIndicator

Relationship: PORX_MT060180CA.MostRecentByDrugIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not the medication records are to be retrieved based on the most recent by Drug Code. If true, only the most recent prescription, dispense or other active medication for a particular drug generic classification will be returned. The default is 'FALSE' indicating that retrieval of prescription, dispense and other active medication records should not be limited to one per drug.

Helps decrease the volume of records returned, while still maintaining information on all drugs that the patient is on.

Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory.

Helps decrease the volume of records returned, while still maintaining information on all drugs that the patient is on.

Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory.

setMostRecentByDrugIndicatorValue

public void setMostRecentByDrugIndicatorValue(Boolean mostRecentByDrugIndicatorValue)

Business Name: MostRecentByDrugIndicator

Un-merged Business Name: MostRecentByDrugIndicator

Relationship: PORX_MT060180CA.MostRecentByDrugIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not the medication records are to be retrieved based on the most recent by Drug Code. If true, only the most recent prescription, dispense or other active medication for a particular drug generic classification will be returned. The default is 'FALSE' indicating that retrieval of prescription, dispense and other active medication records should not be limited to one per drug.

Helps decrease the volume of records returned, while still maintaining information on all drugs that the patient is on.

Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory.

Helps decrease the volume of records returned, while still maintaining information on all drugs that the patient is on.

Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory.

getMostRecentDispenseForEachRxIndicatorValue

public Boolean getMostRecentDispenseForEachRxIndicatorValue()

Business Name: MostRecentDispenseForEachRxIndicator

Un-merged Business Name: MostRecentDispenseForEachRxIndicator

Relationship: PORX_MT060180CA.MostRecentDispenseForEachRxIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not a prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription.

Allows the returning of at most one prescription dispense record per a prescription.

The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result.

Indicates whether or not a prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription.

Allows the returning of at most one prescription dispense record per a prescription.

The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result.

Indicates whether or not a prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription.

Allows the returning of at most one prescription dispense record per a prescription.

The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result.

Helps to trim down volume of query response by eliminating multiple dispenses for the same prescription.

Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory.

Helps to trim down volume of query response by eliminating multiple dispenses for the same prescription.

Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory.

Un-merged Business Name: MostRecentDispenseForEachRxIndicator

Relationship: PORX_MT060170CA.MostRecentDispenseForEachRxIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not a prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription.

Allows the returning of at most one prescription dispense record per a prescription.

The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result.

Indicates whether or not a prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription.

Allows the returning of at most one prescription dispense record per a prescription.

The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result.

Indicates whether or not a prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription.

Allows the returning of at most one prescription dispense record per a prescription.

The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result.

Helps to trim down volume of query response by eliminating multiple dispenses for the same prescription.

Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory.

Helps to trim down volume of query response by eliminating multiple dispenses for the same prescription.

Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory.

setMostRecentDispenseForEachRxIndicatorValue

public void setMostRecentDispenseForEachRxIndicatorValue(Boolean mostRecentDispenseForEachRxIndicatorValue)

Business Name: MostRecentDispenseForEachRxIndicator

Un-merged Business Name: MostRecentDispenseForEachRxIndicator

Relationship: PORX_MT060180CA.MostRecentDispenseForEachRxIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not a prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription.

Allows the returning of at most one prescription dispense record per a prescription.

The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result.

Indicates whether or not a prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription.

Allows the returning of at most one prescription dispense record per a prescription.

The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result.

Indicates whether or not a prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription.

Allows the returning of at most one prescription dispense record per a prescription.

The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result.

Helps to trim down volume of query response by eliminating multiple dispenses for the same prescription.

Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory.

Helps to trim down volume of query response by eliminating multiple dispenses for the same prescription.

Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory.

Un-merged Business Name: MostRecentDispenseForEachRxIndicator

Relationship: PORX_MT060170CA.MostRecentDispenseForEachRxIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not a prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription.

Allows the returning of at most one prescription dispense record per a prescription.

The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result.

Indicates whether or not a prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription.

Allows the returning of at most one prescription dispense record per a prescription.

The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result.

Indicates whether or not a prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription.

Allows the returning of at most one prescription dispense record per a prescription.

The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result.

Helps to trim down volume of query response by eliminating multiple dispenses for the same prescription.

Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory.

Helps to trim down volume of query response by eliminating multiple dispenses for the same prescription.

Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory.

getOtherIndicationCodeValue

public ActNonConditionIndicationCode getOtherIndicationCodeValue()

Business Name: OtherIndicationCode

Un-merged Business Name: OtherIndicationCode

Relationship: PORX_MT060180CA.OtherIndicationCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified non-condition-related indication code.

Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications.

Un-merged Business Name: OtherIndicationCode

Relationship: PORX_MT060170CA.OtherIndicationCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified non-condition-related indication code.

Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications.

setOtherIndicationCodeValue

public void setOtherIndicationCodeValue(ActNonConditionIndicationCode otherIndicationCodeValue)

Business Name: OtherIndicationCode

Un-merged Business Name: OtherIndicationCode

Relationship: PORX_MT060180CA.OtherIndicationCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified non-condition-related indication code.

Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications.

Un-merged Business Name: OtherIndicationCode

Relationship: PORX_MT060170CA.OtherIndicationCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified non-condition-related indication code.

Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications.

getOtherMedicationRecordIdValue

public Identifier getOtherMedicationRecordIdValue()

Business Name: OtherMedicationRecordId

Un-merged Business Name: OtherMedicationRecordId

Relationship: PORX_MT060180CA.OtherMedicationRecordId.value

Conformance/Cardinality: MANDATORY (1)

Identifier of the other active medication record for which detailed information is to be retrieved.

Allows for the retrieval of medication records based on a specific active medication record.

setOtherMedicationRecordIdValue

public void setOtherMedicationRecordIdValue(Identifier otherMedicationRecordIdValue)

Business Name: OtherMedicationRecordId

Un-merged Business Name: OtherMedicationRecordId

Relationship: PORX_MT060180CA.OtherMedicationRecordId.value

Conformance/Cardinality: MANDATORY (1)

Identifier of the other active medication record for which detailed information is to be retrieved.

Allows for the retrieval of medication records based on a specific active medication record.

getPrescriberProviderIDValue

public Identifier getPrescriberProviderIDValue()

Business Name: PrescriberProviderID

Un-merged Business Name: PrescriberProviderID

Relationship: PORX_MT060180CA.PrescriberProviderID.value

Conformance/Cardinality: MANDATORY (1)

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.

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.

Allows for the retrieval of prescriptions based on the specific prescribers.

setPrescriberProviderIDValue

public void setPrescriberProviderIDValue(Identifier prescriberProviderIDValue)

Business Name: PrescriberProviderID

Un-merged Business Name: PrescriberProviderID

Relationship: PORX_MT060180CA.PrescriberProviderID.value

Conformance/Cardinality: MANDATORY (1)

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.

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.

Allows for the retrieval of prescriptions based on the specific prescribers.

getPrescriptionDispenseNumberValue

public Identifier getPrescriptionDispenseNumberValue()

Business Name: PrescriptionDispenseNumber

Un-merged Business Name: PrescriptionDispenseNumber

Relationship: PORX_MT060180CA.PrescriptionDispenseNumber.value

Conformance/Cardinality: MANDATORY (1)

Identifies which prescription dispense record should be retrieved.

Allows for the retrieval of medication records relating to a specific dispense record.

setPrescriptionDispenseNumberValue

public void setPrescriptionDispenseNumberValue(Identifier prescriptionDispenseNumberValue)

Business Name: PrescriptionDispenseNumber

Un-merged Business Name: PrescriptionDispenseNumber

Relationship: PORX_MT060180CA.PrescriptionDispenseNumber.value

Conformance/Cardinality: MANDATORY (1)

Identifies which prescription dispense record should be retrieved.

Allows for the retrieval of medication records relating to a specific dispense record.

getPrescriptionOrderNumberValue

public Identifier getPrescriptionOrderNumberValue()

Business Name: PrescriptionOrderNumber

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT060180CA.PrescriptionOrderNumber.value

Conformance/Cardinality: MANDATORY (1)

Identifier of the prescription for which detailed information is required.

The result set will be filtered to only the specific prescription.

Identifier of the prescription for which detailed information is required.

The result set will be filtered to only the specific prescription.

Identifies the prescription that is to be retrieved.

setPrescriptionOrderNumberValue

public void setPrescriptionOrderNumberValue(Identifier prescriptionOrderNumberValue)

Business Name: PrescriptionOrderNumber

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT060180CA.PrescriptionOrderNumber.value

Conformance/Cardinality: MANDATORY (1)

Identifier of the prescription for which detailed information is required.

The result set will be filtered to only the specific prescription.

Identifier of the prescription for which detailed information is required.

The result set will be filtered to only the specific prescription.

Identifies the prescription that is to be retrieved.

getPrescriptionStatusValue

public List<ActStatus> getPrescriptionStatusValue()

Business Name: PrescriptionStatuses

Un-merged Business Name: PrescriptionStatuses

Relationship: PORX_MT060180CA.PrescriptionStatus.value

Conformance/Cardinality: MANDATORY (1)

Indicates that prescriptions of a specific statuses are to be included in the result set. Specific prescription statuses are: 'active', completed', 'aborted', 'suspended'.

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

getRxDispenseIndicatorValue

public List<PrescriptionDispenseFilterCode> getRxDispenseIndicatorValue()

Business Name: RxDispenserIndicators

Un-merged Business Name: RxDispenserIndicators

Relationship: PORX_MT060180CA.RxDispenseIndicator.value

Conformance/Cardinality: MANDATORY (1)

A coded value indicating the dispensing (fill) status of the prescription to be included in the result set. Rx Dispense Indicators include: ND (Never Dispensed), DRR (Dispensed with Refills Remaining), etc.

The repetition of 3 allows for retrieval based on all three Rx Dispense Indicators.

A coded value indicating the dispensing (fill) status of the prescription to be included in the result set. Rx Dispense Indicators include: ND (Never Dispensed), DRR (Dispensed with Refills Remaining), etc.

The repetition of 3 allows for retrieval based on all three Rx Dispense Indicators.

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

getSymptomCodeValue

public SymptomValue getSymptomCodeValue()

Business Name: SymptomCode

Un-merged Business Name: SymptomCode

Relationship: PORX_MT060180CA.SymptomCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified symptom indication code.

Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications.

Un-merged Business Name: SymptomCode

Relationship: PORX_MT060170CA.SymptomCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified symptom indication code.

Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications.

setSymptomCodeValue

public void setSymptomCodeValue(SymptomValue symptomCodeValue)

Business Name: SymptomCode

Un-merged Business Name: SymptomCode

Relationship: PORX_MT060180CA.SymptomCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified symptom indication code.

Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications.

Un-merged Business Name: SymptomCode

Relationship: PORX_MT060170CA.SymptomCode.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those records pertaining to the specified symptom indication code.

Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications.

getTreatmentTypeValue

public List<ActTherapyDurationWorkingListCode> getTreatmentTypeValue()

Business Name: TreatmentTypes

Un-merged Business Name: TreatmentTypes

Relationship: PORX_MT060180CA.TreatmentType.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to only include those records pertaining to the specified treatment type (categories). The specific values are "Continuous/Chronic", "Short-Term/Acute" and "As-Needed/PRN".

Allows for the retrieval of prescriptions and dispensed based on the intended treatment type of the prescription. Repetition of 2 will allow for the result set to be filtered based on 1 or two treatment types.

getMedicationDocumentIDValue

public Identifier getMedicationDocumentIDValue()

Business Name: MedicationDocumentID

Un-merged Business Name: MedicationDocumentID

Relationship: POME_MT010050CA.MedicationDocumentID.value

Conformance/Cardinality: MANDATORY (1)

Unique identifier for a particular medication document. This will reference a specific kind of documentation (e.g. DDI Monograph, Patient Education Monograph, Allergy Monograph, etc) created by a specific author organization (e.g. Health Canada, FDB, WHO, etc).

Use of an identifier allows for a quick retrieval of the information of interest.

setMedicationDocumentIDValue

public void setMedicationDocumentIDValue(Identifier medicationDocumentIDValue)

Business Name: MedicationDocumentID

Un-merged Business Name: MedicationDocumentID

Relationship: POME_MT010050CA.MedicationDocumentID.value

Conformance/Cardinality: MANDATORY (1)

Unique identifier for a particular medication document. This will reference a specific kind of documentation (e.g. DDI Monograph, Patient Education Monograph, Allergy Monograph, etc) created by a specific author organization (e.g. Health Canada, FDB, WHO, etc).

Use of an identifier allows for a quick retrieval of the information of interest.

getMedicationDocumentTypeValue

public ActMedicationDocumentCode getMedicationDocumentTypeValue()

Business Name: MedicationDocumentType

Un-merged Business Name: MedicationDocumentType

Relationship: POME_MT010050CA.MedicationDocumentType.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those medication documents pertaining to the specified document category.

Valid medication document categories include: Drug Monograph, Contraindication Monograph, Indication Protocol, etc.

Indicates that the result set is to be filtered to include only those medication documents pertaining to the specified document category.

Valid medication document categories include: Drug Monograph, Contraindication Monograph, Indication Protocol, etc.

Allows for the retrieval of all medication documents pertaining to a specific document category.

setMedicationDocumentTypeValue

public void setMedicationDocumentTypeValue(ActMedicationDocumentCode medicationDocumentTypeValue)

Business Name: MedicationDocumentType

Un-merged Business Name: MedicationDocumentType

Relationship: POME_MT010050CA.MedicationDocumentType.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set is to be filtered to include only those medication documents pertaining to the specified document category.

Valid medication document categories include: Drug Monograph, Contraindication Monograph, Indication Protocol, etc.

Indicates that the result set is to be filtered to include only those medication documents pertaining to the specified document category.

Valid medication document categories include: Drug Monograph, Contraindication Monograph, Indication Protocol, etc.

Allows for the retrieval of all medication documents pertaining to a specific document category.

getPrescribingDiagnosisCodeValue

public DiagnosisValue getPrescribingDiagnosisCodeValue()

Business Name: PrescribingIndicationDiagnosisCode

Un-merged Business Name: PrescribingIndicationDiagnosisCode

Relationship: POME_MT010050CA.PrescribingDiagnosisCode.value

Conformance/Cardinality: MANDATORY (1)

Returns documents which relate to a particular diagnosis

Useful for finding protocols and drug monographs associated with an indication

setPrescribingDiagnosisCodeValue

public void setPrescribingDiagnosisCodeValue(DiagnosisValue prescribingDiagnosisCodeValue)

Business Name: PrescribingIndicationDiagnosisCode

Un-merged Business Name: PrescribingIndicationDiagnosisCode

Relationship: POME_MT010050CA.PrescribingDiagnosisCode.value

Conformance/Cardinality: MANDATORY (1)

Returns documents which relate to a particular diagnosis

Useful for finding protocols and drug monographs associated with an indication

getPrescribingSymptomCodeValue

public SymptomValue getPrescribingSymptomCodeValue()

Business Name: PrescribingIndicationSymptomCode

Un-merged Business Name: PrescribingIndicationSymptomCode

Relationship: POME_MT010050CA.PrescribingSymptomCode.value

Conformance/Cardinality: MANDATORY (1)

Returns documents which relate to a particular symptom

Useful for finding protocols and drug monographs associated with an indication

setPrescribingSymptomCodeValue

public void setPrescribingSymptomCodeValue(SymptomValue prescribingSymptomCodeValue)

Business Name: PrescribingIndicationSymptomCode

Un-merged Business Name: PrescribingIndicationSymptomCode

Relationship: POME_MT010050CA.PrescribingSymptomCode.value

Conformance/Cardinality: MANDATORY (1)

Returns documents which relate to a particular symptom

Useful for finding protocols and drug monographs associated with an indication

getDrugCharacteristics

public List<HasCharacteristicBean> getDrugCharacteristics()

Un-merged Business Name: (no business name specified)

Relationship: POME_MT010090CA.ParameterList.drugCharacteristics

Conformance/Cardinality: REQUIRED (0-5)

getDrugFormValue

public OrderableDrugForm getDrugFormValue()

Business Name: OrderableDrugForm

Un-merged Business Name: OrderableDrugForm

Relationship: POME_MT010090CA.DrugForm.value

Conformance/Cardinality: MANDATORY (1)

Indicates the form in which the drug product must is manufactured.

Useful filter for searching drugs. Allows the requester to specify the drug form of interest for the retrieval.

setDrugFormValue

public void setDrugFormValue(OrderableDrugForm drugFormValue)

Business Name: OrderableDrugForm

Un-merged Business Name: OrderableDrugForm

Relationship: POME_MT010090CA.DrugForm.value

Conformance/Cardinality: MANDATORY (1)

Indicates the form in which the drug product must is manufactured.

Useful filter for searching drugs. Allows the requester to specify the drug form of interest for the retrieval.

getDrugManufacturerNameValue

public String getDrugManufacturerNameValue()

Business Name: DrugManufacturerName

Un-merged Business Name: DrugManufacturerName

Relationship: POME_MT010090CA.DrugManufacturerName.value

Conformance/Cardinality: MANDATORY (1)

The name of a drug manufacturer.

Allows for the retrieval of drug products based on the manufacturer.

Manufacturer name search will be 'Starts with...' type of a search.

setDrugManufacturerNameValue

public void setDrugManufacturerNameValue(String drugManufacturerNameValue)

Business Name: DrugManufacturerName

Un-merged Business Name: DrugManufacturerName

Relationship: POME_MT010090CA.DrugManufacturerName.value

Conformance/Cardinality: MANDATORY (1)

The name of a drug manufacturer.

Allows for the retrieval of drug products based on the manufacturer.

Manufacturer name search will be 'Starts with...' type of a search.

getDrugNameValue

public String getDrugNameValue()

Business Name: DrugName

Un-merged Business Name: DrugName

Relationship: POME_MT010090CA.DrugName.value

Conformance/Cardinality: MANDATORY (1)

The name assigned to a drug.

Name may be the only identification of a drug known by many prescribers.

setDrugNameValue

public void setDrugNameValue(String drugNameValue)

Business Name: DrugName

Un-merged Business Name: DrugName

Relationship: POME_MT010090CA.DrugName.value

Conformance/Cardinality: MANDATORY (1)

The name assigned to a drug.

Name may be the only identification of a drug known by many prescribers.

getDrugRouteValue

public RouteOfAdministration getDrugRouteValue()

Business Name: DrugRouteCode

Un-merged Business Name: DrugRouteCode

Relationship: POME_MT010090CA.DrugRoute.value

Conformance/Cardinality: MANDATORY (1)

A filter based on how the drug should be introduced into the patient's body (e.g. Oral, topical, etc.)

Allows limiting the returned list of drugs to a single route.

setDrugRouteValue

public void setDrugRouteValue(RouteOfAdministration drugRouteValue)

Business Name: DrugRouteCode

Un-merged Business Name: DrugRouteCode

Relationship: POME_MT010090CA.DrugRoute.value

Conformance/Cardinality: MANDATORY (1)

A filter based on how the drug should be introduced into the patient's body (e.g. Oral, topical, etc.)

Allows limiting the returned list of drugs to a single route.