Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon

5.6.16 5.6.19 Resource SearchParameter - Search Parameters

Maturity Level : N/A
Responsible Owner: FHIR Infrastructure icon Work Group   Trial Use Normative 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 Generated Narrative: SearchParameter SearchParameter-base

5.6.20 base

Parameter base : token

The resource type(s) this search parameter applies to

Resource SearchParameter
Expression SearchParameter.base
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter SearchParameter-code

5.6.21 code

Parameter code : token

Code used in URL

Resource SearchParameter
Expression SearchParameter.code
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter SearchParameter-component

5.6.22 component

Parameter component : reference

Defines how the part works

Resource SearchParameter
Expression SearchParameter.component.definition
Processing Mode Normal
Target Resources SearchParameter
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter CanonicalResource-context

5.6.23 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter CanonicalResource-context-quantity

5.6.24 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter CanonicalResource-context-type

5.6.25 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter CanonicalResource-context-type-quantity

5.6.26 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components Comparators

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 Generated Narrative: SearchParameter CanonicalResource-context-type-value

5.6.27 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 The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components Comparators

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 Generated Narrative: SearchParameter CanonicalResource-date

5.6.28 date

Parameter date : date

SearchParameter : The search parameter publication date

Resource SearchParameter
Expression SearchParameter.date
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter SearchParameter-derived-from

5.6.29 derived-from

Parameter derived-from : reference

Original definition for the search parameter

Resource SearchParameter
Expression SearchParameter.derivedFrom
Processing Mode Normal
Target Resources SearchParameter
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter CanonicalResource-description

5.6.30 description

Parameter description : string

SearchParameter : The description of the search parameter

Resource SearchParameter
Expression SearchParameter.description
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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-experimental

Generated Narrative: SearchParameter SearchParameter-experimental

5.6.31 experimental

Parameter experimental : token

Whether the SearchParameter is experimental

Resource SearchParameter
Expression SearchParameter.experimental
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 Generated Narrative: SearchParameter CanonicalResource-identifier

5.6.32 identifier

Parameter identifier : token

SearchParameter : External identifier for the search parameter

Resource SearchParameter
Expression SearchParameter.identifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter CanonicalResource-jurisdiction

5.6.33 jurisdiction

Parameter jurisdiction : token

SearchParameter : Intended jurisdiction for Jurisdiction of the authority that maintains the the search parameter

Resource SearchParameter
Expression SearchParameter.jurisdiction
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter CanonicalResource-name

5.6.34 name

Parameter name : string

SearchParameter : Computationally friendly name of the search parameter

Resource SearchParameter
Expression SearchParameter.name
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter CanonicalResource-publisher

5.6.35 publisher

Parameter publisher : string

SearchParameter : Name of the publisher of the search parameter

Resource SearchParameter
Expression SearchParameter.publisher
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter CanonicalResource-status

5.6.36 status

Parameter status : token

SearchParameter : The current status of the search parameter

Resource SearchParameter
Expression SearchParameter.status
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter SearchParameter-target

5.6.37 target

Parameter target : token

Types of resource (if a resource reference)

Resource SearchParameter
Expression SearchParameter.target
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter SearchParameter-type

5.6.38 type

Parameter type : token

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

Resource SearchParameter
Expression SearchParameter.type
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter CanonicalResource-url

5.6.39 url

Parameter url : uri

SearchParameter : The uri that identifies the search parameter

Resource SearchParameter
Expression SearchParameter.url
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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 Generated Narrative: SearchParameter CanonicalResource-version

5.6.40 version

Parameter version : token

SearchParameter : The business version of the search parameter

Resource SearchParameter
Expression SearchParameter.version
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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