Custom Search Parameters
Configure Aidbox
To begin using custom search parameters, enable the FHIR Schema validator engine in Aidbox.
Setup Aidbox with FHIR Schema validation engineCreate a custom search parameter via FHIR API
Let's define a custom search parameter that allows searching Patient resources by a specific extension and its value.
Request
Response
Test Search Parameter:
Create Patient resource with required extension:
Search for Patient by occupation:
Response:
SearchParamter resource structure
This table contains properties required by the FHIR specification and properties that Aidbox interprets.
Property | FHIR datatype | Description |
---|---|---|
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 |
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 |
Last updated