QI-Core Implementation Guide: STU 3.2 (v3.2.0 for FHIR 3.0.1)

This page is part of the Quality Improvement Core Framework (v3.2.0: STU 3) based on FHIR R3. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-qicore-goal

Examples:

Weight Loss Example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

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

Profile of Goal for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

This profile builds on US Core Goal Profile.

This profile was published on Wed Aug 22 00:00:00 AEST 2018 as a draft by Health Level Seven, Inc. - CQI WG.

Description of Profiles, Differentials, and Snapshots.

Summary

Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal I0..*US Core Goal Profile
... id Σ0..1idLogical 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: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... goal-reasonRejected I0..1CodeableConceptThe reason the goal was not accepted
URL: http://hl7.org/fhir/StructureDefinition/goal-reasonRejected
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Ids for this goal
... status ?!SΣ1..1codeproposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected
Binding: GoalStatus (required)
... category SΣ0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... priority Σ0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
... description SΣ1..1CodeableConceptCode or text describing goal
Binding: SNOMED CT Clinical Findings (preferred)
... subject SΣ1..1Reference(QICore-Patient | QICore-Organization)Who this goal is intended for
... start[x] Σ0..1date, CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
... target SI0..1BackboneElementTarget outcome for the goal
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... measure ΣI1..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINC Codes (preferred)
.... detail[x] ΣI1..1Quantity, Range, CodeableConceptThe target value to be achieved
Binding: (unbound) (example)
.... due[x] Σ0..1date, DurationReach goal on or before
... statusDate SΣ0..1dateWhen goal status took effect
... statusReason 0..1stringReason for current status
... expressedBy Σ0..1Reference(QICore-Patient | QICore-Practitioner | QICore-RelatedPerson)Who's responsible for creating Goal?
... addresses S0..*Reference(QICore-Condition | QICore-Observation | QICore-MedicationStatement | NutritionOrder | QICore-ProcedureRequest | RiskAssessment)Issues addressed by this goal
... note 0..*AnnotationComments about the goal
... outcomeCode 0..*CodeableConceptWhat result was achieved regarding the goal?
Binding: SNOMED CT Clinical Findings (example)
... outcomeReference 0..*Reference(Observation)Observation that resulted from goal

doco Documentation for this format

Summary

Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal I0..*US Core Goal Profile
... id Σ0..1idLogical 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: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... goal-reasonRejected I0..1CodeableConceptThe reason the goal was not accepted
URL: http://hl7.org/fhir/StructureDefinition/goal-reasonRejected
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Ids for this goal
... status ?!SΣ1..1codeproposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected
Binding: GoalStatus (required)
... category SΣ0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... priority Σ0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
... description SΣ1..1CodeableConceptCode or text describing goal
Binding: SNOMED CT Clinical Findings (preferred)
... subject SΣ1..1Reference(QICore-Patient | QICore-Organization)Who this goal is intended for
... start[x] Σ0..1date, CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
... target SI0..1BackboneElementTarget outcome for the goal
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... measure ΣI1..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINC Codes (preferred)
.... detail[x] ΣI1..1Quantity, Range, CodeableConceptThe target value to be achieved
Binding: (unbound) (example)
.... due[x] Σ0..1date, DurationReach goal on or before
... statusDate SΣ0..1dateWhen goal status took effect
... statusReason 0..1stringReason for current status
... expressedBy Σ0..1Reference(QICore-Patient | QICore-Practitioner | QICore-RelatedPerson)Who's responsible for creating Goal?
... addresses S0..*Reference(QICore-Condition | QICore-Observation | QICore-MedicationStatement | NutritionOrder | QICore-ProcedureRequest | RiskAssessment)Issues addressed by this goal
... note 0..*AnnotationComments about the goal
... outcomeCode 0..*CodeableConceptWhat result was achieved regarding the goal?
Binding: SNOMED CT Clinical Findings (example)
... outcomeReference 0..*Reference(Observation)Observation that resulted from goal

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Goal.statusrequiredGoalStatus
Goal.categoryexampleGoalCategory
Goal.descriptionpreferredSNOMED CT Clinical Findings

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-1GoalIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.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-3GoalIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1Goal.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Goal.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Goal.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Goal.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Goal.targetAll FHIR elements must have a @value or children
: hasValue() | (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()