Snapshot 3: Connectathon 32 Base

This is Snapshot #3 for FHIR R5, released to support Connectathon 32. For a full list of available versions, see the Directory of published versions.

Extension: CapabilityStatement Search Parameter Use

FHIR Infrastructure Work Group Maturity Level: 1Trial UseUse Context: Any
Official URL: http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use Version: 5.0.0-snapshot3
draft as of 2022-08-12 Computable Name: CSSearchParameterUse
Flags: Non-Modifier OID: 2.16.840.1.113883.4.642.5.1045

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

Definition

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.

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. CSSearchParameterUse0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use
CSSearchParameterUse: This extension defines if a search parameter is only allowed in certain contexts


Use on Element ID CapabilityStatement.rest.resource
... allow-standalone1..1booleanIf this search parameter can use used in standalone search.

... allow-include1..1booleanIf this search parameter can use used in _include search.

... allow-revinclude1..1booleanIf this search parameter can use used in _revinclude search.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use
CSSearchParameterUse: This extension defines if a search parameter is only allowed in certain contexts


Use on Element ID CapabilityStatement.rest.resource
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:required 1..1ExtensionIf this search parameter can use used in standalone search.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"allow-standalone"
.... value[x] 1..1booleanValue of extension
... extension:allow-include 1..1ExtensionIf this search parameter can use used in _include search.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"allow-include"
.... value[x] 1..1booleanValue of extension
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"allow-revinclude"
.... value[x] 1..1booleanValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- CSSearchParameterUse -->doco

<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

{ // CSSearchParameterUse
    "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

NameFlagsCard.TypeDescription & Constraintsdoco
.. CSSearchParameterUse0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use
CSSearchParameterUse: This extension defines if a search parameter is only allowed in certain contexts


Use on Element ID CapabilityStatement.rest.resource
... allow-standalone1..1booleanIf this search parameter can use used in standalone search.

... allow-include1..1booleanIf this search parameter can use used in _include search.

... allow-revinclude1..1booleanIf this search parameter can use used in _revinclude search.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use
CSSearchParameterUse: This extension defines if a search parameter is only allowed in certain contexts


Use on Element ID CapabilityStatement.rest.resource
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:required 1..1ExtensionIf this search parameter can use used in standalone search.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"allow-standalone"
.... value[x] 1..1booleanValue of extension
... extension:allow-include 1..1ExtensionIf this search parameter can use used in _include search.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"allow-include"
.... value[x] 1..1booleanValue of extension
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"allow-revinclude"
.... value[x] 1..1booleanValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-use"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- CSSearchParameterUse -->doco

<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

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