Person-Centered Outcomes, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/mtnlotus/pco-ig/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/pco/StructureDefinition/pco-prom-goal-profile | Version: 0.2.0 | |||
Draft as of 2024-12-13 | Computable Name: PCOGoalOutcomeMeasureProfile |
Person-centered goal with a Patient-Reported Outcome Measure (PROM) score target.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PCOGoalProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | 0..* | PCOGoalProfile | Describes the intended objective(s) for a patient, group or organization | |
target | 1..1 | BackboneElement | (USCDI) Target outcome for the goal | |
measure | S | 1..1 | CodeableConcept | Target score for evaluating PCO Goal using PROMs Binding: PROM Target Measures (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 | Target value for the PROM score |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Goal.target.measure | extensible | PROMTargetMeasureshttp://hl7.org/fhir/us/pco/ValueSet/prom-target-measures from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | 0..* | PCOGoalProfile | Describes the intended objective(s) for a patient, group or organization dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
lifecycleStatus | ?!SΣ | 1..1 | code | (USCDI) proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) ele-1: All FHIR elements must have a @value or children |
Slices for category | SΣ | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this Binding: GoalCategory (example): Codes for grouping and sorting goals. ele-1: All FHIR elements must have a @value or children |
category:pco-goal | SΣ | 1..1 | CodeableConcept | Person-Centered Goal category Binding: GoalCategory (example): Codes for grouping and sorting goals. ele-1: All FHIR elements must have a @value or children 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/pco/CodeSystem/pco-codes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: person-centered-goal | |
category:goal-domain | SΣ | 0..* | CodeableConcept | Person-Centered Outcome domain category Binding: PCO Domain Categories (preferred) ele-1: All FHIR elements must have a @value or children |
description | SΣ | 1..1 | CodeableConcept | (USCDI) Code or text describing goal Binding: US Core Goal Codes (extensible): Value set to describe the Goal ele-1: All FHIR elements must have a @value or children |
subject | SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) Who this goal is intended for ele-1: All FHIR elements must have a @value or children |
start[x] | SΣ | 1..1 | date | (USCDI) When goal pursuit begins ele-1: All FHIR elements must have a @value or children |
target | SC | 1..1 | BackboneElement | (USCDI) Target outcome for the goal ele-1: All FHIR elements must have a @value or children gol-1: Goal.target.measure is required if Goal.target.detail is populated |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
measure | SΣC | 1..1 | CodeableConcept | Target score for evaluating PCO Goal using PROMs Binding: PROM Target Measures (extensible) ele-1: All FHIR elements must have a @value or children |
Slices for detail[x] | ΣC | 1..1 | Quantity | The target value to be achieved Slice: Unordered, Closed by type:$this Binding Description (No ValueSet): (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. ele-1: All FHIR elements must have a @value or children |
detail[x]:detailQuantity | SΣC | 1..1 | Quantity | Target value for the PROM score Binding Description (No ValueSet): (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. ele-1: All FHIR elements must have a @value or children |
due[x] | SΣ | 0..1 | (USCDI) Reach goal on or before ele-1: All FHIR elements must have a @value or children | |
dueDate | date | |||
expressedBy | SΣ | 0..1 | Reference(US Core Patient Profile(6.1.0) | US Core Practitioner Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) | Who's responsible for creating Goal? ele-1: All FHIR elements must have a @value or children |
Slices for addresses | 0..* | Reference(Condition | Observation | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:resolve() ele-1: All FHIR elements must have a @value or children | |
addresses:SupportedAddresses | S | 0..* | Reference(What Matters Assessment | What Matters Statement) | What Matters Assessment or Statement ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Goal.lifecycleStatus | required | GoalLifecycleStatushttp://hl7.org/fhir/ValueSet/goal-status from the FHIR Standard | |
Goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category from the FHIR Standard | |
Goal.category:pco-goal | example | Pattern: person-centered-goalhttp://hl7.org/fhir/ValueSet/goal-category from the FHIR Standard | |
Goal.category:goal-domain | preferred | PCODomainCategoryValueSethttp://hl7.org/fhir/us/pco/ValueSet/pco-domain-category-valueset from this IG | |
Goal.description | extensible | USCoreGoalCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-goal-description | |
Goal.target.measure | extensible | PROMTargetMeasureshttp://hl7.org/fhir/us/pco/ValueSet/prom-target-measures from this IG | |
Goal.target.detail[x] | example | ||
Goal.target.detail[x]:detailQuantity | example |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Goal | 0..* | PCOGoalProfile | 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: 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 | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | External Ids for this goal | |||||
lifecycleStatus | ?!SΣ | 1..1 | code | (USCDI) proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) | ||||
achievementStatus | Σ | 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 | SΣ | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this Binding: GoalCategory (example): Codes for grouping and sorting goals. | ||||
category:pco-goal | SΣ | 1..1 | CodeableConcept | Person-Centered Goal category 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/pco/CodeSystem/pco-codes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: person-centered-goal | |||||
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 | |||||
category:goal-domain | SΣ | 0..* | CodeableConcept | Person-Centered Outcome domain category Binding: PCO Domain Categories (preferred) | ||||
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 | (USCDI) Code or text describing goal Binding: US Core Goal Codes (extensible): Value set to describe the Goal | ||||
subject | SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) Who this goal is intended for | ||||
start[x] | SΣ | 1..1 | date S | (USCDI) When goal pursuit begins | ||||
target | SC | 1..1 | BackboneElement | (USCDI) Target outcome for the goal gol-1: Goal.target.measure is required if Goal.target.detail is populated | ||||
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 | Target score for evaluating PCO Goal using PROMs Binding: PROM Target Measures (extensible) | ||||
Slices for detail[x] | ΣC | 1..1 | Quantity | The target value to be achieved Slice: Unordered, Closed by type:$this Binding Description (No ValueSet): (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 | Target value for the PROM score Binding Description (No ValueSet): (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. | ||||
due[x] | SΣ | 0..1 | (USCDI) Reach goal on or before | |||||
dueDate | date S | |||||||
dueDuration | Duration | |||||||
statusDate | Σ | 0..1 | date | When goal status took effect | ||||
statusReason | 0..1 | string | Reason for current status | |||||
expressedBy | SΣ | 0..1 | Reference(US Core Patient Profile(6.1.0) | US Core Practitioner Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) | Who's responsible for creating Goal? | ||||
Slices for addresses | 0..* | Reference(Condition | Observation | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:resolve() | |||||
addresses:SupportedAddresses | S | 0..* | Reference(What Matters Assessment | What Matters Statement) | What Matters Assessment or Statement | ||||
note | 0..* | Annotation | Comments about the goal | |||||
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 | URI | |||
Goal.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Goal.lifecycleStatus | required | GoalLifecycleStatushttp://hl7.org/fhir/ValueSet/goal-status from the FHIR Standard | ||||
Goal.achievementStatus | preferred | GoalAchievementStatushttp://hl7.org/fhir/ValueSet/goal-achievement from the FHIR Standard | ||||
Goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category from the FHIR Standard | ||||
Goal.category:pco-goal | example | Pattern: person-centered-goalhttp://hl7.org/fhir/ValueSet/goal-category from the FHIR Standard | ||||
Goal.category:goal-domain | preferred | PCODomainCategoryValueSethttp://hl7.org/fhir/us/pco/ValueSet/pco-domain-category-valueset from this IG | ||||
Goal.priority | preferred | GoalPriorityhttp://hl7.org/fhir/ValueSet/goal-priority from the FHIR Standard | ||||
Goal.description | extensible | USCoreGoalCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-goal-description | ||||
Goal.target.measure | extensible | PROMTargetMeasureshttp://hl7.org/fhir/us/pco/ValueSet/prom-target-measures from this IG | ||||
Goal.target.detail[x] | example | |||||
Goal.target.detail[x]:detailQuantity | example | |||||
Goal.outcomeCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from 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() |
This structure is derived from PCOGoalProfile
Summary
Mandatory: 4 elements
Must-Support: 2 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from PCOGoalProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | 0..* | PCOGoalProfile | Describes the intended objective(s) for a patient, group or organization | |
target | 1..1 | BackboneElement | (USCDI) Target outcome for the goal | |
measure | S | 1..1 | CodeableConcept | Target score for evaluating PCO Goal using PROMs Binding: PROM Target Measures (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 | Target value for the PROM score |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Goal.target.measure | extensible | PROMTargetMeasureshttp://hl7.org/fhir/us/pco/ValueSet/prom-target-measures from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | 0..* | PCOGoalProfile | Describes the intended objective(s) for a patient, group or organization dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
lifecycleStatus | ?!SΣ | 1..1 | code | (USCDI) proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) ele-1: All FHIR elements must have a @value or children |
Slices for category | SΣ | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this Binding: GoalCategory (example): Codes for grouping and sorting goals. ele-1: All FHIR elements must have a @value or children |
category:pco-goal | SΣ | 1..1 | CodeableConcept | Person-Centered Goal category Binding: GoalCategory (example): Codes for grouping and sorting goals. ele-1: All FHIR elements must have a @value or children 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/pco/CodeSystem/pco-codes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: person-centered-goal | |
category:goal-domain | SΣ | 0..* | CodeableConcept | Person-Centered Outcome domain category Binding: PCO Domain Categories (preferred) ele-1: All FHIR elements must have a @value or children |
description | SΣ | 1..1 | CodeableConcept | (USCDI) Code or text describing goal Binding: US Core Goal Codes (extensible): Value set to describe the Goal ele-1: All FHIR elements must have a @value or children |
subject | SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) Who this goal is intended for ele-1: All FHIR elements must have a @value or children |
start[x] | SΣ | 1..1 | date | (USCDI) When goal pursuit begins ele-1: All FHIR elements must have a @value or children |
target | SC | 1..1 | BackboneElement | (USCDI) Target outcome for the goal ele-1: All FHIR elements must have a @value or children gol-1: Goal.target.measure is required if Goal.target.detail is populated |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
measure | SΣC | 1..1 | CodeableConcept | Target score for evaluating PCO Goal using PROMs Binding: PROM Target Measures (extensible) ele-1: All FHIR elements must have a @value or children |
Slices for detail[x] | ΣC | 1..1 | Quantity | The target value to be achieved Slice: Unordered, Closed by type:$this Binding Description (No ValueSet): (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. ele-1: All FHIR elements must have a @value or children |
detail[x]:detailQuantity | SΣC | 1..1 | Quantity | Target value for the PROM score Binding Description (No ValueSet): (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. ele-1: All FHIR elements must have a @value or children |
due[x] | SΣ | 0..1 | (USCDI) Reach goal on or before ele-1: All FHIR elements must have a @value or children | |
dueDate | date | |||
expressedBy | SΣ | 0..1 | Reference(US Core Patient Profile(6.1.0) | US Core Practitioner Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) | Who's responsible for creating Goal? ele-1: All FHIR elements must have a @value or children |
Slices for addresses | 0..* | Reference(Condition | Observation | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:resolve() ele-1: All FHIR elements must have a @value or children | |
addresses:SupportedAddresses | S | 0..* | Reference(What Matters Assessment | What Matters Statement) | What Matters Assessment or Statement ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Goal.lifecycleStatus | required | GoalLifecycleStatushttp://hl7.org/fhir/ValueSet/goal-status from the FHIR Standard | |
Goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category from the FHIR Standard | |
Goal.category:pco-goal | example | Pattern: person-centered-goalhttp://hl7.org/fhir/ValueSet/goal-category from the FHIR Standard | |
Goal.category:goal-domain | preferred | PCODomainCategoryValueSethttp://hl7.org/fhir/us/pco/ValueSet/pco-domain-category-valueset from this IG | |
Goal.description | extensible | USCoreGoalCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-goal-description | |
Goal.target.measure | extensible | PROMTargetMeasureshttp://hl7.org/fhir/us/pco/ValueSet/prom-target-measures from this IG | |
Goal.target.detail[x] | example | ||
Goal.target.detail[x]:detailQuantity | example |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Goal | 0..* | PCOGoalProfile | 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: 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 | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | External Ids for this goal | |||||
lifecycleStatus | ?!SΣ | 1..1 | code | (USCDI) proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) | ||||
achievementStatus | Σ | 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 | SΣ | 1..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by pattern:$this Binding: GoalCategory (example): Codes for grouping and sorting goals. | ||||
category:pco-goal | SΣ | 1..1 | CodeableConcept | Person-Centered Goal category 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/pco/CodeSystem/pco-codes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: person-centered-goal | |||||
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 | |||||
category:goal-domain | SΣ | 0..* | CodeableConcept | Person-Centered Outcome domain category Binding: PCO Domain Categories (preferred) | ||||
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 | (USCDI) Code or text describing goal Binding: US Core Goal Codes (extensible): Value set to describe the Goal | ||||
subject | SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) Who this goal is intended for | ||||
start[x] | SΣ | 1..1 | date S | (USCDI) When goal pursuit begins | ||||
target | SC | 1..1 | BackboneElement | (USCDI) Target outcome for the goal gol-1: Goal.target.measure is required if Goal.target.detail is populated | ||||
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 | Target score for evaluating PCO Goal using PROMs Binding: PROM Target Measures (extensible) | ||||
Slices for detail[x] | ΣC | 1..1 | Quantity | The target value to be achieved Slice: Unordered, Closed by type:$this Binding Description (No ValueSet): (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 | Target value for the PROM score Binding Description (No ValueSet): (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal. | ||||
due[x] | SΣ | 0..1 | (USCDI) Reach goal on or before | |||||
dueDate | date S | |||||||
dueDuration | Duration | |||||||
statusDate | Σ | 0..1 | date | When goal status took effect | ||||
statusReason | 0..1 | string | Reason for current status | |||||
expressedBy | SΣ | 0..1 | Reference(US Core Patient Profile(6.1.0) | US Core Practitioner Profile(6.1.0) | US Core RelatedPerson Profile(6.1.0)) | Who's responsible for creating Goal? | ||||
Slices for addresses | 0..* | Reference(Condition | Observation | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:resolve() | |||||
addresses:SupportedAddresses | S | 0..* | Reference(What Matters Assessment | What Matters Statement) | What Matters Assessment or Statement | ||||
note | 0..* | Annotation | Comments about the goal | |||||
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 | URI | |||
Goal.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Goal.lifecycleStatus | required | GoalLifecycleStatushttp://hl7.org/fhir/ValueSet/goal-status from the FHIR Standard | ||||
Goal.achievementStatus | preferred | GoalAchievementStatushttp://hl7.org/fhir/ValueSet/goal-achievement from the FHIR Standard | ||||
Goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category from the FHIR Standard | ||||
Goal.category:pco-goal | example | Pattern: person-centered-goalhttp://hl7.org/fhir/ValueSet/goal-category from the FHIR Standard | ||||
Goal.category:goal-domain | preferred | PCODomainCategoryValueSethttp://hl7.org/fhir/us/pco/ValueSet/pco-domain-category-valueset from this IG | ||||
Goal.priority | preferred | GoalPriorityhttp://hl7.org/fhir/ValueSet/goal-priority from the FHIR Standard | ||||
Goal.description | extensible | USCoreGoalCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-goal-description | ||||
Goal.target.measure | extensible | PROMTargetMeasureshttp://hl7.org/fhir/us/pco/ValueSet/prom-target-measures from this IG | ||||
Goal.target.detail[x] | example | |||||
Goal.target.detail[x]:detailQuantity | example | |||||
Goal.outcomeCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from 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() |
This structure is derived from PCOGoalProfile
Summary
Mandatory: 4 elements
Must-Support: 2 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron