ca.infoway.messagebuilder.model.sk_cerx_v01_r04_2.merged
Class ConsentBean

java.lang.Object
  ca.infoway.messagebuilder.model.MessagePartBean
      ca.infoway.messagebuilder.model.sk_cerx_v01_r04_2.merged.ConsentBean

All Implemented Interfaces:

NullFlavorSupport, Serializable

public class ConsentBean
extends MessagePartBean

Business Name: Consent

COCT_MT470000CA.ConsentEvent: Consent

One and only one of author2 (Consenter) and author1 (Provider) must be specified.

If author1 (provider) is specified, reason code must be specified.

One and only one of author2 (Consenter) and author1 (Provider) must be specified.

If author1 (provider) is specified, reason code must be specified.

Information pertaining to a patient's agreement/acceptance to have his/her clinical information electronically stored and shared.

Provides authorization to record and/or view patient information.

Indicates the consent or keyword used to authorize access or update, including a reason for access; May also be used to override access restriction to the information ('break the glass') on a message by message basis. May be required on a Prescription Request to indicate a keyword for DUR processing.

Provides authorization to record and/or view patient information.

Indicates the consent or keyword used to authorize access or update, including a reason for access; May also be used to override access restriction to the information ('break the glass') on a message by message basis. May be required on a Prescription Request to indicate a keyword for DUR processing.

The keywords will not be passed from prescriber to dispenser by the DIS.

RCMR_MT010001CA.ConsentEvent: Consent

If code is INFA, then InformDefinition must be present, otherwise it must be absent

One and only one of author1 (Consenter) and author2 (Provider) must be specified

If author2 (provider) is specified, reasonCode must be specified

If code is INFA, then InformDefinition must be present, otherwise it must be absent

One and only one of author1 (Consenter) and author2 (Provider) must be specified

If author2 (provider) is specified, reasonCode must be specified

If code is INFA, then InformDefinition must be present, otherwise it must be absent

One and only one of author1 (Consenter) and author2 (Provider) must be specified

If author2 (provider) is specified, reasonCode must be specified

Information pertaining to a patient's agreement/acceptance to have his/her clinical information electronically stored and shared.

Provides authorization to record and/or view patient information.

See Also:

Serialized Form

Constructor Summary

ConsentBean()

Method Summary

ConsentedToByBean	getAuthor1() Business Name: ConsentedToBy
PrescribedByBean	getAuthor2() Business Name: OverriddenBy
ActConsentType	getCode() Business Name: ConsentType
InformationAccessBean	getComponentPermissionToInform() Business Name: ConsentsTo
Interval<Date>	getEffectiveTime() Business Name: ConsentEffectiveAndEndTime
Identifier	getId() Business Name: ConsentFormNumber
Boolean	getNegationInd() Business Name: ConsentRefusedIndicator
ActConsentInformationAccessReason	getReasonCode() Business Name: ConsentOverrideReason
AccessTypeBean	getSubject2InformDefinition() Un-merged Business Name: (no business name specified)
PatientBean	getSubjectPatient() Un-merged Business Name: (no business name specified)
void	setAuthor1(ConsentedToByBean author1) Business Name: ConsentedToBy
void	setAuthor2(PrescribedByBean author2) Business Name: OverriddenBy
void	setCode(ActConsentType code) Business Name: ConsentType
void	setComponentPermissionToInform(InformationAccessBean componentPermissionToInform) Business Name: ConsentsTo
void	setEffectiveTime(Interval<Date> effectiveTime) Business Name: ConsentEffectiveAndEndTime
void	setId(Identifier id) Business Name: ConsentFormNumber
void	setNegationInd(Boolean negationInd) Business Name: ConsentRefusedIndicator
void	setReasonCode(ActConsentInformationAccessReason reasonCode) Business Name: ConsentOverrideReason
void	setSubject2InformDefinition(AccessTypeBean subject2InformDefinition) Un-merged Business Name: (no business name specified)
void	setSubjectPatient(PatientBean subjectPatient) 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

ConsentBean

public ConsentBean()

Method Detail

getId

public Identifier getId()

Business Name: ConsentFormNumber

Un-merged Business Name: ConsentFormNumber

Relationship: COCT_MT470000CA.ConsentEvent.id

Conformance/Cardinality: REQUIRED (0-1)

A unique identifier for a specific consent for a patient.

Authorization.formNumber

Provides a traceable audit link between a physical consent form and its electronic record

Un-merged Business Name: ConsentFormNumber

Relationship: RCMR_MT010001CA.ConsentEvent.id

Conformance/Cardinality: REQUIRED (0-1)

A unique identifier for a specific consent for a patient.

Authorization.formNumber

Provides a traceable audit link between a physical consent form and its electronic record

setId

public void setId(Identifier id)

Business Name: ConsentFormNumber

Un-merged Business Name: ConsentFormNumber

Relationship: COCT_MT470000CA.ConsentEvent.id

Conformance/Cardinality: REQUIRED (0-1)

A unique identifier for a specific consent for a patient.

Authorization.formNumber

Provides a traceable audit link between a physical consent form and its electronic record

Un-merged Business Name: ConsentFormNumber

Relationship: RCMR_MT010001CA.ConsentEvent.id

Conformance/Cardinality: REQUIRED (0-1)

A unique identifier for a specific consent for a patient.

Authorization.formNumber

Provides a traceable audit link between a physical consent form and its electronic record

getEffectiveTime

public Interval<Date> getEffectiveTime()

Business Name: ConsentEffectiveAndEndTime

Un-merged Business Name: ConsentEffectiveAndEndTime

Relationship: COCT_MT470000CA.ConsentEvent.effectiveTime

Conformance/Cardinality: REQUIRED (0-1)

Indicates the time that the consent will expire. 'Low' is effective time and 'High' is end time.

Authorization.endTime (high)

Most consents are not open-ended, to ensure the patient retains a level of control.

Un-merged Business Name: ConsentEffectiveAndEndTime

Relationship: RCMR_MT010001CA.ConsentEvent.effectiveTime

Conformance/Cardinality: MANDATORY (1)

Indicates the time that the consent will expire. 'Low' is effective time and 'High' is end time.

Authorization.endTime (high)

Most consents are not open-ended, to ensure the patient retains a level of control

CeRx defines this as 0..1 but the effective time is required in PIN so this is mandatory.

setEffectiveTime

public void setEffectiveTime(Interval<Date> effectiveTime)

Business Name: ConsentEffectiveAndEndTime

Un-merged Business Name: ConsentEffectiveAndEndTime

Relationship: COCT_MT470000CA.ConsentEvent.effectiveTime

Conformance/Cardinality: REQUIRED (0-1)

Indicates the time that the consent will expire. 'Low' is effective time and 'High' is end time.

Authorization.endTime (high)

Most consents are not open-ended, to ensure the patient retains a level of control.

Un-merged Business Name: ConsentEffectiveAndEndTime

Relationship: RCMR_MT010001CA.ConsentEvent.effectiveTime

Conformance/Cardinality: MANDATORY (1)

Indicates the time that the consent will expire. 'Low' is effective time and 'High' is end time.

Authorization.endTime (high)

Most consents are not open-ended, to ensure the patient retains a level of control

CeRx defines this as 0..1 but the effective time is required in PIN so this is mandatory.

getReasonCode

public ActConsentInformationAccessReason getReasonCode()

Business Name: ConsentOverrideReason

Un-merged Business Name: ConsentOverrideReason

Relationship: COCT_MT470000CA.ConsentEvent.reasonCode

Conformance/Cardinality: REQUIRED (0-1)

Indicates a reason for overriding a patient's consent rules.

Authorization.reason (mnemonic)

Authorization.comment (original text)

Authorization.reason (mnemonic)

Authorization.comment (original text)

Important for audit purposes

Un-merged Business Name: ConsentOverrideReason

Relationship: RCMR_MT010001CA.ConsentEvent.reasonCode

Conformance/Cardinality: REQUIRED (0-1)

Indicates a reason for overriding a patient's consent rules or accessing information without consent.

Authorization.reason (mnemonic)

Authorization.comment (original text)

Authorization.reason (mnemonic)

Authorization.comment (original text)

Important for audit purposes

setReasonCode

public void setReasonCode(ActConsentInformationAccessReason reasonCode)

Business Name: ConsentOverrideReason

Un-merged Business Name: ConsentOverrideReason

Relationship: COCT_MT470000CA.ConsentEvent.reasonCode

Conformance/Cardinality: REQUIRED (0-1)

Indicates a reason for overriding a patient's consent rules.

Authorization.reason (mnemonic)

Authorization.comment (original text)

Authorization.reason (mnemonic)

Authorization.comment (original text)

Important for audit purposes

Un-merged Business Name: ConsentOverrideReason

Relationship: RCMR_MT010001CA.ConsentEvent.reasonCode

Conformance/Cardinality: REQUIRED (0-1)

Indicates a reason for overriding a patient's consent rules or accessing information without consent.

Authorization.reason (mnemonic)

Authorization.comment (original text)

Authorization.reason (mnemonic)

Authorization.comment (original text)

Important for audit purposes

getSubjectPatient

public PatientBean getSubjectPatient()

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

Relationship: COCT_MT470000CA.Subject.patient

Conformance/Cardinality: MANDATORY (1)

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

Relationship: RCMR_MT010001CA.Subject.patient

Conformance/Cardinality: MANDATORY (1)

This uses COCT_MT050202CA – Patient Person Identified Confirmable.

setSubjectPatient

public void setSubjectPatient(PatientBean subjectPatient)

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

Relationship: COCT_MT470000CA.Subject.patient

Conformance/Cardinality: MANDATORY (1)

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

Relationship: RCMR_MT010001CA.Subject.patient

Conformance/Cardinality: MANDATORY (1)

This uses COCT_MT050202CA – Patient Person Identified Confirmable.

getAuthor2

public PrescribedByBean getAuthor2()

Business Name: OverriddenBy

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

Relationship: COCT_MT470000CA.ConsentEvent.author1

Conformance/Cardinality: REQUIRED (0-1)

Un-merged Business Name: OverriddenBy

Relationship: RCMR_MT010001CA.ConsentEvent.author2

Conformance/Cardinality: REQUIRED (0-1)

Indicates that information access was approved

by a provider rather than a patient.

Either this must be specified or author1 must be specified or a MISSCOND error issue will be

returned.

setAuthor2

public void setAuthor2(PrescribedByBean author2)

Business Name: OverriddenBy

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

Relationship: COCT_MT470000CA.ConsentEvent.author1

Conformance/Cardinality: REQUIRED (0-1)

Un-merged Business Name: OverriddenBy

Relationship: RCMR_MT010001CA.ConsentEvent.author2

Conformance/Cardinality: REQUIRED (0-1)

Indicates that information access was approved

by a provider rather than a patient.

Either this must be specified or author1 must be specified or a MISSCOND error issue will be

returned.

getAuthor1

public ConsentedToByBean getAuthor1()

Business Name: ConsentedToBy

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

Relationship: COCT_MT470000CA.ConsentEvent.author2

Conformance/Cardinality: REQUIRED (0-1)

Un-merged Business Name: ConsentedToBy

Relationship: RCMR_MT010001CA.ConsentEvent.author1

Conformance/Cardinality: REQUIRED (0-1)

Indicates that the consent was provided by the patient or representative.

Either this must be specified or author2 must be specified or a MISSCOND error issue will be

returned.

setAuthor1

public void setAuthor1(ConsentedToByBean author1)

Business Name: ConsentedToBy

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

Relationship: COCT_MT470000CA.ConsentEvent.author2

Conformance/Cardinality: REQUIRED (0-1)

Un-merged Business Name: ConsentedToBy

Relationship: RCMR_MT010001CA.ConsentEvent.author1

Conformance/Cardinality: REQUIRED (0-1)

Indicates that the consent was provided by the patient or representative.

Either this must be specified or author2 must be specified or a MISSCOND error issue will be

returned.

getSubject2InformDefinition

public AccessTypeBean getSubject2InformDefinition()

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

Relationship: COCT_MT470000CA.Subject2.informDefinition

Conformance/Cardinality: MANDATORY (1)

setSubject2InformDefinition

public void setSubject2InformDefinition(AccessTypeBean subject2InformDefinition)

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

Relationship: COCT_MT470000CA.Subject2.informDefinition

Conformance/Cardinality: MANDATORY (1)

getCode

public ActConsentType getCode()

Business Name: ConsentType

Un-merged Business Name: ConsentType

Relationship: RCMR_MT010001CA.ConsentEvent.code

Conformance/Cardinality: MANDATORY (1)

Indicates the type of consent being given: Information access or Information maintenance.

Distinguishes what type of consent is being dealt with and is therefore mandatory.

setCode

public void setCode(ActConsentType code)

Business Name: ConsentType

Un-merged Business Name: ConsentType

Relationship: RCMR_MT010001CA.ConsentEvent.code

Conformance/Cardinality: MANDATORY (1)

Indicates the type of consent being given: Information access or Information maintenance.

Distinguishes what type of consent is being dealt with and is therefore mandatory.

getNegationInd

public Boolean getNegationInd()

Business Name: ConsentRefusedIndicator

Un-merged Business Name: ConsentRefusedIndicator

Relationship: RCMR_MT010001CA.ConsentEvent.negationInd

Conformance/Cardinality: OPTIONAL (0-1)

Must be either not present or non-null.

If true, indicates that consent has explicitly *not* been given.

Primarily applies for global "participation" consent, when there is a need to track whether the patient has consented, not consented, or has not recorded a decision.

Because not all jurisdictions will track "participation" consent, this attribute is optional. In jurisdictions where it is supported, the element must always be valued as either true or false.

Primarily applies for global "participation" consent, when there is a need to track whether the patient has consented, not consented, or has not recorded a decision.

Because not all jurisdictions will track "participation" consent, this attribute is optional. In jurisdictions where it is supported, the element must always be valued as either true or false.

setNegationInd

public void setNegationInd(Boolean negationInd)

Business Name: ConsentRefusedIndicator

Un-merged Business Name: ConsentRefusedIndicator

Relationship: RCMR_MT010001CA.ConsentEvent.negationInd

Conformance/Cardinality: OPTIONAL (0-1)

Must be either not present or non-null.

If true, indicates that consent has explicitly *not* been given.

Primarily applies for global "participation" consent, when there is a need to track whether the patient has consented, not consented, or has not recorded a decision.

Because not all jurisdictions will track "participation" consent, this attribute is optional. In jurisdictions where it is supported, the element must always be valued as either true or false.

Primarily applies for global "participation" consent, when there is a need to track whether the patient has consented, not consented, or has not recorded a decision.

Because not all jurisdictions will track "participation" consent, this attribute is optional. In jurisdictions where it is supported, the element must always be valued as either true or false.

getComponentPermissionToInform

public InformationAccessBean getComponentPermissionToInform()

Business Name: ConsentsTo

Un-merged Business Name: ConsentsTo

Relationship: RCMR_MT010001CA.Component.permissionToInform

Conformance/Cardinality: POPULATED (1)

Describes the type of information access being

consented to.

setComponentPermissionToInform

public void setComponentPermissionToInform(InformationAccessBean componentPermissionToInform)

Business Name: ConsentsTo

Un-merged Business Name: ConsentsTo

Relationship: RCMR_MT010001CA.Component.permissionToInform

Conformance/Cardinality: POPULATED (1)

Describes the type of information access being

consented to.