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 . Page versions: R4B R4 R3 R2

Extension: Individual acceptance of goal

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

URL for this extension: 


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

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

Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders.

Context of Use: Use on element: Goal

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/goal-acceptance
Individual acceptance of goal: Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders.
Use on element: Goal
. . . individual 1..1 Reference ( Patient ), Reference ( Practitioner ), Reference ( RelatedPerson ) The person whose acceptance/priority is being reflected.
. . . status 0..1 code Indicates whether the specified individual has accepted the goal or not.
. . . priority 0..1 CodeableConcept Indicates the relative priority assigned to the resource by the stakeholder.

doco Documentation for this format

Fulle Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/goal-acceptance
Individual acceptance of goal: Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders.
Use on element: Goal
. . . extension 1..1 Extension Individual whose acceptance is reflected
. . . . extension 0 .. 0
. . . . url 1..1 uri "individual"
. . . . value[x] 1..1 Reference ( Patient ), Reference ( Practitioner ), Reference ( RelatedPerson ) Value of extension
. . . extension 0..1 Extension agree | disagree | pending
. . . . extension 0 .. 0
. . . . url 1..1 uri "status"
. . . . valueCode 1..1 code Value of extension
Binding: GoalAcceptanceStatus ( required )
. . . extension 0..1 Extension Priority of goal for individual
. . . . extension 0 .. 0
. . . . url 1..1 uri "priority"
. . . . valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: GoalPriority ( example )
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/goal-acceptance"
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- Individual acceptance of goal -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/goal-acceptance" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="individual"> 1..1 Extension  <!-- 1..1 Individual whose acceptance is reflected -->
  <value[x]><!-- 1..1 Reference(Patient)|Reference(Practitioner)|Reference(RelatedPerson) 
      Value of extension --></value[x]>
 </extension>
 <extension url="status"> 0..1 Extension  <!-- 0..1 agree | disagree | pending -->
  <valueCode value="[code]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="priority"> 0..1 Extension  <!-- 0..1 Priority of goal for individual -->
  <valueCodeableConcept><!-- 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template 

{ // Individual acceptance of goal
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // Individual whose acceptance is reflected // R! 
        // from Element: extension
        "url" : "individual", // R! 
// value[x]: Value of extension. One of these 3:
        "valueReference" : { Reference(Patient) } // R! Value of extension
        "valueReference" : { Reference(Practitioner) }, // R! Value of extension
        "valueReference" : { Reference(RelatedPerson) }, // R! Value of extension
      },
      { // agree | disagree | pending //
        // from Element: extension
        "url" : "status", // R! 
        "valueCode" : "<code>" // R! Value of extension
      },
      { // Priority of goal for individual //
        // from Element: extension
        "url" : "priority", // R! 
        "valueCodeableConcept" : { CodeableConcept } // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/goal-acceptance", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/goal-acceptance
Individual acceptance of goal: Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders.
Use on element: Goal
. . . individual 1..1 Reference ( Patient ), Reference ( Practitioner ), Reference ( RelatedPerson ) The person whose acceptance/priority is being reflected.
. . . status 0..1 code Indicates whether the specified individual has accepted the goal or not.
. . . priority 0..1 CodeableConcept Indicates the relative priority assigned to the resource by the stakeholder.

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/goal-acceptance
Individual acceptance of goal: Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders.
Use on element: Goal
. . . extension 1..1 Extension Individual whose acceptance is reflected
. . . . extension 0 .. 0
. . . . url 1..1 uri "individual"
. . . . value[x] 1..1 Reference ( Patient ), Reference ( Practitioner ), Reference ( RelatedPerson ) Value of extension
. . . extension 0..1 Extension agree | disagree | pending
. . . . extension 0 .. 0
. . . . url 1..1 uri "status"
. . . . valueCode 1..1 code Value of extension
Binding: GoalAcceptanceStatus ( required )
. . . extension 0..1 Extension Priority of goal for individual
. . . . extension 0 .. 0
. . . . url 1..1 uri "priority"
. . . . valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: GoalPriority ( example )
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/goal-acceptance"
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- Individual acceptance of goal -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/goal-acceptance" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="individual"> 1..1 Extension  <!-- 1..1 Individual whose acceptance is reflected -->
  <value[x]><!-- 1..1 Reference(Patient)|Reference(Practitioner)|Reference(RelatedPerson) 
      Value of extension --></value[x]>
 </extension>
 <extension url="status"> 0..1 Extension  <!-- 0..1 agree | disagree | pending -->
  <valueCode value="[code]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="priority"> 0..1 Extension  <!-- 0..1 Priority of goal for individual -->
  <valueCodeableConcept><!-- 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template 

{ // Individual acceptance of goal
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // Individual whose acceptance is reflected // R! 
        // from Element: extension
        "url" : "individual", // R! 
// value[x]: Value of extension. One of these 3:
        "valueReference" : { Reference(Patient) } // R! Value of extension
        "valueReference" : { Reference(Practitioner) }, // R! Value of extension
        "valueReference" : { Reference(RelatedPerson) }, // R! Value of extension
      },
      { // agree | disagree | pending //
        // from Element: extension
        "url" : "status", // R! 
        "valueCode" : "<code>" // R! Value of extension
      },
      { // Priority of goal for individual //
        // from Element: extension
        "url" : "priority", // R! 
        "valueCodeableConcept" : { CodeableConcept } // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/goal-acceptance", // 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')]) )