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

4.9.22 Resource ValueSet - Search Parameters

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

Search Parameter Registry for the valueset resource

4.9.23 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/ValueSet-code

4.9.24 code

Parameter code:token

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

ResourceValueSet
ExpressionValueSet.expansion.contains.code | ValueSet.compose.include.concept.code
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/ValueSet-context

4.9.25 context

Parameter context:token

A use context assigned to the value set

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

4.9.26 context-quantity

Parameter context-quantity:quantity

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

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

4.9.27 context-type

Parameter context-type:token

A type of use context assigned to the value set

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

4.9.28 context-type-quantity

Parameter context-type-quantity:composite

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

Resources
ExpressionValueSet.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/ValueSet-context-type-value

4.9.29 context-type-value

Parameter context-type-value:composite

A use context type and value assigned to the value set

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

Components

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

4.9.30 date

Parameter date:date

The value set publication date

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

4.9.31 derived-from

Parameter derived-from:reference

A resource that the ValueSet is derived from

ResourceValueSet
ExpressionValueSet.relatedArtifact.where(type='derived-from').resource
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/ValueSet-description

4.9.32 description

Parameter description:string

The description of the value set

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

4.9.33 effective

Parameter effective:date

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

Resources
ExpressionValueSet.effectivePeriod
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ValueSet-expansion

4.9.34 expansion

Parameter expansion:uri

Identifies the value set expansion (business identifier)

ResourceValueSet
ExpressionValueSet.expansion.identifier
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/ValueSet-identifier

4.9.35 identifier

Parameter identifier:token

External identifier for the value set

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

4.9.36 jurisdiction

Parameter jurisdiction:token

Intended jurisdiction for the value set

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

4.9.37 name

Parameter name:string

Computationally friendly name of the value set

Resources
ExpressionValueSet.name
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ValueSet-predecessor

4.9.38 predecessor

Parameter predecessor:reference

The predecessor of the ValueSet

ResourceValueSet
ExpressionValueSet.relatedArtifact.where(type='predecessor').resource
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/ValueSet-publisher

4.9.39 publisher

Parameter publisher:string

Name of the publisher of the value set

Resources
ExpressionValueSet.publisher
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ValueSet-reference

4.9.40 reference

Parameter reference:uri

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

ResourceValueSet
ExpressionValueSet.compose.include.system
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/ValueSet-status

4.9.41 status

Parameter status:token

The current status of the value set

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

4.9.42 title

Parameter title:string

The human-friendly name of the value set

Resources
ExpressionValueSet.title
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/ValueSet-topic

4.9.43 topic

Parameter topic:token

Topics associated with the ValueSet

ResourceValueSet
ExpressionValueSet.topic
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/ValueSet-url

4.9.44 url

Parameter url:uri

The uri that identifies the value set

Resources
ExpressionValueSet.url
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/valueset-extensions-ValueSet-author

4.9.45 author

Parameter author:string

Optional Extensions Element

ResourceValueSet
ExpressionCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/valueset-author').value
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/valueset-extensions-ValueSet-effective

4.9.46 effective

Parameter effective:date

Optional Extensions Element

ResourceValueSet
ExpressionCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate').value
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/valueset-extensions-ValueSet-end

4.9.47 end

Parameter end:date

Optional Extensions Element

ResourceValueSet
ExpressionCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/valueset-expirationDate').value
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/valueset-extensions-ValueSet-keyword

4.9.48 keyword

Parameter keyword:string

Optional Extensions Element

ResourceValueSet
ExpressionCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/valueset-keyWord').value
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/valueset-extensions-ValueSet-workflow

4.9.49 workflow

Parameter workflow:token

Optional Extensions Element

ResourceValueSet
ExpressionCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/valueset-workflowStatus').value
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/ValueSet-version

4.9.50 version

Parameter version:token

The business version of the value set

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