R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). 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: 1InformativeUse Context: Any

URL for this extension: 

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

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

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.

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

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. search-parameter-combination0..*ExtensionURL = 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.


Use on Element ID CapabilityStatement.rest.resource
... required1..*stringA search parameter name in the combination which is required.

... optional0..*stringA search parameter name in the combination which is optional.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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.


Use on Element ID CapabilityStatement.rest.resource
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension 1..*ExtensionA required search parameter name
.... extension 0..0
.... url 1..1uri"required"
.... valueString 0..1stringValue of extension
... extension 0..*ExtensionAn optional search parameter name
.... extension 0..0
.... url 1..1uri"optional"
.... valueString 0..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
... value[x] 0..0

doco Documentation for this format

XML Template

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

<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"> 1..* Extension  <!-- 1..* A required search parameter name -->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="optional"> 0..* Extension  <!-- 0..* An optional search parameter name -->
  <valueString value="[string]"/><!-- 0..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 // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "required", // R! 
        "valueString" : "<string>" //Value of extension
      },
      { // An optional search parameter name //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "optional", // R! 
        "valueString" : "<string>" //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", // R! 
// value[x]: Value of extension. One of these 49:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. search-parameter-combination0..*ExtensionURL = 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.


Use on Element ID CapabilityStatement.rest.resource
... required1..*stringA search parameter name in the combination which is required.

... optional0..*stringA search parameter name in the combination which is optional.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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.


Use on Element ID CapabilityStatement.rest.resource
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension 1..*ExtensionA required search parameter name
.... extension 0..0
.... url 1..1uri"required"
.... valueString 0..1stringValue of extension
... extension 0..*ExtensionAn optional search parameter name
.... extension 0..0
.... url 1..1uri"optional"
.... valueString 0..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
... value[x] 0..0

doco Documentation for this format

XML Template

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

<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"> 1..* Extension  <!-- 1..* A required search parameter name -->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="optional"> 0..* Extension  <!-- 0..* An optional search parameter name -->
  <valueString value="[string]"/><!-- 0..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 // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "required", // R! 
        "valueString" : "<string>" //Value of extension
      },
      { // An optional search parameter name //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "optional", // R! 
        "valueString" : "<string>" //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", // R! 
// value[x]: Value of extension. One of these 49:
  }

 

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')]))