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

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

All Implemented Interfaces:

NullFlavorSupport, Serializable

public class GenericQueryParametersBean
extends MessagePartBean

REPC_MT000016CA.ParameterList: Adverse Reactions Query Parameters

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

Root class for query definition

PORX_MT060280CA.ParameterList: Drug Prescription Detail Query Parameters

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

Root class for query definition.

REPC_MT000004CA.ParameterList: Allergy/Intolerance Query Parameters

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

Root class for query definition

PORX_MT060360CA.ParameterList: Generic Query Parameters

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

Root class for query definition

See Also:

Serialized Form

Constructor Summary

GenericQueryParametersBean()

Method Summary

ActStatus	getAllergyIntoleranceStatusValue() Business Name: AllergyIntoleranceStatus
ObservationIntoleranceType	getAllergyIntoleranceTypeValue() Business Name: AllergyIntoleranceType
Interval<Date>	getAlllergyIntoleranceChangePeriodValue() Business Name: AllergyIntoleranceChangePeriod
Interval<Date>	getAmendedInTimeRangeValue() Business Name: AmendedInTimeRange
List<Identifier>	getCareCompositionIDValue() Business Name: CareCompositionIDs
List<ActCareEventType>	getCareCompositionTypeValue() Business Name: CareCompositionTypes
Boolean	getIncludeEventHistoryIndicatorValue() Business Name: IncludeEventHistoryIndicator
Boolean	getIncludeIssuesIndicatorValue() Business Name: IncludeIssuesIndicator
Boolean	getIncludeNotesIndicatorValue() Business Name: IncludeNotesIndicator
Boolean	getIncludePendingChangesIndicatorValue() Business Name: IncludePendingChangesIndicator
Identifier	getPrescriptionDispenseNumberValue() Business Name: PrescriptionDispenseNumber
Identifier	getPrescriptionOrderNumberValue() Business Name: PrescriptionOrderNumber
Interval<Date>	getReactionPeriodValue() Business Name: ReactionPeriod
SubjectReaction	getReactionTypeValue() Un-merged Business Name: ReactionType
void	setAllergyIntoleranceStatusValue(ActStatus allergyIntoleranceStatusValue) Business Name: AllergyIntoleranceStatus
void	setAllergyIntoleranceTypeValue(ObservationIntoleranceType allergyIntoleranceTypeValue) Business Name: AllergyIntoleranceType
void	setAlllergyIntoleranceChangePeriodValue(Interval<Date> alllergyIntoleranceChangePeriodValue) Business Name: AllergyIntoleranceChangePeriod
void	setAmendedInTimeRangeValue(Interval<Date> amendedInTimeRangeValue) Business Name: AmendedInTimeRange
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	setPrescriptionDispenseNumberValue(Identifier prescriptionDispenseNumberValue) Business Name: PrescriptionDispenseNumber
void	setPrescriptionOrderNumberValue(Identifier prescriptionOrderNumberValue) Business Name: PrescriptionOrderNumber
void	setReactionPeriodValue(Interval<Date> reactionPeriodValue) Business Name: ReactionPeriod
void	setReactionTypeValue(SubjectReaction reactionTypeValue) Un-merged Business Name: ReactionType

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

getCareCompositionIDValue

public List<Identifier> getCareCompositionIDValue()

Business Name: CareCompositionIDs

Un-merged Business Name: CareCompositionIDs

Relationship: PORX_MT060280CA.CareCompositionID.value

Conformance/Cardinality: MANDATORY (1)

Desc: 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.

Desc: 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: REPC_MT000016CA.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: REPC_MT000004CA.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_MT060280CA.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: REPC_MT000016CA.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: REPC_MT000004CA.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.

getIncludeNotesIndicatorValue

public Boolean getIncludeNotesIndicatorValue()

Business Name: IncludeNotesIndicator

Un-merged Business Name: IncludeNotesIndicator

Relationship: PORX_MT060280CA.IncludeNotesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not notes attached to the selected 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 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 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: REPC_MT000016CA.IncludeNotesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not notes attached to the adverse reactions records are to be returned along with the detailed information.

Allows for the flexibility of omitting/including notes in the retrieval of information for adverse reactions 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 adverse reactions 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_MT060360CA.IncludeNotesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not notes attached to the prescription dispense record are to be returned along with the detailed information.

Allows for the flexibility of omitting/including notes in the retrieval of information for medication 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 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: REPC_MT000004CA.IncludeNotesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not notes attached to the allergy/intolerance records are to be returned along with the detailed information.

Allows for the flexibility of omitting/including notes in the retrieval of information for allergy/intolerance 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 allergy/intolerance 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_MT060280CA.IncludeNotesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not notes attached to the selected 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 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 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: REPC_MT000016CA.IncludeNotesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not notes attached to the adverse reactions records are to be returned along with the detailed information.

Allows for the flexibility of omitting/including notes in the retrieval of information for adverse reactions 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 adverse reactions 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_MT060360CA.IncludeNotesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not notes attached to the prescription dispense record are to be returned along with the detailed information.

Allows for the flexibility of omitting/including notes in the retrieval of information for medication 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 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: REPC_MT000004CA.IncludeNotesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not notes attached to the allergy/intolerance records are to be returned along with the detailed information.

Allows for the flexibility of omitting/including notes in the retrieval of information for allergy/intolerance 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 allergy/intolerance data.

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

getReactionPeriodValue

public Interval<Date> getReactionPeriodValue()

Business Name: ReactionPeriod

Un-merged Business Name: ReactionPeriod

Relationship: REPC_MT000016CA.ReactionPeriod.value

Conformance/Cardinality: MANDATORY (1)

The period in which the recorded adverse reaction occurred or was updated. I.e. Filters the result-set to those reactions whose onset occurred within the time-range specified by this parameter.

Allows the requester to specify the adverse reaction period of interest for retrieval of adverse reaction records. Useful to avoid run-away queries.

setReactionPeriodValue

public void setReactionPeriodValue(Interval<Date> reactionPeriodValue)

Business Name: ReactionPeriod

Un-merged Business Name: ReactionPeriod

Relationship: REPC_MT000016CA.ReactionPeriod.value

Conformance/Cardinality: MANDATORY (1)

The period in which the recorded adverse reaction occurred or was updated. I.e. Filters the result-set to those reactions whose onset occurred within the time-range specified by this parameter.

Allows the requester to specify the adverse reaction period of interest for retrieval of adverse reaction records. Useful to avoid run-away queries.

getReactionTypeValue

public SubjectReaction getReactionTypeValue()

Un-merged Business Name: ReactionType

Relationship: REPC_MT000016CA.ReactionType.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set be filtered to include only those allergy/intolerance records for which specific type of reaction was recorded.

Reaction types include: STEVEN JOHNSON, ANAPHYLAXIS, NAUSEA, etc

Indicates that the result set be filtered to include only those allergy/intolerance records for which specific type of reaction was recorded.

Reaction types include: STEVEN JOHNSON, ANAPHYLAXIS, NAUSEA, etc

Allows the requester to retrieve only those allergy/intolerance records for which there was a specific type of reaction.

Un-merged Business Name: Reaction

Relationship: REPC_MT000004CA.ReactionType.value

Conformance/Cardinality: MANDATORY (1)

A coded value denoting a specific reaction. E.g. Code for 'rash'. The result set will be filtered to include only those allergy records or intolerance records pertaining to the specified reaction.

Allows allergy/intolerance records to be selectively searched and retrieved.

setReactionTypeValue

public void setReactionTypeValue(SubjectReaction reactionTypeValue)

Un-merged Business Name: ReactionType

Relationship: REPC_MT000016CA.ReactionType.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set be filtered to include only those allergy/intolerance records for which specific type of reaction was recorded.

Reaction types include: STEVEN JOHNSON, ANAPHYLAXIS, NAUSEA, etc

Indicates that the result set be filtered to include only those allergy/intolerance records for which specific type of reaction was recorded.

Reaction types include: STEVEN JOHNSON, ANAPHYLAXIS, NAUSEA, etc

Allows the requester to retrieve only those allergy/intolerance records for which there was a specific type of reaction.

Un-merged Business Name: Reaction

Relationship: REPC_MT000004CA.ReactionType.value

Conformance/Cardinality: MANDATORY (1)

A coded value denoting a specific reaction. E.g. Code for 'rash'. The result set will be filtered to include only those allergy records or intolerance records pertaining to the specified reaction.

Allows allergy/intolerance records to be selectively searched and retrieved.

getAmendedInTimeRangeValue

public Interval<Date> getAmendedInTimeRangeValue()

Business Name: AmendedInTimeRange

Un-merged Business Name: AmendedInTimeRange

Relationship: PORX_MT060280CA.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_MT060280CA.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.

getIncludeEventHistoryIndicatorValue

public Boolean getIncludeEventHistoryIndicatorValue()

Business Name: IncludeEventHistoryIndicator

Un-merged Business Name: IncludeEventHistoryIndicator

Relationship: PORX_MT060280CA.IncludeEventHistoryIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not history of selected medication records 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 of selected medication records 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 always either 'TRUE' or 'FALSE' it is mandatory.

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

Because the attribute is always either 'TRUE' or 'FALSE' it is mandatory.

setIncludeEventHistoryIndicatorValue

public void setIncludeEventHistoryIndicatorValue(Boolean includeEventHistoryIndicatorValue)

Business Name: IncludeEventHistoryIndicator

Un-merged Business Name: IncludeEventHistoryIndicator

Relationship: PORX_MT060280CA.IncludeEventHistoryIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not history of selected medication records 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 of selected medication records 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 always either 'TRUE' or 'FALSE' it is mandatory.

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

Because the attribute is always either 'TRUE' or 'FALSE' it is mandatory.

getIncludeIssuesIndicatorValue

public Boolean getIncludeIssuesIndicatorValue()

Business Name: IncludeIssuesIndicator

Un-merged Business Name: IncludeIssuesIndicator

Relationship: PORX_MT060280CA.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_MT060360CA.IncludeIssuesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not Issues (detected and/or managed) attached to the prescription dispense record to be returned along with the detailed information.

Allows for the flexibility of omitting/including issues in the retrieval of patient medication 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 patient medication 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_MT060280CA.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_MT060360CA.IncludeIssuesIndicator.value

Conformance/Cardinality: MANDATORY (1)

Indicates whether or not Issues (detected and/or managed) attached to the prescription dispense record to be returned along with the detailed information.

Allows for the flexibility of omitting/including issues in the retrieval of patient medication 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 patient medication 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_MT060280CA.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 and/or prescription dispense 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_MT060280CA.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 and/or prescription dispense 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.

getPrescriptionOrderNumberValue

public Identifier getPrescriptionOrderNumberValue()

Business Name: PrescriptionOrderNumber

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT060280CA.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, and is therefore mandatory.

setPrescriptionOrderNumberValue

public void setPrescriptionOrderNumberValue(Identifier prescriptionOrderNumberValue)

Business Name: PrescriptionOrderNumber

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT060280CA.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, and is therefore mandatory.

getAllergyIntoleranceStatusValue

public ActStatus getAllergyIntoleranceStatusValue()

Business Name: AllergyIntoleranceStatus

Un-merged Business Name: AllergyIntoleranceStatus

Relationship: REPC_MT000004CA.AllergyIntoleranceStatus.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set should be filtered to include only those allergy/intolerance records for the specified status. Valid statuses include: ACTIVE or COMPLETE.

Allows for the selective retrieval of allergy/intolerance records based on the status of the record.

setAllergyIntoleranceStatusValue

public void setAllergyIntoleranceStatusValue(ActStatus allergyIntoleranceStatusValue)

Business Name: AllergyIntoleranceStatus

Un-merged Business Name: AllergyIntoleranceStatus

Relationship: REPC_MT000004CA.AllergyIntoleranceStatus.value

Conformance/Cardinality: MANDATORY (1)

Indicates that the result set should be filtered to include only those allergy/intolerance records for the specified status. Valid statuses include: ACTIVE or COMPLETE.

Allows for the selective retrieval of allergy/intolerance records based on the status of the record.

getAllergyIntoleranceTypeValue

public ObservationIntoleranceType getAllergyIntoleranceTypeValue()

Business Name: AllergyIntoleranceType

Un-merged Business Name: AllergyIntoleranceType

Relationship: REPC_MT000004CA.AllergyIntoleranceType.value

Conformance/Cardinality: MANDATORY (1)

A coded value indicating whether to return an allergy record or an intolerance record. The result set will be filtered to include only allergy records or intolerance records accordingly.

Allows allergy/intolerance records to be selectively searched and retrieved.

setAllergyIntoleranceTypeValue

public void setAllergyIntoleranceTypeValue(ObservationIntoleranceType allergyIntoleranceTypeValue)

Business Name: AllergyIntoleranceType

Un-merged Business Name: AllergyIntoleranceType

Relationship: REPC_MT000004CA.AllergyIntoleranceType.value

Conformance/Cardinality: MANDATORY (1)

A coded value indicating whether to return an allergy record or an intolerance record. The result set will be filtered to include only allergy records or intolerance records accordingly.

Allows allergy/intolerance records to be selectively searched and retrieved.

getAlllergyIntoleranceChangePeriodValue

public Interval<Date> getAlllergyIntoleranceChangePeriodValue()

Business Name: AllergyIntoleranceChangePeriod

Un-merged Business Name: AllergyIntoleranceChangePeriod

Relationship: REPC_MT000004CA.AlllergyIntoleranceChangePeriod.value

Conformance/Cardinality: MANDATORY (1)

Filters the query response to only include allergy/intolerance records which have been created or modified within the date-range specified.

Useful in retrieving incremental changes to the patient's record.

setAlllergyIntoleranceChangePeriodValue

public void setAlllergyIntoleranceChangePeriodValue(Interval<Date> alllergyIntoleranceChangePeriodValue)

Business Name: AllergyIntoleranceChangePeriod

Un-merged Business Name: AllergyIntoleranceChangePeriod

Relationship: REPC_MT000004CA.AlllergyIntoleranceChangePeriod.value

Conformance/Cardinality: MANDATORY (1)

Filters the query response to only include allergy/intolerance records which have been created or modified within the date-range specified.

Useful in retrieving incremental changes to the patient's record.

getPrescriptionDispenseNumberValue

public Identifier getPrescriptionDispenseNumberValue()

Business Name: PrescriptionDispenseNumber

Un-merged Business Name: PrescriptionDispenseNumber

Relationship: PORX_MT060360CA.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. A dispense cannot be retrieved without the identifier of the record, and the attribute is therefore mandatory.

setPrescriptionDispenseNumberValue

public void setPrescriptionDispenseNumberValue(Identifier prescriptionDispenseNumberValue)

Business Name: PrescriptionDispenseNumber

Un-merged Business Name: PrescriptionDispenseNumber

Relationship: PORX_MT060360CA.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. A dispense cannot be retrieved without the identifier of the record, and the attribute is therefore mandatory.