Custom Search Parameters
Last updated
Was this helpful?
Last updated
Was this helpful?
Let's define a custom search parameter that allows searching Patient resources by a specific extension and its value.
Create Patient resource with required extension:
Search for Patient by occupation:
Response:
This table contains properties required by the FHIR specification and properties that Aidbox interprets.
url
uri
Search parameter unique canonical url
version
string
Search parameter version
name
string
Search parameter name, used to perform actual search queries
status
code
draft | active | retired | unknown
description
markdown
Natural language description of the search parameter
code
code
Recommended name for parameter in search url (Aidbox ignores it, and use .name
instead)
base
code[]
The resource type(s) this search parameter applies to
type
code
number | date | string | token | reference | composite | quantity | uri | special
expression
string
FHIRPath expression that extracts the values
component
BackboneElement
For Composite resources to define the parts
See also: Composite Search Parameters