FHIR Release 3 (STU) R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (v3.3.0: R4 Ballot 2). 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: acceptance

Patient Care Work Group   Maturity Level : 1 Informative Use 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: Element ID 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
acceptance: Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders.


Use on element: Element ID 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
acceptance: Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders.


Use on element: Element ID Goal
. . . extension 1..1 Extension Individual whose acceptance is reflected
. . . . url 1..1 uri "individual" "individual"
. . . . value[x] valueReference 1..1 Reference ( Patient ), Reference ( | Practitioner ), Reference ( | RelatedPerson ) Value of extension
. . . extension 0..1 Extension agree | disagree | pending
. . . . url 1..1 uri "status" "status"
. . . . valueCode 0..1 code Value of extension
Binding: GoalAcceptanceStatus ( required )
. . . extension 0..1 Extension Priority of goal for individual
. . . . url 1..1 uri "priority" "priority"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: GoalPriority ( example )
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/goal-acceptance" "http://hl7.org/fhir/StructureDefinition/goal-acceptance"
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- acceptance -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/goal-acceptance" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="individual"> 1..1 Extension  <!-- 1..1 Individual whose acceptance is reflected -->
  <
      Value of extension</value[x]>

  <valueReference><!-- 1..1 Reference(Patient) 
      Value of extension --></valueReference>

 </extension>
 <extension url="status"> 0..1 Extension  <!-- 0..1 agree | disagree | pending -->
  <

  <valueCode value="[code]"/><!-- 0..1 Value of extension -->

 </extension>
 <extension url="priority"> 0..1 Extension  <!-- 0..1 Priority of goal for individual -->
  <</valueCodeableConcept>

  <valueCodeableConcept><!-- 0..1 CodeableConcept Value of extension --></valueCodeableConcept>

 </extension>
</extension>

JSON Template 

{ // acceptance
    "

    "extension" : [ //  sliced by value:url  in the specified order, Open 

      { // Individual whose acceptance is reflected // R! 
        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "url" : "individual", // R! 


        "valueReference" : { Reference(Patient) } // R! Value of extension
        "
        "

      },
      { // agree | disagree | pending //
        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "url" : "status", // R! 
        "

        "valueCode" : "<code>" //Value of extension

      },
      { // Priority of goal for individual //
        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "url" : "priority", // R! 
        "

        "valueCodeableConcept" : { CodeableConcept } //Value of extension

      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/goal-acceptance", // R! 


// value[x]: Value of extension. One of these 48:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/goal-acceptance
acceptance: Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders.


Use on element: Element ID 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
acceptance: Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders.


Use on element: Element ID Goal
. . . extension 1..1 Extension Individual whose acceptance is reflected
. . . . url 1..1 uri "individual" "individual"
. . . . value[x] valueReference 1..1 Reference ( Patient ), Reference ( | Practitioner ), Reference ( | RelatedPerson ) Value of extension
. . . extension 0..1 Extension agree | disagree | pending
. . . . url 1..1 uri "status" "status"
. . . . valueCode 0..1 code Value of extension
Binding: GoalAcceptanceStatus ( required )
. . . extension 0..1 Extension Priority of goal for individual
. . . . url 1..1 uri "priority" "priority"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: GoalPriority ( example )
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/goal-acceptance" "http://hl7.org/fhir/StructureDefinition/goal-acceptance"
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- acceptance -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/goal-acceptance" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="individual"> 1..1 Extension  <!-- 1..1 Individual whose acceptance is reflected -->
  <
      Value of extension</value[x]>

  <valueReference><!-- 1..1 Reference(Patient) 
      Value of extension --></valueReference>

 </extension>
 <extension url="status"> 0..1 Extension  <!-- 0..1 agree | disagree | pending -->
  <

  <valueCode value="[code]"/><!-- 0..1 Value of extension -->

 </extension>
 <extension url="priority"> 0..1 Extension  <!-- 0..1 Priority of goal for individual -->
  <</valueCodeableConcept>

  <valueCodeableConcept><!-- 0..1 CodeableConcept Value of extension --></valueCodeableConcept>

 </extension>
</extension>

JSON Template 

{ // acceptance
    "

    "extension" : [ //  sliced by value:url  in the specified order, Open 

      { // Individual whose acceptance is reflected // R! 
        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "url" : "individual", // R! 


        "valueReference" : { Reference(Patient) } // R! Value of extension
        "
        "

      },
      { // agree | disagree | pending //
        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "url" : "status", // R! 
        "

        "valueCode" : "<code>" //Value of extension

      },
      { // Priority of goal for individual //
        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "url" : "priority", // R! 
        "

        "valueCodeableConcept" : { CodeableConcept } //Value of extension

      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/goal-acceptance", // R! 


// value[x]: Value of extension. One of these 48:
  }

 

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')]) )