Release 5 Ballot

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

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use

Version: 5.0.0-ballot

Name: search-parameter-use

Title: Search Parameter Use

Modifier: This extension is not a modifier extension

Status: draft

Definition: This extension defines if a search parameter is only allowed in certain contexts

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: Health Level Seven, Inc. - [WG Name] WG

This extension defines if a search parameter is only allowed in certain contexts

Comment:

For example, A search parameter has allow-standalone=false, allow-include=true and allow-revinclude=true. This means server does not support using such search parameter in a standalone search but client can use this parameter in _include and _revInclude searches.

Context of Use: Use on Element ID CapabilityStatement.rest.resource

Summary

Name	Card.	Type	Description & Constraints
search-parameter-use	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use search-parameter-use: This extension defines if a search parameter is only allowed in certain contexts Use on Element ID CapabilityStatement.rest.resource
allow-standalone	1..1	boolean	If this search parameter can use used in standalone search.
allow-include	1..1	boolean	If this search parameter can use used in _include search.
allow-revinclude	1..1	boolean	If this search parameter can use used in _revinclude search.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use search-parameter-use: This extension defines if a search parameter is only allowed in certain contexts Use on Element ID CapabilityStatement.rest.resource
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:required	1..1	Extension	If this search parameter can use used in standalone search.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"allow-standalone"
value[x]	1..1	boolean	Value of extension
extension:allow-include	1..1	Extension	If this search parameter can use used in _include search.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"allow-include"
value[x]	1..1	boolean	Value of extension
extension:allow-revinclude	1..1	Extension	If this search parameter can use used in _revinclude search.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"allow-revinclude"
value[x]	1..1	boolean	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use"
value[x]	0..0
Documentation for this format

XML Template

<!-- search-parameter-use -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="allow-standalone"> I 1..1 Extension  <!-- I 1..1 If this search parameter can use used in standalone search. -->
  <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="allow-include"> I 1..1 Extension  <!-- I 1..1 If this search parameter can use used in _include search. -->
  <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="allow-revinclude"> I 1..1 Extension  <!-- I 1..1 If this search parameter can use used in _revinclude search. -->
  <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // search-parameter-use
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // If this search parameter can use used in standalone search. // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "allow-standalone", // R! 
        "valueBoolean" : <boolean> // I R! Value of extension
      },
      { // If this search parameter can use used in _include search. // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "allow-include", // R! 
        "valueBoolean" : <boolean> // I R! Value of extension
      },
      { // If this search parameter can use used in _revinclude search. // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "allow-revinclude", // R! 
        "valueBoolean" : <boolean> // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! If this search parameter can use used in standalone search.
    "extension" : { Extension }, // I R! If this search parameter can use used in _include search.
    "extension" : { Extension }, // I R! If this search parameter can use used in _revinclude search.
    "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name	Card.	Type	Description & Constraints
search-parameter-use	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use search-parameter-use: This extension defines if a search parameter is only allowed in certain contexts Use on Element ID CapabilityStatement.rest.resource
allow-standalone	1..1	boolean	If this search parameter can use used in standalone search.
allow-include	1..1	boolean	If this search parameter can use used in _include search.
allow-revinclude	1..1	boolean	If this search parameter can use used in _revinclude search.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use search-parameter-use: This extension defines if a search parameter is only allowed in certain contexts Use on Element ID CapabilityStatement.rest.resource
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:required	1..1	Extension	If this search parameter can use used in standalone search.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"allow-standalone"
value[x]	1..1	boolean	Value of extension
extension:allow-include	1..1	Extension	If this search parameter can use used in _include search.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"allow-include"
value[x]	1..1	boolean	Value of extension
extension:allow-revinclude	1..1	Extension	If this search parameter can use used in _revinclude search.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"allow-revinclude"
value[x]	1..1	boolean	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use"
value[x]	0..0
Documentation for this format

XML Template

<!-- search-parameter-use -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="allow-standalone"> I 1..1 Extension  <!-- I 1..1 If this search parameter can use used in standalone search. -->
  <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="allow-include"> I 1..1 Extension  <!-- I 1..1 If this search parameter can use used in _include search. -->
  <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="allow-revinclude"> I 1..1 Extension  <!-- I 1..1 If this search parameter can use used in _revinclude search. -->
  <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // search-parameter-use
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // If this search parameter can use used in standalone search. // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "allow-standalone", // R! 
        "valueBoolean" : <boolean> // I R! Value of extension
      },
      { // If this search parameter can use used in _include search. // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "allow-include", // R! 
        "valueBoolean" : <boolean> // I R! Value of extension
      },
      { // If this search parameter can use used in _revinclude search. // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "allow-revinclude", // R! 
        "valueBoolean" : <boolean> // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! If this search parameter can use used in standalone search.
    "extension" : { Extension }, // I R! If this search parameter can use used in _include search.
    "extension" : { Extension }, // I R! If this search parameter can use used in _revinclude search.
    "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use" // R! 
  // value[x]: Value of extension: Prohibited
  }

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)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.