Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). 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

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

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. Use on 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.
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. Use on Element ID CapabilityStatement.rest.resource
extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:required	1..*	Extension	A required search parameter name
id	0..1	string	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	string	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
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueInteger64		integer64
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueContributor		Contributor
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueDosage		Dosage
valueMeta		Meta
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">  1..* Extension  <!--  1..* A required search parameter name -->
  <valueString value="[string]"/><!--  1..1 Value of extension -->
 </extension>
 <extension url="optional">  0..* Extension  <!--  0..* An optional search parameter name -->
  <valueString value="[string]"/><!--  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 // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "required", // R! 
        "valueString" : "<string>" // C? R! Value of extension
      },
      { // An optional search parameter name // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "optional", // R! 
        "valueString" : "<string>" // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", // R! 
// value[x]: Value of extension. One of these 51:
  }

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. Use on 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.
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. Use on Element ID CapabilityStatement.rest.resource
extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:required	1..*	Extension	A required search parameter name
id	0..1	string	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	string	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
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueInteger64		integer64
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueContributor		Contributor
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueDosage		Dosage
valueMeta		Meta
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">  1..* Extension  <!--  1..* A required search parameter name -->
  <valueString value="[string]"/><!--  1..1 Value of extension -->
 </extension>
 <extension url="optional">  0..* Extension  <!--  0..* An optional search parameter name -->
  <valueString value="[string]"/><!--  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 // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "required", // R! 
        "valueString" : "<string>" // C? R! Value of extension
      },
      { // An optional search parameter name // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "optional", // R! 
        "valueString" : "<string>" // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", // R! 
// value[x]: Value of extension. One of these 51:
  }

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)