Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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

Extension: Variable

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/variable

Version: 5.0.0-ballot

Name: Variable

Title: Variable

Modifier: This extension is not a modifier extension

Status: draft

Definition: Variable specifying a logic to generate a variable for use in subsequent logic. The name of the variable will be added to FHIRPath's context when processing descendants of the element that contains this extension as well as extensions within the same element.

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: Health Level Seven International (FHIR Infrastructure)

Variable specifying a logic to generate a variable for use in subsequent logic. The name of the variable will be added to FHIRPath's context when processing descendants of the element that contains this extension as well as extensions within the same element.

Comment:

Ordering of variable extension declarations is significant as variables declared in one repetition of this extension might be used in subsequent extension repetitions

For questionnaires, see additional guidance and examples in the SDC implementation guide.

Context of Use: Use on Element ID Questionnaire, Element ID Questionnaire.item, Element ID Questionnaire.item.item, Element ID PlanDefinition, Element ID PlanDefinition.action, Element ID PlanDefinition.action.action, Element ID RequestOrchestration, Element ID RequestOrchestration.action, Element ID RequestOrchestration.action.action, Element ID ActivityDefinition, Element ID Measure, Element ID Measure.group or Element ID Measure.group.population

Summary

Name	Flags	Card.	Type	Description & Constraints
Variable		0..*	Expression	URL = http://hl7.org/fhir/StructureDefinition/variable Variable: Variable specifying a logic to generate a variable for use in subsequent logic. The name of the variable will be added to FHIRPath's context when processing descendants of the element that contains this extension as well as extensions within the same element. Use on Element ID Questionnaire, Element ID Questionnaire.item, Element ID Questionnaire.item.item, Element ID PlanDefinition, Element ID PlanDefinition.action, Element ID PlanDefinition.action.action, Element ID RequestOrchestration, Element ID RequestOrchestration.action, Element ID RequestOrchestration.action.action, Element ID ActivityDefinition, Element ID Measure, Element ID Measure.group or Element ID Measure.group.population
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/variable Variable: Variable specifying a logic to generate a variable for use in subsequent logic. The name of the variable will be added to FHIRPath's context when processing descendants of the element that contains this extension as well as extensions within the same element. Use on Element ID Questionnaire, Element ID Questionnaire.item, Element ID Questionnaire.item.item, Element ID PlanDefinition, Element ID PlanDefinition.action, Element ID PlanDefinition.action.action, Element ID RequestOrchestration, Element ID RequestOrchestration.action, Element ID RequestOrchestration.action.action, Element ID ActivityDefinition, Element ID Measure, Element ID Measure.group or Element ID Measure.group.population
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/variable"
value[x]	1..1	Expression	Value of extension
Documentation for this format

XML Template

<!-- Variable -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/variable" >
  <!-- from Element: extension -->
 <valueExpression><!-- I 1..1 Expression Value of extension --></valueExpression>
</extension>

JSON Template

{ // Variable
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/variable", // R! 
    "valueExpression" : { Expression } // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
Variable		0..*	Expression	URL = http://hl7.org/fhir/StructureDefinition/variable Variable: Variable specifying a logic to generate a variable for use in subsequent logic. The name of the variable will be added to FHIRPath's context when processing descendants of the element that contains this extension as well as extensions within the same element. Use on Element ID Questionnaire, Element ID Questionnaire.item, Element ID Questionnaire.item.item, Element ID PlanDefinition, Element ID PlanDefinition.action, Element ID PlanDefinition.action.action, Element ID RequestOrchestration, Element ID RequestOrchestration.action, Element ID RequestOrchestration.action.action, Element ID ActivityDefinition, Element ID Measure, Element ID Measure.group or Element ID Measure.group.population
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/variable Variable: Variable specifying a logic to generate a variable for use in subsequent logic. The name of the variable will be added to FHIRPath's context when processing descendants of the element that contains this extension as well as extensions within the same element. Use on Element ID Questionnaire, Element ID Questionnaire.item, Element ID Questionnaire.item.item, Element ID PlanDefinition, Element ID PlanDefinition.action, Element ID PlanDefinition.action.action, Element ID RequestOrchestration, Element ID RequestOrchestration.action, Element ID RequestOrchestration.action.action, Element ID ActivityDefinition, Element ID Measure, Element ID Measure.group or Element ID Measure.group.population
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/variable"
value[x]	1..1	Expression	Value of extension
Documentation for this format

XML Template

<!-- Variable -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/variable" >
  <!-- from Element: extension -->
 <valueExpression><!-- I 1..1 Expression Value of extension --></valueExpression>
</extension>

JSON Template

{ // Variable
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/variable", // R! 
    "valueExpression" : { Expression } // I R! Value of extension
  }

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')]))
var-1: Variable expressions must have a name (xpath: exists(f:valueExpression/f:name))
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.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.