|
| CarePlan UML Documentation |
CarePlan
Class CareIntervention
A single action (treatment, procedure, or activity) designed to achieve an outcome for a diagnosis for which the clinician is accountable. Note that actions include the following categories: Assess/Monitor, Perform, Teach, Manage."An intervention is a combination of program elements or strategies designed to produce behavior changes or improve health status among individuals or an entire population. interventions may include treatments and procedures, wellness activities, educational programs, new or stronger policies, improvements in the environment, or a health promotion campaign. Interventions that include multiple strategies are typically the most effective in producing desired and lasting change." - DoD/VA iEHR Care and Disease Management model."Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc." - HL7 FHIR, CarePlan.activityNote that FHIR has an Activity and an activity Detail, but since there is a zero to one relationship between activity and detail, we kept the FHIM CareIntervention class as a single class, in keeping with the CarePlan DAM and the FHIM SME review.
| Attributes |
| AcceptanceReview |  acceptanceReview |
Pointer to a (set of) appraisals during which agreements to adopt proposed Care Plan actions are affirmed
|
| ActivityOutcomeReview | activityOutcomeReview |
Pointer to an Observation describing any changes that resulted from the pursuit of the HealthGoal."Identifies the change (or lack of change) at the point where the goal was deemed to be cancelled or achieved." - HL7 FHIR, Goal.outcome.
|
| «IVL_TS» Period | applicability |
"Applicability time point or time frame in which the activity may be carried out." - HL7 Care Plan Domain Analysis Model.
|
| String | category |
This property is used to categorize the Care Intervention. Note that this property is currently modeled as a string because a single suitable valuset could not be identified at this time."A classification of the activity such as Patient Instruction, Medication Administration, Self Blood Glucose Monitoring, etc." - HL7 Care Plan Domain Analysis Model."Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter." - HL7 FHIR, CarePlan.activity.detail.code
|
| Boolean | doNotPerform |
"If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan." - HL7 FHIR, CarePlan.activity.detail.doNotPerform
|
| «EntryPoint» HealthGoal | healthGoal |
"Internal reference that identifies the goals that this activity is intended to contribute towards meeting." - HL7 FHIR, CarePlan.activity.detail.goal
|
| «CS» Code | kind |
"A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest." Possible values are: Appointment; CommunicationRequest; DeviceRequest; MedicationRequest; NutritionOrder; Task; ServiceRequest; VisionPrescription. - HL7 FHIR, CarePlan.activity.detail.kind
|
| Participation | performer |
"Identifies who's expected to be involved in the activity." - HL7 FHIR, CarePlan.activity.detail.performer
|
| «CS» Code | planningStatus |
The state of the Care Intervention with respect to the negotiation process. Possible values include: Proposed, Accepted, Rejected. This property has been modeled separately from the status property which only is used when the Care Intervention has been accepted. It is possible that these two kinds of statuses may be combined into a larger workflow-aware status, but they are modeled separately for now for compatibility with FHIR.
|
| String | postCondition |
"Any conditions expected to be true after the activity is carried out." - HL7 Care Plan Domain Analysis Model
|
| String | preCondition |
"Any required preconditions which must be before the activity can be carried out." - HL7 Care Plan Domain Analysis Model
|
| OrderablePharmacyItem | product |
Pointer to a medicinal product that is to be used in the activity. Note that FHIR can point to a code, a medication, or a substance. In FHIM, this is handled by an Orderable Pharmacy Item"Identifies the food, drug or other product to be consumed or supplied in the activity." - HL7 FHIR, CarePlan.activity.detail.product[x]
|
| «PQ» Quantity | productDailyAmount |
"Identifies the quantity expected to be consumed in a given day." - HL7 FHIR, CarePlan.activity.detail.dailyAmount
|
| «PQ» Quantity | productQuantity |
"Identifies the quantity expected to be supplied, administered or consumed by the subject." - HL7 FHIR, CarePlan.activity.detail.quantity
|
| HealthConcern | reason |
"Provides the health condition(s) or other rationale that drove the inclusion of this particular activity as part of the plan." - HL7 FHIR, CarePlan.activity.detail.reason[x]
|
| ClinicalStatement | reference |
"The details of the proposed activity represented in a specific resource." - HL7 FHIR, CarePlan.activity.reference
|
| ResourceAllocation | resourceAllocation |
Pointer to any physical items or personnel that would be needed to fulfill the Intervention.
|
| Participation | responsibleParty |
Identifies the Care Team Member (typically a Provider) who is responsible for the performance of the Care Intervention.
|
| «TS» PointInTime | scheduledPeriod |
"The actual start instant of the activity." - HL7 Care Plan Domain Analysis Model."The end date/time of the activity." - HL7 Care Plan Domain Analysis Model."The period, timing or frequency upon which the described activity is to occur." - HL7 FHIR, CarePlan.activity.detail.scheduled[x]
|
| Timing | scheduledTiming |
"Specification of repeating frequency of an activity." - HL7 Care Plan Domain Analysis Model"The period, timing or frequency upon which the described activity is to occur." - HL7 FHIR, CarePlan.activity.detail.scheduled[x]
|
| ServiceDeliveryLocation | serviceDeliveryLocation |
"Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc." - HL7 FHIR, CarePlan.activity.detail.location
|
| «CS» Code | status |
"Identifies what progress is being made for the specific activity." - HL7 FHIR, CarePlan.activity.detail.status
|
| String | statusReason |
Provides further detail of the state of the Care Intervention beyond simply active and inactive, which is indicated by the status property."Provides reason why the activity isn't yet started, is on hold, was cancelled, etc." - HL7 FHIR, CarePlan.activity.detail.statusReason
|
Attributes inherited from  FHIM::Common::ActionStatement |
| category, currentStatus, description, indication, inputFinding, instantiatesCanonical, instantiatesUri, insurance, intent, justification, location, method, outputFinding, precondition, reasonCode, reasonNarrative, reasonReference, relevantHistory, scope, supportingInformation, usingDevice, wasReported |
| Attributes inherited from FHIM::Common::ClinicalStatement |
| clinicalDataSource, contentVersion, contextCode, encounter, note, recordStatus, relatedClinicalInformation, sourceRecordType, sourceSystem, subjectGroup, subjectOfInformation, subjectOfRecord, temporalContext, topicCode, cosigned, recorded, signed, verified |
| Attributes inherited from FHIM::Common::InformationEntry |
| identifier |
Properties:
| Alias | |
| Classifier Behavior | |
| Is Abstract | false |
| Is Active | false |
| Is Leaf | false |
| Keywords | |
| Name | CareIntervention |
| Name Expression | |
| Namespace | CarePlan |
| Owned Template Signature | |
| Owner | CarePlan |
| Owning Template Parameter | |
| Package | CarePlan |
| Qualified Name | FHIM::CarePlan::CareIntervention |
| Representation | |
| Stereotype | |
| Template Parameter | |
| Visibility | Public |
acceptanceReview
Public AcceptanceReview acceptanceReview
-
Pointer to a (set of) appraisals during which agreements to adopt proposed Care Plan actions are affirmed
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | careIntervention_acceptanceReview |
| Association End | |
| Class | CareIntervention |
| 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 | acceptanceReview |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::acceptanceReview |
| Stereotype | |
| Template Parameter | |
| Type | AcceptanceReview |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
activityOutcomeReview
Public ActivityOutcomeReview activityOutcomeReview
-
Pointer to an Observation describing any changes that resulted from the pursuit of the HealthGoal."Identifies the change (or lack of change) at the point where the goal was deemed to be cancelled or achieved." - HL7 FHIR, Goal.outcome.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | careIntervention_activityOutcomeReview |
| Association End | |
| Class | CareIntervention |
| 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 | activityOutcomeReview |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::activityOutcomeReview |
| Stereotype | |
| Template Parameter | |
| Type | ActivityOutcomeReview |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
applicability
Public «IVL_TS» Period applicability
-
"Applicability time point or time frame in which the activity may be carried out." - HL7 Care Plan Domain Analysis Model.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| 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 | applicability |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::applicability |
| Stereotype | |
| Template Parameter | |
| Type | «IVL_TS» Period |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
category
Public String category
-
This property is used to categorize the Care Intervention. Note that this property is currently modeled as a string because a single suitable valuset could not be identified at this time."A classification of the activity such as Patient Instruction, Medication Administration, Self Blood Glucose Monitoring, etc." - HL7 Care Plan Domain Analysis Model."Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter." - HL7 FHIR, CarePlan.activity.detail.code
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| Terminologies | [
HL7_FHIR_R4 Procedure codes http://hl7.org/fhir/ValueSet/procedure-code
] |
| 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 | category |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::category |
| Stereotype | ValueSetConstraints |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
doNotPerform
Public Boolean doNotPerform
-
"If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan." - HL7 FHIR, CarePlan.activity.detail.doNotPerform
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| 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 | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::doNotPerform |
| Stereotype | |
| Template Parameter | |
| Type | Boolean |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
healthGoal
Public «EntryPoint» HealthGoal healthGoal
-
"Internal reference that identifies the goals that this activity is intended to contribute towards meeting." - HL7 FHIR, CarePlan.activity.detail.goal
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | careIntervention_healthGoal |
| Association End | |
| Class | CareIntervention |
| 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 | healthGoal |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::healthGoal |
| Stereotype | |
| Template Parameter | |
| Type | «EntryPoint» HealthGoal |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
kind
Public «CS» Code kind
-
"A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest." Possible values are: Appointment; CommunicationRequest; DeviceRequest; MedicationRequest; NutritionOrder; Task; ServiceRequest; VisionPrescription. - HL7 FHIR, CarePlan.activity.detail.kind
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| Terminologies | [
HL7_FHIR_R4 Care Plan Activity Kind http://hl7.org/fhir/ValueSet/care-plan-activity-kind
] |
| 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 | kind |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::kind |
| Stereotype | ValueSetConstraints |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
performer
Public Participation performer
-
"Identifies who's expected to be involved in the activity." - HL7 FHIR, CarePlan.activity.detail.performer
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| 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 | performer |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::performer |
| Stereotype | |
| Template Parameter | |
| Type | Participation |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
planningStatus
Public «CS» Code planningStatus
-
The state of the Care Intervention with respect to the negotiation process. Possible values include: Proposed, Accepted, Rejected. This property has been modeled separately from the status property which only is used when the Care Intervention has been accepted. It is possible that these two kinds of statuses may be combined into a larger workflow-aware status, but they are modeled separately for now for compatibility with FHIR.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| Terminologies | [
FHIM_Defined_Content Intervention planning status 2.16.840.1.113883.3.2074.1.1.74
] |
| 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 | planningStatus |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::planningStatus |
| Stereotype | ValueSetConstraints |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
postCondition
Public String postCondition
-
"Any conditions expected to be true after the activity is carried out." - HL7 Care Plan Domain Analysis Model
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| 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 | postCondition |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::postCondition |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
preCondition
Public String preCondition
-
"Any required preconditions which must be before the activity can be carried out." - HL7 Care Plan Domain Analysis Model
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| 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 | preCondition |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::preCondition |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
product
Public OrderablePharmacyItem product
-
Pointer to a medicinal product that is to be used in the activity. Note that FHIR can point to a code, a medication, or a substance. In FHIM, this is handled by an Orderable Pharmacy Item"Identifies the food, drug or other product to be consumed or supplied in the activity." - HL7 FHIR, CarePlan.activity.detail.product[x]
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | (product:OrderablePharmacyItem) |
| Association End | |
| Class | CareIntervention |
| 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 | product |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::product |
| Stereotype | |
| Template Parameter | |
| Type | OrderablePharmacyItem |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
productDailyAmount
Public «PQ» Quantity productDailyAmount
-
"Identifies the quantity expected to be consumed in a given day." - HL7 FHIR, CarePlan.activity.detail.dailyAmount
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| 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 | productDailyAmount |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::productDailyAmount |
| Stereotype | |
| Template Parameter | |
| Type | «PQ» Quantity |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
productQuantity
Public «PQ» Quantity productQuantity
-
"Identifies the quantity expected to be supplied, administered or consumed by the subject." - HL7 FHIR, CarePlan.activity.detail.quantity
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| 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 | productQuantity |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::productQuantity |
| Stereotype | |
| Template Parameter | |
| Type | «PQ» Quantity |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
reason
Public HealthConcern reason
-
"Provides the health condition(s) or other rationale that drove the inclusion of this particular activity as part of the plan." - HL7 FHIR, CarePlan.activity.detail.reason[x]
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | careIntervention_reason |
| Association End | |
| Class | CareIntervention |
| 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 | reason |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::reason |
| Stereotype | |
| Template Parameter | |
| Type | HealthConcern |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
reference
Public ClinicalStatement reference
-
"The details of the proposed activity represented in a specific resource." - HL7 FHIR, CarePlan.activity.reference
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| 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 | reference |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::reference |
| Stereotype | |
| Template Parameter | |
| Type | ClinicalStatement |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
resourceAllocation
Public ResourceAllocation resourceAllocation
-
Pointer to any physical items or personnel that would be needed to fulfill the Intervention.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | careIntervention_resourceAllocation |
| Association End | |
| Class | CareIntervention |
| 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 | resourceAllocation |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::resourceAllocation |
| Stereotype | |
| Template Parameter | |
| Type | ResourceAllocation |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
responsibleParty
Public Participation responsibleParty
-
Identifies the Care Team Member (typically a Provider) who is responsible for the performance of the Care Intervention.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| 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 | responsibleParty |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::responsibleParty |
| Stereotype | |
| Template Parameter | |
| Type | Participation |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
scheduledPeriod
Public «TS» PointInTime scheduledPeriod
-
"The actual start instant of the activity." - HL7 Care Plan Domain Analysis Model."The end date/time of the activity." - HL7 Care Plan Domain Analysis Model."The period, timing or frequency upon which the described activity is to occur." - HL7 FHIR, CarePlan.activity.detail.scheduled[x]
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| 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 | scheduledPeriod |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::scheduledPeriod |
| Stereotype | |
| Template Parameter | |
| Type | «TS» PointInTime |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
scheduledTiming
Public Timing scheduledTiming
-
"Specification of repeating frequency of an activity." - HL7 Care Plan Domain Analysis Model"The period, timing or frequency upon which the described activity is to occur." - HL7 FHIR, CarePlan.activity.detail.scheduled[x]
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| 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 | scheduledTiming |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::scheduledTiming |
| Stereotype | |
| Template Parameter | |
| Type | Timing |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
serviceDeliveryLocation
Public ServiceDeliveryLocation serviceDeliveryLocation
-
"Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc." - HL7 FHIR, CarePlan.activity.detail.location
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | careIntervention_serviceDeliveryLocation |
| Association End | |
| Class | CareIntervention |
| 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 | serviceDeliveryLocation |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::serviceDeliveryLocation |
| Stereotype | |
| Template Parameter | |
| Type | ServiceDeliveryLocation |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
status
Public «CS» Code status
-
"Identifies what progress is being made for the specific activity." - HL7 FHIR, CarePlan.activity.detail.status
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| Terminologies | [
HL7_FHIR_R4 PlanInterventionStatus http://hl7.org/fhir/ValueSet/care-plan-activity-status
] |
| 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 | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::status |
| Stereotype | ValueSetConstraints |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
statusReason
Public String statusReason
-
Provides further detail of the state of the Care Intervention beyond simply active and inactive, which is indicated by the status property."Provides reason why the activity isn't yet started, is on hold, was cancelled, etc." - HL7 FHIR, CarePlan.activity.detail.statusReason
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | CareIntervention |
| 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 | statusReason |
| Name Expression | |
| Namespace | CareIntervention |
| Opposite | |
| Owner | CareIntervention |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CarePlan::CareIntervention::statusReason |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
-
| In the future, we might include an indication of the degree to which the Care Intervention conforms to the applicable Guideline(s) |
|
| CarePlan UML Documentation |