SearchParameter
FoundationA search parameter that defines a named search item that can be used to search/filter on a resource.
| Path | Card. | Type | Description & Constraints |
|---|---|---|---|
| SearchParameter | 0..* | — | Search parameter for a resource |
| .idΣ | 0..1 | String | Logical id of this artifact |
| .metaΣ | 0..1 | Meta | Metadata about the resource |
| .implicitRules?!Σ | 0..1 | uri | A set of rules under which this content was created |
| .language | 0..1 | code | Language of the resource content Bindinglanguages(preferred) |
| .text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| .contained | 0..* | Resource | Contained, inline Resources |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?! | 0..* | Extension | Extensions that cannot be ignored |
| .urlΣ | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) |
| .versionΣ | 0..1 | string | Business version of the search parameter |
| .nameΣ | 1..1 | string | Name for this search parameter (computer friendly) |
| .derivedFrom | 0..1 | canonical | Original definition for the search parameter |
| .status?!Σ | 1..1 | code | draft | active | retired | unknown Bindingpublication-status(required) |
| .experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
| .dateΣ | 0..1 | dateTime | Date last changed |
| .publisherΣ | 0..1 | string | Name of the publisher (organization or individual) |
| .contactΣ | 0..* | ContactDetail | Contact details for the publisher |
| .descriptionΣ | 1..1 | markdown | Natural language description of the search parameter |
| .useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
| .jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for search parameter (if applicable) Bindingjurisdiction(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 Bindingresource-types(required) |
| .typeΣ | 1..1 | code | number | date | string | token | reference | composite | quantity | uri | special Bindingsearch-param-type(required) |
| .expression | 0..1 | string | FHIRPath expression that extracts the values |
| .xpath | 0..1 | string | XPath that extracts the values |
| .xpathUsage | 0..1 | code | normal | phonetic | nearby | distance | other Bindingsearch-xpath-usage(required) |
| .target | 0..* | code | Types of resource (if a resource reference) Bindingresource-types(required) |
| .multipleOr | 0..1 | boolean | Allow multiple values per parameter (or) |
| .multipleAnd | 0..1 | boolean | Allow multiple parameters (and) |
| .comparator | 0..* | code | eq | ne | gt | lt | ge | le | sa | eb | ap Bindingsearch-comparator(required) |
| .modifier | 0..* | code | missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType Bindingsearch-modifier-code(required) |
| .chain | 0..* | string | Chained names supported |
| .component | 0..* | BackboneElement | For Composite resources to define the parts |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .definition | 1..1 | canonical | Defines how the part works |
| .expression | 1..1 | string | Subexpression relative to main expression |