SearchParameter

Normative Conformance

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

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/SearchParameter

Interaction	Method	Path
Read	GET	/fhir/R5/SearchParameter/[id]
Vread	GET	/fhir/R5/SearchParameter/[id]/_history/[vid]
Update	PUT	/fhir/R5/SearchParameter/[id]
Patch	PATCH	/fhir/R5/SearchParameter/[id]
Delete	DELETE	/fhir/R5/SearchParameter/[id]
Create	POST	/fhir/R5/SearchParameter
Search	GET	/fhir/R5/SearchParameter?...
History	GET	/fhir/R5/SearchParameter/[id]/_history
Type-history	GET	/fhir/R5/SearchParameter/_history

Top-level elements

Element	Type(s)	Cardinality	Description
url	uri	1..1	Canonical identifier for this search parameter, represented as a URI (globally unique)
identifier	Identifier	0..*	Additional identifier for the search parameter (business identifier)
version	string	0..1	Business version of the search parameter
versionAlgorithm[x]	string / Coding	0..1	How to compare versions
name	string	1..1	Name for this search parameter (computer friendly)
title	string	0..1	Name for this search parameter (human friendly)
derivedFrom	canonical	0..1	Original definition for the search parameter
status	code	1..1	draft
experimental	boolean	0..1	For testing purposes, not real usage
date	dateTime	0..1	Date last changed
publisher	string	0..1	Name of the publisher/steward (organization or individual)
contact	ContactDetail	0..*	Contact details for the publisher
description	markdown	1..1	Natural language description of the search parameter
useContext	UsageContext	0..*	The context that the content is intended to support
jurisdiction	CodeableConcept	0..*	Intended jurisdiction for search parameter (if applicable)
purpose	markdown	0..1	Why this search parameter is defined
copyright	markdown	0..1	Use and/or publishing restrictions
copyrightLabel	string	0..1	Copyright holder and year(s)
code	code	1..1	Recommended name for parameter in search url
base	code	1..*	The resource type(s) this search parameter applies to
type	code	1..1	number
expression	string	0..1	FHIRPath expression that extracts the values
processingMode	code	0..1	normal
constraint	string	0..1	FHIRPath expression that constraints the usage of this SearchParamete
target	code	0..*	Types of resource (if a resource reference)
multipleOr	boolean	0..1	Allow multiple values per parameter (or)
multipleAnd	boolean	0..1	Allow multiple parameters (and)
comparator	code	0..*	eq
modifier	code	0..*	missing
chain	string	0..*	Chained names supported
component	BackboneElement	0..*	For Composite resources to define the parts

Resource-specific search parameters

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

Reference

• Official FHIR R5 spec: SearchParameter
• Maturity: Normative (FMM 5).