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

Extension: CharacteristicExpression

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

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

Version: 5.0.0-ballot

Name: CharacteristicExpression

Title: Characteristic Expression

Modifier: This extension is not a modifier extension

Status: draft

Definition: An expression that defines the criteria for group membership. This extension can only be used on a Group resource with a membership of `definitional`. When this expression is used, the Group resource cannot have any characteristic elements; this mechanism is exclusive with characteristics. The result of the expression SHALL be boolean-valued. The expression SHALL be parameterized with a `%context` variable that represents the subject being tested for membership. If evaluation of the expression results in `true`, the subject is considered a member of the group.

Committee: FHIR Infrastructure Work Group

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

An expression that defines the criteria for group membership. This extension can only be used on a Group resource with a membership of definitional. When this expression is used, the Group resource cannot have any characteristic elements; this mechanism is exclusive with characteristics. The result of the expression SHALL be boolean-valued. The expression SHALL be parameterized with a %context variable that represents the subject being tested for membership. If evaluation of the expression results in true, the subject is considered a member of the group.

Context of Use: Use on Element ID Group

Summary

Name	Flags	Card.	Type	Description & Constraints
CharacteristicExpression		0..1	Expression	URL = http://hl7.org/fhir/StructureDefinition/characteristicExpression CharacteristicExpression: An expression that defines the criteria for group membership. This extension can only be used on a Group resource with a membership of definitional. When this expression is used, the Group resource cannot have any characteristic elements; this mechanism is exclusive with characteristics. The result of the expression SHALL be boolean-valued. The expression SHALL be parameterized with a %context variable that represents the subject being tested for membership. If evaluation of the expression results in true, the subject is considered a member of the group. Use on Element ID Group
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/characteristicExpression CharacteristicExpression: An expression that defines the criteria for group membership. This extension can only be used on a Group resource with a membership of definitional. When this expression is used, the Group resource cannot have any characteristic elements; this mechanism is exclusive with characteristics. The result of the expression SHALL be boolean-valued. The expression SHALL be parameterized with a %context variable that represents the subject being tested for membership. If evaluation of the expression results in true, the subject is considered a member of the group. Use on Element ID Group
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/characteristicExpression"
value[x]	1..1	Expression	Value of extension
Documentation for this format

XML Template

<!-- CharacteristicExpression -->

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

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
CharacteristicExpression		0..1	Expression	URL = http://hl7.org/fhir/StructureDefinition/characteristicExpression CharacteristicExpression: An expression that defines the criteria for group membership. This extension can only be used on a Group resource with a membership of definitional. When this expression is used, the Group resource cannot have any characteristic elements; this mechanism is exclusive with characteristics. The result of the expression SHALL be boolean-valued. The expression SHALL be parameterized with a %context variable that represents the subject being tested for membership. If evaluation of the expression results in true, the subject is considered a member of the group. Use on Element ID Group
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/characteristicExpression CharacteristicExpression: An expression that defines the criteria for group membership. This extension can only be used on a Group resource with a membership of definitional. When this expression is used, the Group resource cannot have any characteristic elements; this mechanism is exclusive with characteristics. The result of the expression SHALL be boolean-valued. The expression SHALL be parameterized with a %context variable that represents the subject being tested for membership. If evaluation of the expression results in true, the subject is considered a member of the group. Use on Element ID Group
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/characteristicExpression"
value[x]	1..1	Expression	Value of extension
Documentation for this format

XML Template

<!-- CharacteristicExpression -->

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

JSON Template

{ // CharacteristicExpression
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/characteristicExpression", // 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')]))
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.