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 . Page versions: R4B R4 R3

Extension: search-parameter-combination

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

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

Version: 5.0.0-ballot

Name: search-parameter-combination

Title: Search Parameter Combination

Modifier: This extension is not a modifier extension

Status: draft

Definition: This extension defines a possible search parameter combination by listing a set of search parameters and indicating whether they are required or optional. - If a search combination is specified, clients should expect that they must submit a search that meets one of the required combinations or the search will be unsuccessful. - If multiple search parameter combinations are specified, a client may pick between them, and supply the minimal required parameters for any of the combinations. - If no parameters in the set of search parameters are listed as required, then *at least one* of the listed optional parameters must be present. This shorthand method is the same as repeating the entire extension for each combination of optional and required search parameters.

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: HL7

This extension defines a possible search parameter combination by listing a set of search parameters and indicating whether they are required or optional.

If a search combination is specified, clients should expect that they must submit a search that meets one of the required combinations or the search will be unsuccessful.
If multiple search parameter combinations are specified, a client may pick between them, and supply the minimal required parameters for any of the combinations.
If no parameters in the set of search parameters are listed as required, then at least one of the listed optional parameters must be present. This shorthand method is the same as repeating the entire extension for each combination of optional and required search parameters.

Comment:

For example, on the Patient Resource you could use this to state support for searching by Patient.name and Patient.gender is required.

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

Summary

Name	Card.	Type	Description & Constraints
search-parameter-combination	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination search-parameter-combination: This extension defines a possible search parameter combination by listing a set of search parameters and indicating whether they are required or optional. If a search combination is specified, clients should expect that they must submit a search that meets one of the required combinations or the search will be unsuccessful. If multiple search parameter combinations are specified, a client may pick between them, and supply the minimal required parameters for any of the combinations. If no parameters in the set of search parameters are listed as required, then at least one of the listed optional parameters must be present. This shorthand method is the same as repeating the entire extension for each combination of optional and required search parameters. Use on Element ID CapabilityStatement.rest.resource
required	0..*	string	A required search parameter name
optional	0..*	string	An optional search parameter name
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination search-parameter-combination: This extension defines a possible search parameter combination by listing a set of search parameters and indicating whether they are required or optional. If a search combination is specified, clients should expect that they must submit a search that meets one of the required combinations or the search will be unsuccessful. If multiple search parameter combinations are specified, a client may pick between them, and supply the minimal required parameters for any of the combinations. If no parameters in the set of search parameters are listed as required, then at least one of the listed optional parameters must be present. This shorthand method is the same as repeating the entire extension for each combination of optional and required search parameters. 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	0..*	Extension	A required search parameter name
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"required"
value[x]	1..1	string	Value of extension
extension:optional	0..*	Extension	An optional search parameter name
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"optional"
value[x]	1..1	string	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
value[x]	0..0
Documentation for this format

XML Template

<!-- search-parameter-combination -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="required"> I 0..* Extension  <!-- I 0..* A required search parameter name -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="optional"> I 0..* Extension  <!-- I 0..* An optional search parameter name -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // search-parameter-combination
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // A required search parameter name // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "required", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // An optional search parameter name // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "optional", // R! 
        "valueString" : "<string>" // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : [{ Extension }], // IA required search parameter name
    "extension" : [{ Extension }], // IAn optional search parameter name
    "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name	Card.	Type	Description & Constraints
search-parameter-combination	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination search-parameter-combination: This extension defines a possible search parameter combination by listing a set of search parameters and indicating whether they are required or optional. If a search combination is specified, clients should expect that they must submit a search that meets one of the required combinations or the search will be unsuccessful. If multiple search parameter combinations are specified, a client may pick between them, and supply the minimal required parameters for any of the combinations. If no parameters in the set of search parameters are listed as required, then at least one of the listed optional parameters must be present. This shorthand method is the same as repeating the entire extension for each combination of optional and required search parameters. Use on Element ID CapabilityStatement.rest.resource
required	0..*	string	A required search parameter name
optional	0..*	string	An optional search parameter name
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination search-parameter-combination: This extension defines a possible search parameter combination by listing a set of search parameters and indicating whether they are required or optional. If a search combination is specified, clients should expect that they must submit a search that meets one of the required combinations or the search will be unsuccessful. If multiple search parameter combinations are specified, a client may pick between them, and supply the minimal required parameters for any of the combinations. If no parameters in the set of search parameters are listed as required, then at least one of the listed optional parameters must be present. This shorthand method is the same as repeating the entire extension for each combination of optional and required search parameters. 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	0..*	Extension	A required search parameter name
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"required"
value[x]	1..1	string	Value of extension
extension:optional	0..*	Extension	An optional search parameter name
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"optional"
value[x]	1..1	string	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
value[x]	0..0
Documentation for this format

XML Template

<!-- search-parameter-combination -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="required"> I 0..* Extension  <!-- I 0..* A required search parameter name -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="optional"> I 0..* Extension  <!-- I 0..* An optional search parameter name -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // search-parameter-combination
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // A required search parameter name // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "required", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // An optional search parameter name // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "optional", // R! 
        "valueString" : "<string>" // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : [{ Extension }], // IA required search parameter name
    "extension" : [{ Extension }], // IAn optional search parameter name
    "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" // 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.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.