STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: Target for goal

(No assigned work group) Maturity Level: 0Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/goal-target

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR WG

The element describing the target for the goal, allowing the progress of the goal to be monitored against an observation.

Context of Use: Use on element: Goal

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/goal-target
Target for goal: The element describing the target for the goal, allowing the progress of the goal to be monitored against an observation.
Use on element: Goal
... measure1..1CodeableConceptThe parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
... detail1..1Quantity, Range, CodeableConceptThe target value range of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

doco Documentation for this format

Fulle Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/goal-target
Target for goal: The element describing the target for the goal, allowing the progress of the goal to be monitored against an observation.
Use on element: Goal
... extension 1..1ExtensionThe parameter whose value is being tracked
.... extension 0..0
.... url 1..1uri"measure"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
... extension 1..1ExtensionThe target value range to be achieved
.... extension 0..0
.... url 1..1uri"detail"
.... value[x] 1..1Quantity, Range, CodeableConceptValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/goal-target"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- Target for goal -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/goal-target" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="measure"> 1..1 Extension  <!-- 1..1 The parameter whose value is being tracked -->
  <valueCodeableConcept><!-- 1..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="detail"> 1..1 Extension  <!-- 1..1 The target value range to be achieved -->
  <value[x]><!-- 1..1 Quantity|Range|CodeableConcept 
      Value of extension --></value[x]>
 </extension>
</extension>

JSON Template

{ // Target for goal
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // The parameter whose value is being tracked // R! 
        // from Element: extension
        "url" : "measure", // R! 
        "valueCodeableConcept" : { CodeableConcept } // R! Value of extension
      },
      { // The target value range to be achieved // R! 
        // from Element: extension
        "url" : "detail", // R! 
// value[x]: Value of extension. One of these 3:
        "valueQuantity" : { Quantity } // R! Value of extension
        "valueRange" : { Range }, // R! Value of extension
        "valueCodeableConcept" : { CodeableConcept }, // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/goal-target", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/goal-target
Target for goal: The element describing the target for the goal, allowing the progress of the goal to be monitored against an observation.
Use on element: Goal
... measure1..1CodeableConceptThe parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
... detail1..1Quantity, Range, CodeableConceptThe target value range of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/goal-target
Target for goal: The element describing the target for the goal, allowing the progress of the goal to be monitored against an observation.
Use on element: Goal
... extension 1..1ExtensionThe parameter whose value is being tracked
.... extension 0..0
.... url 1..1uri"measure"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
... extension 1..1ExtensionThe target value range to be achieved
.... extension 0..0
.... url 1..1uri"detail"
.... value[x] 1..1Quantity, Range, CodeableConceptValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/goal-target"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- Target for goal -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/goal-target" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="measure"> 1..1 Extension  <!-- 1..1 The parameter whose value is being tracked -->
  <valueCodeableConcept><!-- 1..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="detail"> 1..1 Extension  <!-- 1..1 The target value range to be achieved -->
  <value[x]><!-- 1..1 Quantity|Range|CodeableConcept 
      Value of extension --></value[x]>
 </extension>
</extension>

JSON Template

{ // Target for goal
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // The parameter whose value is being tracked // R! 
        // from Element: extension
        "url" : "measure", // R! 
        "valueCodeableConcept" : { CodeableConcept } // R! Value of extension
      },
      { // The target value range to be achieved // R! 
        // from Element: extension
        "url" : "detail", // R! 
// value[x]: Value of extension. One of these 3:
        "valueQuantity" : { Quantity } // R! Value of extension
        "valueRange" : { Range }, // R! Value of extension
        "valueCodeableConcept" : { CodeableConcept }, // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/goal-target", // R! 
// value[x]: Value of extension. One of these 38:
  }

 

Constraints

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