R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). 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

Terminology Infrastructure icon Work GroupMaturity Level: N/A  Normative (from v4.0.0)Security Category: Anonymous Compartments: Not linked to any defined compartments

Search parameters for the Resource ValueSet - 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/ValueSet-code

4.9.23 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
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-context
This search parameter is part of the common search parameter CanonicalResource-context

4.9.24 context TU

Parameter context:token

ValueSet: A use context assigned to the value set

ResourceValueSet
Expression(ValueSet.useContext.value.ofType(CodeableConcept))
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-context-quantity
This search parameter is part of the common search parameter CanonicalResource-context-quantity

4.9.25 context-quantity TU

Parameter context-quantity:quantity

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

ResourceValueSet
Expression(ValueSet.useContext.value.ofType(Quantity)) | (ValueSet.useContext.value.ofType(Range))
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: 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

4.9.26 context-type TU

Parameter context-type:token

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

ResourceValueSet
ExpressionValueSet.useContext.code
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-context-type-quantity
This search parameter is part of the common search parameter CanonicalResource-context-type-quantity

4.9.27 context-type-quantity TU

Parameter context-type-quantity:composite

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

ResourceValueSet
ExpressionValueSet.useContext
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

context-typecode
context-quantityvalue.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

4.9.28 context-type-value TU

Parameter context-type-value:composite

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

ResourceValueSet
ExpressionValueSet.useContext
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

context-typecode
contextvalue.ofType(CodeableConcept)
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-date
This search parameter is part of the common search parameter CanonicalResource-date

4.9.29 date TU

Parameter date:date

ValueSet: The value set publication date

ResourceValueSet
ExpressionValueSet.date
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/MetadataResource-derived-from
This search parameter is part of the common search parameter MetadataResource-derived-from

4.9.30 derived-from TU

Parameter derived-from:reference

ValueSet: A resource that the ValueSet is derived from

ResourceValueSet
ExpressionValueSet.relatedArtifact.where(type='derived-from').resource
Processing ModeNormal
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-description
This search parameter is part of the common search parameter CanonicalResource-description

4.9.31 description TU

Parameter description:string

ValueSet: The description of the value set

ResourceValueSet
ExpressionValueSet.description
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/MetadataResource-effective
This search parameter is part of the common search parameter MetadataResource-effective

4.9.32 effective TU

Parameter effective:date

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

ResourceValueSet
ExpressionValueSet.effectivePeriod
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/ValueSet-expansion

4.9.33 expansion

Parameter expansion:uri

Identifies the value set expansion (business identifier)

ResourceValueSet
ExpressionValueSet.expansion.identifier
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-identifier
This search parameter is part of the common search parameter CanonicalResource-identifier

4.9.34 identifier TU

Parameter identifier:token

ValueSet: External identifier for the value set

ResourceValueSet
ExpressionValueSet.identifier
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-jurisdiction
This search parameter is part of the common search parameter CanonicalResource-jurisdiction

4.9.35 jurisdiction TU

Parameter jurisdiction:token

ValueSet: Intended jurisdiction for the value set

ResourceValueSet
ExpressionValueSet.jurisdiction
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-name
This search parameter is part of the common search parameter CanonicalResource-name

4.9.36 name TU

Parameter name:string

ValueSet: Computationally friendly name of the value set

ResourceValueSet
ExpressionValueSet.name
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/MetadataResource-predecessor
This search parameter is part of the common search parameter MetadataResource-predecessor

4.9.37 predecessor TU

Parameter predecessor:reference

ValueSet: The predecessor of the ValueSet

ResourceValueSet
ExpressionValueSet.relatedArtifact.where(type='predecessor').resource
Processing ModeNormal
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-publisher
This search parameter is part of the common search parameter CanonicalResource-publisher

4.9.38 publisher TU

Parameter publisher:string

ValueSet: Name of the publisher of the value set

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

4.9.39 reference

Parameter reference:uri

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

ResourceValueSet
ExpressionValueSet.compose.include.system
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-status
This search parameter is part of the common search parameter CanonicalResource-status

4.9.40 status TU

Parameter status:token

ValueSet: The current status of the value set

ResourceValueSet
ExpressionValueSet.status
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-title
This search parameter is part of the common search parameter CanonicalResource-title

4.9.41 title TU

Parameter title:string

ValueSet: The human-friendly name of the value set

ResourceValueSet
ExpressionValueSet.title
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/MetadataResource-topic
This search parameter is part of the common search parameter MetadataResource-topic

4.9.42 topic TU

Parameter topic:token

ValueSet: Topics associated with the ValueSet

ResourceValueSet
ExpressionValueSet.topic
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-url
This search parameter is part of the common search parameter CanonicalResource-url

4.9.43 url TU

Parameter url:uri

ValueSet: The uri that identifies the value set

ResourceValueSet
ExpressionValueSet.url
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-version
This search parameter is part of the common search parameter CanonicalResource-version

4.9.44 version TU

Parameter version:token

ValueSet: The business version of the value set

ResourceValueSet
ExpressionValueSet.version
Processing ModeNormal
MultiplesThe parameter cannot repeat or have multiple values