View raw Markdown
type: search-paramsresource: SearchParameter

SearchParameter Search Parameters

<a id="base"></a>

base

Description: The resource type(s) this search parameter applies to

Type: token

Expression: SearchParameter.base

Path: SearchParameter.base

Standards Status: normative

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

<a id="code"></a>

code

Description: Code used in URL

Type: token

Expression: SearchParameter.code

Path: SearchParameter.code

Standards Status: normative

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

<a id="component"></a>

component

Description: Defines how the part works

Type: reference

Expression: SearchParameter.component.definition

Path: SearchParameter.component.definition

Standards Status: normative

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

<a id="context"></a>

context

Description: A use context assigned to the search parameter

Type: token

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

Path: {{name}}.useContext.valueCodeableConcept

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/SearchParameter-context

<a id="context-quantity"></a>

context-quantity

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

Type: quantity

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

Path: {{name}}.useContext.valueQuantity,{{name}}.useContext.valueRange

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/SearchParameter-context-quantity

<a id="context-type"></a>

context-type

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

Type: token

Expression: SearchParameter.useContext.code

Path: {{name}}.useContext.code

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/SearchParameter-context-type

<a id="context-type-quantity"></a>

context-type-quantity

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

Type: composite

Expression: SearchParameter.useContext

Standards Status: normative

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

<a id="context-type-value"></a>

context-type-value

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

Type: composite

Expression: SearchParameter.useContext

Standards Status: normative

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

<a id="date"></a>

date

Description: The search parameter publication date

Type: date

Expression: SearchParameter.date

Path: {{name}}.date

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/SearchParameter-date

<a id="derived-from"></a>

derived-from

Description: Original definition for the search parameter

Type: reference

Expression: SearchParameter.derivedFrom

Path: SearchParameter.derivedFrom

Standards Status: normative

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

<a id="description"></a>

description

Description: The description of the search parameter

Type: string

Expression: SearchParameter.description

Path: {{name}}.description

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/SearchParameter-description

<a id="identifier"></a>

identifier

Description: External identifier for the search parameter

Type: token

Expression: SearchParameter.identifier

Path: {{name}}.identifier

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/SearchParameter-identifier

<a id="identifier"></a>

identifier

Description: External identifier for the search parameter

Type: token

Expression: SearchParameter.identifier

Path: {{name}}.identifier

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/SearchParameter-identifier

<a id="jurisdiction"></a>

jurisdiction

Description: Jurisdiction of the authority that maintains the the search parameter

Type: token

Expression: SearchParameter.jurisdiction

Path: {{name}}.jurisdiction

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/SearchParameter-jurisdiction

<a id="name"></a>

name

Description: Computationally friendly name of the search parameter

Type: string

Expression: SearchParameter.name

Path: {{name}}.name

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/SearchParameter-name

<a id="publisher"></a>

publisher

Description: Name of the publisher of the search parameter

Type: string

Expression: SearchParameter.publisher

Path: {{name}}.publisher

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/SearchParameter-publisher

<a id="status"></a>

status

Description: The current status of the search parameter

Type: token

Expression: SearchParameter.status

Path: {{name}}.status

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/SearchParameter-status

<a id="target"></a>

target

Description: Types of resource (if a resource reference)

Type: token

Expression: SearchParameter.target

Path: SearchParameter.target

Standards Status: normative

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

<a id="type"></a>

type

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

Type: token

Expression: SearchParameter.type

Path: SearchParameter.type

Standards Status: normative

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

<a id="url"></a>

url

Description: The uri that identifies the search parameter

Type: uri

Expression: SearchParameter.url

Path: {{name}}.url

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/SearchParameter-url

<a id="version"></a>

version

Description: The business version of the search parameter

Type: token

Expression: SearchParameter.version

Path: {{name}}.version

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/SearchParameter-version

<a id="experimental"></a>

experimental

Description: Whether the SearchParameter is experimental

Type: token

Expression: SearchParameter.experimental

Path: SearchParameter.experimental

Standards Status: normative