Name Flags Card. Type Description & Constraints doco
. . SearchParameter I DomainResource Search Parameter for a resource
+ If an xpath is present, there SHALL be an xpathUsage
+ Search parameters can only have chain names when the search parameter type is 'reference'
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 1..1 uri Logical URI to reference this search parameter (globally unique)
. . . version Σ 0..1 string Business version of the search parameter
. . . name Σ 1..1 string Name for this search parameter (computer friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus ( Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
Jurisdiction ValueSet ( Extensible)
. . . purpose 0..1 markdown Why this search parameter is defined
. . . code Σ 1..1 code Code used in URL
. . . base Σ 1..* code The resource type(s) this search parameter applies to
ResourceType ( Required)
. . . type Σ 1..1 code number | date | string | token | reference | composite | quantity | uri
SearchParamType ( Required)
. . . derivedFrom 0..1 uri Original Definition for the search parameter
. . . description Σ 1..1 markdown Natural language description of the search parameter
. . . expression I 0..1 string FHIRPath expression that extracts the values
. . . xpath I 0..1 string XPath that extracts the values
. . . xpathUsage I 0..1 code normal | phonetic | nearby | distance | other
XPathUsageType ( Required)
. . . target 0..* code Types of resource (if a resource reference)
ResourceType ( Required)
. . . comparator 0..* code eq | ne | gt | lt | ge | le | sa | eb | ap
SearchComparator ( Required)
. . . modifier 0..* code missing | exact | contains | not | text | in | not-in | below | above | type
SearchModifierCode ( Required)
. . . chain 0..* string Chained names supported
. . . component 0..* BackboneElement For Composite resources to define the parts
. . . . definition 1..1 Reference( SearchParameter) Defines how the part works
. . . . expression 1..1 string Subexpression relative to main expression

doco Documentation for this format