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 context

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

String contextLinkId 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 doNotPerform

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

«CS» Code intent intent

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

String linkId 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 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 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 performer

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

String performerLinkId 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 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 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 reason

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

«CS» Code reasonCode 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 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 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 requester

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

String requesterLinkId 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 status

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

ActionSubject subject subject

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

«CS» Code type 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 Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameAction
Name Expression
NamespaceContract
Owned Template Signature
OwnerContract
Owning Template Parameter
PackageContract
Qualified NameFHIM::Contract::Action
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 context
Public AbstractEncounter context

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namecontext
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::context
Stereotype
Template Parameter
TypeAbstractEncounter
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamecontextLinkId
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::contextLinkId
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 doNotPerform
Public Boolean doNotPerform

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamedoNotPerform
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::doNotPerform
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 intent
Public «CS» Code intent

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameintent
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::intent
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamelinkId
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::linkId
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namenote
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::note
Stereotype
Template Parameter
TypeAnnotation
Upper*
Upper Value(*)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameoccurrence
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::occurrence
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameperformer
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::performer
Stereotype
Template Parameter
TypeParticipation
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameperformerLinkId
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::performerLinkId
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameperformerRole
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::performerRole
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameperformerType
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::performerType
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namereason
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::reason
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamereasonCode
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::reasonCode
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamereasonLinkId
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::reasonLinkId
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamereasonReference
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::reasonReference
Stereotype
Template Parameter
Type«ANY» Any
Upper1
Upper Value(1)
VisibilityPublic


 requester
Public Participation requester

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namerequester
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::requester
Stereotype
Template Parameter
TypeParticipation
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamerequesterLinkId
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::requesterLinkId
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 status
Public «CS» Code status

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

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namestatus
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::status
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 subject
Public ActionSubject subject

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

Constraints:
Properties:

AggregationNone
Alias
Associationaction_subject
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namesubject
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::subject
Stereotype
Template Parameter
TypeActionSubject
Upper*
Upper Value(*)
VisibilityPublic


 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:

AggregationNone
Alias
Association
Association End
ClassAction
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nametype
Name Expression
NamespaceAction
Opposite
OwnerAction
Owning Association
Owning Template Parameter
Qualified NameFHIM::Contract::Action::type
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic