FHIR Release 3 (STU) R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (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 : 1 Informative Use 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

A container for This extension defines a single allowable possible search parameter combination. 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: Element ID CapabilityStatement.rest.resource

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension search-parameter-combination 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
search-parameter-combination: A container for This extension defines a single allowable possible search parameter combination. 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: Element ID CapabilityStatement.rest.resource
. . . required 1..* string A search parameter name in the combination which is required.

. . . optional 0..* string A search parameter name in the combination which is optional.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
search-parameter-combination: A container for This extension defines a single allowable possible search parameter combination. 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: Element ID CapabilityStatement.rest.resource
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 1..* Extension A required search parameter name
. . . . extension 0..0
... . url 1..1 uri "required" "required"
. . . . valueString 0..1 string Value of extension
. . . extension 0..* Extension An optional search parameter name
. . . . extension 0..0
... . url 1..1 uri "optional" "optional"
. . . . valueString 0..1 string Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

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

< xmlns="http://hl7.org/fhir"

<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

Name Flags Card. Type Description & Constraints doco
. . extension search-parameter-combination 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
search-parameter-combination: A container for This extension defines a single allowable possible search parameter combination. 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: Element ID CapabilityStatement.rest.resource
. . . required 1..* string A search parameter name in the combination which is required.

. . . optional 0..* string A search parameter name in the combination which is optional.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
search-parameter-combination: A container for This extension defines a single allowable possible search parameter combination. 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: Element ID CapabilityStatement.rest.resource
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 1..* Extension A required search parameter name
. . . . extension 0..0
... . url 1..1 uri "required" "required"
. . . . valueString 0..1 string Value of extension
. . . extension 0..* Extension An optional search parameter name
. . . . extension 0..0
... . url 1..1 uri "optional" "optional"
. . . . valueString 0..1 string Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

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

< xmlns="http://hl7.org/fhir"

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