Release 4B Ballot #1

This page is part of the FHIR Specification (v4.1.0: Release 4B Ballot #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4

Extension: pertainsToGoal

FHIR Infrastructure Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal

Status: draft. Extension maintained by: HL7

Indicates that the resource is related to either the measurement, achievement or progress towards the referenced goal. For example, a Procedure to exercise pertainsToGoal of losing weight.

Comment:

This extension is limited to subject-specific activity-related resources (events & intents). I.e. This can't be put on Goal or Patient. This association isn't for the purpose of goal management, but for things such as noting that a particular observation result, prescription or other activity is pertinent to the achievement (or possibly non-achievement) of the referenced goal.

Context of Use: Use on Element ID Resource

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. pertainsToGoal0..*Reference(Goal)URL = http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
pertainsToGoal: Indicates that the resource is related to either the measurement, achievement or progress towards the referenced goal. For example, a Procedure to exercise pertainsToGoal of losing weight.


Use on Element ID Resource

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
pertainsToGoal: Indicates that the resource is related to either the measurement, achievement or progress towards the referenced goal. For example, a Procedure to exercise pertainsToGoal of losing weight.


Use on Element ID Resource
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal"
... value[x] 1..1Reference(Goal)Value of extension

doco Documentation for this format

XML Template

<!-- pertainsToGoal -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal" >
  <!-- from Element: extension -->
 <valueReference><!-- ?? 1..1 Reference(Goal) Value of extension --></valueReference>
</extension>

JSON Template

{ // pertainsToGoal
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal", // R! 
    "valueReference" : { Reference(Goal) } // C? R! Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. pertainsToGoal0..*Reference(Goal)URL = http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
pertainsToGoal: Indicates that the resource is related to either the measurement, achievement or progress towards the referenced goal. For example, a Procedure to exercise pertainsToGoal of losing weight.


Use on Element ID Resource

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
pertainsToGoal: Indicates that the resource is related to either the measurement, achievement or progress towards the referenced goal. For example, a Procedure to exercise pertainsToGoal of losing weight.


Use on Element ID Resource
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal"
... value[x] 1..1Reference(Goal)Value of extension

doco Documentation for this format

XML Template

<!-- pertainsToGoal -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal" >
  <!-- from Element: extension -->
 <valueReference><!-- ?? 1..1 Reference(Goal) Value of extension --></valueReference>
</extension>

JSON Template

{ // pertainsToGoal
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal", // R! 
    "valueReference" : { Reference(Goal) } // C? R! Value of extension
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
  • ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)