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 R3

Extension: referenceFilter

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter

Version: 5.0.0-ballot

Name: referenceFilter

Title: null

Modifier: This extension is not a modifier extension

Status: retired

Definition: Identifies a filter to apply when looking up candidate answers for the question. **This extension has been replaced by the Structured Data Capture candidateExpression extension.**

Committee: FHIR Infrastructure Work Group

Status: retired. Extension maintained by: HL7

Identifies a filter to apply when looking up candidate answers for the question. This extension has been replaced by the Structured Data Capture candidateExpression extension.

Comment:

The filter may include $subj and/or $encounter which should be substituted by the implementer with the subject and/or encounter id relevant in the context in which the questionnaire is being populated. This extension has been replaced by the Structured Data Capture candidateExpression extension.

Context of Use: Use on Element ID Questionnaire.item or Element ID ElementDefinition, with Context Invariant = type='reference'

Summary

Name	Flags	Card.	Type	Description & Constraints
referenceFilter		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter referenceFilter: Identifies a filter to apply when looking up candidate answers for the question. This extension has been replaced by the Structured Data Capture candidateExpression extension. Use on Element ID Questionnaire.item or Element ID ElementDefinition, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type='reference'</code>
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter referenceFilter: Identifies a filter to apply when looking up candidate answers for the question. This extension has been replaced by the Structured Data Capture candidateExpression extension. Use on Element ID Questionnaire.item or Element ID ElementDefinition, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type='reference'</code>
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter"
value[x]	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- referenceFilter -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // referenceFilter
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter", // R! 
    "valueString" : "<string>" // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
referenceFilter		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter referenceFilter: Identifies a filter to apply when looking up candidate answers for the question. This extension has been replaced by the Structured Data Capture candidateExpression extension. Use on Element ID Questionnaire.item or Element ID ElementDefinition, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type='reference'</code>
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter referenceFilter: Identifies a filter to apply when looking up candidate answers for the question. This extension has been replaced by the Structured Data Capture candidateExpression extension. Use on Element ID Questionnaire.item or Element ID ElementDefinition, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type='reference'</code>
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter"
value[x]	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- referenceFilter -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // referenceFilter
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter", // R! 
    "valueString" : "<string>" // 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.