| CarePlan UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
An objective intended to be realized by the successful execution of the Care Plan. "A health goal specifies a future target or achievement towards which the effort of care planning and execution is directed. Goals represent concrete targets to reduce or eliminate concerns or risks. A Goal may exist in the absence of concerns or risks. For example, a patient may have a goal to improve their fitness level. The plan always has at least one goal." - HL7 Care Plan Domain Analysis Model."Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc." - HL7 FHIR, GoalNote that a goal might be constructed of sub-goals, which might each be associated with a single outcome. For example, a goal to loose 5 pounds per week over 6 weeks might spawn 6 child goals to loose 5 pounds in week 1, week 2, etc. Each child goal would be associated with one actual outcome (i.e., lost 4 pounds in week 1; lost 6 pounds in week 2, etc). Then the "parent" goal outcome could be the total (e.g., lost 28 pounds in 6 weeks).
Attributes | ||
AcceptanceReview | acceptanceReview |
Pointer to a (set of) appraisals of whether the patient is in agreement with the Health Goal. For example, the clinician may want the patient to lose twenty pounds, but the patient is only grudgingly in agreeement. |
«CS» Code | achievementStatus |
"Specifies a judgment on the goal achievement state" - HL7 Care Plan Domain Analysis Model"Describes the progression, or lack thereof, towards the goal against the target." Possible values are: In Progress; Improving; Worsening; No Change; Achieved; Sustaining; Not Achieved; No Progress; Not Attainable.- HL7 FHIR, Goal.achievementStatus |
CareIntervention | careIntervention |
Pointer to a (set of) action(s) (treatment, procedure, or activity) designed to achieve an outcome for a diagnosis for which the clinician is accountable."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.activity |
«CS» Code | category |
"Names or describes the goal" - HL7 Care Plan Domain Analysis Model"Indicates a category the goal falls within." - HL7 FHIR, Goal.category |
«TS» PointInTime | dateEstablished |
The date (and optionally, the time) on which the Health Goal was agreed upon. |
String | description |
A summary of the health objective, whether articulated by the patient or by a clinician. Note that this description may include an indication of whether the goal is to achieve, maintain, manage or avoid a particular condition or circumstance."The goal intent is a modifier of the goal purpose and indicates whether the goal target is something to achieve, maintain, manage or avoid. For example, in late stage diabetes the only path may be to simply manage or control the condition." - HL7 Care Plan Domain Analysis Model"Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding"." - HL7 FHIR, Goal.description |
Participation | expressedBy |
Identifies who determined the Goal. FHIR allows a reference to Patient, Practitioner, or RelatedPerson, so FHIM uses the Participation construct. The FHIM PatientParticipation, PractitionerParticipation, UnAffilliatedParticipation classes correspond to the FHIR ones. The FHIM Participation construct has other participation constructs (such as DeviceParticipation) which would not be used."Indicates whose goal this is - patient goal, practitioner goal, etc." - HL7 FHIR, Goal.expressedBy |
String | goalIntent |
"The goal intent is a modifier of the goal purpose and indicates whether the goal target is something to achieve, maintain, manage or avoid. For example, in late stage diabetes the only path may be to simply manage or control the condition." - HL7 Care Plan Domain Analysis Model |
GoalReview | goalReview |
Pointer to a (set of) assessments of the progress made toward reaching a Goal of the Care Plan. |
GoalSuccessCriterion | goalSuccessCriterion |
Pointer to a statement of a desired future state, expressed as an Observation. |
HealthConcern | healthConcern |
Pointer to the Health Concern(s) (aka Problem(s), or Condition(s)) which the Goal is intended to improve. Note that the FHIR Goal.addresses property can point to multiple resource types, including Condition, Observation, MedicationStatement, NutritionOrder, ProcedureRequest, or RiskAssessment, wherease FHIM currently only points to HealthConcern."The identified conditions and other health record elements that are intended to be addressed by the goal." - HL7 FHIR, Goal.addresses |
«II» Id | identifier |
"This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)." - HL7 FHIR, Goal.identifier |
«CS» Code | lifecycleStatus |
This property indicates the state of the Health Goal within a workflow or within its life-cycle. Note that the progress of the patient towards the goal, or status of the achievement of the goal is not defined by this field, but rather in the goalAchievementState property."Indicates the implementation stage for the goal and related plan components." - HL7 Care Plan Domain Analysis Model."The state of the goal throughout its lifecycle." Possbile values are: Proposed; Planned; Accepted; Active; On Hold; Completed; Cancelled; Entered in Error; Rejected. - HL7 FHIR, Goal.lifecycleStatus. Note that this value set is slightly different from the recordStatus property inherited from Clinical Statement. Therefore, we have added this property for now, but it could conceivably be handled by the recordStatus. |
String | narrative |
"Captures comments or notes about the goal" - HL7 Care Plan Domain Analysis Model"Any comments related to the goal." - HL7 FHIR, Goal.notes. |
String | priority |
"Indicates the preference order to use for care planning purposes. The goal supports multiple priorities in order to support multiple care team perspectives and eventual harmonization." - HL7 Care Plan Domain Analysis Model."Identifies the mutually agreed level of importance associated with reaching/sustaining the goal." - HL7 FHIR, Goal.priority |
«TS» PointInTime | startDate |
The date upon which the activities towards accomplishing the Goal commenced or is expected to commence. Note that FHIR allows either a date or an event (a code) here. For now, the FHIM only has the date."The date or event after which the goal should begin being pursued." - HL7 FHIR, Goal.start[x] |
«TS» PointInTime | statusDate |
"Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc." - HL7 FHIR, Goal.statusDate |
String | statusReason |
"Captures the reason for the current status." - HL7 FHIR, Goal.statusReason |
«TS» PointInTime | targetDate |
The date upon which the goal should be met. Note that FHIR allows either a Date or a Duration, but FHIM only models a date at this time."Desired target date for meeting the goal." - HL7 Care Plan Domain Analysis Model."Indicates either the date or the duration after start by which the goal should be met." - HL7 FHIR, Goal.target.due[x] |
«CS» Code | targetMeasure |
"The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level." - HL7 FHIR, Goal.target.measure |
«ANY» Any | targetValue |
"The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value." - HL7 FHIR, Goal.target.detail[x] |
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 | EntryPoint |
Name | HealthGoal |
Name Expression | |
Namespace | CarePlan |
Owned Template Signature | |
Owner | CarePlan |
Owning Template Parameter | |
Package | CarePlan |
Qualified Name | FHIM::CarePlan::HealthGoal |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public AcceptanceReview acceptanceReview
Pointer to a (set of) appraisals of whether the patient is in agreement with the Health Goal. For example, the clinician may want the patient to lose twenty pounds, but the patient is only grudgingly in agreeement.
Aggregation | None |
Alias | |
Association | healthGoal_acceptanceReview |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::acceptanceReview |
Stereotype | |
Template Parameter | |
Type | AcceptanceReview |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code achievementStatus
"Specifies a judgment on the goal achievement state" - HL7 Care Plan Domain Analysis Model"Describes the progression, or lack thereof, towards the goal against the target." Possible values are: In Progress; Improving; Worsening; No Change; Achieved; Sustaining; Not Achieved; No Progress; Not Attainable.- HL7 FHIR, Goal.achievementStatus
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
Terminologies | [ HL7_FHIR_R4 Goal achievement status " http://hl7.org/fhir/ValueSet/goal-achievement" ] |
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 | achievementStatus |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::achievementStatus |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public CareIntervention careIntervention
Pointer to a (set of) action(s) (treatment, procedure, or activity) designed to achieve an outcome for a diagnosis for which the clinician is accountable."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.activity
Aggregation | None |
Alias | |
Association | healthGoal_careIntervention |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | careIntervention |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::careIntervention |
Stereotype | |
Template Parameter | |
Type | CareIntervention |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code category
"Names or describes the goal" - HL7 Care Plan Domain Analysis Model"Indicates a category the goal falls within." - HL7 FHIR, Goal.category
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
Terminologies | [ HL7_FHIR_R4 Health goal kind http://hl7.org/fhir/ValueSet/goal-category ] |
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 | category |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::category |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «TS» PointInTime dateEstablished
The date (and optionally, the time) on which the Health Goal was agreed upon.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | dateEstablished |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::dateEstablished |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String description
A summary of the health objective, whether articulated by the patient or by a clinician. Note that this description may include an indication of whether the goal is to achieve, maintain, manage or avoid a particular condition or circumstance."The goal intent is a modifier of the goal purpose and indicates whether the goal target is something to achieve, maintain, manage or avoid. For example, in late stage diabetes the only path may be to simply manage or control the condition." - HL7 Care Plan Domain Analysis Model"Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding"." - HL7 FHIR, Goal.description
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
Terminologies | [ HL7_FHIR_R4 Clinical Findings http://hl7.org/fhir/ValueSet/clinical-findings ] |
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 | description |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::description |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Participation expressedBy
Identifies who determined the Goal. FHIR allows a reference to Patient, Practitioner, or RelatedPerson, so FHIM uses the Participation construct. The FHIM PatientParticipation, PractitionerParticipation, UnAffilliatedParticipation classes correspond to the FHIR ones. The FHIM Participation construct has other participation constructs (such as DeviceParticipation) which would not be used."Indicates whose goal this is - patient goal, practitioner goal, etc." - HL7 FHIR, Goal.expressedBy
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | expressedBy |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::expressedBy |
Stereotype | |
Template Parameter | |
Type | Participation |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String goalIntent
"The goal intent is a modifier of the goal purpose and indicates whether the goal target is something to achieve, maintain, manage or avoid. For example, in late stage diabetes the only path may be to simply manage or control the condition." - HL7 Care Plan Domain Analysis Model
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | goalIntent |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::goalIntent |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public GoalReview goalReview
Pointer to a (set of) assessments of the progress made toward reaching a Goal of the Care Plan.
Aggregation | None |
Alias | |
Association | healthGoal_goalReview |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | goalReview |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::goalReview |
Stereotype | |
Template Parameter | |
Type | GoalReview |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public GoalSuccessCriterion goalSuccessCriterion
Pointer to a statement of a desired future state, expressed as an Observation.
Aggregation | None |
Alias | |
Association | healthGoal_goalSuccessCriterion |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | goalSuccessCriterion |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::goalSuccessCriterion |
Stereotype | |
Template Parameter | |
Type | GoalSuccessCriterion |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public HealthConcern healthConcern
Pointer to the Health Concern(s) (aka Problem(s), or Condition(s)) which the Goal is intended to improve. Note that the FHIR Goal.addresses property can point to multiple resource types, including Condition, Observation, MedicationStatement, NutritionOrder, ProcedureRequest, or RiskAssessment, wherease FHIM currently only points to HealthConcern."The identified conditions and other health record elements that are intended to be addressed by the goal." - HL7 FHIR, Goal.addresses
Aggregation | None |
Alias | |
Association | healthGoal_healthConcern |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | healthConcern |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::healthConcern |
Stereotype | |
Template Parameter | |
Type | HealthConcern |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «II» Id identifier
"This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)." - HL7 FHIR, Goal.identifier
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | identifier |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::identifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code lifecycleStatus
This property indicates the state of the Health Goal within a workflow or within its life-cycle. Note that the progress of the patient towards the goal, or status of the achievement of the goal is not defined by this field, but rather in the goalAchievementState property."Indicates the implementation stage for the goal and related plan components." - HL7 Care Plan Domain Analysis Model."The state of the goal throughout its lifecycle." Possbile values are: Proposed; Planned; Accepted; Active; On Hold; Completed; Cancelled; Entered in Error; Rejected. - HL7 FHIR, Goal.lifecycleStatus. Note that this value set is slightly different from the recordStatus property inherited from Clinical Statement. Therefore, we have added this property for now, but it could conceivably be handled by the recordStatus.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
Terminologies | [ HL7_FHIR_R4 Goal Lifecycle Status http://hl7.org/fhir/ValueSet/goal-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 | lifecycleStatus |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::lifecycleStatus |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String narrative
"Captures comments or notes about the goal" - HL7 Care Plan Domain Analysis Model"Any comments related to the goal." - HL7 FHIR, Goal.notes.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | narrative |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::narrative |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String priority
"Indicates the preference order to use for care planning purposes. The goal supports multiple priorities in order to support multiple care team perspectives and eventual harmonization." - HL7 Care Plan Domain Analysis Model."Identifies the mutually agreed level of importance associated with reaching/sustaining the goal." - HL7 FHIR, Goal.priority
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
Terminologies | [ HL7_FHIR_R4 Goal priority http://hl7.org/fhir/ValueSet/goal-priority ] |
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 | priority |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::priority |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime startDate
The date upon which the activities towards accomplishing the Goal commenced or is expected to commence. Note that FHIR allows either a date or an event (a code) here. For now, the FHIM only has the date."The date or event after which the goal should begin being pursued." - HL7 FHIR, Goal.start[x]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | startDate |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::startDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime statusDate
"Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc." - HL7 FHIR, Goal.statusDate
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | statusDate |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::statusDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String statusReason
"Captures the reason for the current status." - HL7 FHIR, Goal.statusReason
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::statusReason |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime targetDate
The date upon which the goal should be met. Note that FHIR allows either a Date or a Duration, but FHIM only models a date at this time."Desired target date for meeting the goal." - HL7 Care Plan Domain Analysis Model."Indicates either the date or the duration after start by which the goal should be met." - HL7 FHIR, Goal.target.due[x]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | targetDate |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::targetDate |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code targetMeasure
"The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level." - HL7 FHIR, Goal.target.measure
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | targetMeasure |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::targetMeasure |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «ANY» Any targetValue
"The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value." - HL7 FHIR, Goal.target.detail[x]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «EntryPoint» HealthGoal |
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 | targetValue |
Name Expression | |
Namespace | «EntryPoint» HealthGoal |
Opposite | |
Owner | «EntryPoint» HealthGoal |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CarePlan::HealthGoal::targetValue |
Stereotype | |
Template Parameter | |
Type | «ANY» Any |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| CarePlan UML Documentation |
Summary:AttributesProperties | Detail:Attributes |