STU 2 Ballot
This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) v1.6.0. The current version which supersedes this version is 7.0.2. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/qicore/StructureDefinition/qicore-goal
This profile was published on Fri Feb 27 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Goal
Summary
Mandatory: 0 element (+2 nested mandatory elements)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from Goal
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Goal | 0..* | |||
  subject | S | 0..1 | Reference(Profile qicore-patient | Group | Profile qicore-organization) | |
| targetDate | S | 0..1 | date, Duration | |
| category | S | 0..* | CodeableConcept | |
| status | S | 1..1 | code | |
| statusDate | S | 0..1 | date | |
| addresses | S | 0..* | Reference(Profile qicore-condition | Profile qicore-observation | Profile qicore-medicationstatement | NutritionRequest | Profile qicore-procedurerequest | RiskAssessment) | |
 goal-target | S | 0..* | (Complex) | Target for goal URL: http://hl7.org/fhir/StructureDefinition/goal-target |
  measure | 1..1 | CodeableConcept | The parameter whose value is being tracked URL: measure Binding: uslab-obs-codes (preferred) | |
 detail | 1..1 | Quantity, Range, CodeableConcept | The target value range to be achieved URL: detail Binding: uslab-obs-codedresults (preferred) | |
| 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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
 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-target | SI | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/goal-target ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 1..1 | Extension | The parameter whose value is being tracked | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "measure" | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value of extension | |
| extension | 1..1 | Extension | The target value range to be achieved | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "detail" | |
 value[x] | 1..1 | Quantity, Range, CodeableConcept | Value of extension | |
| measure | 1..1 | CodeableConcept | Extension URL: measure Binding: uslab-obs-codes (preferred) | |
| detail | 1..1 | Quantity, Range, CodeableConcept | Extension URL: detail Binding: uslab-obs-codedresults (preferred) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/goal-target" | |
| goal-reasonRejected | I | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/goal-reasonRejected Binding: Reasons for rejecting goal codes (example) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | External Ids for this goal | |
| subject | S | 0..1 | Reference(Profile qicore-patient | Group | Profile qicore-organization) | Who this goal is intended for |
| start[x] | ∑ | 0..1 | date, CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example) |
| target[x] | S | 0..1 | date, Duration | Reach goal on or before |
| category | S | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example) |
| description | ∑ | 1..1 | CodeableConcept | Code or text describing goal Binding: (unbound) (example) |
| status | ?!S | 1..1 | code | proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled | on-target | ahead-of-target | behind-target Binding: GoalStatus (required) |
| statusDate | S | 0..1 | date | When goal status took effect |
| statusReason | 0..* | CodeableConcept | Reason for current status Binding: GoalStatusReason (example) | |
| expressedBy | ∑ | 0..1 | Reference(Patient | Practitioner | RelatedPerson) | Who's responsible for creating Goal? |
| priority | ∑ | 0..1 | CodeableConcept | high | medium |low Binding: GoalPriority (preferred) |
| addresses | S | 0..* | Reference(Profile qicore-condition | Profile qicore-observation | Profile qicore-medicationstatement | NutritionRequest | Profile qicore-procedurerequest | RiskAssessment) | Issues addressed by this goal |
| note | 0..* | Annotation | Comments about the goal | |
| outcome | 0..* | BackboneElement | What was end result of 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 |
| result[x] | 0..1 | CodeableConcept, Reference(Observation) | Code or observation that resulted from goal Binding: (unbound) (example) | |
| Documentation for this format | ||||
yet to be done: Xml template
yet to be done: Json template
This structure is derived from StructureDefinition.
Summary
Mandatory: 0 element (+2 nested mandatory elements)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from StructureDefinition.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Goal | 0..* | |||
| subject | S | 0..1 | Reference(Profile qicore-patient | Group | Profile qicore-organization) | |
| targetDate | S | 0..1 | date, Duration | |
| category | S | 0..* | CodeableConcept | |
| status | S | 1..1 | code | |
| statusDate | S | 0..1 | date | |
| addresses | S | 0..* | Reference(Profile qicore-condition | Profile qicore-observation | Profile qicore-medicationstatement | NutritionRequest | Profile qicore-procedurerequest | RiskAssessment) | |
| goal-target | S | 0..* | (Complex) | Target for goal URL: http://hl7.org/fhir/StructureDefinition/goal-target |
| measure | 1..1 | CodeableConcept | The parameter whose value is being tracked URL: measure Binding: uslab-obs-codes (preferred) | |
| detail | 1..1 | Quantity, Range, CodeableConcept | The target value range to be achieved URL: detail Binding: uslab-obs-codedresults (preferred) | |
| 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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
| 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-target | SI | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/goal-target ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 1..1 | Extension | The parameter whose value is being tracked | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "measure" | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value of extension | |
| extension | 1..1 | Extension | The target value range to be achieved | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "detail" | |
| value[x] | 1..1 | Quantity, Range, CodeableConcept | Value of extension | |
| measure | 1..1 | CodeableConcept | Extension URL: measure Binding: uslab-obs-codes (preferred) | |
| detail | 1..1 | Quantity, Range, CodeableConcept | Extension URL: detail Binding: uslab-obs-codedresults (preferred) | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/goal-target" | |
| goal-reasonRejected | I | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/goal-reasonRejected Binding: Reasons for rejecting goal codes (example) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | External Ids for this goal | |
| subject | S | 0..1 | Reference(Profile qicore-patient | Group | Profile qicore-organization) | Who this goal is intended for |
| start[x] | ∑ | 0..1 | date, CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example) |
| target[x] | S | 0..1 | date, Duration | Reach goal on or before |
| category | S | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example) |
| description | ∑ | 1..1 | CodeableConcept | Code or text describing goal Binding: (unbound) (example) |
| status | ?!S | 1..1 | code | proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled | on-target | ahead-of-target | behind-target Binding: GoalStatus (required) |
| statusDate | S | 0..1 | date | When goal status took effect |
| statusReason | 0..* | CodeableConcept | Reason for current status Binding: GoalStatusReason (example) | |
| expressedBy | ∑ | 0..1 | Reference(Patient | Practitioner | RelatedPerson) | Who's responsible for creating Goal? |
| priority | ∑ | 0..1 | CodeableConcept | high | medium |low Binding: GoalPriority (preferred) |
| addresses | S | 0..* | Reference(Profile qicore-condition | Profile qicore-observation | Profile qicore-medicationstatement | NutritionRequest | Profile qicore-procedurerequest | RiskAssessment) | Issues addressed by this goal |
| note | 0..* | Annotation | Comments about the goal | |
| outcome | 0..* | BackboneElement | What was end result of 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 |
| result[x] | 0..1 | CodeableConcept, Reference(Observation) | Code or observation that resulted from goal Binding: (unbound) (example) | |
| Documentation for this format | ||||
XML Template
yet to be done: Xml template
JSON Template
yet to be done: Json template
| Path | Name | Conformance | ValueSet |
| Goal.language | Common Languages | extensible | Common Languages |
| Goal.extension.extension http://hl7.org/fhir/StructureDefinition/goal-target#measure | ?ext | preferred | http://hl7.org/fhir/ValueSet/uslab-obs-codes |
| Goal.extension.extension http://hl7.org/fhir/StructureDefinition/goal-target#detail | ?ext | preferred | http://hl7.org/fhir/ValueSet/uslab-obs-codedresults |
| Goal.extension http://hl7.org/fhir/StructureDefinition/goal-reasonRejected | Reasons for rejecting goal codes | example | Reasons for rejecting goal codes |
| Goal.start[x] | GoalStartEvent | example | GoalStartEvent |
| Goal.category | GoalCategory | example | GoalCategory |
| Goal.description | ?ext | example | |
| Goal.status | GoalStatus | required | GoalStatus |
| Goal.statusReason | GoalStatusReason | example | GoalStatusReason |
| Goal.priority | GoalPriority | preferred | GoalPriority |
| Goal.outcome.result[x] | ?ext | example |
| Id | Path | Details | Requirements |
| dom-2 | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained) | |
| dom-1 | Goal | If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text) | |
| dom-4 | Goal | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)) | |
| dom-3 | Goal | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])) | |
| ele-1 | Goal.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
| ext-1 | Goal.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
| ele-1 | Goal.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
| ext-1 | Goal.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
| ele-1 | Goal.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
| ext-1 | Goal.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) |
© HL7.org 2011+. QICore STU 2 Ballot (v1.6.0-9635) generated on Thu, Aug 11, 2016 20:30+1000. QA Page
Links: Search |
Version History |
Table of Contents |
|
Propose a change 