SearchParameter
SearchParameter
A search parameter that defines a named search item that can be used to search/filter on a resource.
Properties
| Name | Required | Type | Description |
|---|---|---|---|
| url | Yes | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) |
| version | No | string | Business version of the search parameter |
| name | Yes | string | Name for this search parameter (computer friendly) |
| derivedFrom | No | canonical | Original definition for the search parameter |
| status | Yes | code | draft / active / retired / unknown |
| experimental | No | boolean | For testing purposes, not real usage |
| date | No | dateTime | Date last changed |
| publisher | No | string | Name of the publisher (organization or individual) |
| contact | No | ContactDetail[] | Contact details for the publisher |
| description | Yes | markdown | Natural language description of the search parameter |
| useContext | No | UsageContext[] | The context that the content is intended to support |
| jurisdiction | No | CodeableConcept[] | Intended jurisdiction for search parameter (if applicable) |
| purpose | No | markdown | Why this search parameter is defined |
| code | Yes | code | Code used in URL |
| base | Yes | code[] | The resource type(s) this search parameter applies to |
| type | Yes | code | number / date / string / token / reference / composite / quantity / uri / special |
| expression | No | string | FHIRPath expression that extracts the values |
| xpath | No | string | XPath that extracts the values |
| xpathUsage | No | code | normal / phonetic / nearby / distance / other |
| target | No | code[] | Types of resource (if a resource reference) |
| multipleOr | No | boolean | Allow multiple values per parameter (or) |
| multipleAnd | No | boolean | Allow multiple parameters (and) |
| comparator | No | code[] | eq / ne / gt / lt / ge / le / sa / eb / ap |
| modifier | No | code[] | missing / exact / contains / not / text / in / not-in / below / above / type / identifier / ofType |
| chain | No | string[] | Chained names supported |
| component | No | SearchParameterComponent | For Composite resources to define the parts |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - definition | Yes | canonical | Defines how the part works |
| - expression | Yes | string | Subexpression relative to main expression |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| context | token | A use context assigned to the search parameter | SearchParameter.useContext.value |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the search parameter | SearchParameter.useContext.value |
| context-type | token | A type of use context assigned to the search parameter | SearchParameter.useContext.code |
| date | date | The search parameter publication date | SearchParameter.date |
| description | string | The description of the search parameter | SearchParameter.description |
| jurisdiction | token | Intended jurisdiction for the search parameter | SearchParameter.jurisdiction |
| name | string | Computationally friendly name of the search parameter | SearchParameter.name |
| publisher | string | Name of the publisher of the search parameter | SearchParameter.publisher |
| status | token | The current status of the search parameter | SearchParameter.status |
| url | uri | The uri that identifies the search parameter | SearchParameter.url |
| version | token | The business version of the search parameter | SearchParameter.version |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the search parameter | SearchParameter.useContext |
| context-type-value | composite | A use context type and value assigned to the search parameter | SearchParameter.useContext |
| base | token | The resource type(s) this search parameter applies to | SearchParameter.base |
| code | token | Code used in URL | SearchParameter.code |
| component | reference | Defines how the part works | SearchParameter.component.definition |
| derived-from | reference | Original definition for the search parameter | SearchParameter.derivedFrom |
| target | token | Types of resource (if a resource reference) | SearchParameter.target |
| type | token | number / date / string / token / reference / composite / quantity / uri / special | SearchParameter.type |
Inherited Properties
| Name | Required | Type | Description |
|---|---|---|---|
| id | No | string | Logical id of this artifact |
| meta | No | Meta | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | Narrative | Text summary of the resource, for human interpretation |
| contained | No | Resource[] | Contained, inline Resources |
| extension | No | Extension[] | Additional content defined by implementations |
| modifierExtension | No | Extension[] | Extensions that cannot be ignored |
To view the FHIR specification for this resource, see SearchParameter.