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

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

All Implemented Interfaces:

NullFlavorSupport, Serializable

public class OtherMedicationBean
extends MessagePartBean

Business Name: OtherMedication

PORX_MT040020CA.OtherMedication: Other Medication

routeCode must not be used when code is SNOMED and is mandatory otherwise

The medication record being updated.

While SNOMED codes may pre-coordinate the drug code, the drug must not be modified. However route information for a drug may be updated.

PORX_MT040010CA.OtherMedication: Other Medication

Status can only be 'ACTIVE' or 'COMPLETED'

routeCode must not be used when code is SNOMED and is mandatory otherwise

Necessary component of a person's overall medication profile. Allows DUR checking against a more complete drug profile.

A record of a medication the patient is believed to be taking, but for which an electronic order does not exist. 'Other medications' include any drug product deemed relevant to the patient's drug profile, but which was not specifically ordered by a prescriber in a DIS-enabled jurisdiction. Examples include over-the counter medications that were not specifically ordered, herbal remedies, and recreational drugs. Prescription drugs that the patient may be taking but were not prescribed on the EHR (e.g. institutionally administered or out-of-jurisdiction prescriptions) will also be recorded here.

See Also:

Serialized Form

Constructor Summary

OtherMedicationBean()

Method Summary

ActCode	getCode() Business Name: OtherMedicationType
List<AdministrationInstructionsBean>	getComponentDosageInstruction() Un-merged Business Name: (no business name specified)
Set<x_NormalRestrictedTabooConfidentialityKind>	getConfidentialityCode() Business Name: OtherMedicationMaskingIndicators
DrugProductBean	getConsumableMedication() Un-merged Business Name: (no business name specified)
Interval<Date>	getEffectiveTime() Business Name: DrugActivePeriod
Identifier	getId() Business Name: OtherMedicationId
RouteOfAdministration	getRouteCode() Un-merged Business Name: Route
ActStatus	getStatusCode() Un-merged Business Name: MedicationStatus
NotesBean	getSubjectOfAnnotation() Un-merged Business Name: (no business name specified)
void	setCode(ActCode code) Business Name: OtherMedicationType
void	setConsumableMedication(DrugProductBean consumableMedication) Un-merged Business Name: (no business name specified)
void	setEffectiveTime(Interval<Date> effectiveTime) Business Name: DrugActivePeriod
void	setId(Identifier id) Business Name: OtherMedicationId
void	setRouteCode(RouteOfAdministration routeCode) Un-merged Business Name: Route
void	setStatusCode(ActStatus statusCode) Un-merged Business Name: MedicationStatus
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

OtherMedicationBean

public OtherMedicationBean()

Method Detail

getId

public Identifier getId()

Business Name: OtherMedicationId

Un-merged Business Name: OtherMedicationId

Relationship: PORX_MT040020CA.OtherMedication.id

Conformance/Cardinality: MANDATORY (1)

Uniquely identifies the record to be updated and is therefore mandatory.

Identifier of the Other Medication record that needs to be updated.

setId

public void setId(Identifier id)

Business Name: OtherMedicationId

Un-merged Business Name: OtherMedicationId

Relationship: PORX_MT040020CA.OtherMedication.id

Conformance/Cardinality: MANDATORY (1)

Uniquely identifies the record to be updated and is therefore mandatory.

Identifier of the Other Medication record that needs to be updated.

getCode

public ActCode getCode()

Business Name: OtherMedicationType

Un-merged Business Name: OtherMedicationType

Relationship: PORX_MT040020CA.OtherMedication.code

Conformance/Cardinality: MANDATORY (1)

Must be 'DRUG' unless using SNOMED

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

The element allows 'CD' to provide support for SNOMED.

Indicates that the record is a drug administration rather than an immunization or other type of administration. For SNOMED, may also include route, drug and other information.

Un-merged Business Name: OtherMedicationType

Relationship: PORX_MT040010CA.OtherMedication.code

Conformance/Cardinality: MANDATORY (1)

Must be 'DRUG' unless using SNOMED

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

The element allows 'CD' to provide support for SNOMED.

Indicates that the record is a drug administration rather than an immunization or other type of administration. For SNOMED, may also include route, drug and other information.

setCode

public void setCode(ActCode code)

Business Name: OtherMedicationType

Un-merged Business Name: OtherMedicationType

Relationship: PORX_MT040020CA.OtherMedication.code

Conformance/Cardinality: MANDATORY (1)

Must be 'DRUG' unless using SNOMED

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

The element allows 'CD' to provide support for SNOMED.

Indicates that the record is a drug administration rather than an immunization or other type of administration. For SNOMED, may also include route, drug and other information.

Un-merged Business Name: OtherMedicationType

Relationship: PORX_MT040010CA.OtherMedication.code

Conformance/Cardinality: MANDATORY (1)

Must be 'DRUG' unless using SNOMED

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

The element allows 'CD' to provide support for SNOMED.

Indicates that the record is a drug administration rather than an immunization or other type of administration. For SNOMED, may also include route, drug and other information.

getStatusCode

public ActStatus getStatusCode()

Un-merged Business Name: MedicationStatus

Relationship: PORX_MT040020CA.OtherMedication.statusCode

Conformance/Cardinality: MANDATORY (1)

Indicates the new state of the medication and is therefore mandatory.

Note ------ The provider might know that the patient is not taking the medication but not necessarily when the patient stopped it. Thus the status of the medication could be set to 'COMPLETED' by the provider without necessarily setting an End Date on the medication record.

Indicates whether the medication is still considered active.

Valid status can only be 'ACTIVE' or 'COMPLETED'.

Un-merged Business Name: OtherMedicationStatus

Relationship: PORX_MT040010CA.OtherMedication.statusCode

Conformance/Cardinality: MANDATORY (1)

Indicates what actions are allowed to be performed against an other medication record. This is a mandatory field because every recorded 'other medication' needs to be in some state.

Note ------ The provider might know that the patient is not taking the medication but not necessarily when the patient stopped it. Thus the status of the medication could be set to 'COMPLETED' by the provider without necessarily setting an End Date on the medication record.

This denotes a state in the lifecycle of the other medication. Valid statuses are: 'ACTIVE' and 'COMPLETED' only.

setStatusCode

public void setStatusCode(ActStatus statusCode)

Un-merged Business Name: MedicationStatus

Relationship: PORX_MT040020CA.OtherMedication.statusCode

Conformance/Cardinality: MANDATORY (1)

Indicates the new state of the medication and is therefore mandatory.

Note ------ The provider might know that the patient is not taking the medication but not necessarily when the patient stopped it. Thus the status of the medication could be set to 'COMPLETED' by the provider without necessarily setting an End Date on the medication record.

Indicates whether the medication is still considered active.

Valid status can only be 'ACTIVE' or 'COMPLETED'.

Un-merged Business Name: OtherMedicationStatus

Relationship: PORX_MT040010CA.OtherMedication.statusCode

Conformance/Cardinality: MANDATORY (1)

Indicates what actions are allowed to be performed against an other medication record. This is a mandatory field because every recorded 'other medication' needs to be in some state.

Note ------ The provider might know that the patient is not taking the medication but not necessarily when the patient stopped it. Thus the status of the medication could be set to 'COMPLETED' by the provider without necessarily setting an End Date on the medication record.

This denotes a state in the lifecycle of the other medication. Valid statuses are: 'ACTIVE' and 'COMPLETED' only.

getEffectiveTime

public Interval<Date> getEffectiveTime()

Business Name: DrugActivePeriod

Un-merged Business Name: DrugActivePeriod

Relationship: PORX_MT040020CA.OtherMedication.effectiveTime

Conformance/Cardinality: REQUIRED (0-1)

Allows the drug active period information to be changed.

The new period in which the active medication is deemed to be active.

Un-merged Business Name: DrugActivePeriod

Relationship: PORX_MT040010CA.OtherMedication.effectiveTime

Conformance/Cardinality: POPULATED (1)

Used to help determine whether the medication is currently active. Because this information won't always be available, the attribute is marked as 'populated'.

Either the start or end or both can be null if they are not known.

Indicates the time-period in which the patient has been taking or is expected to be taking the medication.

setEffectiveTime

public void setEffectiveTime(Interval<Date> effectiveTime)

Business Name: DrugActivePeriod

Un-merged Business Name: DrugActivePeriod

Relationship: PORX_MT040020CA.OtherMedication.effectiveTime

Conformance/Cardinality: REQUIRED (0-1)

Allows the drug active period information to be changed.

The new period in which the active medication is deemed to be active.

Un-merged Business Name: DrugActivePeriod

Relationship: PORX_MT040010CA.OtherMedication.effectiveTime

Conformance/Cardinality: POPULATED (1)

Used to help determine whether the medication is currently active. Because this information won't always be available, the attribute is marked as 'populated'.

Either the start or end or both can be null if they are not known.

Indicates the time-period in which the patient has been taking or is expected to be taking the medication.

getConfidentialityCode

public Set<x_NormalRestrictedTabooConfidentialityKind> getConfidentialityCode()

Business Name: OtherMedicationMaskingIndicators

Un-merged Business Name: OtherMedicationMaskingIndicators

Relationship: PORX_MT040020CA.OtherMedication.confidentialityCode

Conformance/Cardinality: REQUIRED (0-2)

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.

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.

Un-merged Business Name: OtherMedicationMaskingIndicators

Relationship: PORX_MT040010CA.OtherMedication.confidentialityCode

Conformance/Cardinality: OPTIONAL (0-2)

Provides support for additional confidentiality constraint to reflect the wishes of the patient.

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.

Denotes access restriction place on the other medication record. Methods for accessing masked other medications will be governed by each jurisdiction (e.g. court orders, shared secret/consent, etc.).

getRouteCode

public RouteOfAdministration getRouteCode()

Un-merged Business Name: Route

Relationship: PORX_MT040020CA.OtherMedication.routeCode

Conformance/Cardinality: OPTIONAL (0-1)

Ensures consistency in description of routes. Provides potential for cross-checking dosage form and route. Because this information is pre-coordinated into 'code' for SNOMED, it is marked as optional.

This is the means by which the patient is taking the other medication.

Un-merged Business Name: RouteOfAdministration

Relationship: PORX_MT040010CA.OtherMedication.routeCode

Conformance/Cardinality: OPTIONAL (0-1)

Ensures consistency in description of routes. Provides potential for cross-checking dosage form and route. Because this information is pre-coordinated into 'code' for SNOMED, it is marked as optional.

This is the means by which the patient is taking the other medication.

setRouteCode

public void setRouteCode(RouteOfAdministration routeCode)

Un-merged Business Name: Route

Relationship: PORX_MT040020CA.OtherMedication.routeCode

Conformance/Cardinality: OPTIONAL (0-1)

Ensures consistency in description of routes. Provides potential for cross-checking dosage form and route. Because this information is pre-coordinated into 'code' for SNOMED, it is marked as optional.

This is the means by which the patient is taking the other medication.

Un-merged Business Name: RouteOfAdministration

Relationship: PORX_MT040010CA.OtherMedication.routeCode

Conformance/Cardinality: OPTIONAL (0-1)

Ensures consistency in description of routes. Provides potential for cross-checking dosage form and route. Because this information is pre-coordinated into 'code' for SNOMED, it is marked as optional.

This is the means by which the patient is taking the other medication.

getConsumableMedication

public DrugProductBean getConsumableMedication()

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

Relationship: PORX_MT040010CA.Consumable2.medication

Conformance/Cardinality: MANDATORY (1)

setConsumableMedication

public void setConsumableMedication(DrugProductBean consumableMedication)

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

Relationship: PORX_MT040010CA.Consumable2.medication

Conformance/Cardinality: MANDATORY (1)

getComponentDosageInstruction

public List<AdministrationInstructionsBean> getComponentDosageInstruction()

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

Relationship: PORX_MT040010CA.Component.dosageInstruction

Conformance/Cardinality: POPULATED (1)

getSubjectOfAnnotation

public NotesBean getSubjectOfAnnotation()

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

Relationship: PORX_MT040010CA.Subject9.annotation

Conformance/Cardinality: POPULATED (1)

setSubjectOfAnnotation

public void setSubjectOfAnnotation(NotesBean subjectOfAnnotation)

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

Relationship: PORX_MT040010CA.Subject9.annotation

Conformance/Cardinality: POPULATED (1)