http://hl7.org/fhir/StructureDefinition/SearchParameter|5.0.0
A search parameter that defines a named search item that can be used to search/filter on a resource.
| Name | Flags | Card | Type | Description & Constraints |
|---|---|---|---|---|
SearchParameter | 0..* | Search parameter for a resource | ||
Σ | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) | |
Σ | 0..* | Identifier | Additional identifier for the search parameter (business identifier) | |
Σ | 0..1 | string | Business version of the search parameter | |
Σ | 0..1 | How to compare versions http://hl7.org/fhir/ValueSet/version-algorithm (extensible) | ||
Σ | 0..1 | string | http://hl7.org/fhir/ValueSet/version-algorithm (extensible) | |
Σ | 0..1 | Coding | http://hl7.org/fhir/ValueSet/version-algorithm (extensible) | |
Σ | 1..1 | string | Name for this search parameter (computer friendly) | |
Σ | 0..1 | string | Name for this search parameter (human friendly) | |
| 0..1 | canonical | Original definition for the search parameter | ||
?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (required) | |
Σ | 0..1 | boolean | For testing purposes, not real usage | |
Σ | 0..1 | dateTime | Date last changed | |
Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | |
Σ | 0..* | ContactDetail | Contact details for the publisher | |
Σ | 1..1 | markdown | Natural language description of the search parameter | |
Σ | 0..* | UsageContext | The context that the content is intended to support | |
Σ | 0..* | CodeableConcept | Intended jurisdiction for search parameter (if applicable) Jurisdiction (extensible) | |
| 0..1 | markdown | Why this search parameter is defined | ||
| 0..1 | markdown | Use and/or publishing restrictions | ||
| 0..1 | string | Copyright holder and year(s) | ||
Σ | 1..1 | code | Recommended name for parameter in search url | |
Σ | 1..* | code | The resource type(s) this search parameter applies to FHIRTypes (required) | |
Σ | 1..1 | code | number | date | string | token | reference | composite | quantity | uri | special SearchParamType (required) | |
| 0..1 | string | FHIRPath expression that extracts the values | ||
| 0..1 | code | normal | phonetic | other SearchProcessingModeType (required) | ||
| 0..1 | string | FHIRPath expression that constraints the usage of this SearchParamete | ||
| 0..* | code | Types of resource (if a resource reference) FHIRTypes (required) | ||
| 0..1 | boolean | Allow multiple values per parameter (or) | ||
| 0..1 | boolean | Allow multiple parameters (and) | ||
| 0..* | code | eq | ne | gt | lt | ge | le | sa | eb | ap SearchComparator (required) | ||
| 0..* | code | missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate SearchModifierCode (required) | ||
| 0..* | string | Chained names supported | ||
| 0..* | BackboneElement | For Composite resources to define the parts | ||
| 1..1 | canonical | Defines how the part works | ||
| 1..1 | string | Subexpression relative to main expression |