PrescriptionReferenceBean (Message Builder Parent 1.4.5 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

Package class diagram package PrescriptionReferenceBean

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

All Implemented Interfaces:: NullFlavorSupport, Serializable

public class PrescriptionReferenceBean
extends MessagePartBean
extends MessagePartBean

PORX_MT010110CA.DeviceRequest: Prescription

This is a 'core' class of the medication model and is important for understanding what devices the patient is intended to be receiving.

Information pertaining to a prescriber's authorization for a device to be dispensed to a patient, as well as the instruction on when and how the device is to be used by the patient

PORX_MT020070CA.SubstanceAdministrationRequest: Prescription Reference

The Prescriber Name must be specified only when the Prescription Order Number is Null.

Component MUST be specified if the id is null and CAN NOT be specified if the id is not null

Dispenses for electronically created prescriptions must reference the prescription.

Information pertaining to the prescription for which a dispense is being created

PORX_MT060010CA.SupplyRequest: Prescription Reference

Links a dispense with its parent prescription.

A reference to the prescription order being dispensed

PORX_MT060090CA.SubstanceAdministrationRequest: Prescription Reference

Links a dispense with its parent prescription.

A reference to the prescription order being dispensed

PORX_MT020060CA.DeviceRequest: Prescription Reference

The Prescriber Name must be specified only when the Prescription ID is Null

Dispenses for electronically created prescriptions must reference the prescription.

Information pertaining to the prescription for which a dispense is being created

See Also:: Serialized Form

Constructor Summary
`PrescriptionReferenceBean()`

Method Summary
`RefusedByBean`	`getAuthor()` Un-merged Business Name: (no business name specified)
`ProcedureRequestBean`	`getComponent1ProcedureRequest()` Un-merged Business Name: (no business name specified)
`DispenseInstructions_1Bean`	`getComponent2SupplyRequest()` Un-merged Business Name: (no business name specified)
`Boolean`	`getComponentContextConductionInd()` Un-merged Business Name: (no business name specified)
`DispenseInstructions_2Bean`	`getComponentSupplyRequest()` Un-merged Business Name: (no business name specified)
`Set<x_NormalRestrictedTabooConfidentialityKind>`	`getConfidentialityCode()` Business Name: PrescriptionMaskingIndicators
`List<CoverageExtensions_1Bean>`	`getCoverageCoverage()` Un-merged Business Name: (no business name specified)
`DeviceProductBean`	`getDirectTargetManufacturedProduct()` Un-merged Business Name: (no business name specified)
`Identifier`	`getId()` Un-merged Business Name: PrescriptionNumber
`Boolean`	`getPreconditionVerificationEventCriterion()` Un-merged Business Name: (no business name specified)
`PriorDeviceRequestBean`	`getPredecessorPriorDeviceRequest()` Un-merged Business Name: (no business name specified)
`List<PrescribedBecauseOfBean>`	`getReason()` Un-merged Business Name: (no business name specified)
`HealthcareWorkerBean`	`getResponsiblePartyAssignedEntity()` Un-merged Business Name: (no business name specified)
`ActStatus`	`getStatusCode()` Business Name: PrescriptionStatus
`NotesBean`	`getSubjectOfAnnotation()` Un-merged Business Name: (no business name specified)
`void`	`setAuthor(RefusedByBean author)` Un-merged Business Name: (no business name specified)
`void`	`setComponent1ProcedureRequest(ProcedureRequestBean component1ProcedureRequest)` Un-merged Business Name: (no business name specified)
`void`	`setComponent2SupplyRequest(DispenseInstructions_1Bean component2SupplyRequest)` Un-merged Business Name: (no business name specified)
`void`	`setComponentContextConductionInd(Boolean componentContextConductionInd)` Un-merged Business Name: (no business name specified)
`void`	`setComponentSupplyRequest(DispenseInstructions_2Bean componentSupplyRequest)` Un-merged Business Name: (no business name specified)
`void`	`setDirectTargetManufacturedProduct(DeviceProductBean directTargetManufacturedProduct)` Un-merged Business Name: (no business name specified)
`void`	`setId(Identifier id)` Un-merged Business Name: PrescriptionNumber
`void`	`setPreconditionVerificationEventCriterion(Boolean preconditionVerificationEventCriterion)` Un-merged Business Name: (no business name specified)
`void`	`setPredecessorPriorDeviceRequest(PriorDeviceRequestBean predecessorPriorDeviceRequest)` Un-merged Business Name: (no business name specified)
`void`	`setResponsiblePartyAssignedEntity(HealthcareWorkerBean responsiblePartyAssignedEntity)` Un-merged Business Name: (no business name specified)
`void`	`setStatusCode(ActStatus statusCode)` Business Name: PrescriptionStatus
`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

PrescriptionReferenceBean

public PrescriptionReferenceBean()

Method Detail

getId

public Identifier getId()

Un-merged Business Name: PrescriptionNumber

Relationship: PORX_MT010110CA.DeviceRequest.id

Conformance/Cardinality: OPTIONAL (0-1)

Allows for the situations where the order is originating from the DIS.

Allows prescriptions to be uniquely referenced.

Because this attribute is not used for prescriptions originating from a prescriber system, the element is optional.

The Prescription Order Number is a globally unique number assigned to a prescription by the EHR/DIS irrespective of the source of the order

It is created by the EHR/DIS once the prescription has passed all edits and validation.

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT020070CA.SubstanceAdministrationRequest.id

Conformance/Cardinality: POPULATED (1)

Allows prescriptions to be uniquely referenced.

The ID is only 'populated' because in some cases the prescription will not yet exist electronically.

The identifier of the prescription for which a dispense is being created.

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT060010CA.SupplyRequest.id

Conformance/Cardinality: MANDATORY (1)

Allows prescriptions to be uniquely referenced and associated with the dispense.

The ID is mandatory because the DIS will always assign a Prescription Order Number.

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

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT060090CA.SubstanceAdministrationRequest.id

Conformance/Cardinality: MANDATORY (1)

Allows prescriptions to be uniquely referenced and associated with the dispense.

The ID is mandatory because the DIS will always assign a Prescription Order Number.

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.

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT020060CA.DeviceRequest.id

Conformance/Cardinality: POPULATED (1)

Allows prescriptions to be uniquely referenced.

The ID is only 'populated' because in some cases the prescription will not yet exist electronically.

The identifier of the prescription for which a dispense is beiing created.

setId

public void setId(Identifier id)

Un-merged Business Name: PrescriptionNumber

Relationship: PORX_MT010110CA.DeviceRequest.id

Conformance/Cardinality: OPTIONAL (0-1)

Allows for the situations where the order is originating from the DIS.

Allows prescriptions to be uniquely referenced.

Because this attribute is not used for prescriptions originating from a prescriber system, the element is optional.

The Prescription Order Number is a globally unique number assigned to a prescription by the EHR/DIS irrespective of the source of the order

It is created by the EHR/DIS once the prescription has passed all edits and validation.

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT020070CA.SubstanceAdministrationRequest.id

Conformance/Cardinality: POPULATED (1)

Allows prescriptions to be uniquely referenced.

The ID is only 'populated' because in some cases the prescription will not yet exist electronically.

The identifier of the prescription for which a dispense is being created.

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT060010CA.SupplyRequest.id

Conformance/Cardinality: MANDATORY (1)

Allows prescriptions to be uniquely referenced and associated with the dispense.

The ID is mandatory because the DIS will always assign a Prescription Order Number.

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT060090CA.SubstanceAdministrationRequest.id

Conformance/Cardinality: MANDATORY (1)

Allows prescriptions to be uniquely referenced and associated with the dispense.

The ID is mandatory because the DIS will always assign a Prescription Order Number.

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT020060CA.DeviceRequest.id

Conformance/Cardinality: POPULATED (1)

Allows prescriptions to be uniquely referenced.

The ID is only 'populated' because in some cases the prescription will not yet exist electronically.

The identifier of the prescription for which a dispense is beiing created.

getStatusCode

public ActStatus getStatusCode()

Business Name: PrescriptionStatus

Un-merged Business Name: PrescriptionStatus

Relationship: PORX_MT010110CA.DeviceRequest.statusCode

Conformance/Cardinality: MANDATORY (1)

Indicates what actions are allowed to be performed against a prescription. This is a mandatory field because every prescription needs to be in some state.

This denotes the state of the prescription in the lifecycle of the prescription. Valid statuses are: new, active, suspended, aborted, completed, obsolete and nullified. Use 'active' when registering a new prescription or converting a predetermination into a valid prescription.

setStatusCode

public void setStatusCode(ActStatus statusCode)

Business Name: PrescriptionStatus

Un-merged Business Name: PrescriptionStatus

Relationship: PORX_MT010110CA.DeviceRequest.statusCode

Conformance/Cardinality: MANDATORY (1)

Indicates what actions are allowed to be performed against a prescription. This is a mandatory field because every prescription needs to be in some state.

getConfidentialityCode

public Set<x_NormalRestrictedTabooConfidentialityKind> getConfidentialityCode()

Business Name: PrescriptionMaskingIndicators

Un-merged Business Name: PrescriptionMaskingIndicators

Relationship: PORX_MT010110CA.DeviceRequest.confidentialityCode

Conformance/Cardinality: OPTIONAL (0-2)

Allows the patient to have discrete control over access to their prescription data.

Taboo allows the provider to request restricted access to patient or their care giver.

Constraint: Cant have both normal and one of the other codes simultaneously.

The attribute is optional because not all systems will support masking.

Communicates the intent of the patient to restrict access to their prescriptions. Provides support for additional confidentiality constraint, giving patients a level of control over their information.

Valid values are: 'N' (normal - denotes 'Not Masked'); 'R' (restricted - denotes 'Masked') and 'T' (taboo - denotes 'Patient Access Restricted').

The default is 'normal' signifying 'Not Masked'.