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

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

All Implemented Interfaces:

NullFlavorSupport, Serializable

public class SubstanceAdministrationRequestBean
extends MessagePartBean

Business Name: Prescription

PORX_MT010120CA.CombinedMedicationRequest: Prescription

Id should not be specified if the order is being sent by prescriber; Id is mandatory if the order is being sent by the DIS

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

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

PORX_MT060100CA.SubstanceAdministrationRequest: Prescription

Provides a drill-down link from the prescription to its corresponding order.

Indicates the order being dispensed

See Also:

Serialized Form

Constructor Summary

SubstanceAdministrationRequestBean()

Method Summary

PrescribedByBean	getAuthor() Un-merged Business Name: (no business name specified)
ActCode	getCode() Business Name: PrescriptionType
List<AdministrationInstructionsBean>	getComponent1DosageInstruction() Un-merged Business Name: (no business name specified)
Component2Bean	getComponent2() Un-merged Business Name: (no business name specified)
Includes_1Bean	getComponent3() Un-merged Business Name: (no business name specified)
ClassifiesBean	getComponentOf() 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)
List<ReferencesBean>	getDefinition() Un-merged Business Name: (no business name specified)
DrugProductBean	getDirectTargetMedication() Un-merged Business Name: (no business name specified)
Identifier	getId() Un-merged Business Name: PrescriptionOrderNumber
List<Includes_2Bean>	getPertinentInformation() Un-merged Business Name: (no business name specified)
Boolean	getPreconditionVerificationEventCriterion() Un-merged Business Name: (no business name specified)
ParentPrescriptionBean	getPredecessorPriorCombinedMedicationRequest() 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
AllowedSubstitutionBean	getSubjectOf1SubstitutionPermission() Un-merged Business Name: (no business name specified)
NotesBean	getSubjectOf2Annotation() Un-merged Business Name: (no business name specified)
void	setAuthor(PrescribedByBean author) Un-merged Business Name: (no business name specified)
void	setCode(ActCode code) Business Name: PrescriptionType
void	setComponent2(Component2Bean component2) Un-merged Business Name: (no business name specified)
void	setComponent3(Includes_1Bean component3) Un-merged Business Name: (no business name specified)
void	setComponentOf(ClassifiesBean componentOf) Un-merged Business Name: (no business name specified)
void	setDirectTargetMedication(DrugProductBean directTargetMedication) Un-merged Business Name: (no business name specified)
void	setId(Identifier id) Un-merged Business Name: PrescriptionOrderNumber
void	setPreconditionVerificationEventCriterion(Boolean preconditionVerificationEventCriterion) Un-merged Business Name: (no business name specified)
void	setPredecessorPriorCombinedMedicationRequest(ParentPrescriptionBean predecessorPriorCombinedMedicationRequest) 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	setSubjectOf1SubstitutionPermission(AllowedSubstitutionBean subjectOf1SubstitutionPermission) Un-merged Business Name: (no business name specified)
void	setSubjectOf2Annotation(NotesBean subjectOf2Annotation) 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

SubstanceAdministrationRequestBean

public SubstanceAdministrationRequestBean()

Method Detail

getId

public Identifier getId()

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT010140CA.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.

Un-merged Business Name: PrescriptionNumber

Relationship: PORX_MT010120CA.CombinedMedicationRequest.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: PrescriptionIdentifier

Relationship: PORX_MT060100CA.SubstanceAdministrationRequest.id

Conformance/Cardinality: MANDATORY (1)

Links the dispense to the prescription it fulfilled.

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.

setId

public void setId(Identifier id)

Un-merged Business Name: PrescriptionOrderNumber

Relationship: PORX_MT010140CA.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.

Un-merged Business Name: PrescriptionNumber

Relationship: PORX_MT010120CA.CombinedMedicationRequest.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: PrescriptionIdentifier

Relationship: PORX_MT060100CA.SubstanceAdministrationRequest.id

Conformance/Cardinality: MANDATORY (1)

Links the dispense to the prescription it fulfilled.

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.

getPreconditionVerificationEventCriterion

public Boolean getPreconditionVerificationEventCriterion()

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

Relationship: PORX_MT010140CA.Precondition.verificationEventCriterion

Conformance/Cardinality: POPULATED (1)

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

Relationship: PORX_MT010120CA.Precondition.verificationEventCriterion

Conformance/Cardinality: POPULATED (1)

setPreconditionVerificationEventCriterion

public void setPreconditionVerificationEventCriterion(Boolean preconditionVerificationEventCriterion)

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

Relationship: PORX_MT010140CA.Precondition.verificationEventCriterion

Conformance/Cardinality: POPULATED (1)

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

Relationship: PORX_MT010120CA.Precondition.verificationEventCriterion

Conformance/Cardinality: POPULATED (1)

getCode

public ActCode getCode()

Business Name: PrescriptionType

Un-merged Business Name: PrescriptionType

Relationship: PORX_MT010120CA.CombinedMedicationRequest.code

Conformance/Cardinality: MANDATORY (1)

Needed to convey the meaning of this class and is therefore mandatory.

Indicates that this is a prescription for a drug as opposed to an immunization. For SNOMED, may also contain information regarding drug and route.

setCode

public void setCode(ActCode code)

Business Name: PrescriptionType

Un-merged Business Name: PrescriptionType

Relationship: PORX_MT010120CA.CombinedMedicationRequest.code

Conformance/Cardinality: MANDATORY (1)

Needed to convey the meaning of this class and is therefore mandatory.

Indicates that this is a prescription for a drug as opposed to an immunization. For SNOMED, may also contain information regarding drug and route.

getStatusCode

public ActStatus getStatusCode()

Business Name: PrescriptionStatus

Un-merged Business Name: PrescriptionStatus

Relationship: PORX_MT010120CA.CombinedMedicationRequest.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 'new' when submitting a clinical pre-determination. 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_MT010120CA.CombinedMedicationRequest.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 'new' when submitting a clinical pre-determination. Use 'active' when registering a new prescription or converting a predetermination into a valid prescription.

getConfidentialityCode

public Set<x_NormalRestrictedTabooConfidentialityKind> getConfidentialityCode()

Business Name: PrescriptionMaskingIndicators

Un-merged Business Name: PrescriptionMaskingIndicators

Relationship: PORX_MT010120CA.CombinedMedicationRequest.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'.

getDirectTargetMedication

public DrugProductBean getDirectTargetMedication()

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

Relationship: PORX_MT010120CA.DirectTarget.medication

Conformance/Cardinality: POPULATED (1)

setDirectTargetMedication

public void setDirectTargetMedication(DrugProductBean directTargetMedication)

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

Relationship: PORX_MT010120CA.DirectTarget.medication

Conformance/Cardinality: POPULATED (1)

getDefinition

public List<ReferencesBean> getDefinition()

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

Relationship: PORX_MT010120CA.CombinedMedicationRequest.definition

Conformance/Cardinality: REQUIRED (0-5)

getPredecessorPriorCombinedMedicationRequest

public ParentPrescriptionBean getPredecessorPriorCombinedMedicationRequest()

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

Relationship: PORX_MT010120CA.Predecessor.priorCombinedMedicationRequest

Conformance/Cardinality: POPULATED (1)

setPredecessorPriorCombinedMedicationRequest

public void setPredecessorPriorCombinedMedicationRequest(ParentPrescriptionBean predecessorPriorCombinedMedicationRequest)

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

Relationship: PORX_MT010120CA.Predecessor.priorCombinedMedicationRequest

Conformance/Cardinality: POPULATED (1)

getReason

public List<PrescribedBecauseOfBean> getReason()

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

Relationship: PORX_MT010120CA.CombinedMedicationRequest.reason

Conformance/Cardinality: POPULATED (1-5)

getPertinentInformation

public List<Includes_2Bean> getPertinentInformation()

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

Relationship: PORX_MT010120CA.CombinedMedicationRequest.pertinentInformation

Conformance/Cardinality: REQUIRED (0-6)

getCoverageCoverage

public List<CoverageExtensions_1Bean> getCoverageCoverage()

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

Relationship: PORX_MT010120CA.Coverage2.coverage

Conformance/Cardinality: POPULATED (1)

getComponent1DosageInstruction

public List<AdministrationInstructionsBean> getComponent1DosageInstruction()

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

Relationship: PORX_MT010120CA.Component1.dosageInstruction

Conformance/Cardinality: MANDATORY (1)

getComponent2

public Component2Bean getComponent2()

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

Relationship: PORX_MT010120CA.CombinedMedicationRequest.component2

Conformance/Cardinality: MANDATORY (1)

setComponent2

public void setComponent2(Component2Bean component2)

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

Relationship: PORX_MT010120CA.CombinedMedicationRequest.component2

Conformance/Cardinality: MANDATORY (1)

getComponent3

public Includes_1Bean getComponent3()

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

Relationship: PORX_MT010120CA.CombinedMedicationRequest.component3

Conformance/Cardinality: POPULATED (1)

setComponent3

public void setComponent3(Includes_1Bean component3)

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

Relationship: PORX_MT010120CA.CombinedMedicationRequest.component3

Conformance/Cardinality: POPULATED (1)

getSubjectOf1SubstitutionPermission

public AllowedSubstitutionBean getSubjectOf1SubstitutionPermission()

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

Relationship: PORX_MT010120CA.Subject.substitutionPermission

Conformance/Cardinality: POPULATED (1)

setSubjectOf1SubstitutionPermission

public void setSubjectOf1SubstitutionPermission(AllowedSubstitutionBean subjectOf1SubstitutionPermission)

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

Relationship: PORX_MT010120CA.Subject.substitutionPermission

Conformance/Cardinality: POPULATED (1)

getSubjectOf2Annotation

public NotesBean getSubjectOf2Annotation()

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

Relationship: PORX_MT010120CA.Subject4.annotation

Conformance/Cardinality: POPULATED (1)

setSubjectOf2Annotation

public void setSubjectOf2Annotation(NotesBean subjectOf2Annotation)

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

Relationship: PORX_MT010120CA.Subject4.annotation

Conformance/Cardinality: POPULATED (1)

getComponentOf

public ClassifiesBean getComponentOf()

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

Relationship: PORX_MT010120CA.CombinedMedicationRequest.componentOf

Conformance/Cardinality: POPULATED (1)

setComponentOf

public void setComponentOf(ClassifiesBean componentOf)

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

Relationship: PORX_MT010120CA.CombinedMedicationRequest.componentOf

Conformance/Cardinality: POPULATED (1)

getResponsiblePartyAssignedEntity

public HealthcareWorkerBean getResponsiblePartyAssignedEntity()

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

Relationship: PORX_MT060100CA.ResponsibleParty2.assignedEntity

Conformance/Cardinality: POPULATED (1)

setResponsiblePartyAssignedEntity

public void setResponsiblePartyAssignedEntity(HealthcareWorkerBean responsiblePartyAssignedEntity)

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

Relationship: PORX_MT060100CA.ResponsibleParty2.assignedEntity

Conformance/Cardinality: POPULATED (1)

getAuthor

public PrescribedByBean getAuthor()

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

Relationship: PORX_MT060100CA.SubstanceAdministrationRequest.author

Conformance/Cardinality: MANDATORY (1)

setAuthor

public void setAuthor(PrescribedByBean author)

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

Relationship: PORX_MT060100CA.SubstanceAdministrationRequest.author

Conformance/Cardinality: MANDATORY (1)