Skip to main content

SearchParameter

A search parameter that defines a named search item that can be used to search/filter on a resource.

Properties

NameCardTypeDescription
id0..1stringLogical id of this artifact
meta0..1MetaMetadata about the resource
implicitRules0..1uriA set of rules under which this content was created
language0..1codeLanguage of the resource content
text0..1NarrativeText summary of the resource, for human interpretation
contained0..*ResourceContained, inline Resources
extension0..*ExtensionAdditional content defined by implementations
modifierExtension0..*ExtensionExtensions that cannot be ignored
url1..1uriCanonical identifier for this search parameter, represented as a URI (globally unique)
version0..1stringBusiness version of the search parameter
name1..1stringName for this search parameter (computer friendly)
derivedFrom0..1canonicalOriginal definition for the search parameter
status1..1codedraft | active | retired | unknown
experimental0..1booleanFor testing purposes, not real usage
date0..1dateTimeDate last changed
publisher0..1stringName of the publisher (organization or individual)
contact0..*ContactDetailContact details for the publisher
description1..1markdownNatural language description of the search parameter
useContext0..*UsageContextThe context that the content is intended to support
jurisdiction0..*CodeableConceptIntended jurisdiction for search parameter (if applicable)
purpose0..1markdownWhy this search parameter is defined
code1..1codeCode used in URL
base1..*codeThe resource type(s) this search parameter applies to
type1..1codenumber | date | string | token | reference | composite | quantity | uri | special
expression0..1stringFHIRPath expression that extracts the values
xpath0..1stringXPath that extracts the values
xpathUsage0..1codenormal | phonetic | nearby | distance | other
target0..*codeTypes of resource (if a resource reference)
multipleOr0..1booleanAllow multiple values per parameter (or)
multipleAnd0..1booleanAllow multiple parameters (and)
comparator0..*codeeq | ne | gt | lt | ge | le | sa | eb | ap
modifier0..*codemissing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
chain0..*stringChained names supported
component0..*BackboneElementFor Composite resources to define the parts

Search Parameters

NameTypeDescriptionExpression
contexttokenA use context assigned to the search parameterSearchParameter.useContext.value
context-quantityquantityA quantity- or range-valued use context assigned to the search parameterSearchParameter.useContext.value
context-typetokenA type of use context assigned to the search parameterSearchParameter.useContext.code
datedateThe search parameter publication dateSearchParameter.date
descriptionstringThe description of the search parameterSearchParameter.description
jurisdictiontokenIntended jurisdiction for the search parameterSearchParameter.jurisdiction
namestringComputationally friendly name of the search parameterSearchParameter.name
publisherstringName of the publisher of the search parameterSearchParameter.publisher
statustokenThe current status of the search parameterSearchParameter.status
urluriThe uri that identifies the search parameterSearchParameter.url
versiontokenThe business version of the search parameterSearchParameter.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the search parameterSearchParameter.useContext
context-type-valuecompositeA use context type and value assigned to the search parameterSearchParameter.useContext
basetokenThe resource type(s) this search parameter applies toSearchParameter.base
codetokenCode used in URLSearchParameter.code
componentreferenceDefines how the part worksSearchParameter.component.definition
derived-fromreferenceOriginal definition for the search parameterSearchParameter.derivedFrom
targettokenTypes of resource (if a resource reference)SearchParameter.target
typetokennumber | date | string | token | reference | composite | quantity | uri | specialSearchParameter.type