FHIR Clinical Guidelines (v1.0.0) (STU1)

This page is part of the Clinical Guidelines (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-cpg-goal

Introduction:

Examples:

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-goal

Defines the expectations for the representation of goals used in computable guidelines

This profile builds on Goal.

This profile was published on Thu Jun 06 00:00:00 UTC 2019 as a draft by Health Level Seven, Inc. - CDS WG.

Description of Profiles, Differentials, and Snapshots.

Summary

Must-Support: 12 elements

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*GoalDescribes the intended objective(s) for a patient, group or organization
... cpg-goalFor S0..*canonical(CPGShareablePlanDefinition)Goal For?
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-goalFor
... identifier S0..*IdentifierExternal Ids for this goal
... lifecycleStatus S1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
... achievementStatus S0..1CodeableConceptin-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
... category S0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
... priority S0..1CodeableConcepthigh-priority | medium-priority | low-priority
... description S1..1CodeableConceptCode or text describing goal
... subject S1..1Reference(Patient | Group | Organization)Who this goal is intended for
... start[x] S0..1date, CodeableConceptWhen goal pursuit begins
... target S0..*BackboneElementTarget outcome for the goal
.... measure S0..1CodeableConceptThe parameter whose value is being tracked
.... detail[x] S0..1Quantity, Range, CodeableConcept, string, boolean, integer, RatioThe target value to be achieved

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..*ExtensionExtension
Slice: Unordered, Open by value:url
... cpg-goalFor S0..*canonical(CPGShareablePlanDefinition)Goal For?
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-goalFor
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierExternal Ids for this goal
... lifecycleStatus ?!SΣ1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted.

... achievementStatus SΣ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 SΣ0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example): Codes for grouping and sorting goals.


... priority SΣ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(Patient | Group | Organization)Who this goal is intended for
... start[x] SΣ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 SΣ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] SΣ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] Σ0..1Reach goal on or before
..... dueDatedate
..... 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

Summary

Must-Support: 12 elements

Extensions

This structure refers to these extensions:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*GoalDescribes the intended objective(s) for a patient, group or organization
... cpg-goalFor S0..*canonical(CPGShareablePlanDefinition)Goal For?
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-goalFor
... identifier S0..*IdentifierExternal Ids for this goal
... lifecycleStatus S1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
... achievementStatus S0..1CodeableConceptin-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
... category S0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
... priority S0..1CodeableConcepthigh-priority | medium-priority | low-priority
... description S1..1CodeableConceptCode or text describing goal
... subject S1..1Reference(Patient | Group | Organization)Who this goal is intended for
... start[x] S0..1date, CodeableConceptWhen goal pursuit begins
... target S0..*BackboneElementTarget outcome for the goal
.... measure S0..1CodeableConceptThe parameter whose value is being tracked
.... detail[x] S0..1Quantity, Range, CodeableConcept, string, boolean, integer, RatioThe target value to be achieved

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..*ExtensionExtension
Slice: Unordered, Open by value:url
... cpg-goalFor S0..*canonical(CPGShareablePlanDefinition)Goal For?
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-goalFor
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierExternal Ids for this goal
... lifecycleStatus ?!SΣ1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted.

... achievementStatus SΣ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 SΣ0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example): Codes for grouping and sorting goals.


... priority SΣ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(Patient | Group | Organization)Who this goal is intended for
... start[x] SΣ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 SΣ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] SΣ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] Σ0..1Reach goal on or before
..... dueDatedate
..... 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

 

D.4.1.2 Terminology Bindings

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

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2GoalIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3GoalIf 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-4GoalIf 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-5GoalIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6GoalA resource should have narrative for robust management
: text.`div`.exists()
ele-1Goal.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Goal.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Goal.extension:goalForAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Goal.extension:goalForMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Goal.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Goal.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Goal.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.lifecycleStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.achievementStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.start[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
gol-1Goal.targetGoal.target.measure is required if Goal.target.detail is populated
: (detail.exists() and measure.exists()) or detail.exists().not()
ele-1Goal.target.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Goal.target.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Goal.target.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Goal.target.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Goal.target.measureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.target.detail[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.target.due[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.statusDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.statusReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.expressedByAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.addressesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.outcomeCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.outcomeReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())