SearchParameter - FHIR v6.0.0-ballot1

R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

5.6.16 Resource SearchParameter - Search Parameters

FHIR Infrastructure icon

Work Group

Maturity Level: N/A

Trial Use

Security Category: Anonymous

Compartments: No defined compartments

Search parameters for the Resource SearchParameter - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to 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.6.17 base

Parameter base:token

The resource type(s) this search parameter applies to

Resource SearchParameter

Expression SearchParameter.base

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

5.6.18 code

Parameter code:token

Code used in URL

Resource SearchParameter

Expression SearchParameter.code

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

5.6.19 component

Parameter component:reference

Defines how the part works

Resource SearchParameter

Expression SearchParameter.component.definition

Processing Mode Normal

Target Resources SearchParameter

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/CanonicalResource-context

This search parameter is part of the common search parameter CanonicalResource-context

5.6.20 context

Parameter context:token

SearchParameter: A use context assigned to the search parameter

Resource SearchParameter

Expression (SearchParameter.useContext.value.ofType(CodeableConcept))

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/CanonicalResource-context-quantity

This search parameter is part of the common search parameter CanonicalResource-context-quantity

5.6.21 context-quantity

Parameter context-quantity:quantity

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

Resource SearchParameter

Expression (SearchParameter.useContext.value.ofType(Quantity)) | (SearchParameter.useContext.value.ofType(Range))

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/CanonicalResource-context-type

This search parameter is part of the common search parameter CanonicalResource-context-type

5.6.22 context-type

Parameter context-type:token

SearchParameter: A type of use context assigned to the search parameter

Resource SearchParameter

Expression SearchParameter.useContext.code

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/CanonicalResource-context-type-quantity

This search parameter is part of the common search parameter CanonicalResource-context-type-quantity

5.6.23 context-type-quantity

Parameter context-type-quantity:composite

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

Resource SearchParameter

Expression SearchParameter.useContext

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: The parameter may only have one value (no comma separators)

Components

context-type code

context-quantity value.ofType(Quantity) | value.ofType(Range)

http://hl7.org/fhir/SearchParameter/CanonicalResource-context-type-value

This search parameter is part of the common search parameter CanonicalResource-context-type-value

5.6.24 context-type-value

Parameter context-type-value:composite

SearchParameter: A use context type and value assigned to the search parameter

Resource SearchParameter

Expression SearchParameter.useContext

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: The parameter may only have one value (no comma separators)

Components

context-type code

context value.ofType(CodeableConcept)

http://hl7.org/fhir/SearchParameter/CanonicalResource-date

This search parameter is part of the common search parameter CanonicalResource-date

5.6.25 date

Parameter date:date

SearchParameter: The search parameter publication date

Resource SearchParameter

Expression SearchParameter.date

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/SearchParameter-derived-from

5.6.26 derived-from

Parameter derived-from:reference

Original definition for the search parameter

Resource SearchParameter

Expression SearchParameter.derivedFrom

Processing Mode Normal

Target Resources SearchParameter

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/CanonicalResource-description

This search parameter is part of the common search parameter CanonicalResource-description

5.6.27 description

Parameter description:string

SearchParameter: The description of the search parameter

Resource SearchParameter

Expression SearchParameter.description

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/CanonicalResource-identifier

This search parameter is part of the common search parameter CanonicalResource-identifier

5.6.28 identifier

Parameter identifier:token

SearchParameter: External identifier for the search parameter

Resource SearchParameter

Expression SearchParameter.identifier

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/CanonicalResource-jurisdiction

This search parameter is part of the common search parameter CanonicalResource-jurisdiction

5.6.29 jurisdiction

Parameter jurisdiction:token

SearchParameter: Intended jurisdiction for the search parameter

Resource SearchParameter

Expression SearchParameter.jurisdiction

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/CanonicalResource-name

This search parameter is part of the common search parameter CanonicalResource-name

5.6.30 name

Parameter name:string

SearchParameter: Computationally friendly name of the search parameter

Resource SearchParameter

Expression SearchParameter.name

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/CanonicalResource-publisher

This search parameter is part of the common search parameter CanonicalResource-publisher

5.6.31 publisher

Parameter publisher:string

SearchParameter: Name of the publisher of the search parameter

Resource SearchParameter

Expression SearchParameter.publisher

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/CanonicalResource-status

This search parameter is part of the common search parameter CanonicalResource-status

5.6.32 status

Parameter status:token

SearchParameter: The current status of the search parameter

Resource SearchParameter

Expression SearchParameter.status

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

5.6.33 target

Parameter target:token

Types of resource (if a resource reference)

Resource SearchParameter

Expression SearchParameter.target

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

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

5.6.34 type

Parameter type:token

Resource SearchParameter

Expression SearchParameter.type

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/CanonicalResource-url

This search parameter is part of the common search parameter CanonicalResource-url

5.6.35 url

Parameter url:uri

SearchParameter: The uri that identifies the search parameter

Resource SearchParameter

Expression SearchParameter.url

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true

http://hl7.org/fhir/SearchParameter/CanonicalResource-version

This search parameter is part of the common search parameter CanonicalResource-version

5.6.36 version

Parameter version:token

SearchParameter: The business version of the search parameter

Resource SearchParameter

Expression SearchParameter.version

Processing Mode Normal

Multiples

multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true