Care Coordination Management, published by Helex OÜ. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/helexlab/ig-ccm/ and changes regularly. See the Directory of published versions
Resource Profile: GoalCcm
| Official URL: http://helex.org/ig/ccm/StructureDefinition/goal-ccm | Version: 0.0.1 | |||
| Draft as of 2025-12-05 | Computable Name: GoalCcm | |||
CCM Goal profile linking a patient with a ResearchStudy and tracking lifecycle via progress entries.
Usages:
- Refer to this Profile: CarePlanCcm
- Examples for this Profile: Goal/goal-activity-ccm-example
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Goal |
0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| lifecycleStatus |
?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted. |
 achievementStatus |
SΣ | 1..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. |
| category |
SΣ | 1..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc Binding: https://dev.termx.org/api/fhir/ValueSet/goal-category--1.0.0 (required) |
| description |
SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: https://dev.termx.org/api/fhir/ValueSet/goal-description--1.0.0 (required) |
 subject |
SΣ | 1..1 | Reference(PatientCcm) | Who this goal is intended for |
  Slices for start[x] |
Σ | 0..1 | When goal pursuit begins Slice: Unordered, Open by type:$this Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |
  startDate |
date | |||
| startCodeableConcept |
CodeableConcept | |||
  start[x]:startDate |
SΣ | 0..1 | date | When goal pursuit begins |
| target |
SC | 0..* | BackboneElement | Target outcome for the goal Constraints: gol-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| measure |
SΣC | 1..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. |
  detail[x] |
SΣC | 1..1 | The target value to be achieved Binding Description: (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. | |
 detailQuantity |
Quantity | |||
| detailRange |
Range | |||
| detailCodeableConcept |
CodeableConcept | |||
| detailString |
string | |||
| detailBoolean |
boolean | |||
| detailInteger |
integer | |||
 detailRatio |
Ratio | |||
| statusDate |
SΣ | 0..1 | date | When goal status took effect |
| note |
S | 0..* | Annotation | Comments about the goal |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Goal.lifecycleStatus | Base | required | Goal Lifecycle Status | 📍5.0.0 | FHIR Std. |
| Goal.achievementStatus | Base | preferred | Goal Achievement Status | 📍5.0.0 | FHIR Std. |
| Goal.category | Base | required | https://dev.termx.org/api/fhir/ValueSet/goal-category--1.0.0 | Not State | Unknown |
| Goal.description | Base | required | https://dev.termx.org/api/fhir/ValueSet/goal-description--1.0.0 | Not State | Unknown |
| Goal.start[x] | Base | example | Goal Start Event | 📍5.0.0 | FHIR Std. |
| Goal.target.measure | Base | example | LOINC Codes | 📍5.0.0 | FHIR Std. |
| Goal.target.detail[x] | Base | example | Not State | Unknown |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
This structure is derived from Goal
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Goal |
0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |
 identifier |
0..0 | External Ids for this goal | ||
| lifecycleStatus |
S | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected |
| achievementStatus |
S | 1..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable |
| category |
S | 1..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc Binding: https://dev.termx.org/api/fhir/ValueSet/goal-category--1.0.0 (required) |
| continuous |
0..0 | After meeting the goal, ongoing activity is needed to sustain the goal objective | ||
| priority |
0..0 | high-priority | medium-priority | low-priority | ||
| description |
S | 1..1 | CodeableConcept | Code or text describing goal Binding: https://dev.termx.org/api/fhir/ValueSet/goal-description--1.0.0 (required) |
| subject |
S | 1..1 | Reference(PatientCcm) | Who this goal is intended for |
| Slices for start[x] |
0..1 | date, CodeableConcept | When goal pursuit begins Slice: Unordered, Open by type:$this | |
| start[x]:startDate |
S | 0..1 | date | When goal pursuit begins |
| target |
S | 0..* | BackboneElement | Target outcome for the goal |
| measure |
S | 1..1 | CodeableConcept | The parameter whose value is being tracked |
| detail[x] |
S | 1..1 | Quantity, Range, CodeableConcept, string, boolean, integer, Ratio | The target value to be achieved |
| statusDate |
S | 0..1 | date | When goal status took effect |
| source |
0..0 | Who's responsible for creating Goal? | ||
| addresses |
0..0 | Issues addressed by this goal | ||
| note |
S | 0..* | Annotation | Comments about the goal |
| outcome |
0..0 | What result was achieved regarding the goal? | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Goal.category | Base | required | https://dev.termx.org/api/fhir/ValueSet/goal-category--1.0.0 | Not State | Unknown |
| Goal.description | Base | required | https://dev.termx.org/api/fhir/ValueSet/goal-description--1.0.0 | Not State | Unknown |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Goal |
0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| lifecycleStatus |
?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted. | ||||
| achievementStatus |
SΣ | 1..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. | ||||
| category |
SΣ | 1..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc Binding: https://dev.termx.org/api/fhir/ValueSet/goal-category--1.0.0 (required) | ||||
| description |
SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: https://dev.termx.org/api/fhir/ValueSet/goal-description--1.0.0 (required) | ||||
| subject |
SΣ | 1..1 | Reference(PatientCcm) | Who this goal is intended for | ||||
| Slices for start[x] |
Σ | 0..1 | When goal pursuit begins Slice: Unordered, Open by type:$this Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |||||
| startDate |
date | |||||||
| startCodeableConcept |
CodeableConcept | |||||||
| start[x]:startDate |
SΣ | 0..1 | date | When goal pursuit begins | ||||
| target |
SC | 0..* | BackboneElement | Target outcome for the goal Constraints: gol-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| measure |
SΣC | 1..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. | ||||
| detail[x] |
SΣC | 1..1 | The target value to be achieved Binding Description: (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. | |||||
| detailQuantity |
Quantity | |||||||
| detailRange |
Range | |||||||
| detailCodeableConcept |
CodeableConcept | |||||||
| detailString |
string | |||||||
| detailBoolean |
boolean | |||||||
| detailInteger |
integer | |||||||
| detailRatio |
Ratio | |||||||
| due[x] |
Σ | 0..1 | Reach goal on or before | |||||
| dueDate |
date | |||||||
| dueDuration |
Duration | |||||||
| statusDate |
SΣ | 0..1 | date | When goal status took effect | ||||
| statusReason |
0..1 | string | Reason for current status | |||||
| note |
S | 0..* | Annotation | Comments about the goal | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Goal.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Goal.lifecycleStatus | Base | required | Goal Lifecycle Status | 📍5.0.0 | FHIR Std. |
| Goal.achievementStatus | Base | preferred | Goal Achievement Status | 📍5.0.0 | FHIR Std. |
| Goal.category | Base | required | https://dev.termx.org/api/fhir/ValueSet/goal-category--1.0.0 | Not State | Unknown |
| Goal.description | Base | required | https://dev.termx.org/api/fhir/ValueSet/goal-description--1.0.0 | Not State | Unknown |
| Goal.start[x] | Base | example | Goal Start Event | 📍5.0.0 | FHIR Std. |
| Goal.target.measure | Base | example | LOINC Codes | 📍5.0.0 | FHIR Std. |
| Goal.target.detail[x] | Base | example | Not State | Unknown |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
This structure is derived from Goal
Summary
Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 11 elements
Prohibited: 6 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Goal.start[x]
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Goal |
0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| lifecycleStatus |
?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted. |
| achievementStatus |
SΣ | 1..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. |
| category |
SΣ | 1..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc Binding: https://dev.termx.org/api/fhir/ValueSet/goal-category--1.0.0 (required) |
| description |
SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: https://dev.termx.org/api/fhir/ValueSet/goal-description--1.0.0 (required) |
| subject |
SΣ | 1..1 | Reference(PatientCcm) | Who this goal is intended for |
| Slices for start[x] |
Σ | 0..1 | When goal pursuit begins Slice: Unordered, Open by type:$this Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |
| startDate |
date | |||
| startCodeableConcept |
CodeableConcept | |||
| start[x]:startDate |
SΣ | 0..1 | date | When goal pursuit begins |
| target |
SC | 0..* | BackboneElement | Target outcome for the goal Constraints: gol-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| measure |
SΣC | 1..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. |
| detail[x] |
SΣC | 1..1 | The target value to be achieved Binding Description: (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. | |
| detailQuantity |
Quantity | |||
| detailRange |
Range | |||
| detailCodeableConcept |
CodeableConcept | |||
| detailString |
string | |||
| detailBoolean |
boolean | |||
| detailInteger |
integer | |||
| detailRatio |
Ratio | |||
| statusDate |
SΣ | 0..1 | date | When goal status took effect |
| note |
S | 0..* | Annotation | Comments about the goal |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Goal.lifecycleStatus | Base | required | Goal Lifecycle Status | 📍5.0.0 | FHIR Std. |
| Goal.achievementStatus | Base | preferred | Goal Achievement Status | 📍5.0.0 | FHIR Std. |
| Goal.category | Base | required | https://dev.termx.org/api/fhir/ValueSet/goal-category--1.0.0 | Not State | Unknown |
| Goal.description | Base | required | https://dev.termx.org/api/fhir/ValueSet/goal-description--1.0.0 | Not State | Unknown |
| Goal.start[x] | Base | example | Goal Start Event | 📍5.0.0 | FHIR Std. |
| Goal.target.measure | Base | example | LOINC Codes | 📍5.0.0 | FHIR Std. |
| Goal.target.detail[x] | Base | example | Not State | Unknown |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
Differential View
This structure is derived from Goal
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Goal |
0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |
| identifier |
0..0 | External Ids for this goal | ||
| lifecycleStatus |
S | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected |
| achievementStatus |
S | 1..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable |
| category |
S | 1..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc Binding: https://dev.termx.org/api/fhir/ValueSet/goal-category--1.0.0 (required) |
| continuous |
0..0 | After meeting the goal, ongoing activity is needed to sustain the goal objective | ||
| priority |
0..0 | high-priority | medium-priority | low-priority | ||
| description |
S | 1..1 | CodeableConcept | Code or text describing goal Binding: https://dev.termx.org/api/fhir/ValueSet/goal-description--1.0.0 (required) |
| subject |
S | 1..1 | Reference(PatientCcm) | Who this goal is intended for |
| Slices for start[x] |
0..1 | date, CodeableConcept | When goal pursuit begins Slice: Unordered, Open by type:$this | |
| start[x]:startDate |
S | 0..1 | date | When goal pursuit begins |
| target |
S | 0..* | BackboneElement | Target outcome for the goal |
| measure |
S | 1..1 | CodeableConcept | The parameter whose value is being tracked |
| detail[x] |
S | 1..1 | Quantity, Range, CodeableConcept, string, boolean, integer, Ratio | The target value to be achieved |
| statusDate |
S | 0..1 | date | When goal status took effect |
| source |
0..0 | Who's responsible for creating Goal? | ||
| addresses |
0..0 | Issues addressed by this goal | ||
| note |
S | 0..* | Annotation | Comments about the goal |
| outcome |
0..0 | What result was achieved regarding the goal? | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Goal.category | Base | required | https://dev.termx.org/api/fhir/ValueSet/goal-category--1.0.0 | Not State | Unknown |
| Goal.description | Base | required | https://dev.termx.org/api/fhir/ValueSet/goal-description--1.0.0 | Not State | Unknown |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Goal |
0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| lifecycleStatus |
?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted. | ||||
| achievementStatus |
SΣ | 1..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. | ||||
| category |
SΣ | 1..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc Binding: https://dev.termx.org/api/fhir/ValueSet/goal-category--1.0.0 (required) | ||||
| description |
SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: https://dev.termx.org/api/fhir/ValueSet/goal-description--1.0.0 (required) | ||||
| subject |
SΣ | 1..1 | Reference(PatientCcm) | Who this goal is intended for | ||||
| Slices for start[x] |
Σ | 0..1 | When goal pursuit begins Slice: Unordered, Open by type:$this Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |||||
| startDate |
date | |||||||
| startCodeableConcept |
CodeableConcept | |||||||
| start[x]:startDate |
SΣ | 0..1 | date | When goal pursuit begins | ||||
| target |
SC | 0..* | BackboneElement | Target outcome for the goal Constraints: gol-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| measure |
SΣC | 1..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. | ||||
| detail[x] |
SΣC | 1..1 | The target value to be achieved Binding Description: (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. | |||||
| detailQuantity |
Quantity | |||||||
| detailRange |
Range | |||||||
| detailCodeableConcept |
CodeableConcept | |||||||
| detailString |
string | |||||||
| detailBoolean |
boolean | |||||||
| detailInteger |
integer | |||||||
| detailRatio |
Ratio | |||||||
| due[x] |
Σ | 0..1 | Reach goal on or before | |||||
| dueDate |
date | |||||||
| dueDuration |
Duration | |||||||
| statusDate |
SΣ | 0..1 | date | When goal status took effect | ||||
| statusReason |
0..1 | string | Reason for current status | |||||
| note |
S | 0..* | Annotation | Comments about the goal | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Goal.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Goal.lifecycleStatus | Base | required | Goal Lifecycle Status | 📍5.0.0 | FHIR Std. |
| Goal.achievementStatus | Base | preferred | Goal Achievement Status | 📍5.0.0 | FHIR Std. |
| Goal.category | Base | required | https://dev.termx.org/api/fhir/ValueSet/goal-category--1.0.0 | Not State | Unknown |
| Goal.description | Base | required | https://dev.termx.org/api/fhir/ValueSet/goal-description--1.0.0 | Not State | Unknown |
| Goal.start[x] | Base | example | Goal Start Event | 📍5.0.0 | FHIR Std. |
| Goal.target.measure | Base | example | LOINC Codes | 📍5.0.0 | FHIR Std. |
| Goal.target.detail[x] | Base | example | Not State | Unknown |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
|
This structure is derived from Goal
Summary
Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 11 elements
Prohibited: 6 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Goal.start[x]
Other representations of profile: CSV, Excel, Schematron