Name Flags Card. Type Description & Constraints doco
. . SearchParameter TU DomainResource Search parameter for a resource
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: If an expression is present, there SHALL be a processingMode
+ Rule: Search parameters can only have chain names when the search parameter type is 'reference'
+ Rule: Search parameters comparator can only be used on type 'number', 'date', 'quantity' or 'special'.

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: CanonicalResource
. . . url Σ C 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
. . . identifier Σ 0..* Identifier Additional identifier for the search parameter (business identifier)

. . . version Σ 0..1 string Business version of the search parameter
. . . versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm ( Extensible)
. . . . versionAlgorithmString string
. . . . versionAlgorithmCoding Coding
. . . name Σ C 1..1 string Name for this search parameter (computer friendly)
. . . title Σ T 0..1 string Name for this search parameter (human friendly)
. . . derivedFrom 0..1 canonical( SearchParameter) Original definition for the search parameter
. . . status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required)
. . . experimental Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ T 0..1 string Name of the publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher

. . . description Σ T 1..1 markdown Natural language description of the search parameter
. . . useContext Σ 0..* UsageContext The context that the content is intended to support

. . . jurisdiction Σ XD 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
Binding: Jurisdiction ValueSet ( Extensible)

. . . purpose T 0..1 markdown Why this search parameter is defined
. . . copyright T 0..1 markdown Use and/or publishing restrictions
. . . copyrightLabel T 0..1 string Copyright holder and year(s)
. . . code Σ 1..1 code Recommended name for parameter in search url
. . . base Σ 1..* code The resource type(s) this search parameter applies to
Binding: Version Independent Resource Types (All) ( Required)
Additional Bindings Purpose
All Resource Types UI Binding


. . . type Σ C 1..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType ( Required)
. . . expression C 0..1 string FHIRPath expression that extracts the values
. . . processingMode C 0..1 code normal | phonetic | other
Binding: Search Processing Mode Type ( Required)
. . . constraint 0..1 string FHIRPath expression that constraints the usage of this SearchParamete
. . . target 0..* code Types of resource (if a resource reference)
Binding: Version Independent Resource Types (All) ( Required)
Additional Bindings Purpose
All Resource Types UI Binding


. . . multipleOr 0..1 boolean Allow multiple values per parameter (or)
. . . multipleAnd 0..1 boolean Allow multiple parameters (and)
. . . comparator C 0..* code eq | ne | gt | lt | ge | le | sa | eb | ap
Binding: Search Comparator ( Required)

. . . modifier 0..* code missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Binding: Search Modifier Code ( Required)

. . . chain C 0..* string Chained names supported

. . . component 0..* BackboneElement For Composite resources to define the parts

. . . . definition 1..1 canonical( SearchParameter) Defines how the part works
. . . . expression 1..1 string Subexpression relative to main expression

doco Documentation for this format