SearchParameter

ResourceFoundation · ConformanceTrial useMaturity 3

A search parameter that defines a named search item that can be used to search/filter on a resource.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

17 of 19 parameters tested

Structure

Show inherited elements (11)

Element	Card.	Type	Description
urlRequiredΣ	1..1	uri	Canonical identifier for this search parameter, represented as a URI (globally unique)
versionΣ	0..1	string	Business version of the search parameter
nameRequiredΣ	1..1	string	Name for this search parameter (computer friendly)
derivedFrom	0..1	canonical(SearchParameter)	Original definition for the search parameter
statusRequired?!Σ	1..1	code	draft | active | retired | unknownBinding (required): publication-status
experimentalΣ	0..1	boolean	For testing purposes, not real usage
dateΣ	0..1	dateTime	Date last changed
publisherΣ	0..1	string	Name of the publisher (organization or individual)
contactΣ	0..*	ContactDetail	Contact details for the publisher
descriptionRequiredΣ	1..1	markdown	Natural language description of the search parameter
useContextΣ	0..*	UsageContext	The context that the content is intended to support
jurisdictionΣ	0..*	CodeableConcept	Intended jurisdiction for search parameter (if applicable)Binding (extensible): jurisdiction
purpose	0..1	markdown	Why this search parameter is defined
codeRequiredΣ	1..1	code	Code used in URL
baseRequiredΣ	1..*	code	The resource type(s) this search parameter applies toBinding (required): resource-types
typeRequiredΣ	1..1	code	number | date | string | token | reference | composite | quantity | uri | specialBinding (required): search-param-type
expression	0..1	string	FHIRPath expression that extracts the values
xpath	0..1	string	XPath that extracts the values
xpathUsage	0..1	code	normal | phonetic | nearby | distance | otherBinding (required): search-xpath-usage
target	0..*	code	Types of resource (if a resource reference)Binding (required): resource-types
multipleOr	0..1	boolean	Allow multiple values per parameter (or)
multipleAnd	0..1	boolean	Allow multiple parameters (and)
comparator	0..*	code	eq | ne | gt | lt | ge | le | sa | eb | apBinding (required): search-comparator
modifier	0..*	code	missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofTypeBinding (required): search-modifier-code
chain	0..*	string	Chained names supported
component	0..*	BackboneElement	For Composite resources to define the parts
definitionRequired	1..1	canonical(SearchParameter)	Defines how the part works
expressionRequired	1..1	string	Subexpression relative to main expression

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/SearchParameter?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
base	token	The resource type(s) this search parameter applies to SearchParameter.base
code	token	Code used in URL SearchParameter.code
component	reference	Defines how the part works SearchParameter.component.definition
context	token	A use context assigned to the search parameter (SearchParameter.useContext.value.ofType(CodeableConcept))
context-quantity	quantity	A quantity- or range-valued use context assigned to the search parameter (SearchParameter.useContext.value.ofType(Quantity)) | (SearchParameter.useContext.value.ofType(Range))
context-type	token	A type of use context assigned to the search parameter SearchParameter.useContext.code
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the search parameter SearchParameter.useContext
context-type-value	composite	A use context type and value assigned to the search parameter SearchParameter.useContext
date	date	The search parameter publication date SearchParameter.date
derived-from	reference	Original definition for the search parameter SearchParameter.derivedFrom
description	string	The description of the search parameter SearchParameter.description
jurisdiction	token	Intended jurisdiction for the search parameter SearchParameter.jurisdiction
name	string	Computationally friendly name of the search parameter SearchParameter.name
publisher	string	Name of the publisher of the search parameter SearchParameter.publisher
status	token	The current status of the search parameter SearchParameter.status
target	token	Types of resource (if a resource reference) SearchParameter.target
type	token	number | date | string | token | reference | composite | quantity | uri | special SearchParameter.type
url	uri	The uri that identifies the search parameter SearchParameter.url
version	token	The business version of the search parameter SearchParameter.version

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition