This page is part of the Quality Improvement Core Framework (v2.1.0: STU 3 Ballot 1) 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
Weight Loss Example |
The official URL for this profile is:
http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-goal
This profile builds on US Core Goal Profile.
This profile was published on Mon Aug 21 16:00:00 AEST 2017 as a draft by Health Level Seven International (Clinical Quality Information - QICore).
Description of Profiles, Differentials, and Snapshots.
Summary
Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | ||||
id | 0..1 | id | ||
status | S | Binding: GoalStatus (required) | ||
category | S | |||
description | S | Binding: SNOMED CT Clinical Findings (preferred) | ||
subject | S | 1..1 | Reference(QICore-Patient), Reference(Group), Reference(QICore-Organization) | |
start[x] | 0..1 | date, CodeableConcept | ||
target | S | |||
measure | 1..1 | CodeableConcept | Binding: LOINC Codes (preferred) | |
detail[x] | 1..1 | |||
due[x] | ||||
statusDate | S | |||
expressedBy | 0..1 | Reference(QICore-Patient), Reference(QICore-Practitioner), Reference(QICore-RelatedPerson) | ||
addresses | S | Reference(QICore-Condition), Reference(QICore-Observation), Reference(QICore-MedicationStatement), Reference(NutritionOrder), Reference(QICore-ProcedureRequest), Reference(RiskAssessment) | ||
goal-reasonRejected | 0..1 | CodeableConcept | The reason the goal was not accepted URL: http://hl7.org/fhir/StructureDefinition/goal-reasonRejected Binding: Reasons for rejecting goal codes (example) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | I | 0..* | Describes the intended objective(s) for a patient, group or organization | |
id | Σ | 0..1 | id | 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: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
goal-reasonRejected | I | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/goal-reasonRejected |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | External Ids for this goal | |
status | ?!SΣ | 1..1 | code | proposed | 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..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example) |
priority | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred) |
description | SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: SNOMED CT Clinical Findings (preferred) |
subject | SΣ | 1..1 | Reference(QICore-Patient), Reference(Group), Reference(QICore-Organization) | Who this goal is intended for |
start[x] | Σ | 0..1 | date, CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example) |
target | SI | 0..1 | BackboneElement | Target outcome for the goal |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
measure | ΣI | 1..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINC Codes (preferred) |
detail[x] | ΣI | 1..1 | Quantity, Range, CodeableConcept | The target value to be achieved Binding: (unbound) (example) |
due[x] | Σ | 0..1 | date, Duration | Reach goal on or before |
statusDate | SΣ | 0..1 | date | When goal status took effect |
statusReason | 0..1 | string | Reason for current status | |
expressedBy | Σ | 0..1 | Reference(QICore-Patient), Reference(http://hl7.org/fhir/practitioner.html), Reference(http://hl7.org/fhir/relatedperson.html) | Who's responsible for creating Goal? |
addresses | S | 0..* | Reference(QICore-Condition), Reference(QICore-Observation), Reference(QICore-MedicationStatement), Reference(NutritionOrder), Reference(QICore-ProcedureRequest), Reference(RiskAssessment) | Issues addressed by this goal |
note | 0..* | Annotation | Comments about the goal | |
outcomeCode | 0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SNOMED CT Clinical Findings (example) | |
outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal | |
Documentation for this format |
Summary
Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | ||||
id | 0..1 | id | ||
status | S | Binding: GoalStatus (required) | ||
category | S | |||
description | S | Binding: SNOMED CT Clinical Findings (preferred) | ||
subject | S | 1..1 | Reference(QICore-Patient), Reference(Group), Reference(QICore-Organization) | |
start[x] | 0..1 | date, CodeableConcept | ||
target | S | |||
measure | 1..1 | CodeableConcept | Binding: LOINC Codes (preferred) | |
detail[x] | 1..1 | |||
due[x] | ||||
statusDate | S | |||
expressedBy | 0..1 | Reference(QICore-Patient), Reference(QICore-Practitioner), Reference(QICore-RelatedPerson) | ||
addresses | S | Reference(QICore-Condition), Reference(QICore-Observation), Reference(QICore-MedicationStatement), Reference(NutritionOrder), Reference(QICore-ProcedureRequest), Reference(RiskAssessment) | ||
goal-reasonRejected | 0..1 | CodeableConcept | The reason the goal was not accepted URL: http://hl7.org/fhir/StructureDefinition/goal-reasonRejected Binding: Reasons for rejecting goal codes (example) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | I | 0..* | Describes the intended objective(s) for a patient, group or organization | |
id | Σ | 0..1 | id | 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: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
goal-reasonRejected | I | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/goal-reasonRejected |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | External Ids for this goal | |
status | ?!SΣ | 1..1 | code | proposed | 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..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example) |
priority | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred) |
description | SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: SNOMED CT Clinical Findings (preferred) |
subject | SΣ | 1..1 | Reference(QICore-Patient), Reference(Group), Reference(QICore-Organization) | Who this goal is intended for |
start[x] | Σ | 0..1 | date, CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example) |
target | SI | 0..1 | BackboneElement | Target outcome for the goal |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
measure | ΣI | 1..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINC Codes (preferred) |
detail[x] | ΣI | 1..1 | Quantity, Range, CodeableConcept | The target value to be achieved Binding: (unbound) (example) |
due[x] | Σ | 0..1 | date, Duration | Reach goal on or before |
statusDate | SΣ | 0..1 | date | When goal status took effect |
statusReason | 0..1 | string | Reason for current status | |
expressedBy | Σ | 0..1 | Reference(QICore-Patient), Reference(http://hl7.org/fhir/practitioner.html), Reference(http://hl7.org/fhir/relatedperson.html) | Who's responsible for creating Goal? |
addresses | S | 0..* | Reference(QICore-Condition), Reference(QICore-Observation), Reference(QICore-MedicationStatement), Reference(NutritionOrder), Reference(QICore-ProcedureRequest), Reference(RiskAssessment) | Issues addressed by this goal |
note | 0..* | Annotation | Comments about the goal | |
outcomeCode | 0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SNOMED CT Clinical Findings (example) | |
outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal | |
Documentation for this format |
Path | Name | Conformance | ValueSet |
Goal.language | Common Languages | extensible | Common Languages |
Goal.status | GoalStatus | required | GoalStatus |
Goal.category | GoalCategory | example | GoalCategory |
Goal.priority | GoalPriority | preferred | GoalPriority |
Goal.description | SNOMED CT Clinical Findings | preferred | SNOMED CT Clinical Findings |
Goal.start[x] | GoalStartEvent | example | GoalStartEvent |
Goal.target.measure | LOINC Codes | preferred | LOINC Codes |
Goal.target.detail[x] | ?ext | example | |
Goal.outcomeCode | SNOMED CT Clinical Findings | example | SNOMED CT Clinical Findings |
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-1 | Goal | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.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-3 | Goal | If 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-1 | Goal.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Goal.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Goal.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Goal.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Goal.target | All FHIR elements must have a @value or children : hasValue() | (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() |