SearchParameter
A search parameter that defines a named search item that can be used to search/filter on a resource.
Endpoints
alpha
https://api.dev.ovok.com/fhir/R4/SearchParameter| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/SearchParameter/[id] |
| Vread | GET | /fhir/R4/SearchParameter/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/SearchParameter/[id] |
| Patch | PATCH | /fhir/R4/SearchParameter/[id] |
| Delete | DELETE | /fhir/R4/SearchParameter/[id] |
| Create | POST | /fhir/R4/SearchParameter |
| Search | GET | /fhir/R4/SearchParameter |
| History | GET | /fhir/R4/SearchParameter/[id]/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
url | uri | 1..1 | Canonical identifier for this search parameter, represented as a URI (globally unique) |
version | string | 0..1 | Business version of the search parameter |
name | string | 1..1 | Name for this search parameter (computer friendly) |
derivedFrom | canonical | 0..1 | Original definition for the search parameter |
status | code | 1..1 | draft | active | retired | unknown modifier |
experimental | boolean | 0..1 | For testing purposes, not real usage |
date | dateTime | 0..1 | Date last changed |
publisher | string | 0..1 | Name of the publisher (organization or individual) |
contact | ContactDetail | 0..* | Contact details for the publisher |
description | markdown | 1..1 | Natural language description of the search parameter |
useContext | UsageContext | 0..* | The context that the content is intended to support |
jurisdiction | CodeableConcept | 0..* | Intended jurisdiction for search parameter (if applicable) |
purpose | markdown | 0..1 | Why this search parameter is defined |
code | code | 1..1 | Code used in URL |
base | code | 1..* | The resource type(s) this search parameter applies to |
type | code | 1..1 | number | date | string | token | reference | composite | quantity | uri | special |
expression | string | 0..1 | FHIRPath expression that extracts the values |
xpath | string | 0..1 | XPath that extracts the values |
xpathUsage | code | 0..1 | normal | phonetic | nearby | distance | other |
target | code | 0..* | Types of resource (if a resource reference) |
multipleOr | boolean | 0..1 | Allow multiple values per parameter (or) |
multipleAnd | boolean | 0..1 | Allow multiple parameters (and) |
comparator | code | 0..* | eq | ne | gt | lt | ge | le | sa | eb | ap |
modifier | code | 0..* | missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType |
chain | string | 0..* | Chained names supported |
component | BackboneElement | 0..* | For Composite resources to define the parts |
Resource-specific search parameters
Reference
- Official FHIR R4 spec:
SearchParameter - Maturity: Trial Use 3 (FMM 3).