Person UML Documentation

Element

Person
Class AdvanceDirective

A legal document (as a living will or durable power of attorney for healthcare) signed by a competent person to provide guidance for medical and health-care decisions (as the termination of life support or organ donation) in the event the person becomes incompetent to make such decisions.

Attributes
«CS» Code	category	Categorizes the kind of Advance Directive. "Indicates the patient's instructions to the healthcare facility." - HL7 Version 2.8, PD1-15.
String	comments	Remarks concerning the Advance Directive.
«TS» PointInTime	dateLastVerified	"The date that ... the advance directive [was] last validated." - HL7 Version 2.8, PD1-21.
«IVL_TS» Period	effectiveDateRange	The time period over which the Advance Directive is effective. Note that the end date is typically blank for active Advance Directives.
Image	image	A scanned image of the signed paper form, if applicable.
String	paperLocator	Information to locate the original paper form, if applicable.
«CS» Code	status	Indicates the state of the Advance Directive, as defined in the Act state-transition model in the HL7 RIM. Possible values include: New, Held, Canceled, Active, Suspended, Aborted, Completed, Nullified, and Obsolete.

Properties:

Alias
Classifier Behavior
Is Abstract	false
Is Active	false
Is Leaf	false
Keywords
Name	AdvanceDirective
Name Expression
Namespace	Person
Owned Template Signature
Owner	Person
Owning Template Parameter
Package	Person
Qualified Name	FHIM::Person::AdvanceDirective
Representation
Stereotype
Template Parameter
Visibility	Public

Attribute Details

category

Public «CS» Code category

Categorizes the kind of Advance Directive.
"Indicates the patient's instructions to the healthcare facility." - HL7 Version 2.8, PD1-15.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	AdvanceDirective
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value	(1)
Multiplicity	1
Name	category
Name Expression
Namespace	AdvanceDirective
Opposite
Owner	AdvanceDirective
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Person::AdvanceDirective::category
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

comments

Public String comments

Remarks concerning the Advance Directive.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	AdvanceDirective
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	comments
Name Expression
Namespace	AdvanceDirective
Opposite
Owner	AdvanceDirective
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Person::AdvanceDirective::comments
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value	(1)
Visibility	Public

dateLastVerified

Public «TS» PointInTime dateLastVerified

"The date that ... the advance directive [was] last validated." - HL7 Version 2.8, PD1-21.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	AdvanceDirective
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	dateLastVerified
Name Expression
Namespace	AdvanceDirective
Opposite
Owner	AdvanceDirective
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Person::AdvanceDirective::dateLastVerified
Stereotype
Template Parameter
Type	«TS» PointInTime
Upper	1
Upper Value	(1)
Visibility	Public

effectiveDateRange

Public «IVL_TS» Period effectiveDateRange

The time period over which the Advance Directive is effective. Note that the end date is typically blank for active Advance Directives.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	AdvanceDirective
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	effectiveDateRange
Name Expression
Namespace	AdvanceDirective
Opposite
Owner	AdvanceDirective
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Person::AdvanceDirective::effectiveDateRange
Stereotype
Template Parameter
Type	«IVL_TS» Period
Upper	1
Upper Value	(1)
Visibility	Public

image

Public Image image

A scanned image of the signed paper form, if applicable.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	AdvanceDirective
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	image
Name Expression
Namespace	AdvanceDirective
Opposite
Owner	AdvanceDirective
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Person::AdvanceDirective::image
Stereotype
Template Parameter
Type	Image
Upper	1
Upper Value	(1)
Visibility	Public

paperLocator

Public String paperLocator

Information to locate the original paper form, if applicable.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	AdvanceDirective
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	paperLocator
Name Expression
Namespace	AdvanceDirective
Opposite
Owner	AdvanceDirective
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Person::AdvanceDirective::paperLocator
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value	(1)
Visibility	Public

status

Public «CS» Code status

Indicates the state of the Advance Directive, as defined in the Act state-transition model in the HL7 RIM. Possible values include: New, Held, Canceled, Active, Suspended, Aborted, Completed, Nullified, and Obsolete.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	AdvanceDirective
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value	(1)
Multiplicity	1
Name	status
Name Expression
Namespace	AdvanceDirective
Opposite
Owner	AdvanceDirective
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Person::AdvanceDirective::status
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

Overview

Top

Package

Element

Person UML Documentation

Summary:AttributesProperties

Detail:Attributes