This page is part of the U.S. Physical Activity IG (v1.0.0: STU 1.0) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-goal | Version: 1.0.0 | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: PAGoal |
A goal that sets a target for a patient’s physical activity level
Goals might be set by clinicians, patients, caregivers and/or exercise professionals and their status and the notes on them might be updated by any of these individuals as well. Goals help patients and caregivers to better evaluate their day-to-day supporting measures and help provide motivation for change.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreGoalProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | C | 0..* | USCoreGoalProfile | Describes the intended objective(s) for a patient, group or organization pa-goal-1: Either a description or a target SHALL be provided (or both) |
implicitRules | 0..0 | |||
modifierExtension | 0..0 | |||
achievementStatus | S | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable |
Slices for category | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this | |
category:PA | S | 1..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
description | ||||
text | S | 0..1 | string | Plain text representation of the concept |
target | ||||
modifierExtension | 0..0 | |||
measure | S | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: PA Goal Target Measure Codes (extensible) |
Slices for detail[x] | 1..1 | Quantity | The target value to be achieved Slice: Unordered, Open by type:$this | |
detail[x]:detailQuantity | S | 1..1 | Quantity | The target value to be achieved |
value | S | 0..1 | decimal | Numerical value (with implicit precision) |
system | S | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | S | 0..1 | code | Coded form of the unit |
Slices for addresses | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:$this.resolve() |
addresses:PAIssues | S | 0..* | Reference(PA Condition - Low Physical Activity S | PA Observation - EVS, Minutes/Week S | PA Observation - EVS, Strength Days/Week S) | Issues addressed by this goal |
note | S | 0..* | Annotation | Comments about the goal |
author[x] | S | 1..1 | Reference(US Core Practitioner Profile S | US Core Organization Profile S | US Core Patient Profile S | PA Related Person) | Individual responsible for the annotation |
time | S | 1..1 | dateTime | When the annotation was made |
text | S | 1..1 | markdown | The annotation - text content (as markdown) |
Documentation for this format |
Path | Conformance | ValueSet |
Goal.target.measure | extensible | PAGoalMeasurement |
Id | Grade | Path(s) | Details | Requirements |
pa-goal-1 | error | Goal | Either a description or a target SHALL be provided (or both) : description.exists() or target.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | C | 0..* | USCoreGoalProfile | Describes the intended objective(s) for a patient, group or organization pa-goal-1: Either a description or a target SHALL be provided (or both) |
lifecycleStatus | ?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) |
achievementStatus | SΣ | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable Binding: GoalAchievementStatus (preferred): Indicates the progression, or lack thereof, towards the goal against the target. |
Slices for category | Σ | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this Binding: GoalCategory (example): Codes for grouping and sorting goals. |
category:PA | SΣ | 1..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example): Codes for grouping and sorting goals. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
description | SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: SNOMEDCTClinicalFindings (example): Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used. |
text | SΣ | 0..1 | string | Plain text representation of the concept |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
target | SC | 0..* | BackboneElement | Target outcome for the goal |
measure | SΣC | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: PA Goal Target Measure Codes (extensible) |
Slices for detail[x] | ΣC | 1..1 | Quantity | The target value to be achieved Slice: Unordered, Closed by type:$this Binding: (unbound) (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. |
detail[x]:detailQuantity | SΣC | 1..1 | Quantity | The target value to be achieved Binding: (unbound) (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. |
value | SΣ | 0..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
system | SΣC | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | SΣ | 0..1 | code | Coded form of the unit |
Slices for due[x] | Σ | 0..1 | date | Reach goal on or before Slice: Unordered, Closed by type:$this |
due[x]:dueDate | SΣ | 0..1 | date | Reach goal on or before |
Slices for addresses | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:$this.resolve() |
addresses:PAIssues | S | 0..* | Reference(PA Condition - Low Physical Activity | PA Observation - EVS, Minutes/Week | PA Observation - EVS, Strength Days/Week) | Issues addressed by this goal |
note | S | 0..* | Annotation | Comments about the goal |
author[x] | SΣ | 1..1 | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile) | Individual responsible for the annotation |
time | SΣ | 1..1 | dateTime | When the annotation was made |
text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Goal.lifecycleStatus | required | GoalLifecycleStatus |
Goal.achievementStatus | preferred | GoalAchievementStatus |
Goal.category | example | GoalCategory |
Goal.category:PA | example | Pattern: PhysicalActivity |
Goal.description | example | SNOMEDCTClinicalFindings |
Goal.target.measure | extensible | PAGoalMeasurement |
Goal.target.detail[x] | example | |
Goal.target.detail[x]:detailQuantity | example | |
Goal.target.detail[x]:detailQuantity.comparator | required | QuantityComparator |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Goal | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Goal | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
gol-1 | error | Goal.target | Goal.target.measure is required if Goal.target.detail is populated : (detail.exists() and measure.exists()) or detail.exists().not() | |
pa-goal-1 | error | Goal | Either a description or a target SHALL be provided (or both) : description.exists() or target.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Goal | C | 0..* | USCoreGoalProfile | Describes the intended objective(s) for a patient, group or organization pa-goal-1: Either a description or a target SHALL be provided (or both) | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
identifier | 0..* | Identifier | External Ids for this goal | |||||
lifecycleStatus | ?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) | ||||
achievementStatus | SΣ | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable Binding: GoalAchievementStatus (preferred): Indicates the progression, or lack thereof, towards the goal against the target. | ||||
Slices for category | Σ | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this Binding: GoalCategory (example): Codes for grouping and sorting goals. | ||||
category:PA | SΣ | 1..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example): Codes for grouping and sorting goals. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
priority | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): The level of importance associated with a goal. | ||||
description | SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: SNOMEDCTClinicalFindings (example): Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for | ||||
start[x] | Σ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |||||
startDate | date | |||||||
startCodeableConcept | CodeableConcept | |||||||
target | SC | 0..* | BackboneElement | Target outcome for the goal | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
measure | SΣC | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: PA Goal Target Measure Codes (extensible) | ||||
Slices for detail[x] | ΣC | 1..1 | Quantity | The target value to be achieved Slice: Unordered, Closed by type:$this Binding: (unbound) (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. | ||||
detail[x]:detailQuantity | SΣC | 1..1 | Quantity | The target value to be achieved Binding: (unbound) (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | SΣ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | SΣC | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
code | SΣ | 0..1 | code | Coded form of the unit | ||||
Slices for due[x] | Σ | 0..1 | date | Reach goal on or before Slice: Unordered, Closed by type:$this | ||||
due[x]:dueDate | SΣ | 0..1 | date | Reach goal on or before | ||||
statusDate | Σ | 0..1 | date | When goal status took effect | ||||
statusReason | 0..1 | string | Reason for current status | |||||
expressedBy | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? | ||||
Slices for addresses | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:$this.resolve() | ||||
addresses:PAIssues | S | 0..* | Reference(PA Condition - Low Physical Activity S | PA Observation - EVS, Minutes/Week S | PA Observation - EVS, Strength Days/Week S) | Issues addressed by this goal | ||||
note | S | 0..* | Annotation | Comments about the goal | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | SΣ | 1..1 | Reference(US Core Practitioner Profile S | US Core Organization Profile S | US Core Patient Profile S | PA Related Person) | Individual responsible for the annotation | ||||
time | SΣ | 1..1 | dateTime | When the annotation was made | ||||
text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
outcomeCode | 0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SNOMEDCTClinicalFindings (example): The result of the goal; e.g. "25% increase in shoulder mobility", "Anxiety reduced to moderate levels". "15 kg weight loss sustained over 6 months". | |||||
outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Goal.language | preferred | CommonLanguages
| ||||
Goal.lifecycleStatus | required | GoalLifecycleStatus | ||||
Goal.achievementStatus | preferred | GoalAchievementStatus | ||||
Goal.category | example | GoalCategory | ||||
Goal.category:PA | example | Pattern: PhysicalActivity | ||||
Goal.priority | preferred | GoalPriority | ||||
Goal.description | example | SNOMEDCTClinicalFindings | ||||
Goal.start[x] | example | GoalStartEvent | ||||
Goal.target.measure | extensible | PAGoalMeasurement | ||||
Goal.target.detail[x] | example | |||||
Goal.target.detail[x]:detailQuantity | example | |||||
Goal.target.detail[x]:detailQuantity.comparator | required | QuantityComparator | ||||
Goal.outcomeCode | example | SNOMEDCTClinicalFindings |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Goal | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Goal | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
gol-1 | error | Goal.target | Goal.target.measure is required if Goal.target.detail is populated : (detail.exists() and measure.exists()) or detail.exists().not() | |
pa-goal-1 | error | Goal | Either a description or a target SHALL be provided (or both) : description.exists() or target.exists() |
This structure is derived from USCoreGoalProfile
Summary
Mandatory: 2 elements (4 nested mandatory elements)
Must-Support: 14 elements
Fixed Value: 1 element
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Differential View
This structure is derived from USCoreGoalProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | C | 0..* | USCoreGoalProfile | Describes the intended objective(s) for a patient, group or organization pa-goal-1: Either a description or a target SHALL be provided (or both) |
implicitRules | 0..0 | |||
modifierExtension | 0..0 | |||
achievementStatus | S | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable |
Slices for category | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this | |
category:PA | S | 1..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
description | ||||
text | S | 0..1 | string | Plain text representation of the concept |
target | ||||
modifierExtension | 0..0 | |||
measure | S | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: PA Goal Target Measure Codes (extensible) |
Slices for detail[x] | 1..1 | Quantity | The target value to be achieved Slice: Unordered, Open by type:$this | |
detail[x]:detailQuantity | S | 1..1 | Quantity | The target value to be achieved |
value | S | 0..1 | decimal | Numerical value (with implicit precision) |
system | S | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | S | 0..1 | code | Coded form of the unit |
Slices for addresses | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:$this.resolve() |
addresses:PAIssues | S | 0..* | Reference(PA Condition - Low Physical Activity S | PA Observation - EVS, Minutes/Week S | PA Observation - EVS, Strength Days/Week S) | Issues addressed by this goal |
note | S | 0..* | Annotation | Comments about the goal |
author[x] | S | 1..1 | Reference(US Core Practitioner Profile S | US Core Organization Profile S | US Core Patient Profile S | PA Related Person) | Individual responsible for the annotation |
time | S | 1..1 | dateTime | When the annotation was made |
text | S | 1..1 | markdown | The annotation - text content (as markdown) |
Documentation for this format |
Path | Conformance | ValueSet |
Goal.target.measure | extensible | PAGoalMeasurement |
Id | Grade | Path(s) | Details | Requirements |
pa-goal-1 | error | Goal | Either a description or a target SHALL be provided (or both) : description.exists() or target.exists() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | C | 0..* | USCoreGoalProfile | Describes the intended objective(s) for a patient, group or organization pa-goal-1: Either a description or a target SHALL be provided (or both) |
lifecycleStatus | ?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) |
achievementStatus | SΣ | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable Binding: GoalAchievementStatus (preferred): Indicates the progression, or lack thereof, towards the goal against the target. |
Slices for category | Σ | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this Binding: GoalCategory (example): Codes for grouping and sorting goals. |
category:PA | SΣ | 1..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example): Codes for grouping and sorting goals. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
description | SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: SNOMEDCTClinicalFindings (example): Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used. |
text | SΣ | 0..1 | string | Plain text representation of the concept |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
target | SC | 0..* | BackboneElement | Target outcome for the goal |
measure | SΣC | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: PA Goal Target Measure Codes (extensible) |
Slices for detail[x] | ΣC | 1..1 | Quantity | The target value to be achieved Slice: Unordered, Closed by type:$this Binding: (unbound) (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. |
detail[x]:detailQuantity | SΣC | 1..1 | Quantity | The target value to be achieved Binding: (unbound) (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. |
value | SΣ | 0..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
system | SΣC | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | SΣ | 0..1 | code | Coded form of the unit |
Slices for due[x] | Σ | 0..1 | date | Reach goal on or before Slice: Unordered, Closed by type:$this |
due[x]:dueDate | SΣ | 0..1 | date | Reach goal on or before |
Slices for addresses | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:$this.resolve() |
addresses:PAIssues | S | 0..* | Reference(PA Condition - Low Physical Activity | PA Observation - EVS, Minutes/Week | PA Observation - EVS, Strength Days/Week) | Issues addressed by this goal |
note | S | 0..* | Annotation | Comments about the goal |
author[x] | SΣ | 1..1 | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile) | Individual responsible for the annotation |
time | SΣ | 1..1 | dateTime | When the annotation was made |
text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Goal.lifecycleStatus | required | GoalLifecycleStatus |
Goal.achievementStatus | preferred | GoalAchievementStatus |
Goal.category | example | GoalCategory |
Goal.category:PA | example | Pattern: PhysicalActivity |
Goal.description | example | SNOMEDCTClinicalFindings |
Goal.target.measure | extensible | PAGoalMeasurement |
Goal.target.detail[x] | example | |
Goal.target.detail[x]:detailQuantity | example | |
Goal.target.detail[x]:detailQuantity.comparator | required | QuantityComparator |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Goal | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Goal | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
gol-1 | error | Goal.target | Goal.target.measure is required if Goal.target.detail is populated : (detail.exists() and measure.exists()) or detail.exists().not() | |
pa-goal-1 | error | Goal | Either a description or a target SHALL be provided (or both) : description.exists() or target.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Goal | C | 0..* | USCoreGoalProfile | Describes the intended objective(s) for a patient, group or organization pa-goal-1: Either a description or a target SHALL be provided (or both) | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
identifier | 0..* | Identifier | External Ids for this goal | |||||
lifecycleStatus | ?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) | ||||
achievementStatus | SΣ | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable Binding: GoalAchievementStatus (preferred): Indicates the progression, or lack thereof, towards the goal against the target. | ||||
Slices for category | Σ | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this Binding: GoalCategory (example): Codes for grouping and sorting goals. | ||||
category:PA | SΣ | 1..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example): Codes for grouping and sorting goals. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
priority | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): The level of importance associated with a goal. | ||||
description | SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: SNOMEDCTClinicalFindings (example): Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for | ||||
start[x] | Σ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |||||
startDate | date | |||||||
startCodeableConcept | CodeableConcept | |||||||
target | SC | 0..* | BackboneElement | Target outcome for the goal | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
measure | SΣC | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: PA Goal Target Measure Codes (extensible) | ||||
Slices for detail[x] | ΣC | 1..1 | Quantity | The target value to be achieved Slice: Unordered, Closed by type:$this Binding: (unbound) (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. | ||||
detail[x]:detailQuantity | SΣC | 1..1 | Quantity | The target value to be achieved Binding: (unbound) (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | SΣ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | SΣC | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
code | SΣ | 0..1 | code | Coded form of the unit | ||||
Slices for due[x] | Σ | 0..1 | date | Reach goal on or before Slice: Unordered, Closed by type:$this | ||||
due[x]:dueDate | SΣ | 0..1 | date | Reach goal on or before | ||||
statusDate | Σ | 0..1 | date | When goal status took effect | ||||
statusReason | 0..1 | string | Reason for current status | |||||
expressedBy | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? | ||||
Slices for addresses | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:$this.resolve() | ||||
addresses:PAIssues | S | 0..* | Reference(PA Condition - Low Physical Activity S | PA Observation - EVS, Minutes/Week S | PA Observation - EVS, Strength Days/Week S) | Issues addressed by this goal | ||||
note | S | 0..* | Annotation | Comments about the goal | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | SΣ | 1..1 | Reference(US Core Practitioner Profile S | US Core Organization Profile S | US Core Patient Profile S | PA Related Person) | Individual responsible for the annotation | ||||
time | SΣ | 1..1 | dateTime | When the annotation was made | ||||
text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
outcomeCode | 0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SNOMEDCTClinicalFindings (example): The result of the goal; e.g. "25% increase in shoulder mobility", "Anxiety reduced to moderate levels". "15 kg weight loss sustained over 6 months". | |||||
outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Goal.language | preferred | CommonLanguages
| ||||
Goal.lifecycleStatus | required | GoalLifecycleStatus | ||||
Goal.achievementStatus | preferred | GoalAchievementStatus | ||||
Goal.category | example | GoalCategory | ||||
Goal.category:PA | example | Pattern: PhysicalActivity | ||||
Goal.priority | preferred | GoalPriority | ||||
Goal.description | example | SNOMEDCTClinicalFindings | ||||
Goal.start[x] | example | GoalStartEvent | ||||
Goal.target.measure | extensible | PAGoalMeasurement | ||||
Goal.target.detail[x] | example | |||||
Goal.target.detail[x]:detailQuantity | example | |||||
Goal.target.detail[x]:detailQuantity.comparator | required | QuantityComparator | ||||
Goal.outcomeCode | example | SNOMEDCTClinicalFindings |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Goal | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Goal | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
gol-1 | error | Goal.target | Goal.target.measure is required if Goal.target.detail is populated : (detail.exists() and measure.exists()) or detail.exists().not() | |
pa-goal-1 | error | Goal | Either a description or a target SHALL be provided (or both) : description.exists() or target.exists() |
This structure is derived from USCoreGoalProfile
Summary
Mandatory: 2 elements (4 nested mandatory elements)
Must-Support: 14 elements
Fixed Value: 1 element
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron