FHIR General Extensions IG
0.1.0 - Working Copy International flag

This page is part of the FHIR Core Extensions Registry (v0.1.0: Releases Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Extension: CapabilityStatement Search Parameter Combination

Official URL: http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination Version: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: CSSearchParameterCombination
Other Identifiers: id: urn:oid:2.16.840.1.113883.4.642.5.1044

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.

Context of Use

This extension may be used on the following element(s):

  • Element ID CapabilityStatement.rest.resource

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 3 elements
Prohibited: 3 elements

Maturity: 1

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAn allowable parameter combination
... extension:required 0..*ExtensionA required search parameter name
.... extension 0..0
.... url 1..1uri"required"
.... value[x] 1..1stringValue of extension
... extension:optional 0..*ExtensionAn optional search parameter name
.... extension 0..0
.... url 1..1uri"optional"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAn allowable parameter combination
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:required 0..*ExtensionA required search parameter name
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"required"
.... value[x] 1..1stringValue of extension
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"optional"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 3 elements
Prohibited: 3 elements

Maturity: 1

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAn allowable parameter combination
... extension:required 0..*ExtensionA required search parameter name
.... extension 0..0
.... url 1..1uri"required"
.... value[x] 1..1stringValue of extension
... extension:optional 0..*ExtensionAn optional search parameter name
.... extension 0..0
.... url 1..1uri"optional"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAn allowable parameter combination
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:required 0..*ExtensionA required search parameter name
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"required"
.... value[x] 1..1stringValue of extension
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"optional"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Search Parameters for this Extension

(none found)

;