Extension: search-parameter-combination

R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). 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 - Detailed Descriptions

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Detailed Descriptions for the elements in the extension.

Extension
Definition	A container for a single allowable parameter combination.
Control	0..* This element is affected by the following invariants: ele-1
Comments	If a search combination is specified, clients should expect that they must submit that required combination 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.
Invariants	Defined on this element 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')]))
Extension.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
Extension.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	This element introduces a set of slices. The slicing rules are: unordered Open discriminators: value:url
Extension.extension(required)
Definition	A search parameter name in the combination which is required.
Control	1..*
Type	Extension
Extension.extension.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
Extension.extension.extension
Definition	An Extension
Control	0..0
Type	Extension
Slicing	This element introduces a set of slices. The slicing rules are: unordered Open discriminators: value:url
Extension.extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	required
Extension.extension.valueString
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Control	0..1
Type	string
Extension.extension(optional)
Definition	A search parameter name in the combination which is optional.
Control	0..*
Type	Extension
Comments	If a defined parameter is not listed as a required or optional parameter, the implication is that the parameter is not supported with this combination. Servers may ignore It, though some may return an error if it is used.
Extension.extension.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
Extension.extension.extension
Definition	An Extension
Control	0..0
Type	Extension
Slicing	This element introduces a set of slices. The slicing rules are: unordered Open discriminators: value:url
Extension.extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	optional
Extension.extension.valueString
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Control	0..1
Type	string
Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
Extension.value[x]
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Control	0..0
Type	Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Dosage, ContactDetail, Contributor, DataRequirement, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Meta
[x] Note	See Choice of Data Types for further information about how to use [x]