Extension: Variable

FHIR Infrastructure Work Group

Maturity Level: 1

Trial Use

Use Context: Any

Official URL: `http://hl7.org/fhir/StructureDefinition/variable`				Version: 5.0.0-snapshot3
draft as of 2013-12-05				Computable Name: Variable
Flags: Non-Modifier				OID: TBD

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

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.

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.

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: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
var-1: Variable expressions must have a name (xpath: value.name.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.