FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). 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 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 acceptance 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 I 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension extension:individual I 1..1 Extension Individual whose acceptance is reflected
. . . . extension I 0..0
. . . . url 1..1 uri "individual" "individual"
. . . . value[x] I 1..1 Reference ( Patient ), Reference ( | Practitioner ), Reference ( | RelatedPerson ) Value of extension
. . . extension extension:status I 0..1 Extension agree | disagree | pending
. . . . extension I 0..0
. . . . url 1..1 uri "status" "status"
. . . valueCode . value[x] I 0..1 1..1 code Value of extension
Binding: GoalAcceptanceStatus ( required )
. . . extension extension:priority I 0..1 Extension Priority of goal for individual
. . . . extension I 0..0
. . . . url 1..1 uri "priority" "priority"
. . . valueCodeableConcept . value[x] I 0..1 1..1 CodeableConcept Value of extension
Binding: GoalPriority Goal priority ( example )
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/goal-acceptance" "http://hl7.org/fhir/StructureDefinition/goal-acceptance"
. . . value[x] I 0 .. 0
. . . . valueBase64Binary base64Binary
.... valueBoolean boolean
.... valueCanonical canonical ()
.... valueCode code
.... valueDate date
.... valueDateTime dateTime
.... valueDecimal decimal
.... valueId id
.... valueInstant instant
.... valueInteger integer
.... valueMarkdown markdown
.... valueOid oid
.... valuePositiveInt positiveInt
.... valueString string
.... valueTime time
.... valueUnsignedInt unsignedInt
.... valueUri uri
.... valueUrl url
.... valueUuid uuid
.... valueAddress Address
.... valueAge Age
.... valueAnnotation Annotation
.... valueAttachment Attachment
.... valueCodeableConcept CodeableConcept
.... valueCoding Coding
.... valueContactPoint ContactPoint
.... valueCount Count
.... valueDistance Distance
.... valueDuration Duration
.... valueHumanName HumanName
.... valueIdentifier Identifier
.... valueMoney Money
.... valuePeriod Period
.... valueQuantity Quantity
.... valueRange Range
.... valueRatio Ratio
.... valueReference Reference ()
.... valueSampledData SampledData
.... valueSignature Signature
.... valueTiming Timing
.... valueContactDetail ContactDetail
.... valueContributor Contributor
.... valueDataRequirement DataRequirement
.... valueExpression Expression
.... valueParameterDefinition ParameterDefinition
.... valueRelatedArtifact RelatedArtifact
.... valueTriggerDefinition TriggerDefinition
.... valueUsageContext UsageContext
.... valueDosage Dosage
.... valueMeta Meta

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-->
 <
  <
      Value of extension</value[x]>

 <extension url="individual"> ?? 1..1 Extension  <!-- ?? 1..1 Individual whose acceptance is reflected -->
  <valueReference><!-- ?? 1..1 Reference(Patient) Value of extension --></valueReference>

 </extension>
 <
  <

 <extension url="status"> ?? 0..1 Extension  <!-- ?? 0..1 agree | disagree | pending -->
  <valueCode value="[code]"/><!-- ?? 1..1 Value of extension -->

 </extension>
 <
  <</valueCodeableConcept>

 <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 

{ // acceptance
    "
      { //  

    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Individual whose acceptance is reflected // C? R! 

        // from Element: extension
        "
        ],

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

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

        "
        "
        "

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

      },
      { // 

      { // agree | disagree | pending // C?

        // from Element: extension
        "
        ],

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

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

        "valueCode" : "<code>" // C? R! Value of extension

      },
      { // 

      { // Priority of goal for individual // C?

        // from Element: extension
        "
        ],

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

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

        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension

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


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

Summary

Name Flags Card. Type Description & Constraints doco
. . extension acceptance 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 I 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension extension:individual I 1..1 Extension Individual whose acceptance is reflected
. . . . extension I 0..0
. . . . url 1..1 uri "individual" "individual"
. . . . value[x] I 1..1 Reference ( Patient ), Reference ( | Practitioner ), Reference ( | RelatedPerson ) Value of extension
. . . extension extension:status I 0..1 Extension agree | disagree | pending
. . . . extension I 0..0
. . . . url 1..1 uri "status" "status"
. . . valueCode . value[x] I 0..1 1..1 code Value of extension
Binding: GoalAcceptanceStatus ( required )
. . . extension extension:priority I 0..1 Extension Priority of goal for individual
. . . . extension I 0..0
. . . . url 1..1 uri "priority" "priority"
. . . valueCodeableConcept . value[x] I 0..1 1..1 CodeableConcept Value of extension
Binding: GoalPriority Goal priority ( example )
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/goal-acceptance" "http://hl7.org/fhir/StructureDefinition/goal-acceptance"
. . . value[x] I 0 .. 0
. . . . valueBase64Binary base64Binary
.... valueBoolean boolean
.... valueCanonical canonical ()
.... valueCode code
.... valueDate date
.... valueDateTime dateTime
.... valueDecimal decimal
.... valueId id
.... valueInstant instant
.... valueInteger integer
.... valueMarkdown markdown
.... valueOid oid
.... valuePositiveInt positiveInt
.... valueString string
.... valueTime time
.... valueUnsignedInt unsignedInt
.... valueUri uri
.... valueUrl url
.... valueUuid uuid
.... valueAddress Address
.... valueAge Age
.... valueAnnotation Annotation
.... valueAttachment Attachment
.... valueCodeableConcept CodeableConcept
.... valueCoding Coding
.... valueContactPoint ContactPoint
.... valueCount Count
.... valueDistance Distance
.... valueDuration Duration
.... valueHumanName HumanName
.... valueIdentifier Identifier
.... valueMoney Money
.... valuePeriod Period
.... valueQuantity Quantity
.... valueRange Range
.... valueRatio Ratio
.... valueReference Reference ()
.... valueSampledData SampledData
.... valueSignature Signature
.... valueTiming Timing
.... valueContactDetail ContactDetail
.... valueContributor Contributor
.... valueDataRequirement DataRequirement
.... valueExpression Expression
.... valueParameterDefinition ParameterDefinition
.... valueRelatedArtifact RelatedArtifact
.... valueTriggerDefinition TriggerDefinition
.... valueUsageContext UsageContext
.... valueDosage Dosage
.... valueMeta Meta

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-->
 <
  <
      Value of extension</value[x]>

 <extension url="individual"> ?? 1..1 Extension  <!-- ?? 1..1 Individual whose acceptance is reflected -->
  <valueReference><!-- ?? 1..1 Reference(Patient) Value of extension --></valueReference>

 </extension>
 <
  <

 <extension url="status"> ?? 0..1 Extension  <!-- ?? 0..1 agree | disagree | pending -->
  <valueCode value="[code]"/><!-- ?? 1..1 Value of extension -->

 </extension>
 <
  <</valueCodeableConcept>

 <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 

{ // acceptance
    "
      { //  

    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Individual whose acceptance is reflected // C? R! 

        // from Element: extension
        "
        ],

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

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

        "
        "
        "

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

      },
      { // 

      { // agree | disagree | pending // C?

        // from Element: extension
        "
        ],

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

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

        "valueCode" : "<code>" // C? R! Value of extension

      },
      { // 

      { // Priority of goal for individual // C?

        // from Element: extension
        "
        ],

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

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

        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension

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


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

 

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