Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

5.5.15 Resource SearchParameter - Search Parameters

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Search Parameter Registry for the searchparameter resource

5.5.16 Search Parameters

Search parameter list for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/SearchParameter-base

5.5.17 base

Parameter base:token

The resource type(s) this search parameter applies to

ResourceSearchParameter
ExpressionSearchParameter.base
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/SearchParameter-code

5.5.18 code

Parameter code:token

Code used in URL

ResourceSearchParameter
ExpressionSearchParameter.code
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/SearchParameter-component

5.5.19 component

Parameter component:reference

Defines how the part works

ResourceSearchParameter
ExpressionSearchParameter.component.definition
Target ResourcesSearchParameter
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/SearchParameter-context

5.5.20 context

Parameter context:token

A use context assigned to the search parameter

Resources
Expression(SearchParameter.useContext.value as CodeableConcept)
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/SearchParameter-context-quantity

5.5.21 context-quantity

Parameter context-quantity:quantity

A quantity- or range-valued use context assigned to the search parameter

Resources
Expression(SearchParameter.useContext.value as Quantity) | (SearchParameter.useContext.value as Range)
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/SearchParameter-context-type

5.5.22 context-type

Parameter context-type:token

A type of use context assigned to the search parameter

Resources
ExpressionSearchParameter.useContext.code
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/SearchParameter-context-type-quantity

5.5.23 context-type-quantity

Parameter context-type-quantity:composite

A use context type and quantity- or range-based value assigned to the search parameter

Resources
ExpressionSearchParameter.useContext
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

context-typecode
context-quantityvalue.ofType(Quantity) | value.ofType(Range)
 
http://hl7.org/fhir/build/SearchParameter/SearchParameter-context-type-value

5.5.24 context-type-value

Parameter context-type-value:composite

A use context type and value assigned to the search parameter

Resources
ExpressionSearchParameter.useContext
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

context-typecode
contextvalue.ofType(CodeableConcept)
 
http://hl7.org/fhir/build/SearchParameter/SearchParameter-date

5.5.25 date

Parameter date:date

The search parameter publication date

Resources
ExpressionSearchParameter.date
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/SearchParameter-derived-from

5.5.26 derived-from

Parameter derived-from:reference

Original definition for the search parameter

ResourceSearchParameter
ExpressionSearchParameter.derivedFrom
Target ResourcesSearchParameter
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/SearchParameter-description

5.5.27 description

Parameter description:string

The description of the search parameter

Resources
ExpressionSearchParameter.description
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/SearchParameter-jurisdiction

5.5.28 jurisdiction

Parameter jurisdiction:token

Intended jurisdiction for the search parameter

Resources
ExpressionSearchParameter.jurisdiction
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/SearchParameter-name

5.5.29 name

Parameter name:string

Computationally friendly name of the search parameter

Resources
ExpressionSearchParameter.name
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/SearchParameter-publisher

5.5.30 publisher

Parameter publisher:string

Name of the publisher of the search parameter

Resources
ExpressionSearchParameter.publisher
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/SearchParameter-status

5.5.31 status

Parameter status:token

The current status of the search parameter

Resources
ExpressionSearchParameter.status
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/SearchParameter-target

5.5.32 target

Parameter target:token

Types of resource (if a resource reference)

ResourceSearchParameter
ExpressionSearchParameter.target
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/SearchParameter-type

5.5.33 type

Parameter type:token

number | date | string | token | reference | composite | quantity | uri | special

ResourceSearchParameter
ExpressionSearchParameter.type
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/SearchParameter-url

5.5.34 url

Parameter url:uri

The uri that identifies the search parameter

Resources
ExpressionSearchParameter.url
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/SearchParameter-version

5.5.35 version

Parameter version:token

The business version of the search parameter

Resources
ExpressionSearchParameter.version
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values