Contract UML Documentation

Element

Contract
Class Action

"An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place." - HL7 FHIR, Contract.term.action

Attributes
AbstractEncounter	context	"Encounter or Episode with primary association to specified term activity." - HL7 FHIR, Contract.term.action.context
String	contextLinkId	"Identifier of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse." - HL7 FHIR, Contract.term.action.contextLinkId
Boolean	doNotPerform	"True if the term prohibits the action." - HL7 FHIR, Contract.term.action.doNotPerform
«CS» Code	intent	"Reason or purpose for the action stipulated by this Contract Provision." - HL7 FHIR, Contract.term.action.intent
String	linkId	"Identifier of the clause or question text related to this action in the referenced form or QuestionnaireResponse." - HL7 FHIR, Contract.term.action.linkId
Annotation	note	"Comments made about the term action made by the requester, performer, subject or other participants." - HL7 FHIR, Contract.term.action.note
«TS» PointInTime	occurrence	"When action happens." - HL7 FHIR, Contract.term.action.occurrence[x] Note that FHIR can be a dateTime, Period, or a Timing. The FHIM currently only allows a dateTime
Participation	performer	"Indicates who or what is being asked to perform (or not perform) the ction." - HL7 FHIR, Contract.term.action.performer
String	performerLinkId	"Identifier of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse." - HL7 FHIR, Contract.term.action.performerLinkId
«CS» Code	performerRole	"The type of role or competency of an individual desired or required to perform or not perform the action." - HL7 FHIR, Contract.term.action.performerRole
«CS» Code	performerType	"The type of individual that is desired or required to perform or not perform the action." - HL7 FHIR, Contract.term.action.performerType
String	reason	"Describes why the action is to be performed or not performed in textual form." - HL7 FHIR, Contract.term.action.reason
«CS» Code	reasonCode	"Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited." - HL7 FHIR, Contract.term.action.reasonCode
String	reasonLinkId	"Identifier of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse." - HL7 FHIR, Contract.term.action.reasonLinkId
«ANY» Any	reasonReference	"Indicates another resource whose existence justifies permitting or not permitting this action." - HL7 FHIR, Contract.term.action.reasonReference In FHIR, this can be a Reference to a Condition, Observation, DiagnosticReport, DocumentReference, Questionnaire, or a QuestionnaireResponse; in FHIM this currently modeled as an Any.
Participation	requester	"Who or what initiated the action and has responsibility for its activation." - HL7 FHIR, Contract.term.action.requester
String	requesterLinkId	"Identifier of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse." - HL7 FHIR, Contract.term.action.requesterLinkId
«CS» Code	status	"Current state of the term action." - HL7 FHIR, Contract.term.action.status
ActionSubject	subject	"Entity of the action." - HL7 FHIR, Contract.term.action.subject
«CS» Code	type	"Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term." - HL7 FHIR, Contract.term.action.type

Properties:

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

Attribute Details

context

Public AbstractEncounter context

"Encounter or Episode with primary association to specified term activity." - HL7 FHIR, Contract.term.action.context

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	context
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::context
Stereotype
Template Parameter
Type	AbstractEncounter
Upper	1
Upper Value	(1)
Visibility	Public

contextLinkId

Public String contextLinkId

"Identifier of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse." - HL7 FHIR, Contract.term.action.contextLinkId

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	*
Name	contextLinkId
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::contextLinkId
Stereotype
Template Parameter
Type	String
Upper	*
Upper Value	(*)
Visibility	Public

doNotPerform

Public Boolean doNotPerform

"True if the term prohibits the action." - HL7 FHIR, Contract.term.action.doNotPerform

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	doNotPerform
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::doNotPerform
Stereotype
Template Parameter
Type	Boolean
Upper	1
Upper Value	(1)
Visibility	Public

intent

Public «CS» Code intent

"Reason or purpose for the action stipulated by this Contract Provision." - HL7 FHIR, Contract.term.action.intent

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	intent
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::intent
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

linkId

Public String linkId

"Identifier of the clause or question text related to this action in the referenced form or QuestionnaireResponse." - HL7 FHIR, Contract.term.action.linkId

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	*
Name	linkId
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::linkId
Stereotype
Template Parameter
Type	String
Upper	*
Upper Value	(*)
Visibility	Public

note

Public Annotation note

"Comments made about the term action made by the requester, performer, subject or other participants." - HL7 FHIR, Contract.term.action.note

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	*
Name	note
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::note
Stereotype
Template Parameter
Type	Annotation
Upper	*
Upper Value	(*)
Visibility	Public

occurrence

Public «TS» PointInTime occurrence

"When action happens." - HL7 FHIR, Contract.term.action.occurrence[x]
Note that FHIR can be a dateTime, Period, or a Timing. The FHIM currently only allows a dateTime

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	occurrence
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::occurrence
Stereotype
Template Parameter
Type	«TS» PointInTime
Upper	1
Upper Value	(1)
Visibility	Public

performer

Public Participation performer

"Indicates who or what is being asked to perform (or not perform) the ction." - HL7 FHIR, Contract.term.action.performer

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	performer
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::performer
Stereotype
Template Parameter
Type	Participation
Upper	1
Upper Value	(1)
Visibility	Public

performerLinkId

Public String performerLinkId

"Identifier of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse." - HL7 FHIR, Contract.term.action.performerLinkId

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	*
Name	performerLinkId
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::performerLinkId
Stereotype
Template Parameter
Type	String
Upper	*
Upper Value	(*)
Visibility	Public

performerRole

Public «CS» Code performerRole

"The type of role or competency of an individual desired or required to perform or not perform the action." - HL7 FHIR, Contract.term.action.performerRole

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	performerRole
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::performerRole
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

performerType

Public «CS» Code performerType

"The type of individual that is desired or required to perform or not perform the action." - HL7 FHIR, Contract.term.action.performerType

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	*
Name	performerType
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::performerType
Stereotype
Template Parameter
Type	«CS» Code
Upper	*
Upper Value	(*)
Visibility	Public

reason

Public String reason

"Describes why the action is to be performed or not performed in textual form." - HL7 FHIR, Contract.term.action.reason

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	*
Name	reason
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::reason
Stereotype
Template Parameter
Type	String
Upper	*
Upper Value	(*)
Visibility	Public

reasonCode

Public «CS» Code reasonCode

"Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited." - HL7 FHIR, Contract.term.action.reasonCode

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	*
Name	reasonCode
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::reasonCode
Stereotype
Template Parameter
Type	«CS» Code
Upper	*
Upper Value	(*)
Visibility	Public

reasonLinkId

Public String reasonLinkId

"Identifier of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse." - HL7 FHIR, Contract.term.action.reasonLinkId

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	*
Name	reasonLinkId
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::reasonLinkId
Stereotype
Template Parameter
Type	String
Upper	*
Upper Value	(*)
Visibility	Public

reasonReference

Public «ANY» Any reasonReference

"Indicates another resource whose existence justifies permitting or not permitting this action." - HL7 FHIR, Contract.term.action.reasonReference
In FHIR, this can be a Reference to a Condition, Observation, DiagnosticReport, DocumentReference, Questionnaire, or a QuestionnaireResponse; in FHIM this currently modeled as an Any.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	reasonReference
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::reasonReference
Stereotype
Template Parameter
Type	«ANY» Any
Upper	1
Upper Value	(1)
Visibility	Public

requester

Public Participation requester

"Who or what initiated the action and has responsibility for its activation." - HL7 FHIR, Contract.term.action.requester

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	requester
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::requester
Stereotype
Template Parameter
Type	Participation
Upper	1
Upper Value	(1)
Visibility	Public

requesterLinkId

Public String requesterLinkId

"Identifier of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse." - HL7 FHIR, Contract.term.action.requesterLinkId

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	*
Name	requesterLinkId
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::requesterLinkId
Stereotype
Template Parameter
Type	String
Upper	*
Upper Value	(*)
Visibility	Public

status

Public «CS» Code status

"Current state of the term action." - HL7 FHIR, Contract.term.action.status

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::status
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

subject

Public ActionSubject subject

"Entity of the action." - HL7 FHIR, Contract.term.action.subject

Constraints:

Properties:

Aggregation	None
Alias
Association	action_subject
Association End
Class	Action
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	*
Name	subject
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::subject
Stereotype
Template Parameter
Type	ActionSubject
Upper	*
Upper Value	(*)
Visibility	Public

type

Public «CS» Code type

"Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term." - HL7 FHIR, Contract.term.action.type

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Action
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	type
Name Expression
Namespace	Action
Opposite
Owner	Action
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Contract::Action::type
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

Overview

Top

Package

Element

Contract UML Documentation

Summary:AttributesProperties

Detail:Attributes