View raw Markdown
type: search-paramsresource: ValueSet

ValueSet Search Parameters

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

code

Description: This special parameter searches for codes in the value set. See additional notes on the ValueSet resource

Type: token

Expression: ValueSet.expansion.repeat(contains).code | ValueSet.compose.include.concept.code

Path: ValueSet.expansion.contains.code,ValueSet.compose.include.concept.code

Standards Status: normative

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

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

context

Description: A use context assigned to the value set

Type: token

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

Path: {{name}}.useContext.valueCodeableConcept

Standards Status: normative

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

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

context-quantity

Description: A quantity- or range-valued use context assigned to the value set

Type: quantity

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

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

Standards Status: normative

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

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

context-type

Description: A type of use context assigned to the value set

Type: token

Expression: ValueSet.useContext.code

Path: {{name}}.useContext.code

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/ValueSet-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 value set

Type: composite

Expression: ValueSet.useContext

Standards Status: normative

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

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

context-type-value

Description: A use context type and value assigned to the value set

Type: composite

Expression: ValueSet.useContext

Standards Status: normative

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

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

date

Description: The value set publication date

Type: date

Expression: ValueSet.date

Path: {{name}}.date

Standards Status: normative

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

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

description

Description: The description of the value set

Type: string

Expression: ValueSet.description

Path: {{name}}.description

Standards Status: normative

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

<a id="expansion"></a>

expansion

Description: Identifies the value set expansion (business identifier)

Type: uri

Expression: ValueSet.expansion.identifier

Path: ValueSet.expansion.identifier

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/ValueSet-expansion

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

identifier

Description: External identifier for the value set

Type: token

Expression: ValueSet.identifier

Path: {{name}}.identifier

Standards Status: normative

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

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

jurisdiction

Description: Jurisdiction of the authority that maintains the the value set

Type: token

Expression: ValueSet.jurisdiction

Path: {{name}}.jurisdiction

Standards Status: normative

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

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

name

Description: Computationally friendly name of the value set

Type: string

Expression: ValueSet.name

Path: {{name}}.name

Standards Status: normative

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

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

publisher

Description: Name of the publisher of the value set

Type: string

Expression: ValueSet.publisher

Path: {{name}}.publisher

Standards Status: normative

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

<a id="reference"></a>

reference

Description: A code system included or excluded in the value set or an imported value set

Type: uri

Expression: ValueSet.compose.include.system

Path: ValueSet.compose.include.system

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/ValueSet-reference

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

status

Description: The current status of the value set

Type: token

Expression: ValueSet.status

Path: {{name}}.status

Standards Status: normative

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

<a id="title"></a>

title

Description: The human-friendly name of the value set

Type: string

Expression: ValueSet.title

Path: {{name}}.title

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/ValueSet-title

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

url

Description: The uri that identifies the value set

Type: uri

Expression: ValueSet.url

Path: {{name}}.url

Standards Status: normative

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

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

version

Description: The business version of the value set

Type: token

Expression: ValueSet.version

Path: {{name}}.version

Standards Status: normative

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

<a id="effective"></a>

effective

Description: The time during which the ValueSet is intended to be in use

Type: date

Expression: ValueSet.effectivePeriod

Path: ValueSet.effectivePeriod

Standards Status: normative

URL: http://hl7.org/fhir/build/SearchParameter/MetadataResource-effective

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

derived-from

Description: A resource that the ValueSet is derived from

Type: reference

Expression: ValueSet.relatedArtifact.where(type='derived-from').resource

Path: ValueSet.relatedArtifact.resource

Standards Status: normative

<a id="predecessor"></a>

predecessor

Description: The predecessor of the ValueSet

Type: reference

Expression: ValueSet.relatedArtifact.where(type='predecessor').resource

Path: ValueSet.relatedArtifact.resource

Standards Status: normative

<a id="topic"></a>

topic

Description: Topics associated with the ValueSet

Type: token

Expression: ValueSet.topic

Path: ValueSet.topic

Standards Status: normative

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

experimental

Description: Whether the ValueSet is experimental

Type: token

Expression: ValueSet.experimental

Path: ValueSet.experimental

Standards Status: normative