ca.infoway.messagebuilder.model.pcs_mr2009_r02_04_03.merged
Class CommentBean

java.lang.Object
  ca.infoway.messagebuilder.model.MessagePartBean
      ca.infoway.messagebuilder.model.pcs_mr2009_r02_04_03.merged.CommentBean

All Implemented Interfaces:

NullFlavorSupport, Serializable

public class CommentBean
extends MessagePartBean

Business Name: Comment

COMT_MT300001CA.Annotation: Comment

Allows comments to be attached to a Patient record. A Patient record can pertain to demographic or clinical (Drug, Condition, Lab, DI, Immunization, etc) information.

Identifies the comments to be recorded against a Patient's record.

COMT_MT300003CA.Annotation: Comment

Allows comments to be attached to a Patient record. A Patient record can pertain to demographic or clinical (Drug, Condition, Lab, DI, etc) information.

Identifies the comments to be recorded against a Patient's record.

COMT_MT301001CA.Annotation: Comment

Allows comments to be attached to a Patient record. A Patient record can pertain to demographic or clinical (Drug, Condition, Lab, DI, etc) information.

Identifies the comments to be recorded against a Patient's record.

See Also:

Serialized Form

Constructor Summary

CommentBean()

Method Summary

AnnotatedByBean	getAuthor() Un-merged Business Name: (no business name specified)
ActPatientAnnotationCode	getCode() Business Name: PatientNoteCategory
Set<x_BasicConfidentialityKind>	getConfidentialityCode() Business Name: RestrictedPatientAccess
Identifier	getId() Business Name: PatientNoteId
HumanLanguage	getLanguageCode() Business Name: WrittenIn
OccurredAtBean	getLocation() Un-merged Business Name: (no business name specified)
HealthcareWorkerBean	getResponsiblePartyAssignedEntity() Un-merged Business Name: (no business name specified)
Identifier	getSubjectAnnotatedActId() Business Name: RecordId
String	getText() Un-merged Business Name: PatientNoteText
void	setAuthor(AnnotatedByBean author) Un-merged Business Name: (no business name specified)
void	setCode(ActPatientAnnotationCode code) Business Name: PatientNoteCategory
void	setId(Identifier id) Business Name: PatientNoteId
void	setLanguageCode(HumanLanguage languageCode) Business Name: WrittenIn
void	setLocation(OccurredAtBean location) Un-merged Business Name: (no business name specified)
void	setResponsiblePartyAssignedEntity(HealthcareWorkerBean responsiblePartyAssignedEntity) Un-merged Business Name: (no business name specified)
void	setSubjectAnnotatedActId(Identifier subjectAnnotatedActId) Business Name: RecordId
void	setText(String text) Un-merged Business Name: PatientNoteText

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

CommentBean

public CommentBean()

Method Detail

getCode

public ActPatientAnnotationCode getCode()

Business Name: PatientNoteCategory

Un-merged Business Name: PatientNoteCategory

Relationship: COMT_MT300001CA.Annotation.code

Conformance/Cardinality: MANDATORY (1)

Allows patient notes of different purposes and use, to be attached to a patient. Attribute is mandatory to ensure that patient notes are categorized accordingly. This attribute may also be used by DISs to enforce different access control to different types of notes.

A coded value denoting the category of note being attached to a Patient's record. Categories of note include: General, Medication, Lab, DI, Immunization, etc

Un-merged Business Name: PatientNoteCategory

Relationship: COMT_MT300003CA.Annotation.code

Conformance/Cardinality: MANDATORY (1)

Allows patient notes of different purposes and use, to be attached to a patient. Attribute is mandatory to ensure that patient notes are categorized accordingly. This attribute may also be used by DISs to enforce different access control to different types of notes.

A coded value denoting the category of note being attached to a Patient's record. Categories of note include: General, Medication, Lab, DI, etc.

setCode

public void setCode(ActPatientAnnotationCode code)

Business Name: PatientNoteCategory

Un-merged Business Name: PatientNoteCategory

Relationship: COMT_MT300001CA.Annotation.code

Conformance/Cardinality: MANDATORY (1)

Allows patient notes of different purposes and use, to be attached to a patient. Attribute is mandatory to ensure that patient notes are categorized accordingly. This attribute may also be used by DISs to enforce different access control to different types of notes.

A coded value denoting the category of note being attached to a Patient's record. Categories of note include: General, Medication, Lab, DI, Immunization, etc

Un-merged Business Name: PatientNoteCategory

Relationship: COMT_MT300003CA.Annotation.code

Conformance/Cardinality: MANDATORY (1)

Allows patient notes of different purposes and use, to be attached to a patient. Attribute is mandatory to ensure that patient notes are categorized accordingly. This attribute may also be used by DISs to enforce different access control to different types of notes.

A coded value denoting the category of note being attached to a Patient's record. Categories of note include: General, Medication, Lab, DI, etc.

getText

public String getText()

Un-merged Business Name: PatientNoteText

Relationship: COMT_MT300001CA.Annotation.text

Conformance/Cardinality: MANDATORY (1)

Allows a provider to attach comments to a patient as a whole or to the patient's profile (such as medication, lab. DI, etc). This attribute is mandatory because there's no point in having a patient note unless there's actually content in the note.

Free textual description of the patient note.

Un-merged Business Name: PatientNoteText

Relationship: COMT_MT300003CA.Annotation.text

Conformance/Cardinality: MANDATORY (1)

Allows a provider to attach comments to a patient as a whole or to the patient's profile (such as medication, lab. DI, etc). This attribute is mandatory because there's no point in having a patient note unless there's actually content in the note.

Free textual description of the patient note.

Un-merged Business Name: AnnotationText

Relationship: COMT_MT301001CA.Annotation.text

Conformance/Cardinality: MANDATORY (1)

Allows a provider to attach arbitrary comments to clinical records (prescription, dispenses, lab results, allergies, etc) for communication. This attribute is mandatory because there's no point in having an annotation unless there's actually content in the note.

Free text comment to be attached to a record.

setText

public void setText(String text)

Un-merged Business Name: PatientNoteText

Relationship: COMT_MT300001CA.Annotation.text

Conformance/Cardinality: MANDATORY (1)

Allows a provider to attach comments to a patient as a whole or to the patient's profile (such as medication, lab. DI, etc). This attribute is mandatory because there's no point in having a patient note unless there's actually content in the note.

Free textual description of the patient note.

Un-merged Business Name: PatientNoteText

Relationship: COMT_MT300003CA.Annotation.text

Conformance/Cardinality: MANDATORY (1)

Allows a provider to attach comments to a patient as a whole or to the patient's profile (such as medication, lab. DI, etc). This attribute is mandatory because there's no point in having a patient note unless there's actually content in the note.

Free textual description of the patient note.

Un-merged Business Name: AnnotationText

Relationship: COMT_MT301001CA.Annotation.text

Conformance/Cardinality: MANDATORY (1)

Allows a provider to attach arbitrary comments to clinical records (prescription, dispenses, lab results, allergies, etc) for communication. This attribute is mandatory because there's no point in having an annotation unless there's actually content in the note.

Free text comment to be attached to a record.

getConfidentialityCode

public Set<x_BasicConfidentialityKind> getConfidentialityCode()

Business Name: RestrictedPatientAccess

Un-merged Business Name: RestrictedPatientAccess

Relationship: COMT_MT300001CA.Annotation.confidentialityCode

Conformance/Cardinality: OPTIONAL (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.

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

Communicates the desire of the patient to restrict access to this Health Condition record. Provides support for additional confidentiality constraint, giving patients a level of control over their information. Methods for accessing masked event records will be governed by each jurisdiction (e.g. court orders, shared secret/consent, etc.). Can also be used to communicate that the information is deemed to be sensitive and should not be communicated or exposed to the patient (at least without the guidance of the authoring or other responsible healthcare provider). Valid values are: 'normal' (denotes 'Not Masked'); 'restricted' (denotes 'Masked'); very restricted (denotes Masked by Regulation); and 'taboo' (denotes 'patient restricted'). The default is 'normal' signifying 'Not Masked'. Either or both of the other codes can be asserted to indicate masking by the patient from providers or masking by a provider from the patient, respectively. 'normal' should never be asserted with one of the other codes.

Un-merged Business Name: RestrictedPatientAccess

Relationship: COMT_MT300003CA.Annotation.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.

The attribute is required because even if a jurisdiction doesn't support masking on the way in, it will need to need to communicate masked data returned from other jurisdictions.

Communicates the desire of the patient to restrict access to this Health Condition record. Provides support for additional confidentiality constraint, giving patients a level of control over their information. Methods for accessing masked event records will be governed by each jurisdiction (e.g. court orders, shared secret/consent, etc.). Can also be used to communicate that the information is deemed to be sensitive and should not be communicated or exposed to the patient (at least without the guidance of the authoring or other responsible healthcare provider). Valid values are: 'normal' (denotes 'Not Masked'); 'restricted' (denotes 'Masked'); very restricted (denotes Masked by Regulation); and 'taboo' (denotes 'patient restricted'). The default is 'normal' signifying 'Not Masked'. Either or both of the other codes can be asserted to indicate masking by the patient from providers or masking by a provider from the patient, respectively. 'normal' should never be asserted with one of the other codes.

getId

public Identifier getId()

Business Name: PatientNoteId

Un-merged Business Name: PatientNoteId

Relationship: COMT_MT300003CA.Annotation.id

Conformance/Cardinality: MANDATORY (1)

Allows for the unique reference of a patient note and is therefore mandatory.

Allows for referencing of a particular patient note and thus allows for the removal of the note.

Identifier of the patient note record.

setId

public void setId(Identifier id)

Business Name: PatientNoteId

Un-merged Business Name: PatientNoteId

Relationship: COMT_MT300003CA.Annotation.id

Conformance/Cardinality: MANDATORY (1)

Allows for the unique reference of a patient note and is therefore mandatory.

Allows for referencing of a particular patient note and thus allows for the removal of the note.

Identifier of the patient note record.

getResponsiblePartyAssignedEntity

public HealthcareWorkerBean getResponsiblePartyAssignedEntity()

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

Relationship: COMT_MT300003CA.ResponsibleParty.assignedEntity

Conformance/Cardinality: POPULATED (1)

setResponsiblePartyAssignedEntity

public void setResponsiblePartyAssignedEntity(HealthcareWorkerBean responsiblePartyAssignedEntity)

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

Relationship: COMT_MT300003CA.ResponsibleParty.assignedEntity

Conformance/Cardinality: POPULATED (1)

getAuthor

public AnnotatedByBean getAuthor()

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

Relationship: COMT_MT300003CA.Annotation.author

Conformance/Cardinality: MANDATORY (1)

setAuthor

public void setAuthor(AnnotatedByBean author)

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

Relationship: COMT_MT300003CA.Annotation.author

Conformance/Cardinality: MANDATORY (1)

getLocation

public OccurredAtBean getLocation()

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

Relationship: COMT_MT300003CA.Annotation.location

Conformance/Cardinality: MANDATORY (1)

setLocation

public void setLocation(OccurredAtBean location)

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

Relationship: COMT_MT300003CA.Annotation.location

Conformance/Cardinality: MANDATORY (1)

getLanguageCode

public HumanLanguage getLanguageCode()

Business Name: WrittenIn

Un-merged Business Name: WrittenIn

Relationship: COMT_MT301001CA.Annotation.languageCode

Conformance/Cardinality: MANDATORY (1)

setLanguageCode

public void setLanguageCode(HumanLanguage languageCode)

Business Name: WrittenIn

Un-merged Business Name: WrittenIn

Relationship: COMT_MT301001CA.Annotation.languageCode

Conformance/Cardinality: MANDATORY (1)

getSubjectAnnotatedActId

public Identifier getSubjectAnnotatedActId()

Business Name: RecordId

Un-merged Business Name: RecordId

Relationship: COMT_MT301001CA.AnnotatedAct.id

Conformance/Cardinality: MANDATORY (1)

Allows the record to be uniquely referenced and is therefore mandatory.

The identifier assigned by the central system (EHR) to the record item being annotated.

setSubjectAnnotatedActId

public void setSubjectAnnotatedActId(Identifier subjectAnnotatedActId)

Business Name: RecordId

Un-merged Business Name: RecordId

Relationship: COMT_MT301001CA.AnnotatedAct.id

Conformance/Cardinality: MANDATORY (1)

Allows the record to be uniquely referenced and is therefore mandatory.

The identifier assigned by the central system (EHR) to the record item being annotated.