ca.infoway.messagebuilder.model.pcs_mr2007_v02_r02.cr.merged
Class IdentifiedPersonBean

java.lang.Object
  ca.infoway.messagebuilder.model.MessagePartBean
      ca.infoway.messagebuilder.model.pcs_mr2007_v02_r02.cr.merged.IdentifiedPersonBean

All Implemented Interfaces:

NullFlavorSupport, Serializable

public class IdentifiedPersonBean
extends MessagePartBean

Business Name: IdentifiedPerson

PRPA_MT101104CA.IdentifiedEntity: Identified Person

Provides the message entry point required to add a person to the Client Registry

The IdentifiedEntity class is the entry point to the R-MIM and contains one or more identifiers (for example an "internal" id used only by computer systems and an "external" id for display to users) for the Person in the Client Registry. The statusCode is set to "active". The beginning of the effectiveTime is when the record was added to the registry.

PRPA_MT101002CA.IdentifiedEntity: Identified Person

Provides the message entry point required to add a person to the Client Registry

The IdentifiedEntity class is the entry point to the R-MIM and contains one or more identifiers (for example an "internal" id used only by computer systems and an "external" id for display to users) for the Person in the Client Registry. The statusCode is set to "active". The beginning of the effectiveTime is when the record was added to the registry.

See Also:

Serialized Form

Constructor Summary

IdentifiedPersonBean()

Method Summary

x_NormalRestrictedTabooConfidentialityKind	getConfidentialityCode() Business Name: ClientMaskedInformation
Interval<Date>	getEffectiveTime() Business Name: ClientEffectiveTime
Set<Identifier>	getId() Business Name: ClientHealthcareIdentificationNumber
List<PostalAddress>	getIdentifiedPersonAddr() Business Name: ClientAddress
AdministrativeGender	getIdentifiedPersonAdministrativeGenderCode() Business Name: ClientGender
List<OtherIDsNonHealthcareIdentifiersBean>	getIdentifiedPersonAsOtherIDs() Un-merged Business Name: (no business name specified)
Date	getIdentifiedPersonBirthTime() Business Name: ClientDateOfBirth
Boolean	getIdentifiedPersonDeceasedInd() Business Name: ClientDeceasedIndicator
Date	getIdentifiedPersonDeceasedTime() Business Name: ClientDeceasedDate
List<LanguageCommunicationBean>	getIdentifiedPersonLanguageCommunication() Un-merged Business Name: (no business name specified)
Boolean	getIdentifiedPersonMultipleBirthInd() Business Name: ClientMultipleBirthIndicator
Integer	getIdentifiedPersonMultipleBirthOrderNumber() Business Name: ClientMultipleBirthOrderNumber
List<PersonName>	getIdentifiedPersonName() Business Name: ClientName
List<PersonalRelationshipBean>	getIdentifiedPersonPersonalRelationship() Un-merged Business Name: (no business name specified)
List<TelecommunicationAddress>	getIdentifiedPersonTelecom() Business Name: ClientTelecom
RoleStatus	getStatusCode() Business Name: ClientStatusCode
ConfidenceValueBean	getSubjectOfObservationEvent() Un-merged Business Name: (no business name specified)
void	setConfidentialityCode(x_NormalRestrictedTabooConfidentialityKind confidentialityCode) Business Name: ClientMaskedInformation
void	setEffectiveTime(Interval<Date> effectiveTime) Business Name: ClientEffectiveTime
void	setIdentifiedPersonAdministrativeGenderCode(AdministrativeGender identifiedPersonAdministrativeGenderCode) Business Name: ClientGender
void	setIdentifiedPersonBirthTime(Date identifiedPersonBirthTime) Business Name: ClientDateOfBirth
void	setIdentifiedPersonDeceasedInd(Boolean identifiedPersonDeceasedInd) Business Name: ClientDeceasedIndicator
void	setIdentifiedPersonDeceasedTime(Date identifiedPersonDeceasedTime) Business Name: ClientDeceasedDate
void	setIdentifiedPersonMultipleBirthInd(Boolean identifiedPersonMultipleBirthInd) Business Name: ClientMultipleBirthIndicator
void	setIdentifiedPersonMultipleBirthOrderNumber(Integer identifiedPersonMultipleBirthOrderNumber) Business Name: ClientMultipleBirthOrderNumber
void	setStatusCode(RoleStatus statusCode) Business Name: ClientStatusCode
void	setSubjectOfObservationEvent(ConfidenceValueBean subjectOfObservationEvent) 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

IdentifiedPersonBean

public IdentifiedPersonBean()

Method Detail

getId

public Set<Identifier> getId()

Business Name: ClientHealthcareIdentificationNumber

Un-merged Business Name: ClientHealthcareIdentificationNumber

Relationship: PRPA_MT101104CA.IdentifiedEntity.id

Conformance/Cardinality: POPULATED (1-100)

Mandatory attribute supports unique identification of the client.

At least 1 client identifier must be present in the message

This identification attribute supports capture of a healthcare identifier specific to the client. This identifier may be assigned jurisdictionally or by care facility.

Un-merged Business Name: ClientHealthcareIdentificationNumber

Relationship: PRPA_MT101002CA.IdentifiedEntity.id

Conformance/Cardinality: MANDATORY (1-40)

Mandatory attribute supports unique identification of the client.

This identification attribute supports capture of a healthcare identifier specific to the client. This identifier may be assigned jurisdictionally or by care facility.

getStatusCode

public RoleStatus getStatusCode()

Business Name: ClientStatusCode

Un-merged Business Name: ClientStatusCode

Relationship: PRPA_MT101104CA.IdentifiedEntity.statusCode

Conformance/Cardinality: POPULATED (1)

Populated attribute supports the identification of the client

Indicates the status of the Client role (e.g. Active)

Un-merged Business Name: ClientStatusCode

Relationship: PRPA_MT101002CA.IdentifiedEntity.statusCode

Conformance/Cardinality: POPULATED (1)

Populated attribute supports the identification of the client

Indicates the status of the Client role (e.g. Active)

setStatusCode

public void setStatusCode(RoleStatus statusCode)

Business Name: ClientStatusCode

Un-merged Business Name: ClientStatusCode

Relationship: PRPA_MT101104CA.IdentifiedEntity.statusCode

Conformance/Cardinality: POPULATED (1)

Populated attribute supports the identification of the client

Indicates the status of the Client role (e.g. Active)

Un-merged Business Name: ClientStatusCode

Relationship: PRPA_MT101002CA.IdentifiedEntity.statusCode

Conformance/Cardinality: POPULATED (1)

Populated attribute supports the identification of the client

Indicates the status of the Client role (e.g. Active)

getEffectiveTime

public Interval<Date> getEffectiveTime()

Business Name: ClientEffectiveTime

Un-merged Business Name: ClientEffectiveTime

Relationship: PRPA_MT101104CA.IdentifiedEntity.effectiveTime

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

Indicates the effective time of the Client role

Un-merged Business Name: ClientEffectiveTime

Relationship: PRPA_MT101002CA.IdentifiedEntity.effectiveTime

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

Indicates the effective time of the Client role

setEffectiveTime

public void setEffectiveTime(Interval<Date> effectiveTime)

Business Name: ClientEffectiveTime

Un-merged Business Name: ClientEffectiveTime

Relationship: PRPA_MT101104CA.IdentifiedEntity.effectiveTime

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

Indicates the effective time of the Client role

Un-merged Business Name: ClientEffectiveTime

Relationship: PRPA_MT101002CA.IdentifiedEntity.effectiveTime

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

Indicates the effective time of the Client role

getConfidentialityCode

public x_NormalRestrictedTabooConfidentialityKind getConfidentialityCode()

Business Name: ClientMaskedInformation

Un-merged Business Name: ClientMaskedInformation

Relationship: PRPA_MT101104CA.IdentifiedEntity.confidentialityCode

Conformance/Cardinality: POPULATED (1)

Populated attribute supports the business requirement to provide restricted access where required

Data in the EHR may at some Data in the EHR may at some point (and in some jurisdictions) be accessed directly by patients. Some health information may be deemed inappropriate for direct access by patients and requires interpretation by a clinician (e.g. prescription of placebos, analysis of certain psychiatric conditions, etc) Even where direct access by patient is not provided, there may need to be guidance to other providers viewing the record where care should be used in disclosing information to the patient. Non-clinical data (e.g. demographics) may need to be flagged as not for disclosure to patient and or next of kin. There may be professional policy and or legislative guidelines about when/if records may be flagged as not for direct disclosure.

A code that controls the disclosure of information about this patient encounter.

Un-merged Business Name: ClientMaskedInformation

Relationship: PRPA_MT101002CA.IdentifiedEntity.confidentialityCode

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the business requirement to provide restricted access where required

Data in the EHR may at some point (and in some jurisdictions) be accessed directly by patients. Some health information may be deemed inappropriate for direct access by patients and requires interpretation by a clinician (e.g. prescription of placebos, analysis of certain psychiatric conditions, etc) Even where direct access by patient is not provided, there may need to be guidance to other providers viewing the record where care should be used in disclosing information to the patient. Non-clinical data (e.g. demographics) may need to be flagged as not for disclosure to patient and or next of kin. There may be professional policy and or legislative guidelines about when/if records may be flagged as not for direct disclosure.

A code that controls the disclosure of information about this patient encounter.

setConfidentialityCode

public void setConfidentialityCode(x_NormalRestrictedTabooConfidentialityKind confidentialityCode)

Business Name: ClientMaskedInformation

Un-merged Business Name: ClientMaskedInformation

Relationship: PRPA_MT101104CA.IdentifiedEntity.confidentialityCode

Conformance/Cardinality: POPULATED (1)

Populated attribute supports the business requirement to provide restricted access where required

Data in the EHR may at some Data in the EHR may at some point (and in some jurisdictions) be accessed directly by patients. Some health information may be deemed inappropriate for direct access by patients and requires interpretation by a clinician (e.g. prescription of placebos, analysis of certain psychiatric conditions, etc) Even where direct access by patient is not provided, there may need to be guidance to other providers viewing the record where care should be used in disclosing information to the patient. Non-clinical data (e.g. demographics) may need to be flagged as not for disclosure to patient and or next of kin. There may be professional policy and or legislative guidelines about when/if records may be flagged as not for direct disclosure.

A code that controls the disclosure of information about this patient encounter.

Un-merged Business Name: ClientMaskedInformation

Relationship: PRPA_MT101002CA.IdentifiedEntity.confidentialityCode

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the business requirement to provide restricted access where required

Data in the EHR may at some point (and in some jurisdictions) be accessed directly by patients. Some health information may be deemed inappropriate for direct access by patients and requires interpretation by a clinician (e.g. prescription of placebos, analysis of certain psychiatric conditions, etc) Even where direct access by patient is not provided, there may need to be guidance to other providers viewing the record where care should be used in disclosing information to the patient. Non-clinical data (e.g. demographics) may need to be flagged as not for disclosure to patient and or next of kin. There may be professional policy and or legislative guidelines about when/if records may be flagged as not for direct disclosure.

A code that controls the disclosure of information about this patient encounter.

getIdentifiedPersonName

public List<PersonName> getIdentifiedPersonName()

Business Name: ClientName

Un-merged Business Name: ClientName

Relationship: PRPA_MT101104CA.Person.name

Conformance/Cardinality: POPULATED (1-20)

Populated attribute supports the identification of the client

Name(s) for the Client

Un-merged Business Name: ClientName

Relationship: PRPA_MT101002CA.Person.name

Conformance/Cardinality: POPULATED (1-20)

Populated attribute supports the identification of the client

Name(s) for the Client

getIdentifiedPersonTelecom

public List<TelecommunicationAddress> getIdentifiedPersonTelecom()

Business Name: ClientTelecom

Un-merged Business Name: ClientTelecom

Relationship: PRPA_MT101104CA.Person.telecom

Conformance/Cardinality: POPULATED (1-10)

Populated attribute supports the identification of the client

Provides information about telecom

Un-merged Business Name: ClientTelecom

Relationship: PRPA_MT101002CA.Person.telecom

Conformance/Cardinality: POPULATED (1-20)

Required attribute supports the identification of the client

Provides information about telecom

getIdentifiedPersonAdministrativeGenderCode

public AdministrativeGender getIdentifiedPersonAdministrativeGenderCode()

Business Name: ClientGender

Un-merged Business Name: ClientGender

Relationship: PRPA_MT101104CA.Person.administrativeGenderCode

Conformance/Cardinality: POPULATED (1)

Populated attribute supports the identification of the client

Gender of the Client, this is not to be confused with Clinical Gender of a client. Administrative Gender is typically restricted to Male (M), Female (F) or Undifferentiated (U)

Un-merged Business Name: ClientGender

Relationship: PRPA_MT101002CA.Person.administrativeGenderCode

Conformance/Cardinality: POPULATED (1)

Populated attribute supports the identification of the client

Gender of the Client, this is not to be confused with Clinical Gender of a client. Administrative Gender is typically restricted to Male (M), Female (F) or Undifferentiated (U)

setIdentifiedPersonAdministrativeGenderCode

public void setIdentifiedPersonAdministrativeGenderCode(AdministrativeGender identifiedPersonAdministrativeGenderCode)

Business Name: ClientGender

Un-merged Business Name: ClientGender

Relationship: PRPA_MT101104CA.Person.administrativeGenderCode

Conformance/Cardinality: POPULATED (1)

Populated attribute supports the identification of the client

Gender of the Client, this is not to be confused with Clinical Gender of a client. Administrative Gender is typically restricted to Male (M), Female (F) or Undifferentiated (U)

Un-merged Business Name: ClientGender

Relationship: PRPA_MT101002CA.Person.administrativeGenderCode

Conformance/Cardinality: POPULATED (1)

Populated attribute supports the identification of the client

Gender of the Client, this is not to be confused with Clinical Gender of a client. Administrative Gender is typically restricted to Male (M), Female (F) or Undifferentiated (U)

getIdentifiedPersonBirthTime

public Date getIdentifiedPersonBirthTime()

Business Name: ClientDateOfBirth

Un-merged Business Name: ClientDateOfBirth

Relationship: PRPA_MT101104CA.Person.birthTime

Conformance/Cardinality: POPULATED (1)

Populated attribute supports the identification of the client

Date of birth of the Client

Un-merged Business Name: ClientDateOfBirth

Relationship: PRPA_MT101002CA.Person.birthTime

Conformance/Cardinality: POPULATED (1)

Populated attribute supports the identification of the client

Date of birth of the Client

setIdentifiedPersonBirthTime

public void setIdentifiedPersonBirthTime(Date identifiedPersonBirthTime)

Business Name: ClientDateOfBirth

Un-merged Business Name: ClientDateOfBirth

Relationship: PRPA_MT101104CA.Person.birthTime

Conformance/Cardinality: POPULATED (1)

Populated attribute supports the identification of the client

Date of birth of the Client

Un-merged Business Name: ClientDateOfBirth

Relationship: PRPA_MT101002CA.Person.birthTime

Conformance/Cardinality: POPULATED (1)

Populated attribute supports the identification of the client

Date of birth of the Client

getIdentifiedPersonDeceasedInd

public Boolean getIdentifiedPersonDeceasedInd()

Business Name: ClientDeceasedIndicator

Un-merged Business Name: ClientDeceasedIndicator

Relationship: PRPA_MT101104CA.Person.deceasedInd

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

An indication that the client is deceased.

Un-merged Business Name: ClientDeceasedIndicator

Relationship: PRPA_MT101002CA.Person.deceasedInd

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

An indication that the client is deceased.

setIdentifiedPersonDeceasedInd

public void setIdentifiedPersonDeceasedInd(Boolean identifiedPersonDeceasedInd)

Business Name: ClientDeceasedIndicator

Un-merged Business Name: ClientDeceasedIndicator

Relationship: PRPA_MT101104CA.Person.deceasedInd

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

An indication that the client is deceased.

Un-merged Business Name: ClientDeceasedIndicator

Relationship: PRPA_MT101002CA.Person.deceasedInd

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

An indication that the client is deceased.

getIdentifiedPersonDeceasedTime

public Date getIdentifiedPersonDeceasedTime()

Business Name: ClientDeceasedDate

Un-merged Business Name: ClientDeceasedDate

Relationship: PRPA_MT101104CA.Person.deceasedTime

Conformance/Cardinality: POPULATED (1)

Required attribute supports verification of death from official source such as Vital Statistics.

The date and time that a client's death occurred.

Un-merged Business Name: ClientDeceasedDate

Relationship: PRPA_MT101002CA.Person.deceasedTime

Conformance/Cardinality: REQUIRED (0-1)

deceasedTime only present if deceasedInd is = TRUE

Required attribute supports verification of death from official source such as Vital Statistics.

The date and time that a client's death occurred.

setIdentifiedPersonDeceasedTime

public void setIdentifiedPersonDeceasedTime(Date identifiedPersonDeceasedTime)

Business Name: ClientDeceasedDate

Un-merged Business Name: ClientDeceasedDate

Relationship: PRPA_MT101104CA.Person.deceasedTime

Conformance/Cardinality: POPULATED (1)

Required attribute supports verification of death from official source such as Vital Statistics.

The date and time that a client's death occurred.

Un-merged Business Name: ClientDeceasedDate

Relationship: PRPA_MT101002CA.Person.deceasedTime

Conformance/Cardinality: REQUIRED (0-1)

deceasedTime only present if deceasedInd is = TRUE

Required attribute supports verification of death from official source such as Vital Statistics.

The date and time that a client's death occurred.

getIdentifiedPersonMultipleBirthInd

public Boolean getIdentifiedPersonMultipleBirthInd()

Business Name: ClientMultipleBirthIndicator

Un-merged Business Name: ClientMultipleBirthIndicator

Relationship: PRPA_MT101104CA.Person.multipleBirthInd

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

An indication as to whether the client is part of a multiple birth.

Un-merged Business Name: ClientMultipleBirthIndicator

Relationship: PRPA_MT101002CA.Person.multipleBirthInd

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

An indication as to whether the client is part of a multiple birth.

setIdentifiedPersonMultipleBirthInd

public void setIdentifiedPersonMultipleBirthInd(Boolean identifiedPersonMultipleBirthInd)

Business Name: ClientMultipleBirthIndicator

Un-merged Business Name: ClientMultipleBirthIndicator

Relationship: PRPA_MT101104CA.Person.multipleBirthInd

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

An indication as to whether the client is part of a multiple birth.

Un-merged Business Name: ClientMultipleBirthIndicator

Relationship: PRPA_MT101002CA.Person.multipleBirthInd

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

An indication as to whether the client is part of a multiple birth.

getIdentifiedPersonMultipleBirthOrderNumber

public Integer getIdentifiedPersonMultipleBirthOrderNumber()

Business Name: ClientMultipleBirthOrderNumber

Un-merged Business Name: ClientMultipleBirthOrderNumber

Relationship: PRPA_MT101104CA.Person.multipleBirthOrderNumber

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

The order in which this client was born if part of a multiple birth.

Un-merged Business Name: ClientMultipleBirthOrderNumber

Relationship: PRPA_MT101002CA.Person.multipleBirthOrderNumber

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

The order in which this client was born if part of a multiple birth.

setIdentifiedPersonMultipleBirthOrderNumber

public void setIdentifiedPersonMultipleBirthOrderNumber(Integer identifiedPersonMultipleBirthOrderNumber)

Business Name: ClientMultipleBirthOrderNumber

Un-merged Business Name: ClientMultipleBirthOrderNumber

Relationship: PRPA_MT101104CA.Person.multipleBirthOrderNumber

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

The order in which this client was born if part of a multiple birth.

Un-merged Business Name: ClientMultipleBirthOrderNumber

Relationship: PRPA_MT101002CA.Person.multipleBirthOrderNumber

Conformance/Cardinality: REQUIRED (0-1)

Required attribute supports the identification of the client

The order in which this client was born if part of a multiple birth.

getIdentifiedPersonAddr

public List<PostalAddress> getIdentifiedPersonAddr()

Business Name: ClientAddress

Un-merged Business Name: ClientAddress

Relationship: PRPA_MT101104CA.Person.addr

Conformance/Cardinality: POPULATED (1-10)

Populated attribute supports the identification of the client

Address(es) of the Client

Un-merged Business Name: ClientAddress

Relationship: PRPA_MT101002CA.Person.addr

Conformance/Cardinality: POPULATED (1-10)

Populated attribute supports the identification of the client

Address(es) of the Client

getIdentifiedPersonAsOtherIDs

public List<OtherIDsNonHealthcareIdentifiersBean> getIdentifiedPersonAsOtherIDs()

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

Relationship: PRPA_MT101104CA.Person.asOtherIDs

Conformance/Cardinality: REQUIRED (0-100)

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

Relationship: PRPA_MT101002CA.Person.asOtherIDs

Conformance/Cardinality: REQUIRED (0-100)

getIdentifiedPersonPersonalRelationship

public List<PersonalRelationshipBean> getIdentifiedPersonPersonalRelationship()

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

Relationship: PRPA_MT101104CA.Person.personalRelationship

Conformance/Cardinality: REQUIRED (0-10)

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

Relationship: PRPA_MT101002CA.Person.personalRelationship

Conformance/Cardinality: REQUIRED (0-10)

getIdentifiedPersonLanguageCommunication

public List<LanguageCommunicationBean> getIdentifiedPersonLanguageCommunication()

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

Relationship: PRPA_MT101104CA.Person.languageCommunication

Conformance/Cardinality: MANDATORY (1-10)

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

Relationship: PRPA_MT101002CA.Person.languageCommunication

Conformance/Cardinality: MANDATORY (1-10)

getSubjectOfObservationEvent

public ConfidenceValueBean getSubjectOfObservationEvent()

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

Relationship: PRPA_MT101104CA.Subject.observationEvent

Conformance/Cardinality: POPULATED (1)

setSubjectOfObservationEvent

public void setSubjectOfObservationEvent(ConfidenceValueBean subjectOfObservationEvent)

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

Relationship: PRPA_MT101104CA.Subject.observationEvent

Conformance/Cardinality: POPULATED (1)