STU 2 Ballot

This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. 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

D.4.1.1 Formal Views of Profile Content

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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal I0..*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..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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... goal-target SI0..*(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..1stringxml:id (or equivalent in JSON)
.... extension 1..1ExtensionThe parameter whose value is being tracked
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"measure"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
.... extension 1..1ExtensionThe target value range to be achieved
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"detail"
..... value[x] 1..1Quantity, Range, CodeableConceptValue of extension
.... measure 1..1CodeableConceptExtension
URL: measure
Binding: uslab-obs-codes (preferred)
.... detail 1..1Quantity, Range, CodeableConceptExtension
URL: detail
Binding: uslab-obs-codedresults (preferred)
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/goal-target"
... goal-reasonRejected I0..1CodeableConceptExtension
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..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Ids for this goal
... subject S0..1Reference(Profile qicore-patient | Group | Profile qicore-organization)Who this goal is intended for
... start[x] ∑0..1date, CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
... target[x] S0..1date, DurationReach goal on or before
... category S0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... description ∑1..1CodeableConceptCode or text describing goal
Binding: (unbound) (example)
... status ?!S1..1codeproposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled | on-target | ahead-of-target | behind-target
Binding: GoalStatus (required)
... statusDate S0..1dateWhen goal status took effect
... statusReason 0..*CodeableConceptReason for current status
Binding: GoalStatusReason (example)
... expressedBy ∑0..1Reference(Patient | Practitioner | RelatedPerson)Who's responsible for creating Goal?
... priority ∑0..1CodeableConcepthigh | medium |low
Binding: GoalPriority (preferred)
... addresses S0..*Reference(Profile qicore-condition | Profile qicore-observation | Profile qicore-medicationstatement | NutritionRequest | Profile qicore-procedurerequest | RiskAssessment)Issues addressed by this goal
... note 0..*AnnotationComments about the goal
... outcome 0..*BackboneElementWhat was end result of goal?
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... result[x] 0..1CodeableConcept, Reference(Observation)Code or observation that resulted from goal
Binding: (unbound) (example)

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal I0..*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..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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... goal-target SI0..*(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..1stringxml:id (or equivalent in JSON)
.... extension 1..1ExtensionThe parameter whose value is being tracked
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"measure"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
.... extension 1..1ExtensionThe target value range to be achieved
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"detail"
..... value[x] 1..1Quantity, Range, CodeableConceptValue of extension
.... measure 1..1CodeableConceptExtension
URL: measure
Binding: uslab-obs-codes (preferred)
.... detail 1..1Quantity, Range, CodeableConceptExtension
URL: detail
Binding: uslab-obs-codedresults (preferred)
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/goal-target"
... goal-reasonRejected I0..1CodeableConceptExtension
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..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Ids for this goal
... subject S0..1Reference(Profile qicore-patient | Group | Profile qicore-organization)Who this goal is intended for
... start[x] ∑0..1date, CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
... target[x] S0..1date, DurationReach goal on or before
... category S0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... description ∑1..1CodeableConceptCode or text describing goal
Binding: (unbound) (example)
... status ?!S1..1codeproposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled | on-target | ahead-of-target | behind-target
Binding: GoalStatus (required)
... statusDate S0..1dateWhen goal status took effect
... statusReason 0..*CodeableConceptReason for current status
Binding: GoalStatusReason (example)
... expressedBy ∑0..1Reference(Patient | Practitioner | RelatedPerson)Who's responsible for creating Goal?
... priority ∑0..1CodeableConcepthigh | medium |low
Binding: GoalPriority (preferred)
... addresses S0..*Reference(Profile qicore-condition | Profile qicore-observation | Profile qicore-medicationstatement | NutritionRequest | Profile qicore-procedurerequest | RiskAssessment)Issues addressed by this goal
... note 0..*AnnotationComments about the goal
... outcome 0..*BackboneElementWhat was end result of goal?
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... result[x] 0..1CodeableConcept, Reference(Observation)Code or observation that resulted from goal
Binding: (unbound) (example)

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Goal.languageCommon LanguagesextensibleCommon Languages
Goal.extension.extension
http://hl7.org/fhir/StructureDefinition/goal-target#measure		?extpreferredhttp://hl7.org/fhir/ValueSet/uslab-obs-codes
Goal.extension.extension
http://hl7.org/fhir/StructureDefinition/goal-target#detail		?extpreferredhttp://hl7.org/fhir/ValueSet/uslab-obs-codedresults
Goal.extension
http://hl7.org/fhir/StructureDefinition/goal-reasonRejected		Reasons for rejecting goal codesexampleReasons for rejecting goal codes
Goal.start[x]GoalStartEventexampleGoalStartEvent
Goal.categoryGoalCategoryexampleGoalCategory
Goal.description?extexample
Goal.statusGoalStatusrequiredGoalStatus
Goal.statusReasonGoalStatusReasonexampleGoalStatusReason
Goal.priorityGoalPrioritypreferredGoalPriority
Goal.outcome.result[x]?extexample

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2GoalIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1GoalIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4GoalIf 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-3GoalIf 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-1Goal.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Goal.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Goal.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Goal.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1Goal.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Goal.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
.