US Core Implementation Guide
4.0.0 - STU4 Release

This page is part of the US Core (v4.0.0: STU4) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

Resource Profile: US Core Goal Profile

Defining URL:http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal
Version:4.0.0
Name:USCoreGoalProfile
Title:US Core Goal Profile
Status:Active as of 2020-07-21
Definition:

Defines constraints and extensions on the Goal resource for the minimal set of data to query and retrieve a patient's goal(s).

Publisher:HL7 International - US Realm Steering Committee
Copyright:

Used by permission of HL7 International, all rights reserved Creative Commons License

Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal

This profile sets minimum expectations for the Goal resource to record, search, and fetch Goal information associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the US Core-Goal profile:

Mandatory and Must Support Data Elements

The following data-elements must always be present (Mandatory definition]) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Goal must have:

  1. a status
  2. text description of the goal
  3. a patient

Each Goal must support:

  1. target date(s):

Profile specific implementation guidance:

  • none

Examples

Formal Views of Profile Content

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

This structure is derived from Goal

Summary

Mandatory: 3 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

This structure is derived from Goal

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*GoalDescribes the intended objective(s) for a patient, group or organization
... lifecycleStatus S1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required)
... description S1..1CodeableConceptCode or text describing goal
... subject S1..1Reference(US Core Patient Profile)Who this goal is intended for
... target S0..*BackboneElementTarget outcome for the goal
.... due[x] S0..1Reach goal on or before
..... dueDatedate S
..... dueDurationDuration

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*GoalDescribes the intended objective(s) for a patient, group or organization
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Ids for this goal
... lifecycleStatus ?!SΣ1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required)
... achievementStatus Σ0..1CodeableConceptin-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 Σ0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example): Codes for grouping and sorting goals.


... priority Σ0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): The level of importance associated with a goal.

... description SΣ1..1CodeableConceptCode or text describing goal
Binding: SNOMEDCTClinicalFindings (example): Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used.

... subject SΣ1..1Reference(US Core Patient Profile)Who this goal is intended for
... start[x] Σ0..1When goal pursuit begins
Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal.

.... startDatedate
.... startCodeableConceptCodeableConcept
... target SI0..*BackboneElementTarget outcome for the goal
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... measure ΣI0..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

.... detail[x] ΣI0..1The 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.

..... detailQuantityQuantity
..... detailRangeRange
..... detailCodeableConceptCodeableConcept
..... detailStringstring
..... detailBooleanboolean
..... detailIntegerinteger
..... detailRatioRatio
.... due[x] SΣ0..1Reach goal on or before
..... dueDatedate S
..... dueDurationDuration
... statusDate Σ0..1dateWhen goal status took effect
... statusReason 0..1stringReason for current status
... expressedBy Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)Who's responsible for creating Goal?
... addresses 0..*Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment)Issues addressed by this goal
... note 0..*AnnotationComments about the goal
... outcomeCode 0..*CodeableConceptWhat 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*GoalDescribes the intended objective(s) for a patient, group or organization
... lifecycleStatus ?!Σ1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required)
... description Σ1..1CodeableConceptCode or text describing goal
Binding: SNOMEDCTClinicalFindings (example): Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used.

... subject Σ1..1Reference(US Core Patient Profile)Who this goal is intended for
... target I0..*BackboneElementTarget outcome for the goal
.... due[x] Σ0..1Reach goal on or before
..... dueDatedate

doco Documentation for this format

This structure is derived from Goal

Summary

Mandatory: 3 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Goal

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*GoalDescribes the intended objective(s) for a patient, group or organization
... lifecycleStatus S1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required)
... description S1..1CodeableConceptCode or text describing goal
... subject S1..1Reference(US Core Patient Profile)Who this goal is intended for
... target S0..*BackboneElementTarget outcome for the goal
.... due[x] S0..1Reach goal on or before
..... dueDatedate S
..... dueDurationDuration

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*GoalDescribes the intended objective(s) for a patient, group or organization
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Ids for this goal
... lifecycleStatus ?!SΣ1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required)
... achievementStatus Σ0..1CodeableConceptin-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 Σ0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example): Codes for grouping and sorting goals.


... priority Σ0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): The level of importance associated with a goal.

... description SΣ1..1CodeableConceptCode or text describing goal
Binding: SNOMEDCTClinicalFindings (example): Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used.

... subject SΣ1..1Reference(US Core Patient Profile)Who this goal is intended for
... start[x] Σ0..1When goal pursuit begins
Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal.

.... startDatedate
.... startCodeableConceptCodeableConcept
... target SI0..*BackboneElementTarget outcome for the goal
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... measure ΣI0..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

.... detail[x] ΣI0..1The 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.

..... detailQuantityQuantity
..... detailRangeRange
..... detailCodeableConceptCodeableConcept
..... detailStringstring
..... detailBooleanboolean
..... detailIntegerinteger
..... detailRatioRatio
.... due[x] SΣ0..1Reach goal on or before
..... dueDatedate S
..... dueDurationDuration
... statusDate Σ0..1dateWhen goal status took effect
... statusReason 0..1stringReason for current status
... expressedBy Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)Who's responsible for creating Goal?
... addresses 0..*Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment)Issues addressed by this goal
... note 0..*AnnotationComments about the goal
... outcomeCode 0..*CodeableConceptWhat 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

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Goal.languagepreferredCommonLanguages
Max Binding: AllLanguages
Goal.lifecycleStatusrequiredGoalLifecycleStatus
Goal.achievementStatuspreferredGoalAchievementStatus
Goal.categoryexampleGoalCategory
Goal.prioritypreferredGoalPriority
Goal.descriptionexampleSNOMEDCTClinicalFindings
Goal.start[x]exampleGoalStartEvent
Goal.target.measureexampleLOINCCodes
Goal.target.detail[x]example
Goal.outcomeCodeexampleSNOMEDCTClinicalFindings

Notes:


Quick Start


Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile’s information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

  • The syntax used to describe the interactions is described here.
  • See the General Guidance section for additional rules and expectations when a server requires status parameters.
  • See the General Guidance section for additional guidance on searching for multiple patients.

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching for all goals for a patient using the patient search parameter:

    GET [base]/Goal?patient={Type/}[id]

    Example:

    1. GET [base]/Goal?patient=1137192

    Implementation Notes: Fetches a bundle of all Goal resources for the specified patient (how to search by reference)

Optional Search Parameters:

The following search parameter combinations SHOULD be supported:

  1. SHOULD support searching using the combination of the patient and lifecycle-status search parameters:

    GET [base]/Goal?patient={Type/}[id]&lifecycle-status={system|}[code]

    Example:

    1. GET [base]/Goal?patient=1137192&lifecycle-status=active

    Implementation Notes: Fetches a bundle of all Goal resources for the specified patient and lifecycle-status (how to search by reference and how to search by token)

  2. SHOULD support searching using the combination of the patient and target-date search parameters:

    • including support for these target-date comparators: gt,lt,ge,le
    • including optional support for composite AND search on target-date (e.g.target-date=[date]&target-date=[date]]&...)

    GET [base]/Goal?patient={Type/}[id]&target-date={gt|lt|ge|le}[date]{&target-date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/Goal?patient=1137192&target-date=ge2015-01-14&target-date=le2019-01-14

    Implementation Notes: Fetches a bundle of all Goal resources for the specified patient and target-date (how to search by reference and how to search by date)