ca.infoway.messagebuilder.model.pcs_mr2007_v02_r01.pharmacy.merged
Class PrescriptionDispenseResponseBean

java.lang.Object
  ca.infoway.messagebuilder.model.MessagePartBean
      ca.infoway.messagebuilder.model.pcs_mr2007_v02_r01.pharmacy.merged.PrescriptionDispenseResponseBean

All Implemented Interfaces:

NullFlavorSupport, Serializable

public class PrescriptionDispenseResponseBean
extends MessagePartBean

PORX_MT020030CA.SupplyEvent: Prescription Dispense Response

Allows communication of the identifiers assigned to the dispense and the prescription by the DIS.

Represents the information returned when a dispense has been accepted

PORX_MT020020CA.SupplyEvent: Dispense Pickup

The root class for the message. The time of pickup is specified on the ControlAct wrapper.

Captures information about what prescription was picked up and who received it.

PORX_MT020050CA.SupplyEvent: Office Supply

Allows for tracking of medications supplied to an office.

This is the detailed information about a medication being supplied for office use.

See Also:

Serialized Form

Constructor Summary

PrescriptionDispenseResponseBean()

Method Summary

ActCode	getCode() Business Name: DispenseType
Identifier	getDestinationServiceDeliveryLocationId() Business Name: ShipToFacilityId
Date	getEffectiveTime() Business Name: SupplyDate
SupplyOrderBean	getFulfillmentSupplyRequest() Un-merged Business Name: (no business name specified)
Identifier	getId() Un-merged Business Name: DispenseIdentifier
Identifier	getInFulfillmentOfActRequestId() Business Name: PrescriptionOrderNumber
DrugProductBean	getProductMedication() Un-merged Business Name: (no business name specified)
PhysicalQuantity	getQuantity() Business Name: SuppliedQuantity
RelatedPersonBean	getReceiverPersonalRelationship() Un-merged Business Name: (no business name specified)
NotesBean	getSubjectOfAnnotation() Un-merged Business Name: (no business name specified)
void	setCode(ActCode code) Business Name: DispenseType
void	setDestinationServiceDeliveryLocationId(Identifier destinationServiceDeliveryLocationId) Business Name: ShipToFacilityId
void	setEffectiveTime(Date effectiveTime) Business Name: SupplyDate
void	setFulfillmentSupplyRequest(SupplyOrderBean fulfillmentSupplyRequest) Un-merged Business Name: (no business name specified)
void	setId(Identifier id) Un-merged Business Name: DispenseIdentifier
void	setInFulfillmentOfActRequestId(Identifier inFulfillmentOfActRequestId) Business Name: PrescriptionOrderNumber
void	setProductMedication(DrugProductBean productMedication) Un-merged Business Name: (no business name specified)
void	setQuantity(PhysicalQuantity quantity) Business Name: SuppliedQuantity
void	setReceiverPersonalRelationship(RelatedPersonBean receiverPersonalRelationship) Un-merged Business Name: (no business name specified)
void	setSubjectOfAnnotation(NotesBean subjectOfAnnotation) Un-merged Business Name: (no business name specified)

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

PrescriptionDispenseResponseBean

public PrescriptionDispenseResponseBean()

Method Detail

getId

public Identifier getId()

Un-merged Business Name: DispenseIdentifier

Relationship: PORX_MT020030CA.SupplyEvent.id

Conformance/Cardinality: MANDATORY (1)

Establishes a record of impending dispense on the prescription. Attribute is mandatory to ensure that successful request to dispense has been acknowledged by the DIS.

Identifier of a dispense event to be used by the requesting dispenser.

Un-merged Business Name: DispenseId

Relationship: PORX_MT020020CA.SupplyEvent.id

Conformance/Cardinality: MANDATORY (1)

Allows dispenses to be uniquely identified. This attribute is mandatory because the identity of the dispense record must be known.

Identity of prescription dispense that has been picked up.

Un-merged Business Name: LocalDispenseID

Relationship: PORX_MT020050CA.SupplyEvent.id

Conformance/Cardinality: REQUIRED (0-1)

Allows formal tracking of centrally recorded dispenses to local records for audit and related purposes.

Identifier assigned by the dispensing facility.

setId

public void setId(Identifier id)

Un-merged Business Name: DispenseIdentifier

Relationship: PORX_MT020030CA.SupplyEvent.id

Conformance/Cardinality: MANDATORY (1)

Establishes a record of impending dispense on the prescription. Attribute is mandatory to ensure that successful request to dispense has been acknowledged by the DIS.

Identifier of a dispense event to be used by the requesting dispenser.

Un-merged Business Name: DispenseId

Relationship: PORX_MT020020CA.SupplyEvent.id

Conformance/Cardinality: MANDATORY (1)

Allows dispenses to be uniquely identified. This attribute is mandatory because the identity of the dispense record must be known.

Identity of prescription dispense that has been picked up.

Un-merged Business Name: LocalDispenseID

Relationship: PORX_MT020050CA.SupplyEvent.id

Conformance/Cardinality: REQUIRED (0-1)

Allows formal tracking of centrally recorded dispenses to local records for audit and related purposes.

Identifier assigned by the dispensing facility.

getInFulfillmentOfActRequestId

public Identifier getInFulfillmentOfActRequestId()

Business Name: PrescriptionOrderNumber

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT020030CA.ActRequest.id

Conformance/Cardinality: MANDATORY (1)

Allows prescriptions to be uniquely referenced. Multiple identifiers are allowed to support assigning of prescription ids by the prescriber, EHR, and potentially by pharmacies.

The ID is mandatory to allow every prescription record to be uniquely identified.

This is an identifier assigned to a specific medication order. The number remains constant across the lifetime of the order, regardless of the number of providers or pharmacies involved in fulfilling the order.

setInFulfillmentOfActRequestId

public void setInFulfillmentOfActRequestId(Identifier inFulfillmentOfActRequestId)

Business Name: PrescriptionOrderNumber

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT020030CA.ActRequest.id

Conformance/Cardinality: MANDATORY (1)

Allows prescriptions to be uniquely referenced. Multiple identifiers are allowed to support assigning of prescription ids by the prescriber, EHR, and potentially by pharmacies.

The ID is mandatory to allow every prescription record to be uniquely identified.

This is an identifier assigned to a specific medication order. The number remains constant across the lifetime of the order, regardless of the number of providers or pharmacies involved in fulfilling the order.

getReceiverPersonalRelationship

public RelatedPersonBean getReceiverPersonalRelationship()

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

Relationship: PORX_MT020020CA.Receiver.personalRelationship

Conformance/Cardinality: POPULATED (1)

setReceiverPersonalRelationship

public void setReceiverPersonalRelationship(RelatedPersonBean receiverPersonalRelationship)

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

Relationship: PORX_MT020020CA.Receiver.personalRelationship

Conformance/Cardinality: POPULATED (1)

getCode

public ActCode getCode()

Business Name: DispenseType

Un-merged Business Name: DispenseType

Relationship: PORX_MT020050CA.SupplyEvent.code

Conformance/Cardinality: MANDATORY (1)

Indicates reason for the size of dispense. Because it defines what type of dispense is occurring, the attribute is mandatory.

Indicates the type of dispensing event that is being performed.

This is a fixed dispense type of 'Office Supply' unless using SNOMED.

setCode

public void setCode(ActCode code)

Business Name: DispenseType

Un-merged Business Name: DispenseType

Relationship: PORX_MT020050CA.SupplyEvent.code

Conformance/Cardinality: MANDATORY (1)

Indicates reason for the size of dispense. Because it defines what type of dispense is occurring, the attribute is mandatory.

Indicates the type of dispensing event that is being performed.

This is a fixed dispense type of 'Office Supply' unless using SNOMED.

getEffectiveTime

public Date getEffectiveTime()

Business Name: SupplyDate

Un-merged Business Name: SupplyDate

Relationship: PORX_MT020050CA.SupplyEvent.effectiveTime

Conformance/Cardinality: MANDATORY (1)

Needed for audit purposes.

Because the supply date is always known, the attribute is mandatory.

Must be able to post date a dispense (enter retroactively) e.g. system failure

Represents the date medication was supplied.

setEffectiveTime

public void setEffectiveTime(Date effectiveTime)

Business Name: SupplyDate

Un-merged Business Name: SupplyDate

Relationship: PORX_MT020050CA.SupplyEvent.effectiveTime

Conformance/Cardinality: MANDATORY (1)

Needed for audit purposes.

Because the supply date is always known, the attribute is mandatory.

Must be able to post date a dispense (enter retroactively) e.g. system failure

Represents the date medication was supplied.

getQuantity

public PhysicalQuantity getQuantity()

Business Name: SuppliedQuantity

Un-merged Business Name: SuppliedQuantity

Relationship: PORX_MT020050CA.SupplyEvent.quantity

Conformance/Cardinality: MANDATORY (1)

Allows for auditing of medication dispensed to an office. This is mandatory to allow reconciliation with the amount used from the office.

The amount of medication that has been dispensed. Includes unit of measure.

setQuantity

public void setQuantity(PhysicalQuantity quantity)

Business Name: SuppliedQuantity

Un-merged Business Name: SuppliedQuantity

Relationship: PORX_MT020050CA.SupplyEvent.quantity

Conformance/Cardinality: MANDATORY (1)

Allows for auditing of medication dispensed to an office. This is mandatory to allow reconciliation with the amount used from the office.

The amount of medication that has been dispensed. Includes unit of measure.

getProductMedication

public DrugProductBean getProductMedication()

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

Relationship: PORX_MT020050CA.Product2.medication

Conformance/Cardinality: MANDATORY (1)

setProductMedication

public void setProductMedication(DrugProductBean productMedication)

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

Relationship: PORX_MT020050CA.Product2.medication

Conformance/Cardinality: MANDATORY (1)

getDestinationServiceDeliveryLocationId

public Identifier getDestinationServiceDeliveryLocationId()

Business Name: ShipToFacilityId

Un-merged Business Name: ShipToFacilityId

Relationship: PORX_MT020050CA.ServiceDeliveryLocation.id

Conformance/Cardinality: MANDATORY (1)

Allows tracking what drugs are dispensed to a facility. The attribute is mandatory because identification of the facility must be known.

Identifier of the facility where the dispensed medication was shipped.

setDestinationServiceDeliveryLocationId

public void setDestinationServiceDeliveryLocationId(Identifier destinationServiceDeliveryLocationId)

Business Name: ShipToFacilityId

Un-merged Business Name: ShipToFacilityId

Relationship: PORX_MT020050CA.ServiceDeliveryLocation.id

Conformance/Cardinality: MANDATORY (1)

Allows tracking what drugs are dispensed to a facility. The attribute is mandatory because identification of the facility must be known.

Identifier of the facility where the dispensed medication was shipped.

getFulfillmentSupplyRequest

public SupplyOrderBean getFulfillmentSupplyRequest()

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

Relationship: PORX_MT020050CA.InFulfillmentOf.supplyRequest

Conformance/Cardinality: POPULATED (1)

setFulfillmentSupplyRequest

public void setFulfillmentSupplyRequest(SupplyOrderBean fulfillmentSupplyRequest)

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

Relationship: PORX_MT020050CA.InFulfillmentOf.supplyRequest

Conformance/Cardinality: POPULATED (1)

getSubjectOfAnnotation

public NotesBean getSubjectOfAnnotation()

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

Relationship: PORX_MT020050CA.Subject7.annotation

Conformance/Cardinality: POPULATED (1)

setSubjectOfAnnotation

public void setSubjectOfAnnotation(NotesBean subjectOfAnnotation)

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

Relationship: PORX_MT020050CA.Subject7.annotation

Conformance/Cardinality: POPULATED (1)