AdministrationInstructionsBean (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.ab_mr2007_v02_r02.merged
Class AdministrationInstructionsBean

Package class diagram package AdministrationInstructionsBean

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

All Implemented Interfaces:: NullFlavorSupport, Serializable

public class AdministrationInstructionsBean
extends MessagePartBean
extends MessagePartBean

Business Name: AdministrationInstructions

PORX_MT980040CA.DosageInstruction: Administration Instructions

routeCode is mandatory and apporachSiteCode is required if not using SNOMED

- moodCode must be DEFN for drug definitions (such as monographs) - moodCode must be RQO for orders; - moodCode must be EVN for dispenses and recording of other medications

routeCode is mandatory and apporachSiteCode is required if not using SNOMED

- moodCode must be DEFN for drug definitions (such as monographs) - moodCode must be RQO for orders; - moodCode must be EVN for dispenses and recording of other medications

This comprises all specifications necessary for the dispensed product to be administered to/by the patient in a manner as intended by the prescriber.

Allows providers to communicate intentions and to cross-check intended and actual methods of administration.

COCT_MT270010CA.DosageInstruction: Administration Instructions

routeCode is mandatory and apporachSiteCode is required if not using SNOMED

- moodCode must be DEFN for drug definitions (such as monographs) - moodCode must be RQO for orders; - moodCode must be EVN for dispenses and recording of other medications

routeCode is mandatory and apporachSiteCode is required if not using SNOMED

- moodCode must be DEFN for drug definitions (such as monographs) - moodCode must be RQO for orders; - moodCode must be EVN for dispenses and recording of other medications

This comprises all specifications necessary for the dispensed product to be administered to/by the patient in a manner as intended by the prescriber.

Allows providers to communicate intentions and to cross-check intended and actual methods of administration.

See Also:: Serialized Form

Constructor Summary
`AdministrationInstructionsBean()`

Method Summary
`AdministrableDrugForm`	`getAdministrationUnitCode()` Business Name: DosageUnit
`Set<HumanSubstanceAdministrationSite>`	`getApproachSiteCode()` Business Name: AdministrationSites
`ActCode`	`getCode()` Business Name: DosageType
`AdditionalSIGInstructionBean`	`getComponent1SupplementalInstruction()` Un-merged Business Name: (no business name specified)
`List<ConsistsOfBean>`	`getComponent2()` Un-merged Business Name: (no business name specified)
`Medication`	`getConsumableMedication1()` Un-merged Business Name: (no business name specified)
`Interval<Date>`	`getEffectiveTime()` Business Name: AdministrationPeriod
`Set<Ratio<PhysicalQuantity,PhysicalQuantity>>`	`getMaxDoseQuantity()` Un-merged Business Name: MaximumDosesPerPeriod
`x_ActMoodDefEvnRqo`	`getMoodCode()` Business Name: DosageUsageContext
`RouteOfAdministration`	`getRouteCode()` Business Name: RouteCode
`String`	`getText()` Business Name: RenderedDosageInstruction
`void`	`setAdministrationUnitCode(AdministrableDrugForm administrationUnitCode)` Business Name: DosageUnit
`void`	`setCode(ActCode code)` Business Name: DosageType
`void`	`setComponent1SupplementalInstruction(AdditionalSIGInstructionBean component1SupplementalInstruction)` Un-merged Business Name: (no business name specified)
`void`	`setConsumableMedication1(Medication consumableMedication1)` Un-merged Business Name: (no business name specified)
`void`	`setEffectiveTime(Interval<Date> effectiveTime)` Business Name: AdministrationPeriod
`void`	`setMoodCode(x_ActMoodDefEvnRqo moodCode)` Business Name: DosageUsageContext
`void`	`setRouteCode(RouteOfAdministration routeCode)` Business Name: RouteCode
`void`	`setText(String text)` Business Name: RenderedDosageInstruction

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

AdministrationInstructionsBean

public AdministrationInstructionsBean()

Method Detail

getMoodCode

public x_ActMoodDefEvnRqo getMoodCode()

Business Name: DosageUsageContext

Un-merged Business Name: DosageUsageContext

Relationship: PORX_MT980040CA.DosageInstruction.moodCode

Conformance/Cardinality: MANDATORY (1)

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Puts the class in context, and is therefore mandatory.

Un-merged Business Name: DosageUsageContext

Relationship: COCT_MT270010CA.DosageInstruction.moodCode

Conformance/Cardinality: MANDATORY (1)

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Puts the class in context, and is therefore mandatory.

setMoodCode

public void setMoodCode(x_ActMoodDefEvnRqo moodCode)

Business Name: DosageUsageContext

Un-merged Business Name: DosageUsageContext

Relationship: PORX_MT980040CA.DosageInstruction.moodCode

Conformance/Cardinality: MANDATORY (1)

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Puts the class in context, and is therefore mandatory.

Un-merged Business Name: DosageUsageContext

Relationship: COCT_MT270010CA.DosageInstruction.moodCode

Conformance/Cardinality: MANDATORY (1)

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Indicates the context of the administration.

moodCode = RQO, for administration instruction on orders

moodCode = EVN, for administration instruction on dispenses

moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs).

Puts the class in context, and is therefore mandatory.

getCode

public ActCode getCode()

Business Name: DosageType

Un-merged Business Name: DosageType

Relationship: PORX_MT980040CA.DosageInstruction.code

Conformance/Cardinality: MANDATORY (1)

Distinguishes types of dosage.

Distinguishes between types of dosage administration and is therefore mandatory. Datatype is CD to allow for SNOMED codes.

For SNOMED this will pre-coordinate route, body site and potentially drug. For non-SNOMED, this will be a fixed value of DRUG.

Un-merged Business Name: DosageType

Relationship: COCT_MT270010CA.DosageInstruction.code

Conformance/Cardinality: MANDATORY (1)

Distinguishes types of dosage.

Distinguishes between types of dosage administration and is therefore mandatory. Datatype is CD to allow for SNOMED codes.

For SNOMED this will pre-coordinate route, body site and potentially drug. For non-SNOMED, this will be a fixed value of DRUG.

setCode

public void setCode(ActCode code)

Business Name: DosageType

Un-merged Business Name: DosageType

Relationship: PORX_MT980040CA.DosageInstruction.code

Conformance/Cardinality: MANDATORY (1)

Distinguishes types of dosage.

Distinguishes between types of dosage administration and is therefore mandatory. Datatype is CD to allow for SNOMED codes.

For SNOMED this will pre-coordinate route, body site and potentially drug. For non-SNOMED, this will be a fixed value of DRUG.

Un-merged Business Name: DosageType

Relationship: COCT_MT270010CA.DosageInstruction.code

Conformance/Cardinality: MANDATORY (1)

Distinguishes types of dosage.

Distinguishes between types of dosage administration and is therefore mandatory. Datatype is CD to allow for SNOMED codes.

For SNOMED this will pre-coordinate route, body site and potentially drug. For non-SNOMED, this will be a fixed value of DRUG.

getText

public String getText()

Business Name: RenderedDosageInstruction

Un-merged Business Name: RenderedDosageInstruction

Relationship: PORX_MT980040CA.DosageInstruction.text

Conformance/Cardinality: MANDATORY (1)

A free form textual specification generated from the input specifications as created by the provider.

This is made up of either an 'Ad-hoc dosage instruction' or 'Textual rendition of the structured dosage lines', plus route, dosage unit, and other pertinent administration information specified by the provider.

A free form textual specification generated from the input specifications as created by the provider.

Allows the provider to verify the codified structured dosage information entered and ensure that the exploded instruction is consistent with the intended instructions.

Also useful in bringing back administration instructions on query responses.

This is mandatory as dosage instructions must always be available in rendered form.

Allows the provider to verify the codified structured dosage information entered and ensure that the exploded instruction is consistent with the intended instructions.

Also useful in bringing back administration instructions on query responses.

This is mandatory as dosage instructions must always be available in rendered form.

Allows the provider to verify the codified structured dosage information entered and ensure that the exploded instruction is consistent with the intended instructions.

Also useful in bringing back administration instructions on query responses.

This is mandatory as dosage instructions must always be available in rendered form.

Un-merged Business Name: RenderedDosageInstruction

Relationship: COCT_MT270010CA.DosageInstruction.text