This page is part of the SDOH Clinical Care for Multiple Domains (v1.1.0: STU 2 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Goal |
Version: | 1.1.0 |
Name: | SDOHCCGoal |
Title: | SDOHCC Goal |
Status: | Draft as of 12/14/20 4:01 AM |
Definition: | Profile for goals that address Social Determinants of Health (SDOH). |
Publisher: | HL7 International - Patient Care WG |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Goal
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreGoalProfile
Summary
Mandatory: 1 element
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from USCoreGoalProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | 0..* | USCoreGoalProfile | Describes the intended SDOH-related objective(s) for a patient. | |
achievementStatus | S | 1..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable |
Slices for category | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by value:$this | |
category:SDOH | S | 0..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
description | 1..1 | CodeableConcept | Code or text describing goal Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred): Codes providing the details of a particular goal. In many systems, only the text element will be used. | |
subject | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for | |
target | ||||
measure | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINCCodes (preferred) | |
statusDate | 0..1 | date | When goal status took effect | |
Slices for addresses | 0..* | Reference(Condition | Observation | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:resolve() | |
addresses:SupportedAddresses | S | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | Issues addressed by this goal |
outcomeCode | 0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred): The result of the goal; e.g., "Food security", "Has access to a car ". | |
Slices for outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal Slice: Unordered, Open by profile:resolve() | |
outcomeReference:SupportedOutcomeReference | S | 0..* | Reference(SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | Observation that resulted from goal |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | 0..* | USCoreGoalProfile | Describes the intended SDOH-related objective(s) for a patient. | |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) |
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. |
Slices for category | Σ | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by value:$this Binding: GoalCategory (example): Codes for grouping and sorting goals. |
category:SDOH | SΣ | 0..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
priority | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): The level of importance associated with a goal. |
description | SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred): Codes providing the details of a particular goal. In many systems, only the text element will be used. |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
start[x] | Σ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |
startDate | date | |||
startCodeableConcept | CodeableConcept | |||
target | SI | 0..* | BackboneElement | Target outcome for the goal |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
measure | ΣI | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINCCodes (preferred) |
detail[x] | ΣI | 0..1 | 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. | |
detailQuantity | Quantity | |||
detailRange | Range | |||
detailCodeableConcept | CodeableConcept | |||
detailString | string | |||
detailBoolean | boolean | |||
detailInteger | integer | |||
detailRatio | Ratio | |||
due[x] | SΣ | 0..1 | 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 | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | 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(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | Issues addressed by this goal |
note | 0..* | Annotation | Comments about the goal | |
outcomeCode | 0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred): The result of the goal; e.g., "Food security", "Has access to a car ". | |
Slices for outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal Slice: Unordered, Open by profile:resolve() | |
outcomeReference:SupportedOutcomeReference | S | 0..* | Reference(SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | Observation that resulted from goal |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | 0..* | USCoreGoalProfile | Describes the intended SDOH-related objective(s) for a patient. | |
lifecycleStatus | ?!Σ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) |
achievementStatus | Σ | 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:SDOH | Σ | 0..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
description | Σ | 1..1 | CodeableConcept | Code or text describing goal Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred): Codes providing the details of a particular goal. In many systems, only the text element will be used. |
subject | Σ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
target | I | 0..* | BackboneElement | Target outcome for the goal |
due[x] | Σ | 0..1 | Reach goal on or before | |
dueDate | date | |||
addresses:SupportedAddresses | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | Issues addressed by this goal | |
outcomeReference:SupportedOutcomeReference | 0..* | Reference(SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | Observation that resulted from goal | |
Documentation for this format |
This structure is derived from USCoreGoalProfile
Summary
Mandatory: 1 element
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from USCoreGoalProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | 0..* | USCoreGoalProfile | Describes the intended SDOH-related objective(s) for a patient. | |
achievementStatus | S | 1..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable |
Slices for category | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by value:$this | |
category:SDOH | S | 0..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
description | 1..1 | CodeableConcept | Code or text describing goal Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred): Codes providing the details of a particular goal. In many systems, only the text element will be used. | |
subject | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for | |
target | ||||
measure | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINCCodes (preferred) | |
statusDate | 0..1 | date | When goal status took effect | |
Slices for addresses | 0..* | Reference(Condition | Observation | RiskAssessment) | Issues addressed by this goal Slice: Unordered, Open by profile:resolve() | |
addresses:SupportedAddresses | S | 0..* | Reference(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | Issues addressed by this goal |
outcomeCode | 0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred): The result of the goal; e.g., "Food security", "Has access to a car ". | |
Slices for outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal Slice: Unordered, Open by profile:resolve() | |
outcomeReference:SupportedOutcomeReference | S | 0..* | Reference(SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | Observation that resulted from goal |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | 0..* | USCoreGoalProfile | Describes the intended SDOH-related objective(s) for a patient. | |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) |
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. |
Slices for category | Σ | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Slice: Unordered, Open by value:$this Binding: GoalCategory (example): Codes for grouping and sorting goals. |
category:SDOH | SΣ | 0..* | CodeableConcept | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
priority | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): The level of importance associated with a goal. |
description | SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred): Codes providing the details of a particular goal. In many systems, only the text element will be used. |
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
start[x] | Σ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |
startDate | date | |||
startCodeableConcept | CodeableConcept | |||
target | SI | 0..* | BackboneElement | Target outcome for the goal |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
measure | ΣI | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINCCodes (preferred) |
detail[x] | ΣI | 0..1 | 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. | |
detailQuantity | Quantity | |||
detailRange | Range | |||
detailCodeableConcept | CodeableConcept | |||
detailString | string | |||
detailBoolean | boolean | |||
detailInteger | integer | |||
detailRatio | Ratio | |||
due[x] | SΣ | 0..1 | 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 | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | 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(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | Issues addressed by this goal |
note | 0..* | Annotation | Comments about the goal | |
outcomeCode | 0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SDOHCC ValueSet LOINC SNOMEDCT (preferred): The result of the goal; e.g., "Food security", "Has access to a car ". | |
Slices for outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal Slice: Unordered, Open by profile:resolve() | |
outcomeReference:SupportedOutcomeReference | S | 0..* | Reference(SDOHCC Observation Screening Response | SDOHCC Observation Assessment) | Observation that resulted from goal |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Goal.language | preferred | CommonLanguages Max Binding: AllLanguages |
Goal.lifecycleStatus | required | GoalLifecycleStatus |
Goal.achievementStatus | preferred | GoalAchievementStatus |
Goal.category | example | GoalCategory |
Goal.category:SDOH | required | SDOHCCValueSetSDOHCategory |
Goal.priority | preferred | GoalPriority |
Goal.description | preferred | SDOHCCValueSetLOINCSNOMEDCT |
Goal.start[x] | example | GoalStartEvent |
Goal.target.measure | preferred | LOINCCodes |
Goal.target.detail[x] | example | |
Goal.outcomeCode | preferred | SDOHCCValueSetLOINCSNOMEDCT |
Id | Path | Details | Requirements |
dom-2 | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | 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 | 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 | Goal | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Goal | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | Goal.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Goal.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Goal.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Goal.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Goal.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.lifecycleStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.achievementStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.category:SDOH | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.start[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.target | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
gol-1 | Goal.target | Goal.target.measure is required if Goal.target.detail is populated : (detail.exists() and measure.exists()) or detail.exists().not() | |
ele-1 | Goal.target.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Goal.target.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Goal.target.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Goal.target.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Goal.target.measure | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.target.detail[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.target.due[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.statusDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.expressedBy | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.addresses | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.addresses:SupportedAddresses | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.outcomeCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.outcomeReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Goal.outcomeReference:SupportedOutcomeReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |