This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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
Detailed Descriptions for the elements in the extension.
Extension
Element Id Extension
Definition
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.
Cardinality 0..* This element is affected by the following invariants: ele-1
Comments
For example, on the Patient Resource you could use this to state support for searching by Patient.name and Patient.gender is required.
Invariants
Inherited by this element
ele-1 Rule All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters ext-1 Rule Must have either extensions or value[x], not both
extension.exists() != value.exists()
Extension.id
Element Id 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.
Extension.extension
Element Id Extension.extension
Definition
May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the 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.
Invariants
Inherited by this element
ele-1 Rule All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) ext-1 Rule Must have either extensions or value[x], not both
extension.exists() != value.exists()
Slicing This element introduces a set of slices. The slicing rules are:
- unordered
- Open
- discriminators: value:url
Extension.extension(required)
Element Id Extension.extension:required
Definition
A search parameter name in the combination which is required.
Invariants
Inherited by this element
ele-1 Rule All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) ext-1 Rule Must have either extensions or value[x], not both
extension.exists() != value.exists()
Extension.extension.id
Element Id Extension.extension:required.id
Definition
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extension.extension.extension
Element Id Extension.extension:required.extension
Invariants
Inherited by this element
ele-1 Rule All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) ext-1 Rule Must have either extensions or value[x], not both
extension.exists() != value.exists()
Slicing This element introduces a set of slices. The slicing rules are:
- unordered
- Open
- discriminators: value:url
Extension.extension.url
Element Id Extension.extension:required.url
Definition
Source of the definition for the extension code - a logical name or a URL.
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.value[x]
Element Id Extension.extension:required.value[x]
Definition
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Invariants
Inherited by this element
ele-1 Rule All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Extension.extension(optional)
Element Id Extension.extension:optional
Definition
A search parameter name in the combination which is optional.
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.
Invariants
Inherited by this element
ele-1 Rule All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) ext-1 Rule Must have either extensions or value[x], not both
extension.exists() != value.exists()
Extension.extension.id
Element Id Extension.extension:optional.id
Definition
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extension.extension.extension
Element Id Extension.extension:optional.extension
Invariants
Inherited by this element
ele-1 Rule All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) ext-1 Rule Must have either extensions or value[x], not both
extension.exists() != value.exists()
Slicing This element introduces a set of slices. The slicing rules are:
- unordered
- Open
- discriminators: value:url
Extension.extension.url
Element Id Extension.extension:optional.url
Definition
Source of the definition for the extension code - a logical name or a URL.
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.value[x]
Element Id Extension.extension:optional.value[x]
Definition
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Invariants
Inherited by this element
ele-1 Rule All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Extension.url
Element Id Extension.url
Definition
Source of the definition for the extension code - a logical name or a URL.
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]
Element Id Extension.value[x]
Definition
Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Type Choice of:
base64Binary,
boolean,
canonical,
code,
date,
dateTime,
decimal,
id,
instant,
integer,
markdown,
oid,
positiveInt,
string,
time,
unsignedInt,
uri,
url,
uuid,
Address,
Age,
Annotation,
Attachment,
CodeableConcept,
CodeableReference,
Coding,
ContactPoint,
Count,
Distance,
Duration,
HumanName,
Identifier,
Money,
Period,
Quantity,
Range,
Ratio,
RatioRange,
Reference,
SampledData,
Signature,
Timing,
ContactDetail,
Contributor,
DataRequirement,
Expression,
ParameterDefinition,
RelatedArtifact,
TriggerDefinition,
UsageContext,
Dosage
Invariants
Inherited by this element
ele-1 Rule All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())