1.5.3 - release

SHINNYHRSN - Local Development build (v1.5.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: SHINNY SDOHCCGoal Profile

Official URL: http://shinny.org/us/ny/hrsn/StructureDefinition/shinny-SDOHCCGoal Version: 1.5.3
Computable Name: SHINNYSDOHCCGoalProfile

  • SHINNY HRSN: Needed for the Assessment. Included in all Assessment bundles.
  • Profiled off of the SDOHCC Goal:Profile for goals that address Social Determinants of Health (SDOH).

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..* SDOHCCGoal Describes the intended SDOH-related objective(s) for a patient.
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
... id SΣ 1..1 id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
... meta SΣ 1..1 SHINNYMeta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
... 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
... lifecycleStatus ?!SΣ 1..1 code 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
... achievementStatus SΣ 0..1 CodeableConcept in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
Binding: GoalAchievementStatus (preferred): Indicates the progression, or lack thereof, towards the goal against the target.


ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
.... category:SDOH SΣ 0..* CodeableConcept e.g., food-insecurity | transportation-insecurity
Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.


ele-1: All FHIR elements must have a @value or children
... 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.

Additional BindingsPurposeUsage
SDOHCC ValueSet LOINC SNOMEDCT Preferred Goal.category = digital-access
SDOHCC ValueSet LOINC SNOMEDCT Preferred Goal.category = digital-literacy
Less Than High School Education Goals . Extensible Goal.category = educational-attainment
Elder Abuse Goals . Extensible Goal.category = elder-abuse
Unemployment Goals . Extensible Goal.category = employment-status
Financial Insecurity Goals . Extensible Goal.category = financial-insecurity
Food Insecurity Goals . Extensible Goal.category = food-insecurity
Health Insurance Coverage Status Goals . Extensible Goal.category = health-insurance-coverage-status
Homelessness Goals . Extensible Goal.category = homelessness
Housing Instability Goals . Extensible Goal.category = housing-instability
Inadequate Housing Goals . Extensible Goal.category = inadequate-housing
Intimate Partner Violence Goals . Extensible Goal.category = intimate-partner-violence
Material Hardship Goals . Extensible Goal.category = material-hardship
Medical Cost Burden Goals . Extensible Goal.category = medical-cost-burden
Health Literacy Goals . Extensible Goal.category = personal-health-literacy
Social Connection Goals . Extensible Goal.category = social-connection
Stress Goals . Extensible Goal.category = stress
Transportation Insecurity Goals . Extensible Goal.category = transportation-insecurity
Utility Insecurity Goals . Extensible Goal.category = utility-insecurity
Veteran Status Goals . Extensible Goal.category = veteran-status
SDOHCC ValueSet LOINC SNOMEDCT Preferred Goal.category = sdoh-category-unspecified

ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(US Core Patient Profile) Who this goal is intended for
ele-1: All FHIR elements must have a @value or children
... target SC 0..* BackboneElement 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
.... Slices for due[x] Σ 0..1 date Reach goal on or before
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
..... due[x]:dueDate SΣ 0..1 date Reach goal on or before
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(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) Issues addressed by this goal
ele-1: All FHIR elements must have a @value or children
... Slices for outcomeReference 0..* Reference(Observation) Observation that resulted from goal
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
.... outcomeReference:SupportedOutcomeReference S 0..* Reference(SDOHCC Observation Screening Response | SDOHCC Observation Assessment) Observation that resulted from goal
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Goal.lifecycleStatusrequiredGoalLifecycleStatus
http://hl7.org/fhir/ValueSet/goal-status
from the FHIR Standard
Goal.achievementStatuspreferredGoalAchievementStatus
http://hl7.org/fhir/ValueSet/goal-achievement
from the FHIR Standard
Goal.categoryexampleGoalCategory
http://hl7.org/fhir/ValueSet/goal-category
from the FHIR Standard
Goal.category:SDOHrequiredSDOHCCValueSetSDOHCategory
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
Goal.descriptionpreferredSDOHCCValueSetLOINCSNOMEDCT
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetLOINCSNOMEDCT

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGoalIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGoalIf 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-4errorGoalIf 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-5errorGoalIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGoalA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gol-1errorGoal.targetGoal.target.measure is required if Goal.target.detail is populated
: (detail.exists() and measure.exists()) or detail.exists().not()

This structure is derived from SDOHCCGoal

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..* SDOHCCGoal Describes the intended SDOH-related objective(s) for a patient.
... id S 1..1 id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
... meta S 1..1 SHINNYMeta Metadata about the resource

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..* SDOHCCGoal Describes the intended SDOH-related objective(s) for a patient.
... id SΣ 1..1 id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
... meta SΣ 1..1 SHINNYMeta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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Σ 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 Σ 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.

Additional BindingsPurposeUsage
SDOHCC ValueSet LOINC SNOMEDCT Preferred Goal.category = digital-access
SDOHCC ValueSet LOINC SNOMEDCT Preferred Goal.category = digital-literacy
Less Than High School Education Goals . Extensible Goal.category = educational-attainment
Elder Abuse Goals . Extensible Goal.category = elder-abuse
Unemployment Goals . Extensible Goal.category = employment-status
Financial Insecurity Goals . Extensible Goal.category = financial-insecurity
Food Insecurity Goals . Extensible Goal.category = food-insecurity
Health Insurance Coverage Status Goals . Extensible Goal.category = health-insurance-coverage-status
Homelessness Goals . Extensible Goal.category = homelessness
Housing Instability Goals . Extensible Goal.category = housing-instability
Inadequate Housing Goals . Extensible Goal.category = inadequate-housing
Intimate Partner Violence Goals . Extensible Goal.category = intimate-partner-violence
Material Hardship Goals . Extensible Goal.category = material-hardship
Medical Cost Burden Goals . Extensible Goal.category = medical-cost-burden
Health Literacy Goals . Extensible Goal.category = personal-health-literacy
Social Connection Goals . Extensible Goal.category = social-connection
Stress Goals . Extensible Goal.category = stress
Transportation Insecurity Goals . Extensible Goal.category = transportation-insecurity
Utility Insecurity Goals . Extensible Goal.category = utility-insecurity
Veteran Status Goals . Extensible Goal.category = veteran-status
SDOHCC ValueSet LOINC SNOMEDCT Preferred Goal.category = sdoh-category-unspecified
... subject SΣ 1..1 Reference(US Core Patient Profile) Who this goal is intended for
... start[x] Σ 0..1 When goal pursuit begins
Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal.

.... startDate date
.... startCodeableConcept CodeableConcept
... target SC 0..* BackboneElement Target outcome for the goal
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 ΣC 0..1 CodeableConcept The parameter whose value is being tracked
Binding: LOINCCodes (preferred): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

.... detail[x] ΣC 0..1 The target value to be achieved
Binding Description (No ValueSet): (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
.... Slices for due[x] Σ 0..1 date Reach goal on or before
Slice: Unordered, Closed by type:$this
..... due[x]:dueDate SΣ 0..1 date Reach goal on or before
... statusDate Σ 0..1 date When goal status took effect
... statusReason 0..1 string Reason for current status
... expressedBy Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) Who's responsible for creating Goal?
... Slices for addresses 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Goal.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Goal.lifecycleStatusrequiredGoalLifecycleStatus
http://hl7.org/fhir/ValueSet/goal-status
from the FHIR Standard
Goal.achievementStatuspreferredGoalAchievementStatus
http://hl7.org/fhir/ValueSet/goal-achievement
from the FHIR Standard
Goal.categoryexampleGoalCategory
http://hl7.org/fhir/ValueSet/goal-category
from the FHIR Standard
Goal.category:SDOHrequiredSDOHCCValueSetSDOHCategory
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
Goal.prioritypreferredGoalPriority
http://hl7.org/fhir/ValueSet/goal-priority
from the FHIR Standard
Goal.descriptionpreferredSDOHCCValueSetLOINCSNOMEDCT
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetLOINCSNOMEDCT
Goal.start[x]exampleGoalStartEvent
http://hl7.org/fhir/ValueSet/goal-start-event
from the FHIR Standard
Goal.target.measurepreferredLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Goal.target.detail[x]example
Goal.outcomeCodepreferredSDOHCCValueSetLOINCSNOMEDCT
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetLOINCSNOMEDCT

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGoalIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGoalIf 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-4errorGoalIf 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-5errorGoalIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGoalA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gol-1errorGoal.targetGoal.target.measure is required if Goal.target.detail is populated
: (detail.exists() and measure.exists()) or detail.exists().not()

This structure is derived from SDOHCCGoal

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..* SDOHCCGoal Describes the intended SDOH-related objective(s) for a patient.
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
... id SΣ 1..1 id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
... meta SΣ 1..1 SHINNYMeta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
... 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
... lifecycleStatus ?!SΣ 1..1 code 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
... achievementStatus SΣ 0..1 CodeableConcept in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
Binding: GoalAchievementStatus (preferred): Indicates the progression, or lack thereof, towards the goal against the target.


ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
.... category:SDOH SΣ 0..* CodeableConcept e.g., food-insecurity | transportation-insecurity
Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.


ele-1: All FHIR elements must have a @value or children
... 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.

Additional BindingsPurposeUsage
SDOHCC ValueSet LOINC SNOMEDCT Preferred Goal.category = digital-access
SDOHCC ValueSet LOINC SNOMEDCT Preferred Goal.category = digital-literacy
Less Than High School Education Goals . Extensible Goal.category = educational-attainment
Elder Abuse Goals . Extensible Goal.category = elder-abuse
Unemployment Goals . Extensible Goal.category = employment-status
Financial Insecurity Goals . Extensible Goal.category = financial-insecurity
Food Insecurity Goals . Extensible Goal.category = food-insecurity
Health Insurance Coverage Status Goals . Extensible Goal.category = health-insurance-coverage-status
Homelessness Goals . Extensible Goal.category = homelessness
Housing Instability Goals . Extensible Goal.category = housing-instability
Inadequate Housing Goals . Extensible Goal.category = inadequate-housing
Intimate Partner Violence Goals . Extensible Goal.category = intimate-partner-violence
Material Hardship Goals . Extensible Goal.category = material-hardship
Medical Cost Burden Goals . Extensible Goal.category = medical-cost-burden
Health Literacy Goals . Extensible Goal.category = personal-health-literacy
Social Connection Goals . Extensible Goal.category = social-connection
Stress Goals . Extensible Goal.category = stress
Transportation Insecurity Goals . Extensible Goal.category = transportation-insecurity
Utility Insecurity Goals . Extensible Goal.category = utility-insecurity
Veteran Status Goals . Extensible Goal.category = veteran-status
SDOHCC ValueSet LOINC SNOMEDCT Preferred Goal.category = sdoh-category-unspecified

ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(US Core Patient Profile) Who this goal is intended for
ele-1: All FHIR elements must have a @value or children
... target SC 0..* BackboneElement 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
.... Slices for due[x] Σ 0..1 date Reach goal on or before
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
..... due[x]:dueDate SΣ 0..1 date Reach goal on or before
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(SDOHCC Condition | SDOHCC Observation Screening Response | SDOHCC Observation Assessment) Issues addressed by this goal
ele-1: All FHIR elements must have a @value or children
... Slices for outcomeReference 0..* Reference(Observation) Observation that resulted from goal
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
.... outcomeReference:SupportedOutcomeReference S 0..* Reference(SDOHCC Observation Screening Response | SDOHCC Observation Assessment) Observation that resulted from goal
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Goal.lifecycleStatusrequiredGoalLifecycleStatus
http://hl7.org/fhir/ValueSet/goal-status
from the FHIR Standard
Goal.achievementStatuspreferredGoalAchievementStatus
http://hl7.org/fhir/ValueSet/goal-achievement
from the FHIR Standard
Goal.categoryexampleGoalCategory
http://hl7.org/fhir/ValueSet/goal-category
from the FHIR Standard
Goal.category:SDOHrequiredSDOHCCValueSetSDOHCategory
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
Goal.descriptionpreferredSDOHCCValueSetLOINCSNOMEDCT
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetLOINCSNOMEDCT

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGoalIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGoalIf 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-4errorGoalIf 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-5errorGoalIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGoalA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gol-1errorGoal.targetGoal.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 SDOHCCGoal

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..* SDOHCCGoal Describes the intended SDOH-related objective(s) for a patient.
... id S 1..1 id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
... meta S 1..1 SHINNYMeta Metadata about the resource

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..* SDOHCCGoal Describes the intended SDOH-related objective(s) for a patient.
... id SΣ 1..1 id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
... meta SΣ 1..1 SHINNYMeta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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Σ 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 Σ 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.

Additional BindingsPurposeUsage
SDOHCC ValueSet LOINC SNOMEDCT Preferred Goal.category = digital-access
SDOHCC ValueSet LOINC SNOMEDCT Preferred Goal.category = digital-literacy
Less Than High School Education Goals . Extensible Goal.category = educational-attainment
Elder Abuse Goals . Extensible Goal.category = elder-abuse
Unemployment Goals . Extensible Goal.category = employment-status
Financial Insecurity Goals . Extensible Goal.category = financial-insecurity
Food Insecurity Goals . Extensible Goal.category = food-insecurity
Health Insurance Coverage Status Goals . Extensible Goal.category = health-insurance-coverage-status
Homelessness Goals . Extensible Goal.category = homelessness
Housing Instability Goals . Extensible Goal.category = housing-instability
Inadequate Housing Goals . Extensible Goal.category = inadequate-housing
Intimate Partner Violence Goals . Extensible Goal.category = intimate-partner-violence
Material Hardship Goals . Extensible Goal.category = material-hardship
Medical Cost Burden Goals . Extensible Goal.category = medical-cost-burden
Health Literacy Goals . Extensible Goal.category = personal-health-literacy
Social Connection Goals . Extensible Goal.category = social-connection
Stress Goals . Extensible Goal.category = stress
Transportation Insecurity Goals . Extensible Goal.category = transportation-insecurity
Utility Insecurity Goals . Extensible Goal.category = utility-insecurity
Veteran Status Goals . Extensible Goal.category = veteran-status
SDOHCC ValueSet LOINC SNOMEDCT Preferred Goal.category = sdoh-category-unspecified
... subject SΣ 1..1 Reference(US Core Patient Profile) Who this goal is intended for
... start[x] Σ 0..1 When goal pursuit begins
Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal.

.... startDate date
.... startCodeableConcept CodeableConcept
... target SC 0..* BackboneElement Target outcome for the goal
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 ΣC 0..1 CodeableConcept The parameter whose value is being tracked
Binding: LOINCCodes (preferred): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

.... detail[x] ΣC 0..1 The target value to be achieved
Binding Description (No ValueSet): (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
.... Slices for due[x] Σ 0..1 date Reach goal on or before
Slice: Unordered, Closed by type:$this
..... due[x]:dueDate SΣ 0..1 date Reach goal on or before
... statusDate Σ 0..1 date When goal status took effect
... statusReason 0..1 string Reason for current status
... expressedBy Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) Who's responsible for creating Goal?
... Slices for addresses 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Goal.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Goal.lifecycleStatusrequiredGoalLifecycleStatus
http://hl7.org/fhir/ValueSet/goal-status
from the FHIR Standard
Goal.achievementStatuspreferredGoalAchievementStatus
http://hl7.org/fhir/ValueSet/goal-achievement
from the FHIR Standard
Goal.categoryexampleGoalCategory
http://hl7.org/fhir/ValueSet/goal-category
from the FHIR Standard
Goal.category:SDOHrequiredSDOHCCValueSetSDOHCategory
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory
Goal.prioritypreferredGoalPriority
http://hl7.org/fhir/ValueSet/goal-priority
from the FHIR Standard
Goal.descriptionpreferredSDOHCCValueSetLOINCSNOMEDCT
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetLOINCSNOMEDCT
Goal.start[x]exampleGoalStartEvent
http://hl7.org/fhir/ValueSet/goal-start-event
from the FHIR Standard
Goal.target.measurepreferredLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Goal.target.detail[x]example
Goal.outcomeCodepreferredSDOHCCValueSetLOINCSNOMEDCT
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetLOINCSNOMEDCT

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGoalIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGoalIf 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-4errorGoalIf 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-5errorGoalIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGoalA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gol-1errorGoal.targetGoal.target.measure is required if Goal.target.detail is populated
: (detail.exists() and measure.exists()) or detail.exists().not()

This structure is derived from SDOHCCGoal

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron