Physical Activity Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/physical-activity/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-goal | Version: 1.0.1 | |||
| 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![]() |
|---|---|---|---|---|
![]() | 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) |
![]() ![]() | 0..0 | |||
![]() ![]() | 0..0 | |||
![]() ![]() | S | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable |
![]() ![]() | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() | S | 1..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Required Pattern: At least the following |
![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
![]() ![]() | ||||
![]() ![]() ![]() | S | 0..1 | string | Plain text representation of the concept |
![]() ![]() | ||||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | S | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: PA Goal Target Measure Codes (extensible) |
![]() ![]() ![]() | 1..1 | Quantity | The target value to be achieved Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() | S | 1..1 | Quantity | The target value to be achieved |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | code | Coded form of the unit |
![]() ![]() | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:$this.resolve() |
![]() ![]() ![]() | S | 0..* | ReferenceRest(PA Condition - Low Physical Activity S | PA Observation - EVS, Minutes/Week S | PA Observation - EVS, Strength Days/Week S) | Issues addressed by this goal |
![]() ![]() | S | 0..* | Annotation | Comments about the goal |
![]() ![]() ![]() | S | 1..1 | ReferenceRestOrLogical(US Core Practitioner Profile S | US Core Organization Profile S | US Core Patient Profile S | PA Related Person) | Individual responsible for the annotation |
![]() ![]() ![]() | S | 1..1 | dateTime | When the annotation was made |
![]() ![]() ![]() | S | 1..1 | markdown | The annotation - text content (as markdown) |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Goal.target.measure | extensible | PAGoalMeasurementhttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-goal-target-measurefrom this IG |
| 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![]() |
|---|---|---|---|---|
![]() | 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) |
![]() ![]() | ?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) |
![]() ![]() | 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. |
![]() ![]() | Σ | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this Binding: GoalCategory (example): Codes for grouping and sorting goals. |
![]() ![]() ![]() | 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 |
![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
![]() ![]() | 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. |
![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() | SΣ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
![]() ![]() | SC | 0..* | BackboneElement | Target outcome for the goal gol-1: Goal.target.measure is required if Goal.target.detail is populated |
![]() ![]() ![]() | SΣC | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: PA Goal Target Measure Codes (extensible) |
![]() ![]() ![]() | Σ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. |
![]() ![]() ![]() ![]() | 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. |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
![]() ![]() ![]() ![]() ![]() | SΣC | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | code | Coded form of the unit |
![]() ![]() ![]() | Σ | 0..1 | date | Reach goal on or before Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() | SΣ | 0..1 | date | Reach goal on or before |
![]() ![]() | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:$this.resolve() |
![]() ![]() ![]() | S | 0..* | ReferenceRest(PA Condition - Low Physical Activity | PA Observation - EVS, Minutes/Week | PA Observation - EVS, Strength Days/Week) | Issues addressed by this goal |
![]() ![]() | S | 0..* | Annotation | Comments about the goal |
![]() ![]() ![]() | SΣ | 1..1 | ReferenceRestOrLogical(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile) | Individual responsible for the annotation |
![]() ![]() ![]() | SΣ | 1..1 | dateTime | When the annotation was made |
![]() ![]() ![]() | SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Goal.lifecycleStatus | required | GoalLifecycleStatushttp://hl7.org/fhir/ValueSet/goal-statusfrom the FHIR Standard | |
| Goal.achievementStatus | preferred | GoalAchievementStatushttp://hl7.org/fhir/ValueSet/goal-achievementfrom the FHIR Standard | |
| Goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-categoryfrom the FHIR Standard | |
| Goal.category:PA | example | Pattern: PhysicalActivityhttp://hl7.org/fhir/ValueSet/goal-categoryfrom the FHIR Standard | |
| Goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | |
| Goal.target.measure | extensible | PAGoalMeasurementhttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-goal-target-measurefrom this IG | |
| Goal.target.detail[x] | example | ||
| Goal.target.detail[x]:detailQuantity | example | ||
| Goal.target.detail[x]:detailQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard |
| 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![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | 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) | ||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() | 0..* | Identifier | External Ids for this goal | |||||
![]() ![]() | ?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) | ||||
![]() ![]() | 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. | ||||
![]() ![]() | Σ | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this Binding: GoalCategory (example): Codes for grouping and sorting goals. | ||||
![]() ![]() ![]() | 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 | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |||||
![]() ![]() | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): The level of importance associated with a goal. | ||||
![]() ![]() | 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. | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() | SΣ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for | ||||
![]() ![]() | Σ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |||||
![]() ![]() ![]() | date | |||||||
![]() ![]() ![]() | CodeableConcept | |||||||
![]() ![]() | SC | 0..* | BackboneElement | Target outcome for the goal gol-1: Goal.target.measure is required if Goal.target.detail is populated | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | SΣC | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: PA Goal Target Measure Codes (extensible) | ||||
![]() ![]() ![]() | Σ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. | ||||
![]() ![]() ![]() ![]() | 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. | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Unit representation | ||||
![]() ![]() ![]() ![]() ![]() | SΣC | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | code | Coded form of the unit | ||||
![]() ![]() ![]() | Σ | 0..1 | date | Reach goal on or before Slice: Unordered, Closed by type:$this | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | date | Reach goal on or before | ||||
![]() ![]() | Σ | 0..1 | date | When goal status took effect | ||||
![]() ![]() | 0..1 | string | Reason for current status | |||||
![]() ![]() | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? | ||||
![]() ![]() | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:$this.resolve() | ||||
![]() ![]() ![]() | S | 0..* | ReferenceRest(PA Condition - Low Physical Activity S | PA Observation - EVS, Minutes/Week S | PA Observation - EVS, Strength Days/Week S) | Issues addressed by this goal | ||||
![]() ![]() | S | 0..* | Annotation | Comments about the goal | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | SΣ | 1..1 | ReferenceRestOrLogical(US Core Practitioner Profile S | US Core Organization Profile S | US Core Patient Profile S | PA Related Person) | Individual responsible for the annotation | ||||
![]() ![]() ![]() | SΣ | 1..1 | dateTime | When the annotation was made | ||||
![]() ![]() ![]() | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
![]() ![]() | 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". | |||||
![]() ![]() | 0..* | Reference(Observation) | Observation that resulted from goal | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Goal.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Goal.lifecycleStatus | required | GoalLifecycleStatushttp://hl7.org/fhir/ValueSet/goal-statusfrom the FHIR Standard | ||||
| Goal.achievementStatus | preferred | GoalAchievementStatushttp://hl7.org/fhir/ValueSet/goal-achievementfrom the FHIR Standard | ||||
| Goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-categoryfrom the FHIR Standard | ||||
| Goal.category:PA | example | Pattern: PhysicalActivityhttp://hl7.org/fhir/ValueSet/goal-categoryfrom the FHIR Standard | ||||
| Goal.priority | preferred | GoalPriorityhttp://hl7.org/fhir/ValueSet/goal-priorityfrom the FHIR Standard | ||||
| Goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| Goal.start[x] | example | GoalStartEventhttp://hl7.org/fhir/ValueSet/goal-start-eventfrom the FHIR Standard | ||||
| Goal.target.measure | extensible | PAGoalMeasurementhttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-goal-target-measurefrom this IG | ||||
| Goal.target.detail[x] | example | |||||
| Goal.target.detail[x]:detailQuantity | example | |||||
| Goal.target.detail[x]:detailQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | ||||
| Goal.outcomeCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard |
| 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![]() |
|---|---|---|---|---|
![]() | 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) |
![]() ![]() | 0..0 | |||
![]() ![]() | 0..0 | |||
![]() ![]() | S | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable |
![]() ![]() | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() | S | 1..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Required Pattern: At least the following |
![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
![]() ![]() | ||||
![]() ![]() ![]() | S | 0..1 | string | Plain text representation of the concept |
![]() ![]() | ||||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | S | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: PA Goal Target Measure Codes (extensible) |
![]() ![]() ![]() | 1..1 | Quantity | The target value to be achieved Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() | S | 1..1 | Quantity | The target value to be achieved |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | code | Coded form of the unit |
![]() ![]() | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:$this.resolve() |
![]() ![]() ![]() | S | 0..* | ReferenceRest(PA Condition - Low Physical Activity S | PA Observation - EVS, Minutes/Week S | PA Observation - EVS, Strength Days/Week S) | Issues addressed by this goal |
![]() ![]() | S | 0..* | Annotation | Comments about the goal |
![]() ![]() ![]() | S | 1..1 | ReferenceRestOrLogical(US Core Practitioner Profile S | US Core Organization Profile S | US Core Patient Profile S | PA Related Person) | Individual responsible for the annotation |
![]() ![]() ![]() | S | 1..1 | dateTime | When the annotation was made |
![]() ![]() ![]() | S | 1..1 | markdown | The annotation - text content (as markdown) |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Goal.target.measure | extensible | PAGoalMeasurementhttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-goal-target-measurefrom this IG |
| 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![]() |
|---|---|---|---|---|
![]() | 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) |
![]() ![]() | ?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) |
![]() ![]() | 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. |
![]() ![]() | Σ | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this Binding: GoalCategory (example): Codes for grouping and sorting goals. |
![]() ![]() ![]() | 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 |
![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |
![]() ![]() | 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. |
![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() | SΣ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
![]() ![]() | SC | 0..* | BackboneElement | Target outcome for the goal gol-1: Goal.target.measure is required if Goal.target.detail is populated |
![]() ![]() ![]() | SΣC | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: PA Goal Target Measure Codes (extensible) |
![]() ![]() ![]() | Σ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. |
![]() ![]() ![]() ![]() | 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. |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
![]() ![]() ![]() ![]() ![]() | SΣC | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | code | Coded form of the unit |
![]() ![]() ![]() | Σ | 0..1 | date | Reach goal on or before Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() | SΣ | 0..1 | date | Reach goal on or before |
![]() ![]() | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:$this.resolve() |
![]() ![]() ![]() | S | 0..* | ReferenceRest(PA Condition - Low Physical Activity | PA Observation - EVS, Minutes/Week | PA Observation - EVS, Strength Days/Week) | Issues addressed by this goal |
![]() ![]() | S | 0..* | Annotation | Comments about the goal |
![]() ![]() ![]() | SΣ | 1..1 | ReferenceRestOrLogical(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile) | Individual responsible for the annotation |
![]() ![]() ![]() | SΣ | 1..1 | dateTime | When the annotation was made |
![]() ![]() ![]() | SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Goal.lifecycleStatus | required | GoalLifecycleStatushttp://hl7.org/fhir/ValueSet/goal-statusfrom the FHIR Standard | |
| Goal.achievementStatus | preferred | GoalAchievementStatushttp://hl7.org/fhir/ValueSet/goal-achievementfrom the FHIR Standard | |
| Goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-categoryfrom the FHIR Standard | |
| Goal.category:PA | example | Pattern: PhysicalActivityhttp://hl7.org/fhir/ValueSet/goal-categoryfrom the FHIR Standard | |
| Goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | |
| Goal.target.measure | extensible | PAGoalMeasurementhttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-goal-target-measurefrom this IG | |
| Goal.target.detail[x] | example | ||
| Goal.target.detail[x]:detailQuantity | example | ||
| Goal.target.detail[x]:detailQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard |
| 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![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | 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) | ||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() | 0..* | Identifier | External Ids for this goal | |||||
![]() ![]() | ?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) | ||||
![]() ![]() | 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. | ||||
![]() ![]() | Σ | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this Binding: GoalCategory (example): Codes for grouping and sorting goals. | ||||
![]() ![]() ![]() | 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 | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PhysicalActivity | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |||||
![]() ![]() | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): The level of importance associated with a goal. | ||||
![]() ![]() | 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. | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() | SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() | SΣ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for | ||||
![]() ![]() | Σ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |||||
![]() ![]() ![]() | date | |||||||
![]() ![]() ![]() | CodeableConcept | |||||||
![]() ![]() | SC | 0..* | BackboneElement | Target outcome for the goal gol-1: Goal.target.measure is required if Goal.target.detail is populated | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | SΣC | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: PA Goal Target Measure Codes (extensible) | ||||
![]() ![]() ![]() | Σ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. | ||||
![]() ![]() ![]() ![]() | 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. | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Unit representation | ||||
![]() ![]() ![]() ![]() ![]() | SΣC | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | code | Coded form of the unit | ||||
![]() ![]() ![]() | Σ | 0..1 | date | Reach goal on or before Slice: Unordered, Closed by type:$this | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | date | Reach goal on or before | ||||
![]() ![]() | Σ | 0..1 | date | When goal status took effect | ||||
![]() ![]() | 0..1 | string | Reason for current status | |||||
![]() ![]() | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? | ||||
![]() ![]() | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:$this.resolve() | ||||
![]() ![]() ![]() | S | 0..* | ReferenceRest(PA Condition - Low Physical Activity S | PA Observation - EVS, Minutes/Week S | PA Observation - EVS, Strength Days/Week S) | Issues addressed by this goal | ||||
![]() ![]() | S | 0..* | Annotation | Comments about the goal | ||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | SΣ | 1..1 | ReferenceRestOrLogical(US Core Practitioner Profile S | US Core Organization Profile S | US Core Patient Profile S | PA Related Person) | Individual responsible for the annotation | ||||
![]() ![]() ![]() | SΣ | 1..1 | dateTime | When the annotation was made | ||||
![]() ![]() ![]() | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
![]() ![]() | 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". | |||||
![]() ![]() | 0..* | Reference(Observation) | Observation that resulted from goal | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Goal.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Goal.lifecycleStatus | required | GoalLifecycleStatushttp://hl7.org/fhir/ValueSet/goal-statusfrom the FHIR Standard | ||||
| Goal.achievementStatus | preferred | GoalAchievementStatushttp://hl7.org/fhir/ValueSet/goal-achievementfrom the FHIR Standard | ||||
| Goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-categoryfrom the FHIR Standard | ||||
| Goal.category:PA | example | Pattern: PhysicalActivityhttp://hl7.org/fhir/ValueSet/goal-categoryfrom the FHIR Standard | ||||
| Goal.priority | preferred | GoalPriorityhttp://hl7.org/fhir/ValueSet/goal-priorityfrom the FHIR Standard | ||||
| Goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| Goal.start[x] | example | GoalStartEventhttp://hl7.org/fhir/ValueSet/goal-start-eventfrom the FHIR Standard | ||||
| Goal.target.measure | extensible | PAGoalMeasurementhttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-goal-target-measurefrom this IG | ||||
| Goal.target.detail[x] | example | |||||
| Goal.target.detail[x]:detailQuantity | example | |||||
| Goal.target.detail[x]:detailQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | ||||
| Goal.outcomeCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard |
| 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