FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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: 1InformativeUse 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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: Goal
... individual1..1Reference(Patient), Reference(Practitioner), Reference(RelatedPerson)The person whose acceptance/priority is being reflected.
... status0..1codeIndicates whether the specified individual has accepted the goal or not.
... priority0..1CodeableConceptIndicates the relative priority assigned to the resource by the stakeholder.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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: Goal
... extension 1..1ExtensionIndividual whose acceptance is reflected
.... url 1..1uri"individual"
.... value[x] 1..1Reference(Patient), Reference(Practitioner), Reference(RelatedPerson)Value of extension
... extension 0..1Extensionagree | disagree | pending
.... url 1..1uri"status"
.... valueCode 0..1codeValue of extension
Binding: GoalAcceptanceStatus (required)
... extension 0..1ExtensionPriority of goal for individual
.... url 1..1uri"priority"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: GoalPriority (example)
... url 1..1uri"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[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]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="priority"> 0..1 Extension  <!-- 0..1 Priority of goal for individual -->
  <valueCodeableConcept><!-- 0..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

{ // acceptance
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // Individual whose acceptance is reflected // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "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
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "status", // R! 
        "valueCode" : "<code>" //Value of extension
      },
      { // Priority of goal for individual //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "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 38:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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: Goal
... individual1..1Reference(Patient), Reference(Practitioner), Reference(RelatedPerson)The person whose acceptance/priority is being reflected.
... status0..1codeIndicates whether the specified individual has accepted the goal or not.
... priority0..1CodeableConceptIndicates the relative priority assigned to the resource by the stakeholder.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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: Goal
... extension 1..1ExtensionIndividual whose acceptance is reflected
.... url 1..1uri"individual"
.... value[x] 1..1Reference(Patient), Reference(Practitioner), Reference(RelatedPerson)Value of extension
... extension 0..1Extensionagree | disagree | pending
.... url 1..1uri"status"
.... valueCode 0..1codeValue of extension
Binding: GoalAcceptanceStatus (required)
... extension 0..1ExtensionPriority of goal for individual
.... url 1..1uri"priority"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: GoalPriority (example)
... url 1..1uri"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[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]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="priority"> 0..1 Extension  <!-- 0..1 Priority of goal for individual -->
  <valueCodeableConcept><!-- 0..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

{ // acceptance
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // Individual whose acceptance is reflected // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "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
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "status", // R! 
        "valueCode" : "<code>" //Value of extension
      },
      { // Priority of goal for individual //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "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 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')]))